Approve KYC request

POST /api/v{version}/Kyc/approve

Description

This endpoint is used to approve a KYC (Know Your Customer) request. The approval process involves submitting the approver's ID and the KYC ID to be approved.

Parameters

• 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.

Request Body

• Media Type: application/json

Example Value

{
  "by": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "kycId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Responses

This section outlines the possible responses from the KYC approval API.

Success Response (200)

The Success Response (200) is returned when the KYC request is successfully approved. This response indicates the success of the operation and provides additional details.

Response Fields

Field	Type	Description
succeeded	boolean	Indicates the success of the KYC approval request.
message	string	A message indicating the outcome of the operation.
errors	array	An array of strings providing details about any errors encountered during the request.
data	object	Contains the details of the approved KYC.

Data Object Fields

Field	Type	Description
id	string	The ID of the approved KYC.
tier	string	The tier of the KYC.
name	string	The name associated with the KYC.
tenantId	string	The ID of the tenant.
ownerId	string	The ID of the owner.
approved	boolean	Indicates if the KYC is approved.
isTenant	boolean	Indicates if the KYC is for a tenant.
isAddressVerified	boolean	Indicates if the address is verified.
approvedOn	string	The date and time when the KYC was approved (in ISO 8601 format).
bvn	string	The Bank Verification Number (BVN) associated with the KYC.
status	string	The status of the KYC.

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:32:01.625Z",
    "bvn": "string",
    "status": "string"
  }
}