Get KYC Information

Looks up the identity details held by the verification provider for a BVN, NIN or CAC number.

POST /merchant/account/kyc

Request Body

Field Name	Type	Required	Description
kycType	String	TRUE	`BVN`, `NIN` or `CAC` (upper case)
kycNumber	String	TRUE	The number to look up

Response

Field Name	Type	Description
idType	String	BVN, NIN or CAC
title	String	Title
firstName / middleName / lastName	String	Name held by the provider
email	String	Email held by the provider
phoneNumber	String	Phone number held by the provider
dateOfBirth	String	`yyyy-MM-dd`
gender	String	Gender
image	String	Base64 photo
imageType	String	Image format
stateOfOrigin / lgaOfOrigin / stateOfResidence	String	Location details
address	String	Address
organisation*	various	CAC lookups only: company name, status, registration number, directors and shareholders in `organisationComponents`

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

{
  "kycType": "BVN",
  "kycNumber": "22000000000"
}

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",
  "gender": "Male",
  "imageType": "jpeg",
  "stateOfOrigin": "Lagos",
  "lgaOfOrigin": "Ikeja",
  "stateOfResidence": "Lagos",
  "address": "1 Sample Street, Ikeja",
  "organisationComponents": []
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🔴500| Source | Error | When |

Get KYC Information