Verify Residence Card

Residence Card Verification

POST {{baseurl}}/v2/api/identity/ci/residence-card

This endpoint allows you to perform a Residence card verification.

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Field	Type	Description
id*	String	Residence card number
isSubjectConsent*	Boolean	Indicate subject has given consent. Must be true
validations	Object	Validation object
data	Object	Validation data object
lastName	String	lastname to compare against ID
firstName	String	firstname to compare against ID
dateOfBirth	String	date of birth to compare against ID

Residence Card Verification

Residence Card Verification Sample Request

{
    "id": "11978031809",
    "isSubjectConsent": true
}

Residence Card Verification Sample Response

{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "69325956c04b51be59affb6e",
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": false,
        "selfieValidation": false,
        "firstName": "ETTIEN KAMENAN LAURIS GERVAIS",
        "middleName": null,
        "lastName": "KOUAKOU",
        "fullName": "ETTIEN KAMENAN LAURIS GERVAIS KOUAKOU",
        "fatherFirstName": "VINCENT KOUASSI",
        "fatherLastName": "KOUAKOU",
        "motherFirstName": "AHOU ALICE",
        "motherLastName": "YAO",
        "fatherDateOfBirth": "1966-12-27",
        "motherDateOfBirth": "1900-01-01",
        "image": null,
        "nationality": "CIV",
        "dateOfBirth": "1997-01-02",
        "isConsent": true,
        "idNumber": "I003549637",
        "businessId": "62c2a4868d319373a6280152",
        "type": "ciResidenceCard",
        "allValidationPassed": true,
        "gender": "Male",
        "issuedDate": null,
        "expiredDate": null,
        "documentId": "11978031809",
        "requestedAt": "2025-12-05T04:02:31.244Z",
        "requestedById": "62c2a4868d3193700828014e",
        "country": "CI",
        "createdAt": "2025-12-05T04:02:31.284Z",
        "lastModifiedAt": "2025-12-05T04:02:31.284Z",
        "adverseMediaReport": null,
        "amlReport": null,
        "metadata": {},
        "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "62c2a4868d3193700828014e"
        }
    },
    "links": []
}

Residence Card Validation

Residence Card Validation Sample Request

{
    "id": "11978031809",
    "isSubjectConsent": true,
    "validations": {
        "data": {
            "lastName": "KOFFI",
            "firstName": "LONZO HENOCH ANGE MICHAEL",
            "dateOfBirth": "1999-05-26"
        }
    }
}

Residence Card Validation Sample Response

{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "693259e5c04b51be59affb73",
        "validations": {
            "data": {
                "lastName": {
                    "validated": false,
                    "value": "KOFFI"
                },
                "dateOfBirth": {
                    "validated": false,
                    "value": "1999-05-26"
                },
                "firstName": {
                    "validated": false,
                    "value": "LONZO HENOCH ANGE MICHAEL"
                }
            },
            "validationMessages": "First name does not match, Last name does not match, Date of birth does not match, No Photo from data source"
        },
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": true,
        "selfieValidation": false,
        "firstName": "ETTIEN KAMENAN LAURIS GERVAIS",
        "middleName": null,
        "lastName": "KOUAKOU",
        "fullName": "ETTIEN KAMENAN LAURIS GERVAIS KOUAKOU",
        "fatherFirstName": "VINCENT KOUASSI",
        "fatherLastName": "KOUAKOU",
        "motherFirstName": "AHOU ALICE",
        "motherLastName": "YAO",
        "fatherDateOfBirth": "1966-12-27",
        "motherDateOfBirth": "1900-01-01",
        "image": null,
        "nationality": "CIV",
        "dateOfBirth": "1997-01-02",
        "isConsent": true,
        "idNumber": "I003549637",
        "businessId": "62c2a4868d319373a6280152",
        "type": "ciResidenceCard",
        "allValidationPassed": false,
        "gender": "Male",
        "issuedDate": null,
        "expiredDate": null,
        "documentId": "11978031809",
        "requestedAt": "2025-12-05T04:04:54.729Z",
        "requestedById": "62c2a4868d3193700828014e",
        "country": "CI",
        "createdAt": "2025-12-05T04:04:54.883Z",
        "lastModifiedAt": "2025-12-05T04:04:54.883Z",
        "adverseMediaReport": null,
        "amlReport": null,
        "metadata": {},
        "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "62c2a4868d3193700828014e"
        }
    },
    "links": []
}

Error Responses

  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}