Checks

Fetch a check

Returns a check again, for example after a webhook tells you a pending check has finished. Record fields are never returned here: they're sent once, in the original response.

GET/v1/kyc/checks/{reference_id}

Request

Authenticate with Authorization: Bearer <your key>.

Path parameters

reference_idstringrequired

Example

GET /v1/kyc/checks/{reference_id}

curl https://api.verath.io/v1/kyc/checks/chk_3c5e1f0a9b2d4c7e8f6a1b2c3d4e5f60 \
  -H "Authorization: Bearer $VERATH_KEY"

200 OK

{
  "reference_id": "chk_3c5e1f0a9b2d4c7e8f6a1b2c3d4e5f60",
  "object": "check",
  "check": "nin_basic",
  "status": "completed",
  "found": true,
  "source": "registry",
  "source_ref": "sbx_8f29a712c4e01b5d",
  "id_number": {
    "type": "nin",
    "last_digits": "0006"
  },
  "match": {
    "first_name": 100,
    "last_name": 100,
    "dob": 100
  },
  "match_result": {
    "first_name": "match",
    "last_name": "match",
    "dob": "match"
  },
  "route": [
    {
      "source": "registry",
      "outcome": "found",
      "latency_ms": 412,
      "ref": "sbx_8f29a712c4e01b5d"
    }
  ],
  "latency_ms": 431,
  "error": null,
  "cost": {
    "billed": false,
    "amount_kobo": 0,
    "currency": "NGN"
  },
  "customer": {
    "id": "cus_9a7b…",
    "customer_ref": "cust_1042"
  },
  "purpose": "KYC-ONB",
  "consent_ref": null,
  "mode": "test",
  "created_at": "2026-11-11T15:32:00.112Z",
  "completed_at": "2026-11-11T15:32:00.543Z",
  "retry": null
}

Responses

Status	Meaning
200	The check.
404	No such check.