Get KYC Info

Retrieves identity information (BVN, NIN or CAC) for a client from the verification provider and records a KYC log. Supply clientId and/or kycNumber. For a BVN or NIN request with a clientId, the number stored on the client record is used.

POST /core/kyc/info

Request Body

Field Name	Type	Required	Description
clientId	Long	FALSE	Client whose stored identity number is looked up. Required if `kycNumber` is not supplied
kycType	String	TRUE	`BVN`, `NIN` or `CAC` (case sensitive)
kycNumber	String	FALSE	Identity number to look up. Required if `clientId` is not supplied
kycUpgrade	Boolean	FALSE	Defaults to false
kycUpgradeLevel	String	FALSE	Target level when upgrading

Response

Field Name	Type	Description
id	Long	Record id
idType	String	BVN or NIN
firstName / middleName / lastName	String	Name as held by the provider
email	String	Email as held by the provider
phoneNumber	String	Phone number as held by the provider
dateOfBirth	String	`yyyy-MM-dd`
gender	String	Gender
image	String	Base64 passport photo
address	String	Address
kycLogId	Long	Id of the KYC log created for this request
verifiedStatus	Boolean	Whether the log has been marked verified

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,
  "kycType": "BVN",
  "kycNumber": "22000000000",
  "kycUpgrade": false
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "id": 101,
  "idType": "BVN",
  "title": "Mr",
  "firstName": "Ada",
  "middleName": "Chike",
  "lastName": "Example",
  "email": "ada.example@example.com",
  "phoneNumber": "08000000000",
  "dateOfBirth": "1990-01-15",
  "fullName": "Ada Chike Example",
  "image": "/9j/4AAQSkZJRgABAQ...",
  "gender": "Male",
  "imageType": "jpeg",
  "stateOfOrigin": "Lagos",
  "lgaOfOrigin": "Ikeja",
  "stateOfResidence": "Lagos",
  "address": "1 Sample Street, Ikeja",
  "kycLogId": 101,
  "verifiedStatus": false,
  "verificationStatus": true,
  "verificationMessage": null
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Get KYC Info

Get KYC Info#

Request Body#

Response#

Request

Request Code Samples

Responses

Get KYC Info

Request Body

Response