Get KYC Comparison Details

Returns the full verification record for a KYC log: what was requested, the client's own data, the provider's response and, for automated verification, the per-field comparison results.

GET /core/kyc/comparisondetails/{logId}

Path Parameter

Field Name	Type	Required	Description
logId	Long	TRUE	KYC log id

Response

Field Name	Type	Description
kycLogId	Long	KYC log id
kycRequest	Object	`kycProvider`, `kycType`, `kycNumber`, `clientId`
kycClientData	Object	The client's own name, contact, date of birth, gender, address and passport
kycResponse	Object	Provider response (names, phone, date of birth, image, address)
kycComparisonData	Array	Per KYC level: `kycLevel`, `approved`, `kycAssessmentData` (per-field `kycField`, `clientData`, `kycRequestData`, `kycComparisonSetting`, `kycVerificationData`, `kycVerificationStatus`, `fuzzyMatch`)
verified	Boolean	Verification outcome
isAutomated	Boolean	True if produced by auto verification
approvedKYCLevel	Integer	Level granted, if any
requestBy / requestById	String / Long	User that triggered the verification

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": 11,
  "kycLogId": 101,
  "kycRequest": {
    "kycProvider": "PROVIDER",
    "kycType": "BVN",
    "kycNumber": "22000000000",
    "clientId": 1
  },
  "kycClientData": {
    "id": 1,
    "clientType": "PERSON",
    "firstName": "Ada",
    "lastName": "Example",
    "displayName": "Ada Example",
    "mobileNo": "08000000000",
    "emailAddress": "ada.example@example.com",
    "dateOfBirth": "1990-01-15",
    "gender": "Male",
    "address": "1 Sample Street, Ikeja"
  },
  "kycResponse": {
    "id": 101,
    "idType": "BVN",
    "firstName": "Ada",
    "lastName": "Example",
    "phoneNumber": "08000000000",
    "gender": "Male",
    "kycLogId": 101,
    "verifiedStatus": true
  },
  "kycComparisonData": [
    {
      "kycLevel": "KYC_LEVEL_1",
      "approved": true,
      "kycAssessmentData": {
        "firstName": {
          "kycField": "firstName",
          "clientData": "Ada",
          "kycRequestData": "Ada",
          "kycComparisonSetting": 90,
          "kycComparisonMandatory": true,
          "kycVerificationData": 100,
          "kycVerificationStatus": true,
          "fuzzyMatch": false
        }
      }
    }
  ],
  "verified": true,
  "isAutomated": true,
  "requestById": 5,
  "requestBy": "Sample Admin",
  "approvedKYCLevel": 1
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🔴500| Source | Error | When |

Get KYC Comparison Details