Skip to navigation
API ReferenceIdentity and KYC

Get NIN check status

Returns the state of a NIN check your business started. status is pending, processing, completed or failed. When it is completed, verification_status (verified, rejected or failed) and verification_data are included.

Limited to 60 requests a minute for each API key.

Authentication

AuthorizationBearer

Your Halo partner API key, sent as Authorization: Bearer <key>.

Path parameters

referencestringRequired

The reference_id returned by Verify NIN.

Response

The state of the check.
statusboolean
True on success, false otherwise.
messagestring or map from strings to lists of strings
A short message. On a 422 validation failure it is an object of field names to error lists.
status_codeinteger
The HTTP status code.
dataanyOptional
The result. Left out on most errors.

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error