Auto Verify KYC

Looks up the client's BVN, NIN or CAC, compares the provider data and passport photo with the client record against the automated KYC settings, and assigns a KYC level when the comparison passes. Requires client passport upload and the automatic verification setting to be enabled.

POST /core/kyc/autoverify

Request Body

Field Name	Type	Required	Description
clientId	Long	TRUE	Client to verify
kycType	String	TRUE	`BVN`, `NIN` or `CAC` (case sensitive)
kycUpgrade	Boolean	FALSE	Set true to validate against a specific upgrade level. Defaults to false
kycUpgradeLevel	String	FALSE	Level to validate when upgrading, e.g. `KYC_LEVEL_2`

Response

Field Name	Type	Description
kycRequest	Object	Request as processed
kycClientData	Object	Client data used in the comparison
kycResponse	Object	Provider response
kycComparisonData	Array	Per-level, per-field comparison results
verified	Boolean	True if a KYC level was assigned
approvedKYCLevel	Long	Level assigned, if any
requestById / requestBy	Long / String	User that triggered the verification

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",
  "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

{
  "kycRequest": {
    "kycProvider": "PROVIDER",
    "kycType": "BVN",
    "kycNumber": "22000000000",
    "clientId": 1,
    "kycUpgrade": false
  },
  "kycClientData": {
    "id": 1,
    "firstName": "Ada",
    "lastName": "Example",
    "mobileNo": "08000000000",
    "dateOfBirth": "1990-01-15",
    "gender": "Male"
  },
  "kycResponse": {
    "id": 101,
    "idType": "BVN",
    "firstName": "Ada",
    "lastName": "Example",
    "kycLogId": 101
  },
  "kycComparisonData": [
    {
      "kycLevel": "KYC_LEVEL_1",
      "approved": true
    }
  ],
  "verified": true,
  "approvedKYCLevel": 1,
  "requestById": 5,
  "requestBy": "Sample Admin"
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🔴500| Source | Error | When |

Auto Verify KYC

Auto Verify KYC#

Request Body#

Response#

Request

Request Code Samples

Responses

Auto Verify KYC

Request Body

Response