Get KYC Log Details

Returns the identity information stored for a KYC log, as originally returned by the KYC provider.

GET /core/kyc/logdetails/{logId}

Path Parameter

Field Name	Type	Required	Description
logId	Long	TRUE	KYC log id (from `GET /core/kyc/logs/{clientId}`)

Response

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

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

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",
  "image": "/9j/4AAQSkZJRgABAQ...",
  "gender": "Male",
  "imageType": "jpeg",
  "address": "1 Sample Street, Ikeja",
  "kycLogId": 101,
  "verifiedStatus": true,
  "verificationStatus": true
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🔴500| Source | Error | When |

Get KYC Log Details