For the complete documentation index, see llms.txt. This page is also available as Markdown.

Facial Biometrics

Comparison of the submitted photo with the photo on official bases.

Section: officialData

Required parameter: cpf Required files: selfie or document image containing a picture

Attribute
Type
Description

code

String

Response code

confidence

Number

Percentage of similarity of document face with official base

probability

String

Probability of authenticity of document face with official base

{
  "officialData": {
    "code": "01",
    "confidence": 0.9600528478622437,
    "probability": "Altíssima probabilidade"
  }
}

code

Code
Description

01

Success (comparison performed). confidence, confidenceStatus and probability are only returned when code is 01.

02

Required attribute not informed (e.g. missing CPF)

03

Image/source not applicable to the provider (e.g. provider only accepts selfie)

04

Face not found in the provider's official databases

05

Image quality/size error, or call failure ("face not found")

06

Invalid CPF (validated by the provider itself)

07

Generic error / query failure (default value)

probability

Only returned when code is 01.

Value (API response)
Description

Baixíssima probabilidade

Very low probability

Baixa probabilidade

Low probability

Média probabilidade

Medium probability

Alta probabilidade

High probability

Altíssima probabilidade

Very high probability

Rule
Description

government_document_available

Checks if the document is available in the Government base.

government_document_approved

Verifies the authenticity of the document with the Government's base.

liveness_manual_revision

This rule sends the selfie for manual anti-spoofing verification.

Last updated