# Verify Residence Card

## Residence Card Verification

<mark style="color:green;">`POST`</mark> `{{baseurl}}/v2/api/identity/ci/residence-card`

This endpoint allows you to perform a Residence card verification.

#### Headers

| Name                                    | Type   | Description      |
| --------------------------------------- | ------ | ---------------- |
| token<mark style="color:red;">\*</mark> | String | API secret token |

#### Request Body

| Field                                              | Type    | Description                                                                        |
| -------------------------------------------------- | ------- | ---------------------------------------------------------------------------------- |
| id<mark style="color:red;">\*</mark>               | String  | Residence card number                                                              |
| isSubjectConsent<mark style="color:red;">\*</mark> | Boolean | Indicate subject has given consent. <mark style="color:red;">`Must be true`</mark> |
| 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                                                |

### <mark style="color:green;">Residence Card Verification</mark>

{% tabs %}
{% tab title="Residence Card Verification Sample Request" %}

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

```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Residence Card Verification Sample Response" %}

```json
{
    "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": []
}
```

{% endtab %}
{% endtabs %}

### <mark style="color:green;">Residence Card Validation</mark>

{% tabs %}
{% tab title="Residence Card Validation Sample Request" %}

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

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Residence Card Validation Sample Response" %}

```json
{
    "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": []
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Error Responses" %}

```json

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

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.youverify.co/know-your-customer-services-kyc/id-data-matching-eidv/cote-divoire/verify-residence-card.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.