1. KYC
Core Banking Services
  • Introduction
  • Terminologies
  • Webhooks
  • Authentication
  • Account
    • Product List
      GET
    • Create Account
      POST
    • Update Account
      PUT
    • Find Client
      POST
    • Accounts
      GET
    • Create Additional Account
      POST
    • Account Details By BVN
      GET
    • Get Client Addresses
      GET
    • Get Account Details
      GET
    • Get Account Summary
      GET
    • Client Images
      GET
    • Update BVN
      POST
    • Update Transaction Limit
      POST
    • Client Notifications
      PUT
    • Activate Client Account
      POST
    • Add Client Address
      POST
    • Update Client Address
      PUT
    • Get Full Account Details
      GET
    • Get Full Account Details By NUBAN
      GET
    • Upload Client Passport
      POST
    • Update NIN
      POST
    • Create Client
      POST
    • Get Directors
      GET
    • Create Directors
      POST
    • Update Directors
      PUT
    • Delete Director
      DELETE
    • Get Genders
      GET
    • Get Signatories
      GET
    • Create Signatories
      POST
    • Delete Signatory
      DELETE
    • Get Template
      GET
  • KYC
    • Get KYC Info
      POST
    • Update KYC
      POST
    • Get KYC Level
      GET
    • Auto Verify KYC
      POST
    • Get KYC Comparison Details
      GET
    • Face Comparison
      POST
    • Get KYC Info
      POST
    • Get KYC Settings
      GET
    • Get KYC Info
      POST
    • Create Face Liveness Session
      POST
    • Get KYC Log Details
      GET
    • Get KYC Logs
      GET
    • Set KYC Level
      POST
    • Set KYC Log Status
      POST
  • Transaction
    • Payment Types
    • Debit Account
    • Credit Account
    • Transaction History
    • Transaction Details [Legacy]
    • Transaction Details
    • Get All Transactions
  • Transfer
    • Interbank Transfer
      • Get Institutions
      • Name Inquiry
      • Interbank Transfer
      • InterBank Transfer Query
      • Transfer Details
      • Bulk Interbank Transfer
    • Intrabank Transfer
      • IntraBank Transfer
      • Intrabank Transfer To Virtual Accounts
      • Query Intrabank Transfer Status
      • Intrabank Transfer To Virtual Accounts
      • Query Intrabank Transfer To Virtual Account Status
  • Account Restrictions
    • Block Debit
    • Unblock Debit
    • Hold Amount
    • Release Amount
    • Block Account
    • Block Account Credits
    • Unblock Account
    • Unblock Account Credits
  • Reporting
    • Report Types
    • Get Report Parameters
    • Create Report
    • Report Details
    • Get Reports
  • Organisation
    • Get Address Types
    • Get Offices
    • Get States
  • Schemas
    • Client
    • Product
    • ClientNotificationsRequest
    • ClientNotificationsResponse
    • ErrorDetail
    • ErrorResponse
    • ValidationErrorResponse
  1. KYC

Get KYC Info

POST
/core/kyc/getinfo

Get KYC Info By Client#

Retrieves identity information (BVN, NIN or CAC) for a client using the number stored on the client record, from the verification provider, and records a KYC log. This replaces the old POST /core/account/{clientId}/kycinfo.
POST /core/kyc/getinfo

Request Body#

Field NameTypeRequiredDescription
clientIdLongTRUEClient to look up
kycTypeStringTRUEBVN, NIN or CAC (case sensitive)
kycUpgradeBooleanFALSEDefaults to false
kycUpgradeLevelStringFALSETarget level when upgrading

Response#

Field NameTypeDescription
idLongRecord id
idTypeStringBVN or NIN
firstName / middleName / lastNameStringName as held by the provider
phoneNumberStringPhone number as held by the provider
dateOfBirthStringyyyy-MM-dd
genderStringGender
imageStringBase64 passport photo
addressStringAddress
kycLogIdLongId of the KYC log created for this request
verifiedStatusBooleanWhether 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
or
Body Params application/json

Example
{
  "clientId": 1,
  "kycType": "NIN"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/core/kyc/getinfo' \
--header 'Content-Type: application/json' \
--data '{
  "clientId": 1,
  "kycType": "NIN"
}'

Responses

🟢200Success
application/json
Success
Bodyapplication/json

Example
{
  "id": 0,
  "idType": "NIN",
  "title": "",
  "firstName": "Sample",
  "middleName": "",
  "lastName": "Customer",
  "email": "customer2@example.com",
  "phoneNumber": "08000000012",
  "dateOfBirth": "1998-10-01",
  "fullName": null,
  "image": "{base64 encoded image}",
  "gender": "m",
  "imageType": "BASE64",
  "stateOfOrigin": "Lagos",
  "lgaOfOrigin": "",
  "stateOfResidence": "Abuja Federal Capital Territor",
  "address": "The World",
  "registrationOfBirth": null,
  "kycLogId": null,
  "verifiedStatus": false,
  "verificationStatus": false,
  "verificationMessage": null,
  "verificationDetails": null
}
🟠400| Source | Error | When |
🟠401| Source | Error | When |
🟠403| Source | Error | When |
🟠404| Source | Error | When |
🔴500| Source | Error | When |
Modified at 2026-11-02 05:49:15
Previous
Face Comparison
Next
Get KYC Settings
Built with