https://api.datawow.io/api/v1/face_recognitions/verifications| Method | Description |
|---|---|
| POST | Get 2 photo URLs then return a similarity score, and check if the faces in the photos are the same. |
You can copy the sample code here, and test it on your client.
https://documenter.getpostman.com/view/7277799/SWTK4Zqy?version=latest
Postman collection, you can import the sample code and test it with Postman:
https://www.postman.com/collections/d6169f995627970517f0
All requests must be authenticated for access to API. Authentication is done via HTTP headers.
| Parameter | Type | Value | Description |
|---|---|---|---|
| Authorization | header | Project authorization token | |
| image_url1 | formData | URL String | A photo’s URL which contains exactly one face |
| image_url2 | formData | URL String | A photo’s URL which contains exactly one face |
| custom_id | formData | String | optional custom_id |
curl --location --request POST 'https://api-staging.datawow.io/api/v1/face_recognitions/verifications' \
--header 'Authorization: YOUR_API_KEY' \
--form 'image_url1=https://datawow-shared.s3-ap-southeast-1.amazonaws.com/api-documentation/face1.jpeg' \
--form 'image_url2=https://datawow-shared.s3-ap-southeast-1.amazonaws.com/api-documentation/face2.jpeg' \
--form 'custom_id=SAMPLE_CUSTOM_ID'
Successful response will return a JSON file.
| Key | Type | Metric (FAR) | Description |
|---|---|---|---|
| similarity | float | - | Similarity score of both faces. The higher score means they both are similar |
| match_level_1 | boolean | 0.1% | Return whether the faces match each other. Correctly authorize 999 out of 1,000 faces |
| match_level_2 | boolean | 0.01% | Return whether the faces match each other. Correctly authorize 9,999 out of 10,000 faces |
| match_level_3 | boolean | 0.001% | Return whether the faces match each other. Correctly authorize 99,999 out of 100,000 faces |
| match_level_4 | boolean | 0.0001% | Return whether the faces match each other. Correctly authorize 999,999 out of 1,000,000 faces |
{
"data": {
"id": "5e42471df721f5270958a182",
"type": "face_verification",
"attributes": {
"custom_id": "SAMPLE_CUSTOM_ID",
"image_url1": "https://datawow-shared.s3-ap-southeast-1.amazonaws.com/api-documentation/face1.jpeg",
"image_url2": "https://datawow-shared.s3-ap-southeast-1.amazonaws.com/api-documentation/face2.jpeg",
"processed_at": "2020-02-11T06:18:04.512+07:00",
"result": {
"similarity": 0.04118707403540611,
"match_level_1": false,
"match_level_2": false,
"match_level_3": false,
"match_level_4": false
},
"id": "5e42471df721f5270958a182",
"project_id": 1
}
},
"meta": {
"code": 201,
"message": "Created"
}
}
| Status Code | Message | Description |
|---|---|---|
| 400 | Cannot download image from URL: XXX | One of the image URLs cannot be downloaded. Please make sure the image exists and has public access. |
| 400 | The browser (or proxy) sent a request that this server could not understand. | The request is in a wrong format. |
| 400 | image_url1 is missing, image_url2 is missing | Missing required fields in the requests. |
| 400 | Detected multiple faces in the image. Please upload a new image that has exactly one face to compare. | Each image should contain exactly one face. |
| 400 | Detected no face in the image. Please upload a new image that has exactly one face to compare. | Each image should contain exactly one face. |
| 401 | Unauthorized | Authorization header is missing, incorrect, expired, or disabled. |
| 500 | Internal Server Error | Something went wrong on Data Wow’s application server. The incident will be logged and reported to our team. |
| 504 | Gateway Timeout | The request has been in queue for processing longer than a time limit (60 seconds) Thus, returned with the Gateway Timeout error. |