Get started

Webhooks

Register a webhook and SprintCheck posts each verification result to your server the moment it completes — whether it came through the API directly or a client SDK.

Webhooks allow you to receive real-time notifications about events happening in your SprintCheck account. When a verification is processed, SprintCheck sends an HTTP POST request to the URL you provide.

Setting up Webhooks

To start receiving webhook notifications, follow these steps:

1. Log in to your SprintCheck Dashboard.
2. Navigate to its Developer section.
3. Locate the Webhook URL field.
4. Enter your server's endpoint URL where you wish to receive the POST requests.
5. Save your changes.

Developers page in the SprintCheck dashboard, showing the Webhook URL field

Payload

Match the event back to your records with reference and identifier. kyc_details varies by document type — BVN and NIN shown below.

POST your-webhook-url · BVN VERIFICATION

{
  "schema_version": 1,
  "event": "verification",
  "event_type": "BVN VERIFICATION",
  "event_id": "1000000000000684746915906461696:2026-03-05T13:41:43+00:00",
  "occurred_at": "2026-03-05T13:41:43+00:00",
  "reference": "1000000000000684746915906461696",
  "number": "22454670613",
  "status": 1,
  "source": "SDK",
  "confidence": "80",
  "image": "https://minio-5star-api.dev.5starcompany.com.ng/sprintcheck/db45cd89-e9a0-4190-8d0a-da6d1410c1c8.jpg",
  "identifier": "samjibaba_bvn",
  "kyc_details": {
    "bvn": "22454670613",
    "firstName": "SAMUEL",
    "middleName": "ADEKUNLE",
    "lastName": "ODEJINMI",
    "gender": "Male",
    "birthday": "1996-12-12",
    "photo": "/9j/I/1qD5fcelIDOiusmrYKuKylTawIzg96vQswHYikBLgpU8cxC4DGoiQw4qIybTjn8qYj//Z...........",
    "nameOnCard": "ODEJINMI SAMUEL ADEKUNLE",
    "phoneNumber": "08166939205",
    "phoneNumber2": ""
  }
}

Representative example — field values are illustrative.

POST your-webhook-url · NIN VERIFICATION

{
  "schema_version": 1,
  "event": "verification",
  "event_type": "NIN VERIFICATION",
  "event_id": "1000000000000684741631255388160:2026-03-05T13:39:23+00:00",
  "occurred_at": "2026-03-05T13:39:23+00:00",
  "reference": "1000000000000684741631255388160",
  "number": "52306459347",
  "status": 1,
  "source": "API",
  "confidence": "90",
  "image": "https://minio-5star-api.dev.5starcompany.com.ng/sprintcheck/8f097518-63f6-4af7-b816-d067f7a1517a.jpg",
  "identifier": "identifier_nin",
  "kyc_details": {
    "nin": "52306459347",
    "firstName": "SAMUEL",
    "middleName": "ADEKUNLE",
    "surname": "ODEJINMI",
    "gender": "Male",
    "birthDate": "1996-12-12",
    "photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBw.....",
    "telephoneNo": "08166939205"
  }
}

Representative example — field values are illustrative.

Treat webhook delivery as at-least-once: keep handlers idempotent by keying on reference, and fall back to your dashboard's verification history if your endpoint was down.