Face authentication

Supports response signature.

Face authentication

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.

POSThttps://api.mobile.combateafraude.com/faces/authenticate

Query parameters

Header parameters

Body

application/json

peopleId*string

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

imageUrlstring

URL of the image to be validated.

deviceobject

Basic information of the device being used to authenticate.

Response

200400401404405500

Success

Body

application/json

requestId*string

Unique identifier of request.

Example: "2b8f373-c462-4bbf-9a4f-8aeb7d71ec53"

isMatch*boolean

Indicates whether the facial authentication has been approved.

Example: true

Request

JavaScriptCurlPython

const response = await fetch('https://api.mobile.combateafraude.com/faces/authenticate', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "peopleId": "text"
    }),
});
const data = await response.json();

Response

200

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

Face authentication attempt

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

GEThttps://api.mobile.combateafraude.com/faces/authenticate/{attemptId}

Path parameters

attemptId*string

Authentication attempt ID

Example: "xxxxxxf41e2fcd832e6xxxxx"

Header parameters

Body

application/json

any

Response

200401404500

Authentication attempt success

Body

application/json

requestIdstring

Request ID

Example: "86bb55c3-cecd-4643-95c7-188bb45a60a9"

dataobject

Authentication attempt data

Request

JavaScriptCurlPython

const response = await fetch('https://api.mobile.combateafraude.com/faces/authenticate/{attemptId}', {
    method: 'GET',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200401404500

{
  "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
  }
}