API Reference

REST API Documentation

Integrate Spidify's identity verification platform into your application using our REST API. Build custom flows and handle verifications server-side.

Authentication

All API requests must be authenticated using your **Secret Key** in the request headers. You can manage your keys in the Developer Settings of your dashboard.

Authorization: Bearer YOUR_SECRET_KEY

Keep your Secret Key secure. Do not expose it in client-side code.

API Endpoints

POST

/api/sdk/verification

Initialize Session

Creates a new verification session for a customer.

Request Body

{
  "documentType": "NIN",
  "externalId": "cust_12345"
}

Response (200 OK)

{
  "verification": {
    "reference": "SP_REV_8231...",
    "status": "PENDING",
    "currentStage": "INITIALIZED"
  }
}

PATCH

/api/sdk/verification/:reference

Update Progress

Updates the status or details of an active verification session.

URL Parameters

reference (string): The unique verification reference returned during initialization.

Request Body

{
  "stage": "LIVENESS_COMPLETE",
  "details": {
    "fullName": "John Doe",
    "bvn": "22222222222"
  }
}

Webhooks

Configure your endpoint URL in the dashboard to receive asynchronous updates when a verification status changes.

Sample Event Payload

{
  "event": "verification.completed",
  "data": {
    "reference": "SP_REV_8231...",
    "status": "APPROVED",
    "user_details": {
      "fullName": "John Doe",
      "nin": "1234567890"
    }
  }
}

Ready to test?

Access our Sandbox environment instantly. Generate test API keys and simulate verifications without using real credentials.

Get Sandbox Keys