Skip to main content
POST
/
identity
/
face-match
Compare faces
curl --request POST \
  --url https://api.txcloud.io/v1/identity/face-match \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "image_1": "aSDinaTvuI8gbWludGxpZnk=",
  "image_2": "aSDinaTvuI8gbWludGxpZnk="
}
'
{
  "id": "<string>",
  "object": "identity.face_match",
  "match": true,
  "similarity_score": 0.5,
  "threshold": 123,
  "confidence": 123
}

Authorizations

Authorization
string
header
required

API key as Bearer token

Body

application/json
image_1
string<byte>
required

First face image (base64)

image_2
string<byte>
required

Second face image (base64)

Response

200 - application/json

Face comparison result

id
string
object
enum<string>
Available options:
identity.face_match
match
boolean
similarity_score
number<float>
Required range: 0 <= x <= 1
threshold
number
confidence
number