Error Object Structure
| Field | Type | Description |
|---|
error | String | Error code identifying the specific failure (e.g., EXPIRED_EID). |
message | String | Human-readable description of the error. |
step | String | The processing step where the error occurred (e.g., VALIDATE_RESIDENT_INFO). |
Business Error Codes Reference
| Error Code | Step | Message | Resolution |
|---|
RESIDENT_NOT_FOUND | GET_RESIDENT_DATA | Resident not found in ICP | Verify the EID number is correct and belongs to an active resident registered in the ICP system. |
IMMIGRATION_STATUS_INACTIVE | VALIDATE_RESIDENT_INFO | Immigration file status is not ACTIVE | The resident’s immigration file must have an active status. Contact the relevant authority to resolve the immigration status. |
MISSING_EXPIRY_DATE | VALIDATE_RESIDENT_INFO | Missing EmiratesID expiry date | The EID expiry date could not be retrieved from ICP. Ensure the EID record in ICP has a valid expiry date. |
INVALID_EXPIRY_DATE | VALIDATE_RESIDENT_INFO | Missing EmiratesID expiry date | The expiry date retrieved from ICP is in an unrecognized format. Contact support to investigate the ICP record. |
EXPIRED_EID | VALIDATE_RESIDENT_INFO | EmiratesID is Expired | The customer must renew their Emirates ID before population migration can proceed. |
MARITAL_STATUS_DEAD | VALIDATE_RESIDENT_INFO | Residence marital status is dead | The resident record in ICP shows a deceased marital status. This record cannot be processed for KYC. |
CURRENT_COUNTRY_ABBR_NOT_FOUND | VALIDATE_RESIDENT_INFO | Residence current country abbr not found | The nationality/country code in ICP could not be resolved. Contact support to verify the ICP resident record. |
RESIDENT_NIN_GCC_NOR_ACTIVE_IMG_STATUS | VALIDATE_RESIDENT_INFO | Residence is neither in GCC nor in Active img status | Only GCC nationals or residents with active immigration files can be processed. Verify the resident’s eligibility. |
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.
Status Reference
File Status Values
| Status | Description |
|---|
Pending | The batch has been created but the CSV file has not yet been uploaded. |
Uploaded | The CSV file has been uploaded and verified for integrity. |
Approval Status Values
| Status | Description |
|---|
Pending Approval | The batch request has been submitted and is awaiting approval from an authorized reviewer. |
Approved | The batch has been approved and is ready for processing. A unique Batch ID is assigned. |
