UAE Single Document KYC Extraction
Overview
The UAE KYC Document API is designed to simplify the process of extracting critical information from various UAE identification documents, including the Emirates ID, Mulkiya Card, Passport, and Driver's License. This API helps to extract information from a single document with multiple IDs. The API accepts a file URL as input and returns structured data for easy integration into various applications, enabling organizations to extract or prefill details automatically.
Note :- If usecase is to extract single document's data then use Global ID intelligence APIs. Contact your sales SPOC to know more or send a mail to [email protected]
Use Case
- Customer Onboarding: Streamline the process of verifying customer identities during onboarding by extracting essential details from various identification documents.
- KYC Compliance: Automatically extract from multiple documents to meet regulatory requirements for Know Your Customer (KYC) compliance.
- Fraud Prevention: Reduce the risk of fraud by extracting the details of the ID Cards
API Details
Request Body
curl --location 'https://api.signzy.ae/api/v3/uae-api/single-doc-kyc' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data '{
"fileUrl": "https://persist.signzy.tech/api/files/963883305/download/630easdfsdfdsfwerfsd21a823jb4233a4255e3.pdf"
}'Request Body Parameters
Parameter | Type | Description |
|---|---|---|
fileUrl | string | Link of the file being entered - Should be one Pdf, tiff, tiff, jpeg, jpg, png formats in persist link. |
Response Body
Output Example
{
"result": {
"eid": {
"idNumber": "784-1998-0529596-3",
"name": "Manoj Kumar",
"dob": "29/01/1993",
"nationality": "IND",
"issueDate": "14/11/2022",
"expiryDate": "13/11/2032",
"sex": "M",
"cardNumber": "125470285",
"occupation": "Not Employed",
"issuePlace": "Dubai",
"mrzCode": "ILHED378293774993792395639801277M3211131IND<<<<<<<<<3KOTHAPALLY<UJWAL<RAJEEV<KUMAR"
},
"mulkiyaCard": {
"trafficPlateNumber": "24234",
"placeOfIssue": "دبي",
"tcNumber": "13732423",
"nationality": "India",
"expiryDate": "18/12/2023",
"registeredDate": "28/12/2013",
"insuranceExpiry": "18/01/2024",
"policyNumber": "P-122-1099-2023-453",
"mortgagedBy": "",
"modelYear": "2013",
"numberOfPass": "5",
"origin": "India",
"vehicleType": "FORD MUSTANG",
"grossVehicleWeight": "2600 K",
"emptyWeight": "1959",
"engineNumber": "EBA93234",
"chassisNumber": "2FMKEFC2EBA93261"
},
"passport": {
"type": "P",
"countryCode": "IND",
"number": "U0528311",
"givenSurname": "RAJEEV KUMAR",
"givenName": "UJWAL",
"nationality": "INDIAN",
"sex": "M",
"dob": "27/01/1993",
"placeOfBirth": "ABU DHABI, UNITED ARAB EMIRATES",
"placeOfIssue": "NEW YORK",
"dateOfIssue": "25/02/2021",
"mrz": "<IND<MANOJKUMAR<<<U05223246IND234324233M3234324<<<<<<<<<<<<<<<<<<",
"nameOfFatherGuardian": "",
"nameOfMother": "",
"nameOfSpouse": "",
"address": "",
"oldPassportNumber": "",
"oldPassportIssueDate": "",
"oldPassportIssuePlace": "",
"fileNumber": ""
},
"driverLicense": {
"dlNumber": "3857223",
"name": "Manoj Kumar",
"nationality": "India",
"dob": "27/01/1993",
"issueDate": "03/09/2017",
"expiryDate": "03/09/2023",
"issuingPlace": "Dubai",
"licensingAuthority": "rat10111",
"trafficCodeNumber": "",
"permittedVehicles": ""
}
}
}Response Body Paramters
Output Mapping
Parameter Name | Data Type | Description |
|---|---|---|
eid | Object | Contains information related to the Emirates ID. |
- idNumber | String | Unique Emirates ID number. |
- name | String | Full name of the individual as per Emirates ID. |
- dob | String (Date) | Date of birth in DD/MM/YYYY format. |
- nationality | String | Nationality code as per the Emirates ID. |
- issueDate | String (Date) | Date when the Emirates ID was issued in DD/MM/YYYY format. |
- expiryDate | String (Date) | Expiry date of the Emirates ID in DD/MM/YYYY format. |
- sex | String | Gender of the individual (M for Male, F for Female). |
- cardNumber | String | Unique card number of the Emirates ID. |
- occupation | String | Occupation listed on the Emirates ID. |
- issuePlace | String | Place where the Emirates ID was issued. |
- mrzCode | String | Machine Readable Zone code of the Emirates ID. |
mulkiyaCard | Object | Contains information related to the vehicle registration (Mulkiya Card). |
- trafficPlateNumber | String | Traffic plate number of the vehicle. |
- placeOfIssue | String | Place of issue of the Mulkiya Card. |
- tcNumber | String | Traffic code number associated with the vehicle registration. |
- nationality | String | Nationality of the vehicle owner. |
- expiryDate | String (Date) | Expiry date of the Mulkiya Card in DD/MM/YYYY format. |
- registeredDate | String (Date) | Date when the vehicle was registered in DD/MM/YYYY format. |
- insuranceExpiry | String (Date) | Expiry date of the vehicle insurance in DD/MM/YYYY format. |
- policyNumber | String | Insurance policy number for the vehicle. |
- mortgagedBy | String | Details of the entity that holds the mortgage on the vehicle, if any. |
- modelYear | String | Manufacturing year of the vehicle. |
- numberOfPass | String | Number of passengers the vehicle is allowed to carry. |
- origin | String | Country of origin of the vehicle. |
- vehicleType | String | Make and model of the vehicle. |
- grossVehicleWeight | String | Maximum gross weight of the vehicle. |
- emptyWeight | String | Weight of the vehicle without any passengers or cargo. |
- engineNumber | String | Engine number of the vehicle. |
- chassisNumber | String | Chassis number of the vehicle. |
passport | Object | Contains information extracted from the passport. |
- type | String | Type of passport (P for Personal). |
- countryCode | String | ISO country code of the passport issuer. |
- number | String | Passport number. |
- givenSurname | String | Surname of the individual as per passport. |
- givenName | String | Given name(s) of the individual as per passport. |
- nationality | String | Nationality as stated in the passport. |
- sex | String | Gender of the individual (M for Male, F for Female). |
- dob | String (Date) | Date of birth as per the passport in DD/MM/YYYY format. |
- placeOfBirth | String | Place of birth as mentioned in the passport. |
- placeOfIssue | String | Location where the passport was issued. |
- dateOfIssue | String (Date) | Date when the passport was issued in DD/MM/YYYY format. |
- mrz | String | Machine Readable Zone code of the passport. |
- nameOfFatherGuardian | String | Name of the father or guardian, if available. |
- nameOfMother | String | Name of the mother, if available. |
- nameOfSpouse | String | Name of the spouse, if available. |
- address | String | Address of the individual, if available. |
- oldPassportNumber | String | Number of the previous passport, if available. |
- oldPassportIssueDate | String (Date) | Date when the previous passport was issued, if available. |
- oldPassportIssuePlace | String | Place where the previous passport was issued, if available. |
- fileNumber | String | File number associated with the passport, if available. |
driverLicense | Object | Contains information related to the driver's license. |
- dlNumber | String | Driver's license number. |
- name | String | Full name of the individual as per the driver's license. |
- nationality | String | Nationality of the individual as per the driver's license. |
- dob | String (Date) | Date of birth in DD/MM/YYYY format. |
- issueDate | String (Date) | Date when the driver's license was issued in DD/MM/YYYY format. |
- expiryDate | String (Date) | Expiry date of the driver's license in DD/MM/YYYY format. |
- issuingPlace | String | Place where the driver's license was issued. |
- licensingAuthority | String | Licensing authority that issued the driver's license. |
- trafficCodeNumber | String | Traffic code number associated with the driver's license, if available. |
- permittedVehicles | String | Types of vehicles the individual is permitted to drive, if available. |
Error Code Responses
Sample Errors
Error Code | Message | Description |
|---|---|---|
400 | Invalid Input | The input data is missing or malformed. |
401 | Unauthorized | Authorization failed; invalid or missing API key. |
403 | Forbidden | You do not have permission to access this resource. |
404 | Not Found | The requested document could not be found. |
500 | Internal Server Error | An unexpected error occurred on the server. |
503 | Service Unavailable | The service is temporarily unavailable; please try again later. |
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!