API Reference

This endpoint is used for comparing a live face image (or a document image) with a database of image

Log in to see full request history

This endpoint is used to fetch users that you've added to the database via PUT guest method. It can be used for logging into a certain service you provide exclusively via face recognition.

Request format

Accepts a JSON encoded specification in the request body, example is given:

{ "AcceptTermsAndConditions":true, "DataFields": { "ImageType": "base64", "Image": "..." }, "Settings":{ } }

The request body must contain AcceptTermsAndConditions as previously explained.
DataFields is a subdictionary that must contain two fields: ImageType and Image.
ImageType is a string field that contains Image encoding. Currently, the only supported
ImageType is base64 which corresponds to BASE64 image encoding. Image field needs
to contain an image encoded by the ImageType algorithm.
Settings, as in the POST /guest/ request is currently an optional field which doesn’t
need to be provided.

Response format

In the case the service recognized the input, it will return 200 OK response as presented by 200 Successful recognition response, otherwise it will return 200 Unsuccessful recognition response containing recognition: false field.

Body Params
boolean
required
Defaults to true

Terms and conditions must be accepted or the request will be rejected

DataFields
object
required

Image payload

Headers
string
required

Access token fetched from the key service

Response

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json