Skip to navigation
API ReferenceIdentity and KYC

Get KYC status

Returns the outcome of the KYC documents sent for a customer of your business. A rejected check lists the reasons. A customer who also banks with Halo directly or through another business is refused with 403.

Authentication

AuthorizationBearer

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

Path parameters

paramstringRequired
The customer email, or an account number your business opened.

Response

The verification outcome.
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

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error