API Reference

It starts with merchant registration, followed by API key creation, access token retrieval, user registration, image upload, and finally, match face.

HTTP Status Codes

HTTP Code Meaning
400 Bad Request -- You provided a request that can't be successfully parsed. Verify you are providing valid JSON.
401 Unauthorized -- We could not authenticate your request. You used an incorrect API Key.
402 Upstream Processor Error -- Errors caused by 3rd party service.
403 Forbidden -- Your credentials don't have the right permissions to submit the request.
404 Not Found -- The specified resource could not be found.
405 Method Not Allowed -- The HTTP request method used to submit the request is not supported by the specified resource.
406 Not Acceptable -- The server can't accept the submitted request. Double-check how the request was formatted and submitted.
409 Conflict -- The submitted request conflicts with the current state of the server.
422 Unprocessable Entity -- The parameters were valid but the request failed. The error is usually some misunderstanding of various steps that have to be executed in order (e.g., attempting to initiate a transfer on behalf of a seller that has not yet been approved).
500 Internal Server Error -- We had a problem with our server. Try again later.