Face authentication

Supports response signature.

Face authentication

post

It performs facial authentication, i.e., it checks if the face that is in the photo sent is the same as the one linked to the CPF in our base.

Query parameters

shouldSignResponsebooleanoptional

Specifies whether the request should be signed. The default is false. e.g. shouldSignResponse=true.

Header parameters

Authorizationstringrequired

Your access token. See more in the 'Authentication' topic of this section.

Body

peopleIdstringrequired

CPF of the user you want to authenticate (only numbers).

imageUrlstringoptional

URL of the image to be validated.

deviceobjectoptional

Basic information of the device being used to authenticate.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.mobile.combateafraude.com/faces/authenticate' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "peopleId": "text",
    "imageUrl": "text",
    "device": {
      "operatingSystem": "text",
      "fingerprint": "text",
      "manufacturer": "text",
      "model": "text"
    }
  }'

application/json

200

400

401

404

405

500

200

{
  "requestId": "2b8f373-c462-4bbf-9a4f-8aeb7d71ec53",
  "isMatch": true
}

Success

Face authentication attempt

get

Get a face authentication attempt based on the provided attempt ID.

Path parameters

attemptIdstringrequired

Authentication attempt ID

Example: xxxxxxf41e2fcd832e6xxxxx

Header parameters

Authorizationstringrequired

Mobile API Authorization Token

Body

anyoptional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.mobile.combateafraude.com/faces/authenticate/{attemptId}' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json'

application/json

200

401

404

500

200

{
  "requestId": "86bb55c3-cecd-4643-95c7-188bb45a60a9",
  "data": {
    "id": "xxxxxxf41e2fcd832e6xxxxx",
    "createdAt": "2024-04-04T13:45:24.321Z",
    "peopleId": "00011122233",
    "sourceIp": "000.000.000.00",
    "executionOriginId": "xxxxxxd3a480530008xxxxxx",
    "registeredImageUrl": "https://xxx.s3.amazonaws.com/xxxxxxx",
    "receivedImageUrl": "https://xxx.s3.amazonaws.com/xxxxxxx",
    "faceMatch": {
      "similarity": 0.9999998474121093,
      "isFaceMatch": true
    },
    "liveness": {
      "probability": 1,
      "isAlive": true
    },
    "isMatch": true
  }
}

Authentication attempt success