Face Extraction
Introduction
This API accepts ID card or document images as input and adeptly extracts the face, returning a URL of the cropped face image. Users submit the image URL, and the API utilizes sophisticated image processing techniques to isolate and retrieve the facial image. The outcome is a convenient and accurate URL link to the extracted face, streamlining integration into various digital verification and security systems.
API details
Endpoint
POST https://api.signzy.app/api/v3/face/get-facePOST https://api-preproduction.signzy.app/api/v3/face/get-faceRequest Body Parameters
Parameter | Data Type | Description | Required |
|---|---|---|---|
url | String | URL of the ID card/document from which the face is to be extracted. | Mandatory |
{
"url": ["img_url"]
}Request Headers
Name | Value | Required | Description |
|---|---|---|---|
Content-Type | application/json | Mandatory | The type of content that the request body contains. |
Authorization | XXXXXXXXXXXXXXX | Mandatory | An authentication token to authorize the request. Reach out to the Signzy support team to get one created. |
Code Samples
curl --location 'https://api.signzy.app/api/v3/face/get-face' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Access-Token>' \
--data '{
"url": "---input-image-url---"
}'Response body parameters
Parameter Name | Description |
|---|---|
faceUrl | URL of the extracted face from the ID card/document. |
{
"faceUrl": "--cropped-face-url---"
}Document related Constraints
The size of the document should not exceed 10 MB.
For best results, ensure the image you use fits tightly in the camera view and horizontally aligned.
Supported document types:
- Image - JPEG, JPG, PNG and TIFF/TIF.
- PDF - Maximum 2-page PDF is supported.
Contact Us for Any Assistance
If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email 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!