Quickstart

Create an API key

In your Verifisha workspace, create a vrf_test_ key. Test keys run against sandbox, where paid providers are never called — nothing you do with one can bill.

Keep the key server-side. Anyone holding it can act as your workspace.

Build against sandbox

Point your integration at the sandbox host and create a report:

curl -X POST https://sandbox-api.verifisha.com/api/v1/reports \
  -H "Authorization: Bearer vrf_test_..." \
  -H "Idempotency-Key: customer-case-1042" \
  -H "Content-Type: application/json" \
  -d '{
    "reports": [{
      "subject": {
        "subjectType": "INDIVIDUAL",
        "fullName": "Jane Wanjiku Doe",
        "idNumber": "36901234",
        "email": "jane@example.com",
        "country": "KE"
      },
      "checksRequested": ["IDENTITY", "KRA_PIN", "CRB_STANDARD"],
      "purpose": "Employment screening",
      "consent": { "mode": "VERIFISHA_HOSTED" },
      "paymentMode": "SELF"
    }]
  }'

Then read it back:

curl https://sandbox-api.verifisha.com/api/v1/reports/{reportId} \
  -H "Authorization: Bearer vrf_test_..."

Sandbox responses carry X-Verifisha-Sandbox: true. Sandbox returns fixtures for a subset of the API — see environments for what is covered.

Request go-live

When your integration works against sandbox, request go-live from your workspace.

• Signed up as an individual? Your account is converted to a business workspace as part of the request.
• Upload your business KYB documents.
• Verifisha runs a business verification check on your company.

Get approved

Once your request is approved, you will receive an email containing your vrf_live_ API key. Switch your integration to it and to the production host, https://api.verifisha.com.

Treat that email as a secret: move the key into your secret store and do not forward it.