Verification ChecksCatalogue

Get one check definition

GET
/api/v1/checks/definitions/{checkName}

One check from the catalogue.

Authorization

AuthorizationBearer <token>

Use Authorization: Bearer vrf_live_... or vrf_test_....

In: header

Path Parameters

checkName*string

The check to act on.

Value in

  • "ACADEMIC_VERIFY"
  • "ALIEN_ID"
  • "AML_CHECK"
  • "BANK_ACCOUNT_VALIDATION"
  • "BRS_BUSINESS"
  • "CERT_GOOD_CONDUCT"
  • "COMPANY_EXPOSURE"
  • "CREDITINFO_CRB_SCORE"
  • "CREDITINFO_CRB_STATUS"
  • "CREDITINFO_FULL_CRB_REPORT"
  • "CV_ANALYSIS"
  • "DARK_WEB"
  • "DRIVERS_LICENCE_CHECK"
  • "EMPLOYER_VERIFICATION"
  • "HAKIKISHA"
  • "IDENTITY"
  • "IDENTITY_WITH_IMAGE"
  • "INTERNET_PRESENCE"
  • "KPLC_LOCATION"
  • "KRA_PIN"
  • "LIVENESS_CHECK"
  • "METROPOL_CRB_SCORE"
  • "METROPOL_FULL_CRB_REPORT"
  • "METROPOL_MOBILE_CREDIT_SCORE"
  • "METROPOL_SUMMARY_CRB_REPORT"
  • "MPESA_KYC"
  • "PASSPORT"
  • "PAYSLIP_VERIFICATION"
  • "REFERENCES"
  • "SIM_SWAP"
  • "VEHICLE_OWNERSHIP"

Response Body

application/json

application/problem+json

curl -X GET "https://example.com/api/v1/checks/definitions/ACADEMIC_VERIFY"
{  "id": "51e34092-dc2d-9105-fc25-72238f4acd82",  "checkName": "IDENTITY",  "displayName": "Identity verification",  "checkCategory": "IDENTITY",  "currencyCode": "KES",  "active": true,  "sandbox": true,  "requestId": "sandbox-670fe53bd4bd"}