Set KYC Level

POST

/core/kyc/setlevel

Set KYC Level

Sets the KYC level of a client. When KYC enforcement is on, the level is only set if the client has the required verified identity records.

POST /core/kyc/setlevel

Request Body

Field Name	Type	Required	Description
clientId	Long	TRUE	Client id
kycLevel	Long	TRUE	`1` needs BVN or NIN verified, `2` needs BVN and NIN verified, `3` needs BVN and NIN verified plus both document ids
idDocumentId	Long	FALSE	Identity document id. Required for level 3
addressDocumentId	Long	FALSE	Address document id. Required for level 3

Response

Echoes the request body.

Field Name	Type	Description
clientId	Long	Client id
kycLevel	Long	Level requested
idDocumentId	Long	Identity document id, or null
addressDocumentId	Long	Address document id, or null

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Body Params application/json

Example

{
  "clientId": 1,
  "kycLevel": 3,
  "idDocumentId": 12,
  "addressDocumentId": 13
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/core/kyc/setlevel' \
--header 'Content-Type: application/json' \
--data '{
  "clientId": 1,
  "kycLevel": 3,
  "idDocumentId": 12,
  "addressDocumentId": 13
}'

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "clientId": 1,
  "kycLevel": 3,
  "idDocumentId": 12,
  "addressDocumentId": 13
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🔴500| Source | Error | When |

Modified at 2026-11-02 05:49:15

Get KYC Logs

Set KYC Log Status

Set KYC Level

Set KYC Level#

Request Body#

Response#

Request

Request Code Samples

Responses

Set KYC Level

Request Body

Response