Customer Details

Customer data is available for 24 hours after journey creation. Call this API promptly after the journey completes and store the data you need.

Field Availability: Not all fields are populated for every customer. Available fields depend on the document type scanned and the modules enabled for your organization. Always handle empty or missing fields gracefully.

Authentication

x-transaction-key

string

required

Your API key. Get your key →

string

required

Must be application/json

Path Parameters

journeyToken

string

required

UUID v4 of the journey from the Create Journey API (36 characters).

Code Examples

curl "{base_url}/otk-service/customer-details/{journeyToken}" \
  -H "accept: application/json" \
  -H "x-transaction-key: your-api-key"

Response Fields

Response Structure

{
  "result": {
    "success": true,
    "message": "...",
    "data": { ... },
    "createdAt": ...,
    "meta": { ... },
    "errors": [],
    "warnings": []
  },
  "signature": "..."
}

Envelope

Field	Type	Description
`result.success`	boolean \| absent	`true` for `COMPLETED` or `ADJUDICATED` journeys, `false` for `REJECTED`. Not present for other statuses (`NOT STARTED`, `IN PROGRESS`, `EXPIRED`, `ABANDONED`).
`result.message`	string	Human-readable status message.
`result.data`	object	Customer data container (present on success).
`result.createdAt`	number	Journey creation timestamp (epoch milliseconds).
`result.meta.apiEndpoint`	string	The API endpoint that was called.
`result.meta.serverTimestamp`	number	Server timestamp (epoch milliseconds).
`result.meta.journeyType`	string	The journey type: `ONBOARDING`, `REKYC`, or `AUTHORISE`.
`result.meta.journeyToken`	string	The journey token that was queried.
`result.errors`	object[]	Filtered errors (type `ICP` only) objects. Empty array on success.
`result.warnings`	object[]	Filtered warnings (type `ICP` only) object. Empty array when none. Each object has `code`, `type`, and `message`.
`signature`	string	Cryptographic signature for response verification.

Top-Level Customer Data

Field	Type	Description
`result.data.uaeKycId`	string	Unique UAE KYC identifier for this customer. Save this — you’ll need it for Re-KYC and AUTHORISE journeys.
`result.data.uidNumber`	integer	UID person number.
`result.data.uaeKycCertificate`	string (Base64)	Base64-encoded PDF of the digital KYC certificate issued upon successful verification.

Tourist Information (`result.data.touristInfo`)

null when the customer is not a tourist or GCC visitor.

Field	Type	Description	Data Availability
`result.data.touristInfo.touristId`	string	Unique tourist identification number.	Available for Tourists & GCC Visitors

Personal Information (`result.data.personalInfo`)

Field	Type	Description	Data Availability
`result.data.personalInfo.currentNationality`	string	Current nationality (ISO 3166-1 alpha-3 code, 3 characters). Example: `"IND"`, `"ARE"`, `"GBR"`.	Available for all scenarios
`result.data.personalInfo.fullNameAr` / `fullNameEn`	string	Full name in Arabic / English (up to 200 characters).	Available for all scenarios
`result.data.personalInfo.firstNameAr` / `firstNameEn`	string	First name in Arabic / English (up to 100 characters).	Available for all scenarios
`result.data.personalInfo.secondNameAr` / `secondNameEn`	string	Middle/second name in Arabic / English (up to 100 characters).	Available for all scenarios
`result.data.personalInfo.familyNameAr` / `familyNameEn`	string	Family (last) name in Arabic / English (up to 100 characters).	Available for all scenarios
`result.data.personalInfo.motherNameAr` / `motherNameEn`	string	Mother’s name in Arabic / English (up to 200 characters).	Available for all scenarios
`result.data.personalInfo.dateOfBirth`	string	Date of birth (`YYYY-MM-DD`, 10 characters).	Available for all scenarios
`result.data.personalInfo.hijriDateOfBirth`	string	Date of birth in Hijri calendar (`YYYY-MM-DD`, 10 characters).	Available for all scenarios
`result.data.personalInfo.personClass`	enum	Residency classification: `UAE Citizen`, `GCC Citizen`, `Visitor`, `Resident`.	Available for all scenarios
`result.data.personalInfo.personClassification`	string	Person classification code: `LOCAL`, `GCC`, `RESIDENCE`, `VISITOR`, `GOLDEN`.	Available for all scenarios
`result.data.personalInfo.genderEn` / `genderAr`	enum	`MALE`, `FEMALE`, `UNKNOWN`.	Available for all scenarios
`result.data.personalInfo.maritalStatusEn` / `maritalStatusAr`	enum	`SINGLE`, `MARRIED`, `DIVORCED`, `WIDOWED`, `Bachelor`, `Dead`.	Available for all scenarios
`result.data.personalInfo.placeOfBirthAr` / `placeOfBirthEn`	string	Place of birth in Arabic / English (up to 100 characters).	Available for all scenarios
`result.data.personalInfo.mobileNo`	string	Registered mobile number (E.164 format, up to 15 characters). Example: `"+971501234567"`.	Available for all scenarios
`result.data.personalInfo.titleEn` / `titleAr`	string	Name title/prefix in English / Arabic (up to 50 characters). Example: `"Mr"`, `"H.E."`.	Available for all scenarios
`result.data.personalInfo.insideUAE`	enum	Whether the person is currently inside UAE: `Yes`, `No`.	Available for all scenarios
`result.data.personalInfo.immigrationStatus`	enum	`ACTIVE`, `INACTIVE`, `NA`.	Available for all scenarios
`result.data.personalInfo.occupationAr` / `occupationEn`	string	Occupation in Arabic / English (up to 200 characters).	Available for all scenarios

Passport (`result.data.activePassport`)

null when the customer does not have a passport on record (e.g., UAE citizens using only Emirates ID).

Field	Type	Description	Data Availability
`result.data.activePassport.documentType`	string	Passport document type. See Passport Document Types below.	Available for all scenarios
`result.data.activePassport.documentNo`	string	Passport number (up to 20 characters).	Available for all scenarios
`result.data.activePassport.documentNationality`	string	Nationality on the passport — full name (up to 100 characters).	Available for all scenarios
`result.data.activePassport.documentNationalityAbbr`	string	Nationality abbreviation (ISO 3166-1 alpha-3, 3 characters).	Available for all scenarios
`result.data.activePassport.documentIssueCountry`	string	Country that issued the passport — full name (up to 100 characters).	Available for all scenarios
`result.data.activePassport.documentIssueCountryAbbr`	string	Issuing country abbreviation (ISO 3166-1 alpha-3, 3 characters).	Available for all scenarios
`result.data.activePassport.issueDate`	string	Passport issue date (`YYYY-MM-DD`, 10 characters).	Available for all scenarios
`result.data.activePassport.expiryDate`	string	Passport expiry date (`YYYY-MM-DD`, 10 characters).	Available for all scenarios

Passport Document Types

Document Type
`ORDINARY PASSPORT`
`DIPLOMATIC PASSPORT`
`OFFICIAL PASSPORT`
`SERVICE PASSPORT`
`TEMPRORY PASSPORT`
`TRAVEL DOCUMENT`
`ORDINARY ONE DAY PASSPORT -MISSION PASSPORT`
`PRIVATE PASSPORT`
`Passport For Public Affairs`
`NAUTICAL PASSPORT`
`ASSIGNMENT PASSPORT`
`European Union passport`
`PERSONAL IDENTITY`
`SYRIAN TRAVEL DOCUMENT`
`EGYPTIAN TRAVEL DOCUMENT`
`LEBANSE TRAVEL DOCUMENT`

This is not an exhaustive list. Additional document types may be returned depending on the government record.

Contact & Address (`result.data.personContactDetails`)

null when no contact information is available in government records.

Field	Type	Description	Data Availability
`result.data.personContactDetails.emirateEn` / `emirateAr`	enum	Emirate of residence: `ABU DHABI`, `DUBAI`, `SHARJAH`, `AJMAN`, `UMM AL QUWAIN`, `RAS AL KHAIMAH`, `FUJAIRAH`.	Available for all scenarios
`result.data.personContactDetails.cityAr` / `cityEn`	string	City of residence (up to 100 characters).	Available for all scenarios
`result.data.personContactDetails.areaAr` / `areaEn`	string	Area/district (up to 100 characters).	Available for all scenarios
`result.data.personContactDetails.streetAr` / `streetEn`	string	Street address (up to 200 characters).	Available for all scenarios
`result.data.personContactDetails.poBox`	string	P.O. Box number (up to 10 characters).	Available for all scenarios
`result.data.personContactDetails.mobileNo`	string	Mobile phone number (E.164 format, up to 15 characters).	Available for all scenarios
`result.data.personContactDetails.homePhone`	string	Home landline number (E.164 format, up to 15 characters).	Available for all scenarios
`result.data.personContactDetails.workPhone`	string	Work phone number (E.164 format, up to 15 characters).	Available for all scenarios

Travel Details (`result.data.travelDetail`)

null when no travel history is on record.

Field	Type	Description	Data Availability
`result.data.travelDetail.isInsideUAE`	boolean	Whether the person is currently inside the UAE: `true`, `false`.	Available for all scenarios
`result.data.travelDetail.travelType`	enum	Direction of last travel movement: `Inside UAE`, `Outside UAE`.	Available for all scenarios
`result.data.travelDetail.travelDate`	string	Date of last travel movement (`YYYY-MM-DD`).	Available for all scenarios
`result.data.travelDetail.travelTime`	string	Time of last travel movement (`HH:mm:ss`, 24-hour).	Available for all scenarios
`result.data.travelDetail.travelDocumentNo`	string	Passport or travel document number used at the border (up to 20 characters).	Available for all scenarios
`result.data.travelDetail.travelDocumentIssueDate`	string	Issue date of the travel document (`YYYY-MM-DD`).	Available for all scenarios
`result.data.travelDetail.travelDocumentExpiryDate`	string	Expiry date of the travel document (`YYYY-MM-DD`).	Available for all scenarios

Residence & Emirates ID (`result.data.residenceInfo`)

null for visitors and short-term visa holders without an active residence permit.

Field	Type	Description	Data Availability
`result.data.residenceInfo.residenceClassEn` / `residenceClassAr`	enum	`WORK RESIDENCE`, `SERVICE`, `RESIDENT RESIDENCE`.	Available for Active Residents
`result.data.residenceInfo.residenceDepartmentEn` / `residenceDepartmentAr`	string	Government department that issued the residence permit (up to 200 characters).	Available for Active Residents
`result.data.residenceInfo.accompanyCount`	string	Number of dependents included on the visa (up to 5 characters).	Available for Active Residents
`result.data.residenceInfo.sponsorNameEn` / `sponsorNameAr`	string	Visa sponsor name in English / Arabic (up to 200 characters).	Available for Active Residents
`result.data.residenceInfo.issueDate`	string	Residence visa issue date (`YYYY-MM-DD`).	Not Available for Visitors
`result.data.residenceInfo.expiryDate`	string	Residence visa expiry date (`YYYY-MM-DD`).	Not Available for Visitors
`result.data.residenceInfo.emiratesIdNumber`	string	Emirates ID number (15 digits starting with `784`).	Not Available for Visitors
`result.data.residenceInfo.documentNo`	string	Residence document/visa number.	Not Available for Visitors

null for UAE/GCC citizens.

Field	Type	Description	Data Availability
`result.data.sponsorDetails.nameEn` / `nameAr`	string	Sponsor name in English / Arabic (up to 200 characters).	Available for Active Residents and Visitors
`result.data.sponsorDetails.departmentEn` / `departmentAr`	string	Government department managing the sponsorship (up to 200 characters).	Available for Active Residents and Visitors
`result.data.sponsorDetails.sponsorNo`	string	Unique sponsor reference number (up to 20 characters).	Available for Active Residents and Visitors
`result.data.sponsorDetails.sponsorTypeEn` / `sponsorTypeAr`	enum	Sponsor category: `AGRICULTURAL ORGANIZATION`, `COMPANIES`, `DIPLOMATIC GUARANTOR`, `ESTATE GUARANTOR`, `FARM GUARANTOR`, `FISHING BOATS`, `GCC GUARANTOR`, `GOVERNMENT-FEDERAL`, `GOVERNMENT -LOCAL`, `GUARDIAN OF THE HEIRS`, `LOCAL GUARANTOR`, `OTHERS`, `RESIDENCE GUARANTOR`, `SEMI - GOVERNMENT`, `SHEIKH GUARANTOR`.	Available for Active Residents and Visitors
`result.data.sponsorDetails.sponsorIdn`	string	Sponsor’s Emirates ID or trade license identification number (up to 20 characters).	Available for Active Residents and Visitors
`result.data.sponsorDetails.sponsorNationality`	string	Sponsor nationality — full name (up to 100 characters).	Available for Active Residents and Visitors
`result.data.sponsorDetails.sponsorNationalityAbbr`	string	Sponsor nationality (ISO 3166-1 alpha-3, 3 characters).	Available for Active Residents and Visitors
`result.data.sponsorDetails.tradeLicense`	string	Trade license number for company sponsors (up to 20 characters).	Available for Active Residents and Visitors

null when sponsorDetails is null.

Field	Type	Description	Data Availability
`result.data.sponsorContactDetails.emirateEn` / `emirateAr`	enum/string	Sponsor’s emirate in English / Arabic.	Available for Active Residents and Visitors
`result.data.sponsorContactDetails.cityEn` / `cityAr`	string	Sponsor’s city in English / Arabic (up to 100 characters).	Available for Active Residents and Visitors
`result.data.sponsorContactDetails.areaEn` / `areaAr`	string	Sponsor’s area/district in English / Arabic (up to 100 characters).	Available for Active Residents and Visitors
`result.data.sponsorContactDetails.streetEn` / `streetAr`	string	Sponsor’s street address in English / Arabic (up to 200 characters).	Available for Active Residents and Visitors
`result.data.sponsorContactDetails.poBox`	string	Sponsor’s P.O. Box number (up to 10 characters).	Available for Active Residents and Visitors
`result.data.sponsorContactDetails.email`	string	Sponsor’s email address (up to 100 characters).	Available for Active Residents and Visitors
`result.data.sponsorContactDetails.mobileNo`	string	Sponsor’s mobile number (E.164 format, up to 15 characters).	Available for Active Residents and Visitors
`result.data.sponsorContactDetails.homePhone`	string	Sponsor’s home phone number (up to 15 characters).	Available for Active Residents and Visitors
`result.data.sponsorContactDetails.workPhone`	string	Sponsor’s work phone number (up to 15 characters).	Available for Active Residents and Visitors

Immigration File (`result.data.immigrationFile`)

Data Availability by Customer Type:

UAE Citizens & GCC Nationals: Only status: "NA" field is populated, as they do not require immigration files for UAE entry
Residents: Complete immigration file data including status, fileTypeEn/Ar, fileNumber, issuePlace, issueDate, and expiryDate
Visitors/Tourists: Full immigration file details with status: "INACTIVE" and relevant visa information

For Tourist Visa Holders: Ignore the status field for tourist visa holders - focus on issueDate and expiryDate for visa validity. The status field is only applicable for residents.

Field	Type	Description	Data Availability
`result.data.immigrationFile.status`	enum	Immigration file status: `Active`, `Inactive`, `NA`.	Available for Active Residents and Visitors
`result.data.immigrationFile.fileTypeEn` / `fileTypeAr`	string	Immigration file type. See Immigration File Types below.	Available for Active Residents and Visitors
`result.data.immigrationFile.fileNumber`	string	Immigration file number (format: `XXX/XXXX/XXX/XXXXXX`, up to 20 characters).	Available for Active Residents and Visitors
`result.data.immigrationFile.issuePlace`	string	Emirate or location where the file was issued (up to 100 characters).	Available for Active Residents and Visitors
`result.data.immigrationFile.issueDate`	string	Immigration file issue date (`YYYY-MM-DD`, 10 characters).	Available for Active Residents and Visitors
`result.data.immigrationFile.expiryDate`	string	Immigration file expiry date (`YYYY-MM-DD`, 10 characters).	Available for Active Residents and Visitors
`result.data.immigrationFile.workFlag`	boolean	Indicates if the tourist/visitor has a work permit. `true` for tourists with work authorization, `false` otherwise.	Available for Tourists and Visitors

Immigration File Types

Person Classification	Visa Type English	Visa Type Arabic
GOLDEN	RESIDENT RESIDENCE	اقامة
GOLDEN	SERVICE	عمل/هـ
GREEN	RESIDENT RESIDENCE	اقامة
GREEN	SERVICE	عمل/هـ
RESIDENCE	WORK RESIDENCE	عمل
RESIDENCE	RESIDENT RESIDENCE	اقامة
RESIDENCE	SERVICE	عمل/هـ
VISITOR	EMPLOYMENT	عمل
VISITOR	PRIVATE	أذن خاص
VISITOR	EMPLOYMENT/IMM	عمل/هـ
VISITOR	MULTI S.TERM VISIT/LEISURE/CITIZENS/SOME COUNTRIES	زيارة قصيرة لعدة سفرات ترفيه لرعايا بعض الدول
VISITOR	ENTRY PERMIT(RECIPROCITY) FOR 30 DAYS	تأشيرات المعاملة بالمثل (30) يوم
VISITOR	TRANSIT VISA( 48 hrs)	48 ساعة
VISITOR	96 HRS	96 ساعة
VISITOR	TOURIST CABIN CREW ENTRY PERMIT	أذن دخول للعاملين على متن السفن السياحية
VISITOR	SGI L.TERM ENTRY PERMIT/EMPLOYMENT (MISSION)	إذن دخول زيارة طويلة لسفرة واحدة عمل (مهمة عمل)
VISITOR	PRIVATE BOAT CABIN CREW ENTRY PERMIT	أذن دخول طاقم مركب النزهه
VISITOR	RECIPROCITY	تأشيرات المعاملة بالمثل
VISITOR	SHORT VISIT ENTRY PERMIT(30 DAYS INVITATION)	إذن دخول للزيارة ( دعوة ) قصيرة 30 يوم
VISITOR	S.Term Entry Permit of Courtesy/Embassy	إذن دخول قصيرة مجاملة / سفارة
VISITOR	ENTRY PERMIT/EUROPEAN CITIZENS(SCHENGEN)	أذن دخول لرعايا الدول الأوروبية ( منطقة الشنغن )
VISITOR	VISA FOR INDIAN IN SPECIAL COUNTRIES 14 DAYS	تأشيرة رعايا الهند في بعض الدول 14 يوم
VISITOR	ENTRY PERMIT FOR ٌ ٌREPUBLIC OF MAURITIUS CITIZENS	إذن دخول لرعايا جمهورية موريشيوس
VISITOR	MEDICAL TREATMENT	إذن دخول للعلاج لسفرة واحدة
VISITOR	GCC Accompany	مجلس تعاون / مـرافـق
VISITOR	GCC Resident	مـجـلس تـعاون / مـقـيـم
VISITOR	SINGL Entry Visa for(SA)90 Days /180 Days	تأشيرة سفرة واحدة إتفاقيات خاصه90 يوم خلال 180 يوم
VISITOR	Multi Entry Visa for (S A) 90 Days / 12 Months	تأشيرة عدة سفرات إتفاقيات خاصه 90 يوم خلال 12 شهر
VISITOR	VISA FOR JOB SEEKERS	تأشيرة الباحثين عن العمل
VISITOR	Multi S. Term Entry Permit Visit/Tourism	إذن دخول زيارة قصيرة لعدة سفرات سياحية
VISITOR	Sgl L. Term Entry Permit Visit/Tourism	إذن دخول زيارة طويلة لسفرة واحدة سياحية
VISITOR	Emergency Entry Permit	إذن دخول طارئ (إلغاء رحلات الاعطال/ ظروف جوية)
VISITOR	Sgl S. Term Entry Permit Visit/Leisure	إذن دخول زيارة قصيرة لسفرة واحدة ترفيه
VISITOR	Sgl L. Term Entry Permit Visit/Leisure	إذن دخول زيارة طويلة لسفرة واحدة ترفيه
VISITOR	Sgl S. Term Entry Permit Visit/Tourism	إذن دخول زيارة قصيرة لسفرة واحدة سياحية
VISITOR	Cabin Crew Entry Permit	إذن دخول أطقم الطائرات / سفن
VISITOR	Sgl L. Term Entry Permit Visit/Employment (GOVT)	إذن دخول زيارة طويلة لسفرة واحدة عمل (الحكومية)
VISITOR	ENTRY PERMIT(RECIPROCITY) FOR 180 DAYS	تأشيرات المعاملة بالمثل (180) يوم
VISITOR	Multi L. Term Entry Permit Visit/Tourism\5year	أذن دخول سياحة متعددة السفرات لمدة 5 سنوات
VISITOR	Tourist visa - single trip - 60 days	تأشيرة سياحة - سفرة واحدة - 60 يوم
VISITOR	Tourist visa - multiple trips - 60 days	تأشيرة سياحة - عدة سفرات - 60 يوم
VISITOR	Visa - visit a relative or friend 30 days	تأشيرة - سفرة واحدة - زيارة قريب أو صديق 30 يوم
VISITOR	Visa - Visit Relative or Friend 60 Days	تأشيرة - سفرة واحدة - زيارة قريب أو صديق 60 يوم
VISITOR	Visa - Visit a relative or friend 60 days	تأشيرة - عدة سفرات - زيارة قريب أو صديق 60 يوم
VISITOR	Visa - Visit Relative or Friend 90 Days	تأشيرة - سفرة واحدة - زيارة قريب أو صديق 90 يوم
VISITOR	Visa - 60 Days Explore Business Opportunities	تأشيرة - إستكشاف فرص العمل 60 يوم
VISITOR	Visa - Explore Business Opportunities 90 Days	تأشيرة - إستكشاف فرص العمل 90 يوم
VISITOR	Visa - Explore Business Opportunities 120 Days	تأشيرة - إستكشاف فرص العمل 120 يوم
VISITOR	VISA FOR INDIAN IN SPECIAL COUNTRIES 60 DAYS	تأشيرة رعايا الهند في بعض الدول 60 يوم

This is not an exhaustive list. Additional visa types may be returned depending on the immigration record. Stay periods and visa types are subject to change as per UAE visa and federal policy updates.

Active Visa (`result.data.activeVisa`)

null for UAE/GCC citizens who do not require visas.

Field	Type	Description	Data Availability
`result.data.activeVisa.visaType`	enum	Visa category: `Work`, `Visit`, `Residence`, `Transit`, `Student`, `Mission`.	Available for Active Visitors
`result.data.activeVisa.visaDepartment`	string	Government department that issued the visa (up to 200 characters).	Available for Active Visitors
`result.data.activeVisa.passportNo`	string	Passport number linked to this visa (up to 20 characters).	Available for Active Visitors
`result.data.activeVisa.passportExpiryDate`	string	Expiry date of the linked passport (`YYYY-MM-DD`).	Available for Active Visitors
`result.data.activeVisa.passportIssuePlace`	string	City or country where the linked passport was issued (up to 100 characters).	Available for Active Visitors
`result.data.activeVisa.visaStatus`	enum	Current visa status: `USED`, `CLOSED`, `CANCELLED`, `CHANGE STATUS`, `EXTENDED`, `VIOLATED`.	Available for Active Visitors
`result.data.activeVisa.issueDate`	string	Visa issue date (`YYYY-MM-DD`).	Available for Active Visitors
`result.data.activeVisa.createdDate`	string	Date the visa record was created (`YYYY-MM-DD`).	Available for Active Visitors
`result.data.activeVisa.validityDate`	string	Date until which the visa is valid for entry (`YYYY-MM-DD`).	Available for Active Visitors
`result.data.activeVisa.expiryDate`	string	Visa expiry date (`YYYY-MM-DD`).	Available for Active Visitors

Visa Status Values

The visaStatus field on the active visa record indicates the current lifecycle state of the visa:

Status	Event
`Used`	After valid entry
`Closed`	After valid exit
`Cancelled`	After cancellation
`Change Status`	After change status inside the country
`Extended`	After do the extension for the visa
`Violated`	If the visa holder start violation

Document Images (`result.data.documents`)

Base64-encoded document images. Individual fields are empty strings when the corresponding document was not captured during the journey. Store these securely in encrypted storage.

Field	Type	Description	Data Availability
`result.data.documents.passportImage`	string (Base64)	JPEG, typically 50–500 KB. Base64-encoded passport scan. Empty string when passport was not used.	Available for all scenarios
`result.data.documents.personFace`	string (Base64)	JPEG, typically 30–200 KB. Base64-encoded facial photograph captured during selfie step. Always present for completed journeys.	Available for all scenarios
`result.data.documents.digitalEID`	string (Base64)	PDF. Base64-encoded digital Emirates ID. Empty string when Emirates ID was not used.	Available for UAE Nationals and Residents
`result.data.documents.digitalSignature`	string (Base64)	TIFF, typically 5–50 KB. Base64-encoded digital signature. Empty string when not captured.	Available for UAE National, Residents and Ex-Residents
`result.data.documents.activeVisa`	string (Base64)	JPEG, typically 50–500 KB. Base64-encoded active visa document. Empty string for UAE/GCC citizens or when no visa image is on record.	Available for Active Residents
`result.data.documents.touristID`	string (Base64)	PDF, typically 5–100 KB. Base64-encoded tourist identification document. Empty string when tourist ID was not captured.	Available for Tourists & GCC Visitors

Next Steps

Save the uaeKycId

Store the customer’s unique identifier — you’ll need it for future REKYC and AUTHORISE journeys.

Store data within 24 hours

Customer data expires after 24 hours. Extract and persist everything you need into your own database.

Store document images securely

The documents object contains sensitive images. Decode and store them in encrypted storage per your data protection policies.

Verify the response signature

Use the signature field to verify response integrity before storing any data.

All date fields use YYYY-MM-DD format. Fields suffixed with Ar contain Arabic text, En contains English text.

{
  "result": {
    "success": true,
    "message": "Customer details fetched successfully",
    "data": {
      "uaeKycId": "139",
      "uidNumber": -144,
      "uaeKycCertificate": "",      
      "touristInfo": {
        "touristId": "1234"
      },

      "personalInfo": {
        "genderAr": "ذكر",
        "genderEn": "Male",
        "mobileNo": "0000000000",
        "insideUAE": "No",
        "fullNameAr": "جون أحمد دو",
        "fullNameEn": "John Ahmed Doe",
        "dateOfBirth": "1990-01-15",
        "firstNameAr": "جون",
        "firstNameEn": "John",
        "personClass": "Resident",
        "familyNameAr": "دو",
        "familyNameEn": "Doe",
        "motherNameAr": "فاطمة",
        "motherNameEn": "Fatima",
        "occupationAr": "مهندس",
        "occupationEn": "Engineer",
        "secondNameAr": "أحمد",
        "secondNameEn": "Ahmed",
        "placeOfBirthAr": "مومباي",
        "placeOfBirthEn": "Mumbai",
        "maritalStatusAr": "أعزب",
        "maritalStatusEn": "SINGLE",
        "hijriDateOfBirth": "1410-06-18",
        "immigrationStatus": "ACTIVE",
        "currentNationality": "IND",
        "personClassification": "RESIDENCE"
      },

      "travelDetail": {
         "isInsideUAE": true,
        "travelDate": "2024-12-01",
        "travelTime": "14:30:23",
        "travelType": "Inside UAE",
        "travelDocumentNo": "A1234567",
        "travelDocumentIssueDate": "2020-03-10",
        "travelDocumentExpiryDate": "2030-03-09"
      },
      "residenceInfo": {
        "issueDate": "2023-05-01",
        "documentNo": "201/2023/1234567",
        "expiryDate": "2033-05-01",
        "sponsorNameAr": "شركة أ ب ج ذ.م.م",
        "sponsorNameEn": "ABC Company LLC",
        "emiratesIdNumber": "784200058404151",
        "residenceClassAr": "إقامة عمل",
        "residenceClassEn": "WORK RESIDENCE",
        "residenceDepartmentAr": "غير معروف",
        "residenceDepartmentEn": "UNKNOWN",
        "accompanyCount": "0"
      },

      "activePassport": {
        "issueDate": "2020-03-10",
        "documentNo": "A1234567",
        "expiryDate": "2030-03-09",
        "documentType": "ORDINARY PASSPORT",
        "documentNationality": "India",
        "documentIssueCountry": "India",
        "documentNationalityAbbr": "IND",
        "documentIssueCountryAbbr": "IND"
      },

      "sponsorDetails": {
        "nameAr": "شركة أ ب ج ذ.م.م",
        "nameEn": "ABC Company LLC",
        "departmentAr": "غير معروف",
        "departmentEn": "UNKNOWN",
        "sponsorTypeAr": "شركات",
        "sponsorTypeEn": "COMPANIES",
        "sponsorNationality": "United Arab Emirates",
        "sponsorNationalityAbbr": "ARE",
        "sponsorIdn": "123456789",
        "tradeLicense": "TL-12345",
      },
      "immigrationFile": {
        "status": "ACTIVE",
        "issueDate": "2023-05-01",
        "expiryDate": "2025-04-30",
        "fileNumber": "101/2025/123/123456",
        "fileTypeAr": "تصريح دخول متعدد قصير المدة زيارة/سياحة",
        "fileTypeEn": "Multi S. Term Entry Permit Visit/Tourism",
        "issuePlace": "FEDERAL AUTHORITY FOR IDENTITY & CITIZENSHIP \\ ABU DHABI"
      },

  "personContactDetails": {
    "poBox": "12345",
    "areaAr": "البرشاء",
    "areaEn": "Al Barsha",
    "cityAr": "دبي",
    "cityEn": "Dubai",
    "mobileNo": "+971501234567",
    "emirateAr": "دبي",
    "emirateEn": "DUBAI",
    "streetAr": "شارع الشيخ زايد",
    "streetEn": "Sheikh Zayed Road",
    "homePhone": "+97141234567",
    "workPhone": "+97142345678"
  },

  "sponsorContactDetails": {
    "poBox": "54321",
    "emirateAr": "دبي",
    "emirateEn": "DUBAI",
    "cityAr": "دبي",
    "cityEn": "Dubai",
    "areaAr": "ديرة",
    "areaEn": "Deira",
    "streetAr": "شارع بني ياس",
    "streetEn": "Baniyas Road",
    "email": "info@abccompany.ae",
    "mobileNo": "+971501234567",
    "workPhone": "+97142345678",
    "homePhone": "+97141234567"
  },
      "documents": {
        "passportImage": "",
        "personFace": "",
        "digitalSignature": "",
        "digitalEID": ""
      }
    },
    "createdAt": 1776343071887,
    "meta": {
      "apiEndpoint": "/otk-service/customer-details",
      "serverTimestamp": 1776343497975,
      "journeyType": "ONBOARDING",
      "journeyToken": "13a7efd7-d32d-4392-acd8-2e149e58d12b"
    },
    "errors": [],
    "warnings": [
      {
        "code": "UAEKYC-WARN-ICP-002",
        "type": "ICP",
        "message": "Document & ICP record data mismatch for document expiry"
      }
    ]
  },
  "signature": ""
}

Sample Response Files

For additional reference, sample API response files are available that demonstrate how customer data varies by customer type:

UAE Citizen Response
GCC Citizen Response
Resident Response
Tourist/Visitor Response

Sample UAE Citizen Response (assets/local.json)

{
  "result": {
    "success": true,
    "message": "Customer details have been successfully retrieved.",
    "data": {
        "uaeKycId": "123456789",
        "uidNumber": 1234567,
        "uaeKycCertificate": "data:application/pdf;base64,JVBERi0xLjQ...",
        "personalInfo": {
            "genderEn": "MALE",
            "genderAr": "ذكر",
            "mobileNo": "+971501234567",
            "insideUAE": "Yes",
            "fullNameAr": "جون أحمد دو",
            "fullNameEn": "John Ahmed Doe",
            "dateOfBirth": "1990-01-15",
            "firstNameAr": "جون",
            "firstNameEn": "John",
            "personClass": "UAE Citizen",
            "familyNameAr": "دو",
            "familyNameEn": "Doe",
            "occupationAr": "مهندس",
            "occupationEn": "Engineer",
            "secondNameAr": "أحمد",
            "secondNameEn": "Ahmed",
            "placeOfBirthAr": "العين",
            "placeOfBirthEn": "AL AIN",
            "maritalStatusEn": "SINGLE",
            "maritalStatusAr": "أعزب",
            "immigrationStatus": "NA",
            "hijriDateOfBirth": "1410-06-18",
            "motherNameAr": "فاطمة",
            "motherNameEn": "Fatima",
            "currentNationality": "ARE",
            "personClassification": "LOCAL"
        },
        "travelDetail": {
            "travelType": "Inside UAE",
            "travelTime": "14:30:23",
            "travelDate": "2024-12-01",
            "isInsideUAE": true,
            "travelDocumentNo": "A1234567",
            "travelDocumentIssueDate": "2020-03-10",
            "travelDocumentExpiryDate": "2030-03-09"
        },
        "residenceInfo": {
            "issueDate": "2025-10-07",
            "documentNo": "123456789",
            "expiryDate": "2030-10-06",
            "emiratesIdNumber": "784202512345678"
        },
        "activePassport": {
            "issueDate": "2020-03-10",
            "documentNo": "A1234567",
            "expiryDate": "2030-03-09",
            "documentType": "ORDINARY PASSPORT",
            "documentNationality": "UNITED ARAB EMIRATES",
            "documentIssueCountry": "UNITED ARAB EMIRATES",
            "documentNationalityAbbr": "ARE",
            "documentIssueCountryAbbr": "ARE"
        },
        "immigrationFile": {
            "status": "NA"
        },
        "personContactDetails": {
            "poBox": "12345",
            "areaAr": "البرشاء",
            "areaEn": "Al Barsha",
            "cityAr": "دبي",
            "cityEn": "Dubai",
            "mobileNo": "+971501234567",
            "emirateAr": "دبي",
            "emirateEn": "DUBAI",
            "streetAr": "شارع الشيخ زايد",
            "streetEn": "Sheikh Zayed Road",
            "homePhone": "+97141234567",
            "workPhone": "+97142345678"
        },
        "documents": {
            "personFace": "data:image/jpeg;base64,/9j/4AAQ...",
            "passportImage": "data:image/jpeg;base64,/9j/4AAQ...",
            "digitalEID": "data:application/pdf;base64,JVBERi0xLjQ...",
            "digitalSignature": "data:image/tiff;base64,SUkqAA..."
        }
    },
    "createdAt": 1737018028786,
    "meta": {
        "apiEndpoint": "/otk-service/customer-details/:journeyToken",
        "serverTimestamp": 1739585925000,
        "journeyType": "ONBOARDING",
        "journeyToken": "550e8400-e29b-41d4-a716-446655440000"
    },
    "errors": [],
    "warnings": []
  },
  "signature": ""
}

Sample GCC Citizen Response (assets/GCC.json)

{
  "result": {
    "success": true,
    "message": "Customer details have been successfully retrieved.",
    "data": {
        "uaeKycId": "123456789",
        "uidNumber": 1234567,
        "uaeKycCertificate": "data:application/pdf;base64,JVBERi0xLjQ...",
        "touristInfo": {
            "touristId": "1234"
        },
        "personalInfo": {
            "genderEn": "MALE",
            "genderAr": "ذكر",
            "mobileNo": "+971501234567",
            "insideUAE": "Yes",
            "fullNameAr": "جون أحمد دو",
            "fullNameEn": "John Ahmed Doe",
            "dateOfBirth": "1990-01-15",
            "firstNameAr": "جون",
            "firstNameEn": "John",
            "personClass": "GCC Citizen",
            "familyNameAr": "دو",
            "familyNameEn": "Doe",
            "occupationAr": "مهندس",
            "occupationEn": "Engineer",
            "secondNameAr": "أحمد",
            "secondNameEn": "Ahmed",
            "placeOfBirthAr": "سلطنة عمان",
            "placeOfBirthEn": "SULTANATE OF OMAN",
            "maritalStatusEn": "SINGLE",
            "maritalStatusAr": "أعزب",
            "immigrationStatus": "NA",
            "hijriDateOfBirth": "1410-06-18",
            "motherNameAr": "فاطمة",
            "motherNameEn": "Fatima",
            "currentNationality": "OMN",
            "personClassification": "GCC"
        },
        "travelDetail": {
            "travelType": "Inside UAE",
            "travelTime": "14:30:23",
            "travelDate": "2024-12-01",
            "isInsideUAE": true,
            "travelDocumentNo": "A1234567",
            "travelDocumentIssueDate": "2020-03-10",
            "travelDocumentExpiryDate": "2030-03-09"
        },
        "residenceInfo": {
            "issueDate": "2025-10-07",
            "documentNo": "123456789",
            "expiryDate": "2030-10-06",
            "emiratesIdNumber": "784202512345678"
        },
        "activePassport": {
            "issueDate": "2020-03-10",
            "documentNo": "A1234567",
            "expiryDate": "2030-03-09",
            "documentType": "ORDINARY PASSPORT",
            "documentNationality": "OMAN",
            "documentIssueCountry": "OMAN",
            "documentNationalityAbbr": "OMN",
            "documentIssueCountryAbbr": "OMN"
        },
        "immigrationFile": {
            "status": "NA"
        },
        "personContactDetails": {
            "poBox": "12345",
            "areaAr": "البرشاء",
            "areaEn": "Al Barsha",
            "cityAr": "دبي",
            "cityEn": "Dubai",
            "mobileNo": "+971501234567",
            "emirateAr": "دبي",
            "emirateEn": "DUBAI",
            "streetAr": "شارع الشيخ زايد",
            "streetEn": "Sheikh Zayed Road",
            "homePhone": "+97141234567",
            "workPhone": "+97142345678"
        },
        "documents": {
            "personFace": "data:image/jpeg;base64,/9j/4AAQ...",
            "passportImage": "data:image/jpeg;base64,/9j/4AAQ...",
            "digitalEID": "data:application/pdf;base64,JVBERi0xLjQ...",
            "digitalSignature": "data:image/tiff;base64,SUkqAA...",
            "touristID": "data:application/pdf;base64,JVBERi0xLjQ..."
        }
    },
    "createdAt": 1737018028786,
    "meta": {
        "apiEndpoint": "/otk-service/customer-details/:journeyToken",
        "serverTimestamp": 1739585925000,
        "journeyType": "ONBOARDING",
        "journeyToken": "550e8400-e29b-41d4-a716-446655440000"
    },
    "errors": [],
    "warnings": []
  },
  "signature": ""
}

Sample Resident Response (assets/Resident.json)

{
  "result": {
    "success": true,
    "message": "Customer details have been successfully retrieved.",
    "data": {
        "uaeKycId": "123456789",
        "uidNumber": 1234567,
        "uaeKycCertificate": "data:application/pdf;base64,JVBERi0xLjQ...",
        "personalInfo": {
            "genderEn": "MALE",
            "genderAr": "ذكر",
            "mobileNo": "+971501234567",
            "insideUAE": "Yes",
            "fullNameAr": "جون أحمد دو",
            "fullNameEn": "John Ahmed Doe",
            "dateOfBirth": "1990-01-15",
            "firstNameAr": "جون",
            "firstNameEn": "John",
            "personClass": "Resident",
            "familyNameAr": "دو",
            "familyNameEn": "Doe",
            "occupationAr": "مهندس",
            "occupationEn": "Engineer",
            "secondNameAr": "أحمد",
            "secondNameEn": "Ahmed",
            "placeOfBirthAr": "مومباي",
            "placeOfBirthEn": "Mumbai",
            "maritalStatusEn": "SINGLE",
            "maritalStatusAr": "أعزب",
            "immigrationStatus": "ACTIVE",
            "hijriDateOfBirth": "1410-06-18",
            "motherNameAr": "فاطمة",
            "motherNameEn": "Fatima",
            "currentNationality": "IND",
            "personClassification": "RESIDENCE"
        },
        "travelDetail": {
            "travelType": "Inside UAE",
            "travelTime": "14:30:23",
            "travelDate": "2024-12-01",
            "isInsideUAE": true,
            "travelDocumentNo": "A1234567",
            "travelDocumentIssueDate": "2020-03-10",
            "travelDocumentExpiryDate": "2030-03-09"
        },
        "residenceInfo": {
            "issueDate": "2023-05-01",
            "documentNo": "201/2023/1234567",
            "expiryDate": "2025-04-30",
            "sponsorNameEn": "ABC Company LLC",
            "sponsorNameAr": "شركة أ ب ج ذ.م.م",
            "emiratesIdNumber": "784-1990-1234567-1",
            "residenceClassAr": "إقامة عمل",
            "accompanyCount": "0",
            "residenceClassEn": "WORK RESIDENCE"
        },
        "activePassport": {
            "issueDate": "2020-03-10",
            "documentNo": "A1234567",
            "expiryDate": "2030-03-09",
            "documentType": "ORDINARY PASSPORT",
            "documentNationality": "India",
            "documentIssueCountry": "India",
            "documentNationalityAbbr": "IND",
            "documentIssueCountryAbbr": "IND"
        },
        "sponsorDetails": {
            "nameEn": "ABC Company LLC",
            "nameAr": "شركة أ ب ج ذ.م.م",
            "sponsorNo": "S12345678",
            "departmentEn": "FEDERAL AUTHORITY FOR IDENTITY & CITIZENSHIP \\ ABU DHABI",
            "departmentAr": "الهيئة الاتحادية للهوية والجنسية / أبوظبي",
            "sponsorIdn": "123456789",
            "sponsorNationality": "United Arab Emirates",
            "sponsorNationalityAbbr": "ARE",
            "tradeLicense": "TL-12345",
            "sponsorTypeAr": "شركات",
            "sponsorTypeEn": "COMPANIES"
        },
        "immigrationFile": {
            "status": "ACTIVE",
            "issueDate": "2023-05-01",
            "expiryDate": "2025-04-30",
            "fileNumber": "101/2025/123/123456",
            "fileTypeAr": "تصريح دخول متعدد قصير المدة زيارة/سياحة",
            "fileTypeEn": "Multi S. Term Entry Permit Visit/Tourism",
            "issuePlace": "FEDERAL AUTHORITY FOR IDENTITY & CITIZENSHIP \\ ABU DHABI"
        },
        "personContactDetails": {
            "poBox": "12345",
            "areaAr": "البرشاء",
            "areaEn": "Al Barsha",
            "cityAr": "دبي",
            "cityEn": "Dubai",
            "mobileNo": "+971501234567",
            "emirateAr": "دبي",
            "emirateEn": "DUBAI",
            "streetAr": "شارع الشيخ زايد",
            "streetEn": "Sheikh Zayed Road",
            "homePhone": "+97141234567",
            "workPhone": "+97142345678"
        },
        "sponsorContactDetails": {
            "poBox": "54321",
            "emirateAr": "دبي",
            "emirateEn": "DUBAI",
            "cityAr": "دبي",
            "cityEn": "Dubai",
            "areaAr": "ديرة",
            "areaEn": "Deira",
            "streetAr": "شارع بني ياس",
            "streetEn": "Baniyas Road",
            "email": "info@abccompany.ae",
            "mobileNo": "+971501234567",
            "workPhone": "+97142345678",
            "homePhone": "+97141234567"
        },
        "documents": {
            "personFace": "data:image/jpeg;base64,/9j/4AAQ...",
            "passportImage": "data:image/jpeg;base64,/9j/4AAQ...",
            "digitalEID": "data:application/pdf;base64,JVBERi0xLjQ...",
            "digitalSignature": "data:image/tiff;base64,SUkqAA..."
        }
    },
    "createdAt": 1737018028786,
    "meta": {
        "apiEndpoint": "/otk-service/customer-details/:journeyToken",
        "serverTimestamp": 1739585925000,
        "journeyType": "ONBOARDING",
        "journeyToken": "550e8400-e29b-41d4-a716-446655440000"
    },
    "errors": [],
    "warnings": []
  },
  "signature": ""
}

Sample Tourist/Visitor Response (assets/Tourist.json)

{
  "result": {
    "success": true,
    "message": "Customer details have been successfully retrieved.",
    "data": {
        "uaeKycId": "123456789",
        "uidNumber": 1234567,
        "uaeKycCertificate": "data:application/pdf;base64,JVBERi0xLjQ...",
        "touristInfo": {
            "touristId": "1234"
        },
        "personalInfo": {
            "genderEn": "MALE",
            "genderAr": "ذكر",
            "mobileNo": "+971501234567",
            "insideUAE": "Yes",
            "fullNameAr": "جون أحمد دو",
            "fullNameEn": "John Ahmed Doe",
            "dateOfBirth": "1990-01-15",
            "firstNameAr": "جون",
            "firstNameEn": "John",
            "personClass": "Visitor",
            "familyNameAr": "دو",
            "familyNameEn": "Doe",
            "occupationAr": "مهندس",
            "occupationEn": "Engineer",
            "secondNameAr": "أحمد",
            "secondNameEn": "Ahmed",
            "placeOfBirthAr": "مومباي",
            "placeOfBirthEn": "Mumbai",
            "maritalStatusEn": "SINGLE",
            "maritalStatusAr": "أعزب",
            "immigrationStatus": "INACTIVE",
            "hijriDateOfBirth": "1410-06-18",
            "motherNameAr": "فاطمة",
            "motherNameEn": "Fatima",
            "currentNationality": "IND",
            "personClassification": "VISITOR"
        },
        "activePassport": {
            "issueDate": "2020-03-10",
            "documentNo": "A1234567",
            "expiryDate": "2030-03-09",
            "documentType": "ORDINARY PASSPORT",
            "documentNationality": "India",
            "documentIssueCountry": "India",
            "documentNationalityAbbr": "IND",
            "documentIssueCountryAbbr": "IND"
        },
        "personContactDetails": {
            "poBox": "12345",
            "areaAr": "البرشاء",
            "areaEn": "Al Barsha",
            "cityAr": "دبي",
            "cityEn": "Dubai",
            "mobileNo": "+971501234567",
            "emirateAr": "دبي",
            "emirateEn": "DUBAI",
            "streetAr": "شارع الشيخ زايد",
            "streetEn": "Sheikh Zayed Road",
            "homePhone": "+97141234567",
            "workPhone": "+97142345678"
        },
        "travelDetail": {
            "travelType": "Inside UAE",
            "travelTime": "14:30:32",
            "travelDate": "2024-12-01",
            "isInsideUAE": true,
            "travelDocumentNo": "A1234567",
            "travelDocumentIssueDate": "2020-03-10",
            "travelDocumentExpiryDate": "2030-03-09"
        },
        "sponsorDetails": {
            "nameEn": "ABC Company LLC",
            "nameAr": "شركة أ ب ج ذ.م.م",
            "sponsorNo": "S12345678",
            "departmentEn": "FEDERAL AUTHORITY FOR IDENTITY & CITIZENSHIP \\ ABU DHABI",
            "departmentAr": "الهيئة الاتحادية للهوية والجنسية / أبوظبي",
            "sponsorIdn": "123456789",
            "sponsorNationality": "United Arab Emirates",
            "sponsorNationalityAbbr": "ARE",
            "tradeLicense": "TL-1234567",
            "sponsorTypeAr": "شركات",
            "sponsorTypeEn": "COMPANIES"
        },
        "immigrationFile": {
            "status": "INACTIVE",
            "issueDate": "2023-05-01",
            "expiryDate": "2025-04-30",
            "fileNumber": "101/2026/76/123456",
            "fileTypeAr": "تصريح دخول متعدد قصير المدة زيارة/سياحة",
            "fileTypeEn": "Multi S. Term Entry Permit Visit/Tourism",
            "issuePlace": "FEDERAL AUTHORITY FOR IDENTITY & CITIZENSHIP \\ ABU DHABI"
        },
        "sponsorContactDetails": {
            "poBox": "54321",
            "emirateAr": "دبي",
            "emirateEn": "DUBAI",
            "cityAr": "دبي",
            "cityEn": "Dubai",
            "areaAr": "ديرة",
            "areaEn": "Deira",
            "streetAr": "شارع بني ياس",
            "streetEn": "Baniyas Road",
            "email": "info@abccompany.ae",
            "mobileNo": "+971501234567",
            "workPhone": "+97142345678",
            "homePhone": "+97141234567"
        },
        "documents": {
            "personFace": "data:image/jpeg;base64,/9j/4AAQ...",
            "passportImage": "data:image/jpeg;base64,/9j/4AAQ...",
            "touristID": "data:application/pdf;base64,JVBERi0xLjQ..."
        }
    },
    "createdAt": 1737018028786,
    "meta": {
        "apiEndpoint": "/otk-service/customer-details/:journeyToken",
        "serverTimestamp": 1739585925000,
        "journeyType": "ONBOARDING",
        "journeyToken": "550e8400-e29b-41d4-a716-446655440000"
    },
    "errors": [],
    "warnings": []
  },
  "signature": ""
}

These sample files are provided for development and testing purposes. Actual API responses will contain real customer data with the same structure but different values.

Overview

API Key Management

Journey APIs

Remote Verification

Certificate APIs

Validation APIs

Response Integrity

Customer Details

Authentication

Path Parameters

Code Examples

Response Fields

Envelope

Top-Level Customer Data

Tourist Information (`result.data.touristInfo`)

Personal Information (`result.data.personalInfo`)

Passport (`result.data.activePassport`)

Contact & Address (`result.data.personContactDetails`)

Travel Details (`result.data.travelDetail`)

Residence & Emirates ID (`result.data.residenceInfo`)

Immigration File (`result.data.immigrationFile`)

Active Visa (`result.data.activeVisa`)

Document Images (`result.data.documents`)

Next Steps

Sample Response Files

Overview

API Key Management

Journey APIs

Remote Verification

Certificate APIs

Validation APIs

Response Integrity

​Authentication

​Path Parameters

​Code Examples

​Response Fields

​Envelope

​Top-Level Customer Data

​Tourist Information (result.data.touristInfo)

​Personal Information (result.data.personalInfo)

​Passport (result.data.activePassport)

​Contact & Address (result.data.personContactDetails)

​Travel Details (result.data.travelDetail)

​Residence & Emirates ID (result.data.residenceInfo)

​Sponsor Details (result.data.sponsorDetails)

​Sponsor Contact (result.data.sponsorContactDetails)

​Immigration File (result.data.immigrationFile)

​Active Visa (result.data.activeVisa)

​Document Images (result.data.documents)

​Next Steps

​Sample Response Files

Authentication

Path Parameters

Code Examples

Response Fields

Envelope

Top-Level Customer Data

Tourist Information (`result.data.touristInfo`)

Personal Information (`result.data.personalInfo`)

Passport (`result.data.activePassport`)

Contact & Address (`result.data.personContactDetails`)

Travel Details (`result.data.travelDetail`)

Residence & Emirates ID (`result.data.residenceInfo`)

Sponsor Details (`result.data.sponsorDetails`)

Sponsor Contact (`result.data.sponsorContactDetails`)

Immigration File (`result.data.immigrationFile`)

Active Visa (`result.data.activeVisa`)

Document Images (`result.data.documents`)

Next Steps

Sample Response Files