Skip to main content
POST
{base_url}
/
digitization
/
v1
/
batch
/
{batch_id}
/
getCustomerData
Get Customer Data
curl --request POST \
  --url https://api.example.com/{base_url}/digitization/v1/batch/{batch_id}/getCustomerData \
  --header 'Content-Type: <content-type>' \
  --header 'x-transaction-key: <x-transaction-key>' \
  --data '
{
  "customer_id": "<string>"
}
'
Retrieves the full digitized KYC data for a specific customer within a processed batch. It returns the complete resident profile including personal information, residence details, immigration status, sponsor information, travel details, and more. Use this after a batch is COMPLETED to fetch the enriched data for successfully processed records.
This API should only be called for records with status success from the Get Batch Records API. Calling it for failed records will return error details instead of customer data.

​
Authentication

​
x-transaction-key
string
required
Your API key. Get your key →
​
Content-Type
string
required
Must be application/json

​
Path Parameters

​
batch_id
string
required
The Batch ID assigned after approval.

​
Request Body

​
customer_id
string
required
The customer ID from your CSV that you want to retrieve data for.

​
Code Examples

curl -X POST "{base_url}/digitization/v1/batch/{batch_id}/getCustomerData" \
  -H "Content-Type: application/json" \
  -H "x-transaction-key: your-transaction-key" \
  -d '{ "customer_id": "100009" }'

​
Response

200 - Success
{
  "data": {
    "batch_id": "1a322c45-ab3f-...",
    "status": "success",
    "biometric_completed": false,
    "digitised_on": "2026-03-13T16:35:20.118344Z",
    "data": {
      "personalInfo": {
        "fullNameEn": "JOHN DOES",
        "fullNameAr": "",
        "dateOfBirth": "1970-01-01",
        "genderEn": "Male",
        "currentNationality": "KWT",
        "personClass": "Resident",
        "immigrationStatus": "ACTIVE",
        "insideUAE": "Yes"
      },
      "residenceInfo": {
        "emiratesIdNumber": "784300000001715",
        "expiryDate": "2027-01-01",
        "issueDate": "2025-01-01",
        "residenceClassEn": "WORK RESIDENCE"
      },
      "personContactDetails": {
        "emirateEn": "",
        "cityEn": "",
        "mobileNo": ""
      },
      "activePassport": {
        "documentType": "",
        "documentNo": "",
        "documentNationality": "",
        "issueDate": "",
        "expiryDate": ""
      },
      "activeVisa": {
        "visaType": "",
        "visaDepartment": ""
      },
      "immigrationFile": {
        "status": "",
        "fileTypeEn": "",
        "issueDate": "",
        "expiryDate": ""
      },
      "sponsorDetails": {
        "nameEn": "",
        "nameAr": "",
        "departmentEn": "",
        "sponsorNationality": "",
        "sponsorTypeEn": ""
      },
      "travelDetail": {
        "isInsideUAE": "",
        "travelType": "",
        "travelDate": "",
        "travelTime": "",
        "travelDocumentNo": ""
      },
      "uaeKycId": "222"
    },
    "errors": {}
  },
  "message": "Customer data fetched successfully",
  "success": true
}

​
Response Fields

FieldTypeDescription
successBooleanRequest success status.
messageStringHuman-readable status message.
data.batch_idUUIDThe batch ID this customer belongs to.
data.statusStringProcessing result: success or failure.
data.biometric_completedBooleanWhether biometric verification has been completed.
data.digitised_onStringTimestamp when the record was digitized (ISO 8601 format).
data.dataObjectThe full KYC profile data (see sections below).
data.data.uaeKycIdStringThe UAE KYC unique identifier for this customer. Save this — you’ll need it for Re-KYC and AUTHORISE journeys.
data.errorsObjectError details if status is failure (empty if successful).

​
Response Data Sections

FieldDescription
fullNameEn / fullNameArFull name in English / Arabic.
firstNameEn / firstNameArFirst name in English / Arabic.
secondNameEn / secondNameArSecond name in English / Arabic.
familyNameEn / familyNameArFamily name in English / Arabic.
motherNameEn / motherNameArMother’s name in English / Arabic.
dateOfBirthDate of birth.
hijriDateOfBirthDate of birth in Hijri calendar.
genderEn / genderArGender in English / Arabic.
currentNationalityCurrent nationality.
personClassPerson classification.
maritalStatusEn / maritalStatusArMarital status in English / Arabic.
placeOfBirthEn / placeOfBirthArPlace of birth in English / Arabic.
mobileNoMobile number.
titleEn / titleArTitle in English / Arabic.
insideUAEWhether the person is currently inside the UAE.
immigrationStatusCurrent immigration status.
occupationEn / occupationArOccupation in English / Arabic.
FieldDescription
emiratesIdNumberEmirates ID number associated with the residence.
documentNoResidence document number.
residenceClassEn / residenceClassArResidence class in English / Arabic.
residenceDepartmentEn / residenceDepartmentArResidence department in English / Arabic.
accompanyCountNumber of accompanying persons.
sponsorNameEn / sponsorNameArSponsor name in English / Arabic.
issueDateResidence permit issue date.
expiryDateResidence permit expiry date.
FieldDescription
emirateEn / emirateArEmirate in English / Arabic.
cityEn / cityArCity in English / Arabic.
areaEn / areaArArea in English / Arabic.
streetEn / streetArStreet in English / Arabic.
poBoxP.O. Box number.
mobileNoMobile number.
homePhoneHome phone number.
workPhoneWork phone number.
FieldDescription
documentTypePassport document type.
documentNoPassport number.
documentNationality / documentNationalityAbbrPassport nationality (full / abbreviated).
documentIssueCountry / documentIssueCountryAbbrIssue country (full / abbreviated).
issueDatePassport issue date.
expiryDatePassport expiry date.
FieldDescription
visaTypeType of visa.
visaDepartmentVisa issuing department.
passportNoPassport number on the visa.
passportExpiryDatePassport expiry date.
passportIssuePlacePassport issue place.
visaStatusCurrent visa status.
issueDateVisa issue date.
createdDateVisa creation date.
validityDateVisa validity date.
expiryDateVisa expiry date.
FieldDescription
statusImmigration file status.
fileTypeEn / fileTypeArFile type in English / Arabic.
fileNumberImmigration file number.
issuePlacePlace of issue.
issueDateIssue date.
expiryDateExpiry date.
FieldDescription
isInsideUAEBoolean — whether the person is inside the UAE.
travelTypeTravel type (e.g., Inside UAE, Outside UAE).
travelDateTravel date (YYYY-MM-DD).
travelTimeTravel time (HH:MM:SS).
travelDocumentNoPassport or GCC card number.
travelDocumentIssueDateTravel document issue date (YYYY-MM-DD).
travelDocumentExpiryDateTravel document expiry date (YYYY-MM-DD).

​
Usage Notes

  1. Only call this API for records with status success from the Get Batch Records API.
  2. The x-transaction-key header is mandatory and is unique to your client organization.
  3. The response structure is consistent with the Customer Details API used for journey-based KYC.
  4. All dates in the response use YYYY-MM-DD format unless otherwise specified.