Foreign id classification

Introduction
This API allows you to classify a given image into one of the pre-defined categories based on the visual content. The API supports the classification of images from different countries and can be used for a variety of use cases, such as image moderation, content filtering, and more.
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":"classification","essentials":{"country":"...country code...", "files":["...files..."]}}'Parameter | Type | Description |
|---|---|---|
task | String | The name of the task, which is always "classification" for this API. |
essentials | Object | A JSON object containing the following sub-parameters: |
country | String | The two-letter ISO country code for the country where the image was captured. |
files | Array | An array of URLs points to the image(s) to classify. |

Sample Response
{
"essentials": {
"country": "...3 letter ISO Code of the country..."
"files": [
"...front image url...",
"...back image url..."
]
},
"id": "..id..",
"patronId": "...patron id...",
"task": "classification",
"result": {
{
"idType": "...Emirates ID/Kuwait ID/Passport/unknown...",
"country": "...country...",
"countryCode": "...country code..."
}
}
}
Output Parameter | Data Type | Description |
|---|---|---|
idType | string | The type of ID extracted. Can be Emirates ID, Kuwait ID, Passport, or unknown |
country | string | The name of the country from which the ID is issued |
countryCode | string | The 3-letter ISO code of the country from which the ID is issued |