> ## Documentation Index
> Fetch the complete documentation index at: https://eurusys-6c0957fa.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Verification response

> Every field the Validation Gateway can return in the data object of a successful verification, and how your organization's response template shapes it.

A successful `validate` call returns a [`VerificationResult`](/reference/data-types#verificationresult). Its **`data`** object carries the resident's verified details pulled from ICP records. This page documents every field `data` can contain.

```ts theme={null}
VerificationResult {
  success: boolean,            // true = passed (COMPLETED), false = failed (REJECTED)
  message: string,            // human-readable status
  data: object,               // the resident details — documented below
  clientReferenceId: string,  // your UUID, echoed back
}
```

<Info>
  **A response template controls which fields appear.** Which fields `data` includes is governed by a **response template configured for your organization by ICP**. Fields not enabled by your template are **omitted entirely** from `data`, so a given integration receives a subset of this catalogue. To change which fields are returned, contact ICP support or your account manager.
</Info>

<Warning>
  The per-check breakdown (document checks, residency checks, **fingerprint match and score**, face match) is **not** returned in `data`. The top-level `success` is the overall outcome; the detailed breakdown is available on the **[transaction](/dashboard/journeys)** in the dashboard, not in the SDK response.
</Warning>

## Identity

| Field                       | Type   | Description                                    |
| --------------------------- | ------ | ---------------------------------------------- |
| `emiratesId`                | string | Emirates ID number, e.g. `784-XXXX-XXXXXXX-X`. |
| `fullNameEn` / `fullNameAr` | string | Full name (English / Arabic).                  |

## `personalInfo`

| Field                                              | Type   | Description                                     |
| -------------------------------------------------- | ------ | ----------------------------------------------- |
| `personalInfo.currentNationality`                  | string | Nationality code (e.g. `ARE`).                  |
| `personalInfo.fullNameEn` / `fullNameAr`           | string | Full name.                                      |
| `personalInfo.firstNameEn` / `firstNameAr`         | string | First name.                                     |
| `personalInfo.secondNameEn` / `secondNameAr`       | string | Second (middle) name.                           |
| `personalInfo.familyNameEn` / `familyNameAr`       | string | Family name.                                    |
| `personalInfo.motherNameEn` / `motherNameAr`       | string | Mother's name.                                  |
| `personalInfo.dateOfBirth`                         | string | Date of birth (`YYYY-MM-DD`).                   |
| `personalInfo.hijriDateOfBirth`                    | string | Date of birth (Hijri calendar).                 |
| `personalInfo.personClass`                         | string | Person class.                                   |
| `personalInfo.personClassification`                | string | Classification (e.g. `LOCAL`).                  |
| `personalInfo.genderEn` / `genderAr`               | string | Gender.                                         |
| `personalInfo.maritalStatusEn` / `maritalStatusAr` | string | Marital status.                                 |
| `personalInfo.placeOfBirthEn` / `placeOfBirthAr`   | string | Place of birth.                                 |
| `personalInfo.mobileNo`                            | string | Mobile number.                                  |
| `personalInfo.titleEn` / `titleAr`                 | string | Title / salutation.                             |
| `personalInfo.insideUAE`                           | string | Whether the person is currently inside the UAE. |
| `personalInfo.immigrationStatus`                   | string | Immigration status.                             |
| `personalInfo.occupationEn` / `occupationAr`       | string | Occupation.                                     |

## `activePassport`

`null` / omitted when no active passport is on record.

| Field                                     | Type   | Description                |
| ----------------------------------------- | ------ | -------------------------- |
| `activePassport.documentType`             | string | Passport / document type.  |
| `activePassport.documentNo`               | string | Passport number.           |
| `activePassport.documentNationality`      | string | Issuing nationality.       |
| `activePassport.documentNationalityAbbr`  | string | 3-letter nationality code. |
| `activePassport.documentIssueCountry`     | string | Issuing country name.      |
| `activePassport.documentIssueCountryAbbr` | string | 2-letter country code.     |
| `activePassport.issueDate`                | string | Issue date.                |
| `activePassport.expiryDate`               | string | Expiry date.               |

## `personContactDetails`

| Field                                          | Type   | Description           |
| ---------------------------------------------- | ------ | --------------------- |
| `personContactDetails.emirateEn` / `emirateAr` | string | Emirate of residence. |
| `personContactDetails.cityEn` / `cityAr`       | string | City.                 |
| `personContactDetails.areaEn` / `areaAr`       | string | Area / district.      |
| `personContactDetails.streetEn` / `streetAr`   | string | Street.               |
| `personContactDetails.poBox`                   | string | PO box.               |
| `personContactDetails.mobileNo`                | string | Mobile number.        |
| `personContactDetails.homePhone`               | string | Home phone.           |
| `personContactDetails.workPhone`               | string | Work phone.           |

## `travelDetail`

| Field                                   | Type    | Description                                     |
| --------------------------------------- | ------- | ----------------------------------------------- |
| `travelDetail.isInsideUAE`              | boolean | Whether the person is currently inside the UAE. |
| `travelDetail.travelType`               | string  | Travel type.                                    |
| `travelDetail.travelDate`               | string  | Most recent travel date.                        |
| `travelDetail.travelTime`               | string  | Travel time.                                    |
| `travelDetail.travelDocumentNo`         | string  | Travel document number.                         |
| `travelDetail.travelDocumentIssueDate`  | string  | Travel document issue date.                     |
| `travelDetail.travelDocumentExpiryDate` | string  | Travel document expiry date.                    |

## `residenceInfo`

Residency / visa sponsorship details. Omitted for citizens.

| Field                                                           | Type    | Description                          |
| --------------------------------------------------------------- | ------- | ------------------------------------ |
| `residenceInfo.residenceClassEn` / `residenceClassAr`           | string  | Residence class.                     |
| `residenceInfo.residenceDepartmentEn` / `residenceDepartmentAr` | string  | Issuing department.                  |
| `residenceInfo.accompanyCount`                                  | integer | Number of accompanying dependants.   |
| `residenceInfo.sponsorNameEn` / `sponsorNameAr`                 | string  | Sponsor name.                        |
| `residenceInfo.issueDate`                                       | string  | Residence issue date.                |
| `residenceInfo.expiryDate`                                      | string  | Residence expiry date.               |
| `residenceInfo.emiratesIdNumber`                                | string  | Emirates ID on the residence record. |
| `residenceInfo.documentNo`                                      | string  | Residence document number.           |

## `familyBook`

| Field                            | Type   | Description                                |
| -------------------------------- | ------ | ------------------------------------------ |
| `familyBook.khulasitQaidNo`      | string | Family registry (Khulasat Al Qaid) number. |
| `familyBook.familyBookNo`        | string | Family book number.                        |
| `familyBook.familyBookStartDate` | string | Family book start date.                    |
| `familyBook.familyBookRelation`  | string | Relation to the head of family.            |

## `sponsorDetails`

| Field                                            | Type    | Description                |
| ------------------------------------------------ | ------- | -------------------------- |
| `sponsorDetails.nameEn` / `nameAr`               | string  | Sponsor name.              |
| `sponsorDetails.departmentEn` / `departmentAr`   | string  | Sponsor department.        |
| `sponsorDetails.sponsorNo`                       | integer | Sponsor number.            |
| `sponsorDetails.sponsorTypeEn` / `sponsorTypeAr` | string  | Sponsor type.              |
| `sponsorDetails.sponsorIdn`                      | string  | Sponsor IDN.               |
| `sponsorDetails.sponsorNationality`              | string  | Sponsor nationality.       |
| `sponsorDetails.sponsorNationalityAbbr`          | string  | 3-letter nationality code. |
| `sponsorDetails.tradeLicense`                    | string  | Trade licence number.      |

## `immigrationFile`

| Field                                       | Type   | Description  |
| ------------------------------------------- | ------ | ------------ |
| `immigrationFile.status`                    | string | File status. |
| `immigrationFile.fileTypeEn` / `fileTypeAr` | string | File type.   |
| `immigrationFile.fileNumber`                | string | File number. |
| `immigrationFile.issuePlace`                | string | Issue place. |
| `immigrationFile.issueDate`                 | string | Issue date.  |
| `immigrationFile.expiryDate`                | string | Expiry date. |

## `sponsorContactDetails`

| Field                                           | Type   | Description    |
| ----------------------------------------------- | ------ | -------------- |
| `sponsorContactDetails.emirateEn` / `emirateAr` | string | Emirate.       |
| `sponsorContactDetails.cityEn` / `cityAr`       | string | City.          |
| `sponsorContactDetails.areaEn` / `areaAr`       | string | Area.          |
| `sponsorContactDetails.streetEn` / `streetAr`   | string | Street.        |
| `sponsorContactDetails.poBox`                   | string | PO box.        |
| `sponsorContactDetails.email`                   | string | Email address. |
| `sponsorContactDetails.mobileNo`                | string | Mobile number. |
| `sponsorContactDetails.homePhone`               | string | Home phone.    |
| `sponsorContactDetails.workPhone`               | string | Work phone.    |

## `activeVisa`

| Field                           | Type   | Description                  |
| ------------------------------- | ------ | ---------------------------- |
| `activeVisa.visaType`           | string | Visa type.                   |
| `activeVisa.visaDepartment`     | string | Issuing department.          |
| `activeVisa.passportNo`         | string | Passport number on the visa. |
| `activeVisa.passportExpiryDate` | string | Passport expiry date.        |
| `activeVisa.passportIssuePlace` | string | Passport issue place.        |
| `activeVisa.visaStatus`         | string | Visa status.                 |
| `activeVisa.issueDate`          | string | Visa issue date.             |
| `activeVisa.createdDate`        | string | Visa creation date.          |
| `activeVisa.validityDate`       | string | Validity start date.         |
| `activeVisa.expiryDate`         | string | Visa expiry date.            |

## `documents`

Document images, returned as **raw Base64** (no `data:` URI / MIME-type prefix — prepend your own, e.g. `data:image/jpeg;base64,`, if you need a data URI).

| Field                        | Type   | Description                 |
| ---------------------------- | ------ | --------------------------- |
| `documents.passportImage`    | string | Passport image.             |
| `documents.gccIdImage`       | string | GCC ID image.               |
| `documents.personFace`       | string | Face photo.                 |
| `documents.digitalEID`       | string | Digital Emirates ID image.  |
| `documents.digitalSignature` | string | Digital signature.          |
| `documents.activeVisa`       | string | Active visa document image. |

## Field values

Several string fields carry categorical values. The common ones are listed below.

<Warning>
  These value lists are **non-exhaustive** — ICP records can contain values not shown here. Treat them as illustrative, match case-insensitively where you can, and handle unrecognized values gracefully. Each `*En` field has an Arabic (`*Ar`) counterpart carrying the same value in Arabic.
</Warning>

<AccordionGroup>
  <Accordion title="Gender — personalInfo.genderEn">
    `MALE` · `FEMALE` · `UNKNOWN`
  </Accordion>

  <Accordion title="Person class — personalInfo.personClass">
    `UAE Citizen` · `GCC Citizen` · `Resident` · `Visitor` · `UNKNOWN`
  </Accordion>

  <Accordion title="Person classification — personalInfo.personClassification">
    `GOLDEN` · `GREEN` · `LOCAL` · `GCC` · `RESIDENCE` · `VISITOR` · `UNKNOWN`
  </Accordion>

  <Accordion title="Marital status — personalInfo.maritalStatusEn">
    `SINGLE` · `MARRIED` · `DIVORCED` · `WIDOWED` · `DEAD` · `UNKNOWN`
  </Accordion>

  <Accordion title="Immigration status — personalInfo.immigrationStatus">
    `ACTIVE` · `INACTIVE` · `NA`
  </Accordion>

  <Accordion title="Inside UAE — personalInfo.insideUAE">
    `Yes` · `No`
  </Accordion>

  <Accordion title="Emirate — personContactDetails.emirateEn / sponsorContactDetails.emirateEn">
    `ABU DHABI` · `DUBAI` · `SHARJAH` · `AJMAN` · `UMM AL QUWAIN` · `RAS AL KHAIMAH` · `FUJAIRAH`
  </Accordion>

  <Accordion title="Travel type — travelDetail.travelType">
    `Inside UAE` · `Outside UAE`
  </Accordion>

  <Accordion title="Passport / document type — activePassport.documentType">
    `ORDINARY PASSPORT` · `DIPLOMATIC PASSPORT` · `TEMPORARY PASSPORT` · `PRIVATE PASSPORT` · `OFFICIAL PASSPORT` · `SERVICE PASSPORT` · `FOREIGN PASSPORT` · `U.N PASSPORT` · `TRAVEL DOCUMENT` · `EIDA CARD` · `Emirates ID` · … (\~29 codes — non-exhaustive)
  </Accordion>

  <Accordion title="Residence class — residenceInfo.residenceClassEn">
    `WORK RESIDENCE` · `RESIDENT RESIDENCE` · `DIPLOMAT-WORK` · `BUSINESSMAN SHORT` · `BUSINESSMAN LONG` · `SERVICE` · `UNKNOWN`
  </Accordion>

  <Accordion title="Immigration file type — immigrationFile.fileTypeEn">
    `WORK RESIDENCE` · `RESIDENT RESIDENCE` · `RESIDENCE` · `EMPLOYMENT` · `EMPLOYMENT/IMM` · `SERVICE` · `UNKNOWN`
  </Accordion>

  <Accordion title="Sponsor type — sponsorDetails.sponsorTypeEn">
    `INVESTOR GUARANTOR` · `LOCAL GUARANTOR` · `RESIDENCE GUARANTOR` · `GCC GUARANTOR` · `DIPLOMATIC GUARANTOR` · `COMPANIES` · `GOVERNMENT-FEDERAL` · `GOVERNMENT-LOCAL` · `SEMI-GOVERNMENT` · `FREE ZONE` · `OTHERS` · … (non-exhaustive)
  </Accordion>

  <Accordion title="Visa type — activeVisa.visaType">
    `TOURIST VISA` · `WORK VISA` · `RESIDENCE VISA` · `VISIT VISA` · `MISSION VISA` · `UNKNOWN`
  </Accordion>
</AccordionGroup>

## Example

A successful response — the exact set of `data` fields depends on the response template configured for your organization and the resident's record:

```json theme={null}
{
  "success": true,
  "message": "COMPLETED",
  "data": {
    "emiratesId": "784-XXXX-XXXXXXX-X",
    "fullNameEn": "Ahmed Al Mazrouei",
    "fullNameAr": "أحمد المزروعي",
    "personalInfo": {
      "currentNationality": "ARE",
      "firstNameEn": "Ahmed",
      "familyNameEn": "Al Mazrouei",
      "dateOfBirth": "1990-01-15",
      "genderEn": "M",
      "maritalStatusEn": "Married",
      "personClassification": "LOCAL",
      "occupationEn": "Engineer",
      "insideUAE": "Yes"
    },
    "residenceInfo": {
      "sponsorNameEn": "ABC Trading LLC",
      "issueDate": "2020-01-01",
      "expiryDate": "2030-01-01"
    },
    "documents": {
      "personFace": "/9j/4AAQSkZJRg..."
    }
  },
  "clientReferenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

A failed verification returns `success: false` with a status `message` (e.g. `REJECTED`); `data` may be absent or partial. Inspect the [transaction](/dashboard/journeys) in the dashboard for the per-check breakdown.

<Info>
  The fields you receive are determined by the **response template configured for your organization by ICP** — it is not a client-editable setting. To add or remove fields, contact ICP support or your account manager. You can review the methods enabled for your organization under [Methods](/dashboard/methods).
</Info>