Hand-held ID Card Comparison

Analyze the possibility of the person holding the ID card and the photo of ID card belonging to the same person. Using our face matching technology, you will get our judgment about whether it is the same person as well as a similarity score.

Code example:

curl --location --request POST 'https://api.ekycpro.com/v1/idholding' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-API-Key: AbcdEfgh' \
--data-urlencode 'img=BASE64_ENCODE_VALUE'

Response example for same person

{
  "status": "OK",
  "message": {
    "similarity": 97.501,
    "result": "SAME PERSON"
  }
}

Response example for not the same person

{
  "status": "OK",
  "message": {
    "similarity": 27.501,
    "result": "NOT SAME PERSON"
  }
}

Response example for error request

{
  "status": "INVALID_REQUEST",
  "message": "error message"
}

Response example for uploaded image larger than 2M

{
  "status": "IMAGE_INVALID_SIZE",
  "message": "image larger than 2M"
}

Response example for wrong image, not ID holding image

{
  "status": "RETRY_LATER",
  "message": "error not idholding image"
}

Response for server error

{
  "status": "INNER_ERROR",
  "message": "Inner error, please retry later"
}

HTTP request

POST https://api.ekycpro.com/v1/idholding

Request parameters

parameter	description
img	string, base64 encoded image

Response format

fields	description
status	status code
message	similarity: similarity score, 0~100 result: judgment

Status code

status	description
OK	charge, success, message.similarity contains the similarity score
RETRY_LATER	charge, invalid idholding image
INVALID_REQUEST	free, invalid request parameters
IMAGE_INVALID_SIZE	free, image size larger than 2M
INNER_ERROR	free, server error