Get All KYC Records

GET /api/v{version}/Kyc/get-all

Description

This endpoint retrieves all Know Your Customer (KYC) records based on the provided query parameters.

Parameters

• OwnerId (string($uuid), query, optional): The ID of the owner.
• TenantId (string($uuid), query, optional): The ID of the tenant.
• Orderby (integer($int32), query, optional): The order in which to sort the results. Available values: 1, 2, 3, 4.
• Tier (integer($int32), query, optional): The tier level to filter results by. Available values: 0, 1, 2.
• Descending (boolean, query, optional): Whether to sort the results in descending order.
• PageNumber (integer($int32), query, optional): The page number for pagination.
• PageSize (integer($int32), query, optional): The number of records per page.
• 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

Success Response (200)

The Success Response (200) is returned when the KYC records are successfully retrieved. This response includes the retrieved KYC data and additional pagination details.

Response Fields

Field	Type	Description
succeeded	boolean	Indicates the success of the 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	array	An array of objects containing the KYC records. Each object includes the following fields:
data.id	string	The ID of the KYC record.
data.tier	string	The tier level of the KYC record.
data.name	string	The name associated with the KYC record.
data.tenantId	string	The ID of the tenant associated with the KYC record.
data.ownerId	string	The ID of the owner associated with the KYC record.
data.approved	boolean	Indicates if the KYC record is approved.
data.isTenant	boolean	Indicates if the record belongs to a tenant.
data.isAddressVerified	boolean	Indicates if the address is verified.
data.approvedOn	string	The date and time when the KYC record was approved.
data.bvn	string	The Bank Verification Number (BVN) associated with the KYC record.
data.status	string	The status of the KYC record.
pageNumber	integer	The current page number.
pageSize	integer	The number of records per page.
total	integer	The total number of records available.

Example

JSON:

{
  "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-07T10:06:00.868Z",
      "bvn": "string",
      "status": "string"
    }
  ],
  "pageNumber": 0,
  "pageSize": 0,
  "total": 0
}