Cliqet

Cliqet

Identify Service: API Introduction

Identify Service has 3 services you can use depending on what you want to achieve. These services include:

  • OCR extract with name compare - This api allows you to extract text from an ID image and have the option to do a name comparison between a name that you have versus the name extracted on the ID.
  • Face Compare - This api allows you to compare images between a person's face in an ID and their actual face image taken through a selfie and check if they are similar.
  • Anti Selfie Spoofing - This api allows you to check if a selfie image is indeed a live image taken and not a spoofed image such as using a face image from a device or face image printout.

Getting Started

To get started, you need to have credits in your account and an api key that you will send together with your request and a webhook endpoint to receive the results. The webhook endpoint is necessary since it takes some time for the task to complete. Upon making a request, you will receive a response from the api that your request has been received. The api will process your request and post the results in your webhook endpoint.

You can find your credits and api key in your dashboard home page. The api key is automatically created for you when you signup. You get free credits for testing the api and may request to purchase for more. For the webhook endpoints, you need to save them in the Identify Service settings page under Services.

Webhook Flow

When making a request, please make sure to have the following:

  • Set the value of the headers Content-Type to application/json
  • Set the value of the headers x-api-key to your api key
  • Set the method of the request to POST
  • Provide the correct request body for the specific api. This will be discussed in more detail.

When your request does not meet the right format, you will receive the error in the response. If your request follows the right format but encounters an error during the processing of the task, you will receive the error in your webhook endpoint. Details on the error responses will be discussed in more detail.

API Endpoint

https://api.cliqet.com/identify

There is only one api endpoint for the 3 Identify services. The body of the request determines which service will be used in the endpoint. The 3 service names you can use in this endpoint are:

Data Storage

The service does not save any data such as images from your link or the results of the service. This means that it is your responsibility to make sure that you save your data. Images once downloaded are disposed of after the service has generated results and posted on your webhook endpoint.