Skip to main content
GET
{base_url}
/
digitization
/
v1
/
batch
/
{batch_id}
/
records
Get Batch Records
curl --request GET \
  --url https://api.example.com/{base_url}/digitization/v1/batch/{batch_id}/records \
  --header 'Content-Type: <content-type>' \
  --header 'x-transaction-key: <x-transaction-key>'
Returns the individual records within a batch, including their processing status, mapped field values, and any errors encountered. Results are paginated.

​
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.

​
Query Parameters

​
page
integer
Page number (default: 1).
​
limit
integer
Records per page (default: 10).

​
Code Examples

curl "{base_url}/digitization/v1/batch/{batch_id}/records?page=1&limit=10" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "x-transaction-key: your-transaction-key"

​
Response

200 - Success
{
  "data": {
    "page": 1,
    "limit": 10,
    "total_count": 2,
    "total_pages": 1,
    "records": [
      {
        "customer_id": "100009",
        "status": "success",
        "document_number": "784300000001715",
        "name_on_document": "Jhon Does",
        "transaction_id": "dd1dd212-be9c-4648-...",
        "digitization_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "errors": {}
      },
      {
        "customer_id": "100010",
        "status": "failure",
        "document_number": "784300000001855",
        "name_on_document": "Kartik Naik",
        "transaction_id": "6de88d37-9dd2-484b-...",
        "digitization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "errors": {
          "business_error": [
            {
              "error": "EXPIRED_EID",
              "message": "EmiratesID is Expired",
              "step": "VALIDATE_RESIDENT_INFO"
            }
          ]
        }
      }
    ]
  },
  "success": true
}

​
Response Fields

FieldTypeDescription
successBooleanRequest success status.
data.pageIntegerCurrent page number.
data.limitIntegerRecords per page.
data.total_countIntegerTotal number of records in the batch.
data.total_pagesIntegerTotal number of pages.
data.recordsArrayList of record objects.

​
Record Fields

FieldTypeDescription
idUUIDUnique identifier for this record within the batch.
batch_idUUIDThe parent batch ID this record belongs to.
customer_idStringThe customer identifier from your CSV file.
statusStringRecord processing result: success or failure.
transaction_idUUIDThe KYC transaction ID generated for this record.
digitization_idUUIDUnique identifier for the digitization transaction.
document_typeStringDocument type processed (e.g., EID).
document_numberStringThe Emirates ID number from the CSV.
name_on_documentStringName as it appears on the Emirates ID.
date_of_birthStringDate of birth of the customer.
document_issue_dateStringIssue date of the Emirates ID.
document_expiry_dateStringExpiry date of the Emirates ID.
onboarding_dateStringThe onboarding date provided in the CSV.
consent_versionStringConsent version used for this record.
validityStringDocument validity status.
errorsObjectError details if status is failure (see Error Handling).
created_atStringTimestamp when the record was created (ISO 8601 format).
updated_atStringTimestamp of the last update to this record (ISO 8601 format).

​
Usage Notes

  1. For large result sets, use pagination by incrementing the page parameter.
  2. Check total_pages to determine how many pages of records exist.
  3. For records with status success, use the customer_id to fetch full KYC data via the Get Customer Data API.
  4. For records with status failure, use the Get Errored Records API for detailed error information and original CSV input data.