Skip to main content
You can build against the sandbox with a test key straight away. Live keys, which return real farmers’ attestations, are issued after the FaWCOS team reviews your organisation once. Going live is then a key swap: the endpoints, request shapes and responses are the same. Only organisation administrators can apply.

​
Before you start

You need an organisation on the FaWCOS enterprise dashboard with sandbox access turned on. Live access always starts from a working sandbox setup.

​
The application

You apply from the Compliance page of the dashboard. The application has five sections. You can save a section and come back later.
Your business type, legal and trading name, industry, staff size and registration number. Registered companies also give their incorporation period and tax identification number (TIN).The business type decides what the rest of the application asks for:
  • Private or public limited company
  • Registered business name (sole proprietor)
  • Incorporated trustees (NGO, religious body, association)
  • Cooperative society
  • Free zone entity
  • Government agency
  • Private entity created by government approval
Business, support and disputes email addresses, a phone number, your website, and your registered address. Add an office address if it differs.
The directors and beneficial owners your business type requires, each with a government ID (driver’s licence, NIN slip, voter’s card or international passport) uploaded against their name. The application shows how many of each you need once you have chosen the business type.
The registration documents for your business type, such as the certificate of incorporation, status report, TIN certificate and proof of address. The application lists exactly which ones apply to you. Some organisations, such as non-profits, must also provide an anti-money-laundering registration certificate.
Why you will ask farmers for consent. Choose the purposes that apply to you: loan_assessment, crop_insurance, input_financing, programme_verification or research. Name a responsible officer, and accept the FaWCOS data-sharing agreement.
Uploads must be PDF, PNG or JPEG files under 5 MB. Uploading a document again replaces the earlier file. Files are stored privately and only ever shown to the reviewers handling your application.
The purposes you name are recorded with your application and reviewed by the FaWCOS team. Name every purpose you expect to need, and describe each accurately.

​
Submit and review

Submit is available once every section is complete. If something is missing, the application tells you which section and what. After you submit, the application is locked while the FaWCOS team reviews it, and you get an email confirming it was received. Your application is always in one of these states: We email the decision to your organisation. When changes are requested, the email says what needs fixing.

​
After you are approved

Create a live key with the scopes you need (see Authentication) and use it in place of your test key. Your test keys keep working. If FaWCOS suspends live access, live keys stop working at once and requests with them return 403 live_access_not_approved. Test keys are not affected. Keys are kept, so reinstating access needs no new keys.