ID Check Composto - Plataforma ID

POST

id-check

api

scan

ID Check Composto

curl --request POST \
  --url https://api.valid.com/id-check/api/v1/scan \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "identity": {
    "type": "<string>",
    "value": "<string>"
  },
  "attributes": {
    "biographic": {
      "name": "<string>",
      "socialName": "<string>",
      "motherName": "<string>",
      "fatherName": "<string>",
      "dateOfBirth": "<string>",
      "gender": "<string>",
      "nationality": "<string>"
    },
    "biometrics": {
      "face": {
        "image": "<string>",
        "referenceImage": "<string>"
      },
      "fingerprints": [
        {
          "position": 123,
          "image": "<string>"
        }
      ]
    },
    "documents": {
      "cpf": {
        "number": "<string>",
        "status": "<string>",
        "registrationDate": "<string>"
      },
      "cnh": {
        "registrationNumber": "<string>",
        "category": "<string>",
        "status": "<string>",
        "foreignRegistration": "<string>",
        "firstIssueDate": "<string>",
        "lastIssueDate": "<string>",
        "expirationDate": "<string>",
        "hasRestriction": true,
        "observations": "<string>",
        "qrCode": "<string>"
      },
      "rg": {
        "number": "<string>",
        "issuer": "<string>",
        "issuerState": "<string>"
      },
      "ctps": {
        "number": "<string>",
        "issuer": "<string>",
        "issuerState": "<string>"
      },
      "passport": {
        "number": "<string>",
        "issuer": "<string>",
        "issuerState": "<string>"
      },
      "militaryService": {
        "number": "<string>",
        "issuer": "<string>",
        "issuerState": "<string>"
      }
    },
    "address": {
      "street": "<string>",
      "number": "<string>",
      "complement": "<string>",
      "neighborhood": "<string>",
      "postalCode": "<string>",
      "city": "<string>",
      "state": "<string>"
    }
  }
}
'

import requests

url = "https://api.valid.com/id-check/api/v1/scan"

payload = {
    "identity": {
        "type": "<string>",
        "value": "<string>"
    },
    "attributes": {
        "biographic": {
            "name": "<string>",
            "socialName": "<string>",
            "motherName": "<string>",
            "fatherName": "<string>",
            "dateOfBirth": "<string>",
            "gender": "<string>",
            "nationality": "<string>"
        },
        "biometrics": {
            "face": {
                "image": "<string>",
                "referenceImage": "<string>"
            },
            "fingerprints": [
                {
                    "position": 123,
                    "image": "<string>"
                }
            ]
        },
        "documents": {
            "cpf": {
                "number": "<string>",
                "status": "<string>",
                "registrationDate": "<string>"
            },
            "cnh": {
                "registrationNumber": "<string>",
                "category": "<string>",
                "status": "<string>",
                "foreignRegistration": "<string>",
                "firstIssueDate": "<string>",
                "lastIssueDate": "<string>",
                "expirationDate": "<string>",
                "hasRestriction": True,
                "observations": "<string>",
                "qrCode": "<string>"
            },
            "rg": {
                "number": "<string>",
                "issuer": "<string>",
                "issuerState": "<string>"
            },
            "ctps": {
                "number": "<string>",
                "issuer": "<string>",
                "issuerState": "<string>"
            },
            "passport": {
                "number": "<string>",
                "issuer": "<string>",
                "issuerState": "<string>"
            },
            "militaryService": {
                "number": "<string>",
                "issuer": "<string>",
                "issuerState": "<string>"
            }
        },
        "address": {
            "street": "<string>",
            "number": "<string>",
            "complement": "<string>",
            "neighborhood": "<string>",
            "postalCode": "<string>",
            "city": "<string>",
            "state": "<string>"
        }
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    identity: {type: '<string>', value: '<string>'},
    attributes: {
      biographic: {
        name: '<string>',
        socialName: '<string>',
        motherName: '<string>',
        fatherName: '<string>',
        dateOfBirth: '<string>',
        gender: '<string>',
        nationality: '<string>'
      },
      biometrics: {
        face: {image: '<string>', referenceImage: '<string>'},
        fingerprints: [{position: 123, image: '<string>'}]
      },
      documents: {
        cpf: {number: '<string>', status: '<string>', registrationDate: '<string>'},
        cnh: {
          registrationNumber: '<string>',
          category: '<string>',
          status: '<string>',
          foreignRegistration: '<string>',
          firstIssueDate: '<string>',
          lastIssueDate: '<string>',
          expirationDate: '<string>',
          hasRestriction: true,
          observations: '<string>',
          qrCode: '<string>'
        },
        rg: {number: '<string>', issuer: '<string>', issuerState: '<string>'},
        ctps: {number: '<string>', issuer: '<string>', issuerState: '<string>'},
        passport: {number: '<string>', issuer: '<string>', issuerState: '<string>'},
        militaryService: {number: '<string>', issuer: '<string>', issuerState: '<string>'}
      },
      address: {
        street: '<string>',
        number: '<string>',
        complement: '<string>',
        neighborhood: '<string>',
        postalCode: '<string>',
        city: '<string>',
        state: '<string>'
      }
    }
  })
};

fetch('https://api.valid.com/id-check/api/v1/scan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valid.com/id-check/api/v1/scan",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'identity' => [
        'type' => '<string>',
        'value' => '<string>'
    ],
    'attributes' => [
        'biographic' => [
                'name' => '<string>',
                'socialName' => '<string>',
                'motherName' => '<string>',
                'fatherName' => '<string>',
                'dateOfBirth' => '<string>',
                'gender' => '<string>',
                'nationality' => '<string>'
        ],
        'biometrics' => [
                'face' => [
                                'image' => '<string>',
                                'referenceImage' => '<string>'
                ],
                'fingerprints' => [
                                [
                                                                'position' => 123,
                                                                'image' => '<string>'
                                ]
                ]
        ],
        'documents' => [
                'cpf' => [
                                'number' => '<string>',
                                'status' => '<string>',
                                'registrationDate' => '<string>'
                ],
                'cnh' => [
                                'registrationNumber' => '<string>',
                                'category' => '<string>',
                                'status' => '<string>',
                                'foreignRegistration' => '<string>',
                                'firstIssueDate' => '<string>',
                                'lastIssueDate' => '<string>',
                                'expirationDate' => '<string>',
                                'hasRestriction' => true,
                                'observations' => '<string>',
                                'qrCode' => '<string>'
                ],
                'rg' => [
                                'number' => '<string>',
                                'issuer' => '<string>',
                                'issuerState' => '<string>'
                ],
                'ctps' => [
                                'number' => '<string>',
                                'issuer' => '<string>',
                                'issuerState' => '<string>'
                ],
                'passport' => [
                                'number' => '<string>',
                                'issuer' => '<string>',
                                'issuerState' => '<string>'
                ],
                'militaryService' => [
                                'number' => '<string>',
                                'issuer' => '<string>',
                                'issuerState' => '<string>'
                ]
        ],
        'address' => [
                'street' => '<string>',
                'number' => '<string>',
                'complement' => '<string>',
                'neighborhood' => '<string>',
                'postalCode' => '<string>',
                'city' => '<string>',
                'state' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.valid.com/id-check/api/v1/scan"

	payload := strings.NewReader("{\n  \"identity\": {\n    \"type\": \"<string>\",\n    \"value\": \"<string>\"\n  },\n  \"attributes\": {\n    \"biographic\": {\n      \"name\": \"<string>\",\n      \"socialName\": \"<string>\",\n      \"motherName\": \"<string>\",\n      \"fatherName\": \"<string>\",\n      \"dateOfBirth\": \"<string>\",\n      \"gender\": \"<string>\",\n      \"nationality\": \"<string>\"\n    },\n    \"biometrics\": {\n      \"face\": {\n        \"image\": \"<string>\",\n        \"referenceImage\": \"<string>\"\n      },\n      \"fingerprints\": [\n        {\n          \"position\": 123,\n          \"image\": \"<string>\"\n        }\n      ]\n    },\n    \"documents\": {\n      \"cpf\": {\n        \"number\": \"<string>\",\n        \"status\": \"<string>\",\n        \"registrationDate\": \"<string>\"\n      },\n      \"cnh\": {\n        \"registrationNumber\": \"<string>\",\n        \"category\": \"<string>\",\n        \"status\": \"<string>\",\n        \"foreignRegistration\": \"<string>\",\n        \"firstIssueDate\": \"<string>\",\n        \"lastIssueDate\": \"<string>\",\n        \"expirationDate\": \"<string>\",\n        \"hasRestriction\": true,\n        \"observations\": \"<string>\",\n        \"qrCode\": \"<string>\"\n      },\n      \"rg\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"ctps\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"passport\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"militaryService\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      }\n    },\n    \"address\": {\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.valid.com/id-check/api/v1/scan")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"identity\": {\n    \"type\": \"<string>\",\n    \"value\": \"<string>\"\n  },\n  \"attributes\": {\n    \"biographic\": {\n      \"name\": \"<string>\",\n      \"socialName\": \"<string>\",\n      \"motherName\": \"<string>\",\n      \"fatherName\": \"<string>\",\n      \"dateOfBirth\": \"<string>\",\n      \"gender\": \"<string>\",\n      \"nationality\": \"<string>\"\n    },\n    \"biometrics\": {\n      \"face\": {\n        \"image\": \"<string>\",\n        \"referenceImage\": \"<string>\"\n      },\n      \"fingerprints\": [\n        {\n          \"position\": 123,\n          \"image\": \"<string>\"\n        }\n      ]\n    },\n    \"documents\": {\n      \"cpf\": {\n        \"number\": \"<string>\",\n        \"status\": \"<string>\",\n        \"registrationDate\": \"<string>\"\n      },\n      \"cnh\": {\n        \"registrationNumber\": \"<string>\",\n        \"category\": \"<string>\",\n        \"status\": \"<string>\",\n        \"foreignRegistration\": \"<string>\",\n        \"firstIssueDate\": \"<string>\",\n        \"lastIssueDate\": \"<string>\",\n        \"expirationDate\": \"<string>\",\n        \"hasRestriction\": true,\n        \"observations\": \"<string>\",\n        \"qrCode\": \"<string>\"\n      },\n      \"rg\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"ctps\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"passport\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"militaryService\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      }\n    },\n    \"address\": {\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/id-check/api/v1/scan")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"identity\": {\n    \"type\": \"<string>\",\n    \"value\": \"<string>\"\n  },\n  \"attributes\": {\n    \"biographic\": {\n      \"name\": \"<string>\",\n      \"socialName\": \"<string>\",\n      \"motherName\": \"<string>\",\n      \"fatherName\": \"<string>\",\n      \"dateOfBirth\": \"<string>\",\n      \"gender\": \"<string>\",\n      \"nationality\": \"<string>\"\n    },\n    \"biometrics\": {\n      \"face\": {\n        \"image\": \"<string>\",\n        \"referenceImage\": \"<string>\"\n      },\n      \"fingerprints\": [\n        {\n          \"position\": 123,\n          \"image\": \"<string>\"\n        }\n      ]\n    },\n    \"documents\": {\n      \"cpf\": {\n        \"number\": \"<string>\",\n        \"status\": \"<string>\",\n        \"registrationDate\": \"<string>\"\n      },\n      \"cnh\": {\n        \"registrationNumber\": \"<string>\",\n        \"category\": \"<string>\",\n        \"status\": \"<string>\",\n        \"foreignRegistration\": \"<string>\",\n        \"firstIssueDate\": \"<string>\",\n        \"lastIssueDate\": \"<string>\",\n        \"expirationDate\": \"<string>\",\n        \"hasRestriction\": true,\n        \"observations\": \"<string>\",\n        \"qrCode\": \"<string>\"\n      },\n      \"rg\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"ctps\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"passport\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"militaryService\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      }\n    },\n    \"address\": {\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "scanId": "123e4567-e89b-12d3-a456-426614174000",
  "identity": {
	  "type": "cpf",
	  "value": true
  },
  "attributes": {
    "biographic": {
      "name": true,
      "nameSimilarity": 9.8,
      "socialName": true,
      "socialNameSimilarity": 9.9,
      "motherName": true,
      "motherNameSimilarity": 10.0,
      "fatherName": false,
      "fatherNameSimilarity": 1.2,
      "dateOfBirth": true,
      "gender": true,
      "nationality": true
    },
    "biometrics": {
      "face": {
        "confidence": "HIGH",
      },
      "fingerprints": [
        {
          "position": 1,
          "confidence": "MAXIMUM",
        },
        {
          "position": 2,
          "confidence": "HIGH",
        }
      ]
    },
    "documents": {
      "cpf": {
        "number": true,
        "status": true,
        "registrationDate": true
      },
      "cnh": {
        "registrationNumber": true,
        "category": true,
        "status": true,
        "foreignRegistration": false,
        "firstIssueDate": true,
        "lastIssueDate": true,
        "expirationDate": true,
        "hasRestriction": true,
        "observations": true,
        "qrCode": {
          "returnCode": "0",
          "name": true,
          "nameSimilarity": 9.9,
          "decodedName": "JOAO DA SILVA",
          "decodedCivilName": "JOAO DA SILVA",
          "sourceDocument": true,
          "sourceDocumentSimilarity": 10.0,
          "decodedSourceDocument": "CNH",
          "dateOfBirth": true,
          "decodedDateOfBirth": "1990-01-01",
          "motherName": true,
          "motherNameSimilarity": 9.7,
          "decodedMotherName": "MARIA DA SILVA",
          "fatherName": false,
          "fatherNameSimilarity": 2.2,
          "decodedFatherName": "JOSE DA SILVA",
          "decodedPermission": "ACC",
          "decodedAcc": "N",
          "category": true,
          "categorySimilarity": 10.0,
          "decodedCategory": "B",
          "registrationNumber": true,
          "decodedRegistrationNumber": "12345678900",
          "expirationDate": true,
          "decodedExpirationDate": "2030-01-15",
          "firstLicenseDate": true,
          "decodedFirstLicenseDate": "2010-01-15",
          "observations": true,
          "observationsSimilarity": 9.1,
          "decodedObservations": "EAR;A",
          "decodedIssueLocation": "SAO PAULO",
          "decodedIssueState": "SP",
          "lastIssueDate": true,
          "decodedLastIssueDate": "2020-01-15",
          "decodedValidationNumber": "123456789",
          "decodedRenachNumber": "987654321"
        }
      },
      "rg": {
        "number": true,
        "issuer": true,
        "issuerState": true
      },
      "ctps": {
        "number": true,
        "issuer": true,
        "issuerState": true
      },
      "passport": {
        "number": false,
        "issuer": true,
        "issuerState": true
      },
      "militaryService": {
        "number": true,
        "issuer": true,
        "issuerState": true
      }
    },
    "address": {
      "street": true,
      "streetSimilarity": 9.4,
      "number": true,
      "numberSimilarity": 10.0,
      "complement": false,
      "complementSimilarity": 2.1,
      "neighborhood": true,
      "neighborhoodSimilarity": 9.9,
      "postalCode": true,
      "city": true,
      "citySimilarity": 10.0,
      "state": true,
    }
  },
  "metadata": {
    "processingTime": 2345,
    "timestamp": "2026-04-20T19:04:17.412Z"
  }
}

{
    "success": false,
    "error": {
        "issues": [
            {
                "code": "invalid_type",
                "expected": "string",
                "received": "undefined",
                "path": [
                    "cpf"
                ],
                "message": "Required"
            }
        ],
        "name": "ZodError"
    }
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "Unexpected error while processing scan request",
  "requestId": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": "2026-04-20T19:04:17.412Z"
}

Request Body

identity

object

required

Dados de identificação mínima do titular. Obrigatório informar um tipo e valor do documento

Show propriedades

type

string

required

Tipo de documento a ser verificado: cpf ou rnm.CPF: Cadastro de Pessoas FísicasRNM: Registro Nacional MigratórioExemplo: cpf

value

string

required

Número do documento do titular a ser verificado, relacionado ao tipo informado.Exemplo: 12345678900

attributes

object

required

Conjunto de atributos utilizados na validação composta da identidade.

Show propriedades

biographic

object

Dados biográficos do titular.

Show propriedades

name

string

Nome civil informado para validação.Exemplo: João da Silva

Nome social informado para validação.Exemplo: João Silva

motherName

string

Nome da mãe informado para validação.Exemplo: Maria da Silva

fatherName

string

Nome do pai informado para validação.Exemplo: José da Silva

dateOfBirth

date

Data de nascimento do titular.Exemplo: 1990-01-01

gender

string

Gênero informado para validação.Exemplo: MALE

nationality

string

Nacionalidade informada para validação.Exemplo: BRAZILIAN

biometrics

object

Dados biométricos utilizados na validação.

Show propriedades

face

object

Dados da biometria facial.

Show propriedades

image

string

Imagem facial em formato base64.Exemplo: base64

referenceImage

string

Imagem facial de refêrencia para comparação em formato base64.Exemplo: base64

fingerprints

array

Lista de impressões digitais a serem verificadas. Cada item representa uma digital com sua posição e imagem biométrica.

Show propriedades

position

integer

required

Posição do dedo conforme tabela padrão NIST (1–10).1 - Polegar Direito2 - Indicador Direito3 - Médio Direito4 - Anelar Direito5 - Mínimo Direito6 - Polegar Esquerdo7 - Indicador Esquerdo8 - Médio Esquerdo9 - Anelar Esquerdo10 - Mínimo EsquerdoExemplo: 1

image

string

required

Imagem da digital em formato base64.Exemplo: base64

documents

object

Documentos utilizados na validação.

Show propriedades

cpf

object

Dados do CPF informados para validação.

Show propriedades

number

string

Número do CPF informado para validação.Exemplo: 12345678900

status

string

Situação cadastral do CPF.Exemplo: REGULAR

registrationDate

date

Data de registro do CPF.Exemplo: 1990-01-01

cnh

object

Dados da CNH informados para validação.

Show propriedades

registrationNumber

string

Número de registro da CNH.Exemplo: 12345678900

Response

scanId

string

Identificador interno da transação.Exemplo: 123e4567-e89b-12d3-a456-426614174000

identity

object

Dados do documento consultado

Show propriedades

type

string

Tipo de documento verificado: cpf ou rnm.Exemplo: cpf

value

boolean

Indica se o documento foi encontrado e validadoExemplo: true

attributes

object

Resultado consolidado das validações executadas.

Show propriedades

biographic

object

Resultado das validações de dados biográficos.

Show propriedades

name

boolean

Indica se o nome civil foi validado com sucesso.Exemplo: true

nameSimilarity

double

Grau de similaridade calculado para o nome civil informado.Exemplo: 9.8

Indica se o nome social foi validado com sucesso.Exemplo: true

Grau de similaridade calculado para o nome social informado.Exemplo: 10.0

motherName

boolean

Indica se o nome da mãe foi validado com sucesso.Exemplo: true

motherNameSimilarity

double

Grau de similaridade calculado para o nome da mãe informada.Exemplo: 9.7

fatherName

boolean

Indica se o nome do pai foi validado com sucesso.Exemplo: false

fatherNameSimilarity

double

Grau de similaridade calculado para o nome do pai informado.Exemplo: 2.2

dateOfBirth

boolean

Indica se a data de nascimento foi validada com sucesso.Exemplo: true

gender

boolean

Indica se o gênero foi validado com sucesso.Exemplo: true

nationality

boolean

Indica se a nacionalidade foi validada com sucesso.Exemplo: true

biometrics

object

Resultado das validações biométricas.

Show propriedades

face

object

Resultado da validação facial.

Show propriedades

confidence

string

Nível de confiança do resultado. Valores possíveis:Low: Alta probabilidade de fraude, recomendado reprovarMedium: Alguma probabilidade de fraude, zona cinzenta que precisa de reavaliaçãoHigh: Baixa probabilidade de fraude, recomendado aprovarMaximum: Probabilidade quase nula de fraude, recomendado aprovarExemplo: MAXIMUM

fingerprints

array

Lista com o resultado individual de cada digital verificada.

Show propriedades

position

integer

Posição da digital verificada, conforme enviada na requisição.Exemplo: 1

confidence

string

Nível de confiança do reconhecimento biométrico para aquela digital. Valores possíveis:Low: Alta probabilidade de fraude, recomendado reprovarMedium: Alguma probabilidade de fraude, zona cinzenta que precisa de reavaliaçãoHigh: Baixa probabilidade de fraude, recomendado aprovarMaximum: Probabilidade quase nula de fraude, recomendado aprovarExemplo: MAXIMUM

documents

object

Resultado das validações de documentos. Todos os campos retornam true para informação válida e false para negativa na validação.

Show propriedades

cpf

object

Resultado das validações do CPF.

Show propriedades

number

boolean

Indica se o número do CPF foi validado com sucesso.Exemplo: true

status

boolean

Indica se a situação cadastral do CPF foi validada com sucesso.Exemplo: true

registrationDate

boolean

Indica se a data de registro do CPF foi validada com sucesso.Exemplo: true

cnh

object

Resultado das validações da CNH.

Show propriedades

registrationNumber

boolean

Indica se o número de registro da CNH foi validado com sucesso.Exemplo: true

category

boolean

Indica se a categoria decodificada foi validada com sucesso.Exemplo: true

categorySimilarity

double

Grau de similaridade calculado para a categoria.Exemplo: 10.0

decodedCategory

string

Categoria decodificada a partir do QR Code.Exemplo: B

registrationNumber

boolean

Indica se o número de registro decodificado foi validado com sucesso.Exemplo: true

decodedRegistrationNumber

string

Número de registro decodificado a partir do QR Code.Exemplo: 12345678900

expirationDate

boolean

Indica se a data de validade decodificada foi validada com sucesso.Exemplo: true

decodedExpirationDate

date

Data de validade decodificada a partir do QR Code.Exemplo: 2030-01-15

firstLicenseDate

boolean

Indica se a data da primeira habilitação decodificada foi validada com sucesso.Exemplo: true

decodedFirstLicenseDate

date

Data da primeira habilitação decodificada a partir do QR Code.Exemplo: 2010-01-15

observations

boolean

Indica se as observações decodificadas foram validadas com sucesso.Exemplo: true

observationsSimilarity

double

Grau de similaridade calculado para as observações.Exemplo: 9.1

decodedObservations

string

Observações decodificadas a partir do QR Code.Exemplo: EAR;A

decodedIssueLocation

string

Local de emissão decodificado a partir do QR Code.Exemplo: SAO PAULO

decodedIssueState

string

UF de emissão decodificada a partir do QR Code.Exemplo: SP

lastIssueDate

boolean

Indica se a data da última emissão decodificada foi validada com sucesso.Exemplo: true

decodedLastIssueDate

date

Data da última emissão decodificada a partir do QR Code.Exemplo: 2020-01-15

decodedValidationNumber

string

Número de validação decodificado a partir do QR Code.Exemplo: 123456789

decodedRenachNumber

string

Número RENACH decodificado a partir do QR Code.Exemplo: 987654321

object

Resultado das validações do RG.

Show propriedades

number

boolean

Indica se o número do RG foi validado com sucesso.Exemplo: true

issuer

boolean

Indica se o órgão emissor do RG foi validado com sucesso.Exemplo: true

issuerState

boolean

Indica se a UF emissora do RG foi validada com sucesso.Exemplo: true

ctps

object

Resultado das validações da CTPS.

Show propriedades

number

boolean

Indica se o número da CTPS foi validado com sucesso.Exemplo: true

issuer

boolean

Indica se o órgão emissor da CTPS foi validado com sucesso.Exemplo: true

issuerState

boolean

Indica se a UF emissora da CTPS foi validada com sucesso.Exemplo: true

passport

object

Resultado das validações do passaporte.

Show propriedades

number

boolean

Indica se o número do passaporte foi validado com sucesso.Exemplo: false

issuer

boolean

Indica se o órgão emissor do passaporte foi validado com sucesso.Exemplo: true

issuerState

boolean

Indica se a UF emissora do passaporte foi validada com sucesso.Exemplo: true

militaryService

object

Resultado das validações do documento militar.

Show propriedades

number

boolean

Indica se o número do documento militar foi validado com sucesso.Exemplo: true

issuer

boolean

Indica se o órgão emissor do documento militar foi validado com sucesso.Exemplo: true

issuerState

boolean

Indica se a UF emissora do documento militar foi validada com sucesso.Exemplo: true

address

object

Resultado das validações de endereço.

Show propriedades

street

boolean

Indica se o logradouro foi validado com sucesso.Exemplo: true

streetSimilarity

double

Grau de similaridade calculado para o logradouro informado.Exemplo: 0.94

number

boolean

Indica se o número do endereço foi validado com sucesso.Exemplo: true

numberSimilarity

double

Grau de similaridade calculado para o número informado.Exemplo: 10.0

complement

boolean

Indica se o complemento foi validado com sucesso.Exemplo: false

complementSimilarity

double

Grau de similaridade calculado para o complemento informado.Exemplo: 1.4

neighborhood

boolean

Indica se o bairro foi validado com sucesso.Exemplo: true

neighborhoodSimilarity

double

Grau de similaridade calculado para o bairro informado.Exemplo: 9.6

postalCode

boolean

Indica se o CEP foi validado com sucesso.Exemplo: true

city

boolean

Indica se a cidade foi validada com sucesso.Exemplo: true

citySimilarity

double

Grau de similaridade calculado para a cidade informada.Exemplo: 9.9

state

boolean

Indica se o estado foi validado com sucesso.Exemplo: true

metadata

object

Metadados da requisição

Show propriedades

processingTime

integer

Tempo total de processamento em milisegundos.Exemplo: 2345

timestamp

datetime

Data e hora da transação.Exemplo: 2026-04-20T19:04:17.412Z

{
  "scanId": "123e4567-e89b-12d3-a456-426614174000",
  "identity": {
	  "type": "cpf",
	  "value": true
  },
  "attributes": {
    "biographic": {
      "name": true,
      "nameSimilarity": 9.8,
      "socialName": true,
      "socialNameSimilarity": 9.9,
      "motherName": true,
      "motherNameSimilarity": 10.0,
      "fatherName": false,
      "fatherNameSimilarity": 1.2,
      "dateOfBirth": true,
      "gender": true,
      "nationality": true
    },
    "biometrics": {
      "face": {
        "confidence": "HIGH",
      },
      "fingerprints": [
        {
          "position": 1,
          "confidence": "MAXIMUM",
        },
        {
          "position": 2,
          "confidence": "HIGH",
        }
      ]
    },
    "documents": {
      "cpf": {
        "number": true,
        "status": true,
        "registrationDate": true
      },
      "cnh": {
        "registrationNumber": true,
        "category": true,
        "status": true,
        "foreignRegistration": false,
        "firstIssueDate": true,
        "lastIssueDate": true,
        "expirationDate": true,
        "hasRestriction": true,
        "observations": true,
        "qrCode": {
          "returnCode": "0",
          "name": true,
          "nameSimilarity": 9.9,
          "decodedName": "JOAO DA SILVA",
          "decodedCivilName": "JOAO DA SILVA",
          "sourceDocument": true,
          "sourceDocumentSimilarity": 10.0,
          "decodedSourceDocument": "CNH",
          "dateOfBirth": true,
          "decodedDateOfBirth": "1990-01-01",
          "motherName": true,
          "motherNameSimilarity": 9.7,
          "decodedMotherName": "MARIA DA SILVA",
          "fatherName": false,
          "fatherNameSimilarity": 2.2,
          "decodedFatherName": "JOSE DA SILVA",
          "decodedPermission": "ACC",
          "decodedAcc": "N",
          "category": true,
          "categorySimilarity": 10.0,
          "decodedCategory": "B",
          "registrationNumber": true,
          "decodedRegistrationNumber": "12345678900",
          "expirationDate": true,
          "decodedExpirationDate": "2030-01-15",
          "firstLicenseDate": true,
          "decodedFirstLicenseDate": "2010-01-15",
          "observations": true,
          "observationsSimilarity": 9.1,
          "decodedObservations": "EAR;A",
          "decodedIssueLocation": "SAO PAULO",
          "decodedIssueState": "SP",
          "lastIssueDate": true,
          "decodedLastIssueDate": "2020-01-15",
          "decodedValidationNumber": "123456789",
          "decodedRenachNumber": "987654321"
        }
      },
      "rg": {
        "number": true,
        "issuer": true,
        "issuerState": true
      },
      "ctps": {
        "number": true,
        "issuer": true,
        "issuerState": true
      },
      "passport": {
        "number": false,
        "issuer": true,
        "issuerState": true
      },
      "militaryService": {
        "number": true,
        "issuer": true,
        "issuerState": true
      }
    },
    "address": {
      "street": true,
      "streetSimilarity": 9.4,
      "number": true,
      "numberSimilarity": 10.0,
      "complement": false,
      "complementSimilarity": 2.1,
      "neighborhood": true,
      "neighborhoodSimilarity": 9.9,
      "postalCode": true,
      "city": true,
      "citySimilarity": 10.0,
      "state": true,
    }
  },
  "metadata": {
    "processingTime": 2345,
    "timestamp": "2026-04-20T19:04:17.412Z"
  }
}

{
    "success": false,
    "error": {
        "issues": [
            {
                "code": "invalid_type",
                "expected": "string",
                "received": "undefined",
                "path": [
                    "cpf"
                ],
                "message": "Required"
            }
        ],
        "name": "ZodError"
    }
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "Unexpected error while processing scan request",
  "requestId": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": "2026-04-20T19:04:17.412Z"
}

Apresentação

⌘I

ID Check Composto

curl --request POST \
  --url https://api.valid.com/id-check/api/v1/scan \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "identity": {
    "type": "<string>",
    "value": "<string>"
  },
  "attributes": {
    "biographic": {
      "name": "<string>",
      "socialName": "<string>",
      "motherName": "<string>",
      "fatherName": "<string>",
      "dateOfBirth": "<string>",
      "gender": "<string>",
      "nationality": "<string>"
    },
    "biometrics": {
      "face": {
        "image": "<string>",
        "referenceImage": "<string>"
      },
      "fingerprints": [
        {
          "position": 123,
          "image": "<string>"
        }
      ]
    },
    "documents": {
      "cpf": {
        "number": "<string>",
        "status": "<string>",
        "registrationDate": "<string>"
      },
      "cnh": {
        "registrationNumber": "<string>",
        "category": "<string>",
        "status": "<string>",
        "foreignRegistration": "<string>",
        "firstIssueDate": "<string>",
        "lastIssueDate": "<string>",
        "expirationDate": "<string>",
        "hasRestriction": true,
        "observations": "<string>",
        "qrCode": "<string>"
      },
      "rg": {
        "number": "<string>",
        "issuer": "<string>",
        "issuerState": "<string>"
      },
      "ctps": {
        "number": "<string>",
        "issuer": "<string>",
        "issuerState": "<string>"
      },
      "passport": {
        "number": "<string>",
        "issuer": "<string>",
        "issuerState": "<string>"
      },
      "militaryService": {
        "number": "<string>",
        "issuer": "<string>",
        "issuerState": "<string>"
      }
    },
    "address": {
      "street": "<string>",
      "number": "<string>",
      "complement": "<string>",
      "neighborhood": "<string>",
      "postalCode": "<string>",
      "city": "<string>",
      "state": "<string>"
    }
  }
}
'

import requests

url = "https://api.valid.com/id-check/api/v1/scan"

payload = {
    "identity": {
        "type": "<string>",
        "value": "<string>"
    },
    "attributes": {
        "biographic": {
            "name": "<string>",
            "socialName": "<string>",
            "motherName": "<string>",
            "fatherName": "<string>",
            "dateOfBirth": "<string>",
            "gender": "<string>",
            "nationality": "<string>"
        },
        "biometrics": {
            "face": {
                "image": "<string>",
                "referenceImage": "<string>"
            },
            "fingerprints": [
                {
                    "position": 123,
                    "image": "<string>"
                }
            ]
        },
        "documents": {
            "cpf": {
                "number": "<string>",
                "status": "<string>",
                "registrationDate": "<string>"
            },
            "cnh": {
                "registrationNumber": "<string>",
                "category": "<string>",
                "status": "<string>",
                "foreignRegistration": "<string>",
                "firstIssueDate": "<string>",
                "lastIssueDate": "<string>",
                "expirationDate": "<string>",
                "hasRestriction": True,
                "observations": "<string>",
                "qrCode": "<string>"
            },
            "rg": {
                "number": "<string>",
                "issuer": "<string>",
                "issuerState": "<string>"
            },
            "ctps": {
                "number": "<string>",
                "issuer": "<string>",
                "issuerState": "<string>"
            },
            "passport": {
                "number": "<string>",
                "issuer": "<string>",
                "issuerState": "<string>"
            },
            "militaryService": {
                "number": "<string>",
                "issuer": "<string>",
                "issuerState": "<string>"
            }
        },
        "address": {
            "street": "<string>",
            "number": "<string>",
            "complement": "<string>",
            "neighborhood": "<string>",
            "postalCode": "<string>",
            "city": "<string>",
            "state": "<string>"
        }
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    identity: {type: '<string>', value: '<string>'},
    attributes: {
      biographic: {
        name: '<string>',
        socialName: '<string>',
        motherName: '<string>',
        fatherName: '<string>',
        dateOfBirth: '<string>',
        gender: '<string>',
        nationality: '<string>'
      },
      biometrics: {
        face: {image: '<string>', referenceImage: '<string>'},
        fingerprints: [{position: 123, image: '<string>'}]
      },
      documents: {
        cpf: {number: '<string>', status: '<string>', registrationDate: '<string>'},
        cnh: {
          registrationNumber: '<string>',
          category: '<string>',
          status: '<string>',
          foreignRegistration: '<string>',
          firstIssueDate: '<string>',
          lastIssueDate: '<string>',
          expirationDate: '<string>',
          hasRestriction: true,
          observations: '<string>',
          qrCode: '<string>'
        },
        rg: {number: '<string>', issuer: '<string>', issuerState: '<string>'},
        ctps: {number: '<string>', issuer: '<string>', issuerState: '<string>'},
        passport: {number: '<string>', issuer: '<string>', issuerState: '<string>'},
        militaryService: {number: '<string>', issuer: '<string>', issuerState: '<string>'}
      },
      address: {
        street: '<string>',
        number: '<string>',
        complement: '<string>',
        neighborhood: '<string>',
        postalCode: '<string>',
        city: '<string>',
        state: '<string>'
      }
    }
  })
};

fetch('https://api.valid.com/id-check/api/v1/scan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valid.com/id-check/api/v1/scan",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'identity' => [
        'type' => '<string>',
        'value' => '<string>'
    ],
    'attributes' => [
        'biographic' => [
                'name' => '<string>',
                'socialName' => '<string>',
                'motherName' => '<string>',
                'fatherName' => '<string>',
                'dateOfBirth' => '<string>',
                'gender' => '<string>',
                'nationality' => '<string>'
        ],
        'biometrics' => [
                'face' => [
                                'image' => '<string>',
                                'referenceImage' => '<string>'
                ],
                'fingerprints' => [
                                [
                                                                'position' => 123,
                                                                'image' => '<string>'
                                ]
                ]
        ],
        'documents' => [
                'cpf' => [
                                'number' => '<string>',
                                'status' => '<string>',
                                'registrationDate' => '<string>'
                ],
                'cnh' => [
                                'registrationNumber' => '<string>',
                                'category' => '<string>',
                                'status' => '<string>',
                                'foreignRegistration' => '<string>',
                                'firstIssueDate' => '<string>',
                                'lastIssueDate' => '<string>',
                                'expirationDate' => '<string>',
                                'hasRestriction' => true,
                                'observations' => '<string>',
                                'qrCode' => '<string>'
                ],
                'rg' => [
                                'number' => '<string>',
                                'issuer' => '<string>',
                                'issuerState' => '<string>'
                ],
                'ctps' => [
                                'number' => '<string>',
                                'issuer' => '<string>',
                                'issuerState' => '<string>'
                ],
                'passport' => [
                                'number' => '<string>',
                                'issuer' => '<string>',
                                'issuerState' => '<string>'
                ],
                'militaryService' => [
                                'number' => '<string>',
                                'issuer' => '<string>',
                                'issuerState' => '<string>'
                ]
        ],
        'address' => [
                'street' => '<string>',
                'number' => '<string>',
                'complement' => '<string>',
                'neighborhood' => '<string>',
                'postalCode' => '<string>',
                'city' => '<string>',
                'state' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.valid.com/id-check/api/v1/scan"

	payload := strings.NewReader("{\n  \"identity\": {\n    \"type\": \"<string>\",\n    \"value\": \"<string>\"\n  },\n  \"attributes\": {\n    \"biographic\": {\n      \"name\": \"<string>\",\n      \"socialName\": \"<string>\",\n      \"motherName\": \"<string>\",\n      \"fatherName\": \"<string>\",\n      \"dateOfBirth\": \"<string>\",\n      \"gender\": \"<string>\",\n      \"nationality\": \"<string>\"\n    },\n    \"biometrics\": {\n      \"face\": {\n        \"image\": \"<string>\",\n        \"referenceImage\": \"<string>\"\n      },\n      \"fingerprints\": [\n        {\n          \"position\": 123,\n          \"image\": \"<string>\"\n        }\n      ]\n    },\n    \"documents\": {\n      \"cpf\": {\n        \"number\": \"<string>\",\n        \"status\": \"<string>\",\n        \"registrationDate\": \"<string>\"\n      },\n      \"cnh\": {\n        \"registrationNumber\": \"<string>\",\n        \"category\": \"<string>\",\n        \"status\": \"<string>\",\n        \"foreignRegistration\": \"<string>\",\n        \"firstIssueDate\": \"<string>\",\n        \"lastIssueDate\": \"<string>\",\n        \"expirationDate\": \"<string>\",\n        \"hasRestriction\": true,\n        \"observations\": \"<string>\",\n        \"qrCode\": \"<string>\"\n      },\n      \"rg\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"ctps\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"passport\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"militaryService\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      }\n    },\n    \"address\": {\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.valid.com/id-check/api/v1/scan")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"identity\": {\n    \"type\": \"<string>\",\n    \"value\": \"<string>\"\n  },\n  \"attributes\": {\n    \"biographic\": {\n      \"name\": \"<string>\",\n      \"socialName\": \"<string>\",\n      \"motherName\": \"<string>\",\n      \"fatherName\": \"<string>\",\n      \"dateOfBirth\": \"<string>\",\n      \"gender\": \"<string>\",\n      \"nationality\": \"<string>\"\n    },\n    \"biometrics\": {\n      \"face\": {\n        \"image\": \"<string>\",\n        \"referenceImage\": \"<string>\"\n      },\n      \"fingerprints\": [\n        {\n          \"position\": 123,\n          \"image\": \"<string>\"\n        }\n      ]\n    },\n    \"documents\": {\n      \"cpf\": {\n        \"number\": \"<string>\",\n        \"status\": \"<string>\",\n        \"registrationDate\": \"<string>\"\n      },\n      \"cnh\": {\n        \"registrationNumber\": \"<string>\",\n        \"category\": \"<string>\",\n        \"status\": \"<string>\",\n        \"foreignRegistration\": \"<string>\",\n        \"firstIssueDate\": \"<string>\",\n        \"lastIssueDate\": \"<string>\",\n        \"expirationDate\": \"<string>\",\n        \"hasRestriction\": true,\n        \"observations\": \"<string>\",\n        \"qrCode\": \"<string>\"\n      },\n      \"rg\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"ctps\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"passport\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"militaryService\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      }\n    },\n    \"address\": {\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/id-check/api/v1/scan")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"identity\": {\n    \"type\": \"<string>\",\n    \"value\": \"<string>\"\n  },\n  \"attributes\": {\n    \"biographic\": {\n      \"name\": \"<string>\",\n      \"socialName\": \"<string>\",\n      \"motherName\": \"<string>\",\n      \"fatherName\": \"<string>\",\n      \"dateOfBirth\": \"<string>\",\n      \"gender\": \"<string>\",\n      \"nationality\": \"<string>\"\n    },\n    \"biometrics\": {\n      \"face\": {\n        \"image\": \"<string>\",\n        \"referenceImage\": \"<string>\"\n      },\n      \"fingerprints\": [\n        {\n          \"position\": 123,\n          \"image\": \"<string>\"\n        }\n      ]\n    },\n    \"documents\": {\n      \"cpf\": {\n        \"number\": \"<string>\",\n        \"status\": \"<string>\",\n        \"registrationDate\": \"<string>\"\n      },\n      \"cnh\": {\n        \"registrationNumber\": \"<string>\",\n        \"category\": \"<string>\",\n        \"status\": \"<string>\",\n        \"foreignRegistration\": \"<string>\",\n        \"firstIssueDate\": \"<string>\",\n        \"lastIssueDate\": \"<string>\",\n        \"expirationDate\": \"<string>\",\n        \"hasRestriction\": true,\n        \"observations\": \"<string>\",\n        \"qrCode\": \"<string>\"\n      },\n      \"rg\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"ctps\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"passport\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      },\n      \"militaryService\": {\n        \"number\": \"<string>\",\n        \"issuer\": \"<string>\",\n        \"issuerState\": \"<string>\"\n      }\n    },\n    \"address\": {\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "scanId": "123e4567-e89b-12d3-a456-426614174000",
  "identity": {
	  "type": "cpf",
	  "value": true
  },
  "attributes": {
    "biographic": {
      "name": true,
      "nameSimilarity": 9.8,
      "socialName": true,
      "socialNameSimilarity": 9.9,
      "motherName": true,
      "motherNameSimilarity": 10.0,
      "fatherName": false,
      "fatherNameSimilarity": 1.2,
      "dateOfBirth": true,
      "gender": true,
      "nationality": true
    },
    "biometrics": {
      "face": {
        "confidence": "HIGH",
      },
      "fingerprints": [
        {
          "position": 1,
          "confidence": "MAXIMUM",
        },
        {
          "position": 2,
          "confidence": "HIGH",
        }
      ]
    },
    "documents": {
      "cpf": {
        "number": true,
        "status": true,
        "registrationDate": true
      },
      "cnh": {
        "registrationNumber": true,
        "category": true,
        "status": true,
        "foreignRegistration": false,
        "firstIssueDate": true,
        "lastIssueDate": true,
        "expirationDate": true,
        "hasRestriction": true,
        "observations": true,
        "qrCode": {
          "returnCode": "0",
          "name": true,
          "nameSimilarity": 9.9,
          "decodedName": "JOAO DA SILVA",
          "decodedCivilName": "JOAO DA SILVA",
          "sourceDocument": true,
          "sourceDocumentSimilarity": 10.0,
          "decodedSourceDocument": "CNH",
          "dateOfBirth": true,
          "decodedDateOfBirth": "1990-01-01",
          "motherName": true,
          "motherNameSimilarity": 9.7,
          "decodedMotherName": "MARIA DA SILVA",
          "fatherName": false,
          "fatherNameSimilarity": 2.2,
          "decodedFatherName": "JOSE DA SILVA",
          "decodedPermission": "ACC",
          "decodedAcc": "N",
          "category": true,
          "categorySimilarity": 10.0,
          "decodedCategory": "B",
          "registrationNumber": true,
          "decodedRegistrationNumber": "12345678900",
          "expirationDate": true,
          "decodedExpirationDate": "2030-01-15",
          "firstLicenseDate": true,
          "decodedFirstLicenseDate": "2010-01-15",
          "observations": true,
          "observationsSimilarity": 9.1,
          "decodedObservations": "EAR;A",
          "decodedIssueLocation": "SAO PAULO",
          "decodedIssueState": "SP",
          "lastIssueDate": true,
          "decodedLastIssueDate": "2020-01-15",
          "decodedValidationNumber": "123456789",
          "decodedRenachNumber": "987654321"
        }
      },
      "rg": {
        "number": true,
        "issuer": true,
        "issuerState": true
      },
      "ctps": {
        "number": true,
        "issuer": true,
        "issuerState": true
      },
      "passport": {
        "number": false,
        "issuer": true,
        "issuerState": true
      },
      "militaryService": {
        "number": true,
        "issuer": true,
        "issuerState": true
      }
    },
    "address": {
      "street": true,
      "streetSimilarity": 9.4,
      "number": true,
      "numberSimilarity": 10.0,
      "complement": false,
      "complementSimilarity": 2.1,
      "neighborhood": true,
      "neighborhoodSimilarity": 9.9,
      "postalCode": true,
      "city": true,
      "citySimilarity": 10.0,
      "state": true,
    }
  },
  "metadata": {
    "processingTime": 2345,
    "timestamp": "2026-04-20T19:04:17.412Z"
  }
}

{
    "success": false,
    "error": {
        "issues": [
            {
                "code": "invalid_type",
                "expected": "string",
                "received": "undefined",
                "path": [
                    "cpf"
                ],
                "message": "Required"
            }
        ],
        "name": "ZodError"
    }
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "Unexpected error while processing scan request",
  "requestId": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": "2026-04-20T19:04:17.412Z"
}

​Request Body

​Response

Request Body

Response