Get KYC by ID

GET /api/v{version}/Kyc/{id}/get

Description

This endpoint retrieves the Know Your Customer (KYC) details for a specific user based on their unique identifier (ID). It returns detailed information about the user's KYC status, including tier, approval status, and verification details.

Parameters

• id (string (UUID), path, required): The unique identifier of the KYC record.
• version (string, path, required): The version of the API.
• Accept-Language (string, header, optional): Change the default response message language from English (en). Available languages are fr and en.

Responses

• 200 OK
  • Media type: Controls Accept header.
  • Example Value:

{
  "succeeded": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tier": "string",
    "name": "string",
    "tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "approved": true,
    "isTenant": true,
    "isAddressVerified": true,
    "approvedOn": "2024-08-07T09:58:23.111Z",
    "bvn": "string",
    "status": "string"
  }
}