Ivorian National ID Verification

National ID lookup API

To perform verification on an Ivorian National ID, make a POST request to the National ID lookup endpoint;

https://api.korapay.com/merchant/api/v1/identities/ci/national-id

The request body should have the following parameters:

{
  "id": "00112233440",
  "verification_consent": true
}

Request with data matching

{
  "id": "00112233440",
  "verification_consent": true,
  "validation": {
    "first_name": "john",
    "last_name": "doe",
    "date_of_birth": "1988-04-04"
  }
}

Request with data and facial matching

{
  "id": "00112233440",
  "verification_consent": true,
  "validation": {
    "first_name": "john",
    "last_name": "doe",
    "date_of_birth": "1988-04-04",
    "selfie": "<base64-encoded-image>"
  }
}

Field	Data Type	Description
`id`	string	Required - 7 to 12 alphanumeric characters (uppercase)
`verification_consent`	Boolean	Required - Indicate subject has given consent. Must be true
`validation.first_name`	string	Optional - First name for data matching
`validation.last_name`	string	Optional - Last name for data matching
`validation.date_of_birth`	string	Optional - Date of birth for data matching
`validation.selfie`	string	Optional - Base64-encoded selfie image for facial matching

National ID response

{
  "status": true,
  "message": "National identity verified successfully",
  "data": {
    "reference": "VR-wDafCrOCRZx6DtnBT",
    "id": "00112233440",
    "id_type": "ci_national_id",
    "first_name": "ENOCH",
    "last_name": "KOFFI",
    "middle_name": null,
    "full_name": "ENOCH KOFFI",
    "gender": "Male",
    "date_of_birth": "1998-05-26",
    "image": null,
    "father_first_name": "KOUADIO",
    "father_last_name": "KOFFI",
    "mother_first_name": "PIERRE",
    "mother_last_name": "TOUKOURA",
    "father_date_of_birth": "1965-02-27",
    "mother_date_of_birth": "1972-01-17",
    "nationality": "CIV",
    "issued_date": null,
    "expired_date": null,
    "adverse_media_report": null,
    "aml_report": null,
    "requested_by": "API User"
  }
}