FaWCOS
Early access: not live yet

Build with verified farm data, shared with consent.

One API for banks and insurers. You never read raw farmer records. You receive signed attestations a farmer agreed to share with you, for one purpose and a limited time.

Read the documentation Request early access
Request a farmer’s consent Draft 
$ curl -X POST $FAWCOS_API/v1/consent-requests \
  -H "x-api-key: $FAWCOS_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "farmer_phone": "+2348000000001",
    "purpose": "loan_assessment",
    "data_scope": ["levels", "tier", "verified_area"]
  }'

# 202 Accepted: the same answer whether or not
# the farmer is registered.

Illustrative and draft. Endpoints follow the published design and are not implemented yet.

From test key to attestation in three steps.

  1. 1

    Get a test key

    Create a test key in the FaWCOS workspace under Settings, API access. It starts with FWS_test_ and is shown once.

  2. 2

    Request consent

    Name the farmer, the purpose and the data scope. The answer is the same whether or not the farmer is registered.

  3. 3

    Fetch the attestation

    When the farmer consents, you receive a signed attestation with only the facts they agreed to share.

One host. The key decides the environment.

A test key only ever returns synthetic farmers. A live key only returns real farmers who consented. The two cannot be mixed.

Key prefixEnvironmentData
FWS_test_SandboxSynthetic farmers and consents only
FWS_live_LiveReal attestations under real consents

Keys are shown once, stored hashed, and revoked immediately when you ask. Test keys are self-serve. Live keys are issued after a manual review by the FaWCOS team.

Going live is a review, not a form.

The FaWCOS team reviews every live key request. You will be asked for:

  • Your registered business identity
  • A named responsible officer
  • The purposes you will request consent for
  • A signed data-sharing agreement

You can use test keys at any time while the review is under way. Requests for purposes outside the list you submit are refused.

Documentation

Open the docs

The documentation is a draft until the endpoints are live. Anything not yet built is marked Draft there.

Want to build on FaWCOS first?

Tell us what you want to use verified, consented farm data for. We will reach out when sandbox access opens.

Request early access