Face Extraction API
Introduction
This API is used to extract the face from the DL. The extracted image can than be used to verify the peron during the kyc.
How to call the API
Before going for Auto reading calls, you first need to create an Identity object. Need to pass accessToken and itemid obtained from identity call along with other input parameters
API Input Guidelines
Need to put URL of the Front Side Image of the driving licence.
Step 1: Hit Identities API
Sample cURL
curl --location --request POST 'https://preproduction.signzy.tech/api/v2/patrons/..patronId../identities' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "drivingLicence",
"email": "<email Id>",
"callbackUrl": "<Call back Url>",
"images": [<images Url>]
}'Input Parameters
Parameter Name | Required/Optional | Description |
|---|---|---|
Authorization | Required | Contains the id parameter returned from the login step |
Content-Type | Required | application/json |
type | Required | Type of identity |
Required | e-mail ID | |
callbackurl | Required | URL where response will be posted |
images | Required | Front image of driving licence |
Sample Response
{
"type": "drivingLicence",
"email": "[email protected]",
"callbackUrl": "https://www.w3schools.com",
"images": [],
"accessToken": " ",
"autoRecognition": [],
"verification": [],
"forgeryCheck": [],
"id": "633124060b9e46d4a042xxxx",
"patronId": "6319d81fa341350e79xxxx"
}Response Parameter
Parameter Name | Description |
|---|---|
type | Type of identity |
e-mail ID | |
callbackUrl | URL where response will be posted |
images | Front image of driving licence |
accessToken | This is provided by identities API |
autoRecognition | Auto recognises text from upload image |
verification | verification is done |
forgeryCheck | Forgery check is done |
id | Unique user id |
patronId | Unique patron id |
Step 2: Hit Snoops API and receives a response
Sample CURL
curl --location --request POST 'https://preproduction.signzy.tech/api/v2/snoops' \
--header 'content-type: application/json' \
--header 'Authorization: <token>' \
--data-raw '{
"service": "Identity",
"itemId": "",
"accessToken": "",
"task": "faceExtraction",
"essentials": {
"url": " "
}
}'Input Parameters
Parameter Name | Required/Optional | Description |
|---|---|---|
Content-Type | Required | application/json |
service | Required | Type of Signzy service - “identity” |
itemId | Required | Contains the identity item id |
accessToken | Required | This is provided by the identities API |
task | Required | task should be faceExtraction for this API |
essentials.Url | Required | URL of the image |
Sample API Response
{
"service": "Identity",
"itemId": "",
"task": "faceExtraction",
"essentials": {
"url": "frontimage.jpg"
},
"accessToken": "",
"id": "",
"response": {
"url": "frontImage.jpg",
"ttl": "10 mins",
"id": 23,
"result": {
"cropped": "croppedimage.png"
}
}
}
Output Parameters
Parameter Name | Description |
|---|---|
service | Type of Signzy service - “identity” |
itemId | Contains the identity item id |
task | The type of task performed - “Auto Recognition” |
essentials.url | URL of the input image |
accessToken | Contains the access token that was received from identity request |
id | Contains the unique Id |
response.url | URL where response will be posted |
response.ttl | Time to live (validity of the file) |
response.id | Unique ID of the image |
result.cropped | Contains Cropped front Image |
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].