Kuwait ID
Introduction
The Kuwait ID extraction API allows you to extract relevant information from the Kuwait ID card images. The API uses OCR technology to recognize the text on the image and extract the relevant details.
Sample cURL
curl --request POST \
--url https://signzy.tech/api/v2/patrons/....patronid.../foreignidentitiesextractions \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.8' \
--header 'Authorization: <Access-Token>' \
--header 'content-type: application/json' \
--data '{
"task": "kuwaitId",
"essentials": {
"files": [
"...front image url...",
"...back image url..."
]
}
}'Input Parameters
Parameter Name | Data Type | Description |
|---|---|---|
task | string | The specific task that needs to be performed, i.e., "kuwaitId" in this case. |
essentials.files | array | The array of files to be used for the extraction process. This array should contain the URLs of the image files. |
Sample API Response
// Expected response
{
"essentials": {
"files": [
"...front image url...",
"...back image url..."
]
},
"id": "..id..",
"patronId": "...patron id...",
"task": "kuwaitId",
"result": {
"dob": "...dob...",
"doe": "...doe...",
"nationality": "...nationality...",
"name": "...name...",
"surName": "...surName...",
"gender": "...gender...",
"number": "...number..."
}
}Response Parameters
Parameter | Description |
|---|---|
essentials | The file URLs for the front and back images of the ID |
id | The ID generated for the verification request |
patronId | The patron ID for whom the verification is being performed |
task | The task that was requested, which is kuwaitId in this case |
result | The verification result, containing the following fields: |
- dob | Date of Birth of the individual |
- doe | Expiry of the card |
- nationality | Nationality |
- name | Name of the individual |
- surName | Surname of the individual |
- gender | Gender |
- number | ID number |