Skip to main content
GET
{base_url}
/
digitization
/
v1
/
batch
/
{batch_id}
/
errored
Get Errored Records
curl --request GET \
  --url https://api.example.com/{base_url}/digitization/v1/batch/{batch_id}/errored \
  --header 'Content-Type: <content-type>' \
  --header 'x-transaction-key: <x-transaction-key>'
Returns only the records that failed during processing, along with the original input data from the CSV and the specific business errors that caused the failure. This is particularly useful for debugging and preparing corrected records for re-submission.

​
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_no
integer
Page number (default: 1).

​
Code Examples

curl "{base_url}/digitization/v1/batch/{batch_id}/errored?page_no=1" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "x-transaction-key: your-transaction-key"

​
Response

200 - Success
{
  "data": {
    "batch_id": "1a322c45-ab3f-4856-800d-d084a4b5597c",
    "page_no": 1,
    "hasNext": false,
    "data": [
      {
        "status": "failure",
        "business_errors": [
          {
            "error": "EXPIRED_EID",
            "message": "EmiratesID is Expired",
            "step": "VALIDATE_RESIDENT_INFO"
          }
        ],
        "input_data": {
          "customer_id": "100010",
          "eid_number": "784300000001855",
          "name_on_eid": "Kartik Naik",
          "dob": "27/07/1993",
          "eid_issue_date": "01/01/2024",
          "eid_expiry_date": "01/01/2026",
          "onboarding_date": "12/03/2026",
          "consent_version": "v1"
        }
      }
    ]
  },
  "message": "Errored records fetched successfully",
  "success": true
}

​
Response Fields

FieldTypeDescription
successBooleanRequest success status.
messageStringHuman-readable status message.
data.batch_idUUIDThe batch ID these errored records belong to.
data.page_noIntegerCurrent page number.
data.hasNextBooleanWhether more pages of errored records exist.
data.dataArrayList of errored record objects.

​
Errored Record Fields

FieldTypeDescription
statusStringAlways failure for records in this endpoint.
business_errorsArrayList of error objects with error code, message, and step.
input_dataObjectThe original CSV row data as key-value pairs (see below).

​
Input Data Fields (Original CSV Values)

The input_data object mirrors the original CSV row, giving you full visibility into what was submitted. This is essential for identifying and correcting the data issue before re-submission.
FieldDescription
customer_idThe client’s internal customer identifier.
eid_numberEmirates ID number (15 digits, starts with 784).
name_on_eidFull name as printed on the Emirates ID.
dobDate of birth (DD/MM/YYYY format).
eid_issue_dateEmirates ID issue date (DD/MM/YYYY format).
eid_expiry_dateEmirates ID expiry date (DD/MM/YYYY format).
onboarding_dateCustomer onboarding date (DD/MM/YYYY format).
consent_versionVersion of consent used (e.g., v1).
card_numberCard number (if applicable, otherwise empty).
eid_front_imgBase64 EID front image (if applicable, otherwise empty).
eid_back_imgBase64 EID back image (if applicable, otherwise empty).
person_selfieBase64 selfie image (if applicable, otherwise empty).

​
Usage Notes

  1. Use this endpoint to identify and debug failed records.
  2. The input_data contains the exact values from the original CSV, making it easy to spot data issues.
  3. For the full list of business error codes, see the Error Handling section.
Re-submitting Failed Records: Failed records cannot be retried within the same batch. Create a new CSV containing only the corrected records and submit it as a new batch through the Population Migration workflow.