Face match (face vs. ID photo)

POST

/v1/ocr/face/match

POST

/v1/ocr/face/match

curl -X POST https://api.vlenseg.com/v1/ocr/face/match \
     -H "ApiKey: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "image": "string",
  "transaction_id": "string"
}'

200Successful

{
  "services": {
    "validations": {
      "validation_errors": [
        {
          "field": "string",
          "value": "string",
          "errors": [
            {
              "code": 1,
              "message": "string"
            }
          ]
        }
      ]
    },
    "spoofing": {
      "fake": true
    },
    "classification": {
      "doc_type": "string"
    },
    "liveness": true,
    "AML": {},
    "SRC": {}
  },
  "data": {
    "isMatched": "string",
    "dissimilarity": "string",
    "threshold": "string",
    "score": "string",
    "detected_face_image": "string",
    "detected_id_face_image": "string",
    "transaction_id": "string",
    "request_id": "string",
    "client_transaction_id": "string"
  },
  "error_code": 1,
  "error_message": "string"
}

Matches a face image against the ID front photo stored in a transaction. Complete the id/front step for the same transaction_id first.

Authentication

ApiKeystring

Static API key issued to your tenant. Required on every request.

AuthorizationBearer

End-user JWT from registration or login. Required for verification, signing, and user-scoped operations.

Request

This endpoint expects an object.

imagestringRequired

Base64-encoded face image.

transaction_idstringRequired

Transaction that already contains an id/front scan.

client_transaction_idstringOptional

Response

servicesobjectOptional

Per-service check results attached to every OCR response.

dataobjectOptional

error_codeinteger or nullOptional

error_messagestring or nullOptional