Sobre esta API

Lê os dois lados do RG — ou a CNH — numa chamada só e devolve o nome do titular, a filiação e a naturalidade.

Informe document_type e envie a CNH em document_front; o RG vai em document_front e document_back, e a ordem das imagens não importa.

Para CPF, número do documento, datas e órgão expedidor, use a Leitura de documentos.

Tecnologia

OCR com visão computacional · Atualização: tempo real

Requisição

POST /api/v1/oracle/document/identify

Autenticação HTTP Basic: public_key:secret_key em Base64. Guarde a chave secreta no servidor.

Cabeçalho	Descrição
`Authorization` Obrigatório	Chave de API em Basic: `public_key:secret_key` em Base64.
`X-Project-Id` Opcional	Projeto que recebe a chamada. Sem ele, vale o projeto padrão da conta.
`Idempotency-Key` Opcional	Repetir a mesma chave em até 24 horas devolve a resposta anterior, sem executar nem cobrar de novo.

Parâmetros

Campo	Tipo e local	Descrição
`document_front` Obrigatório	filefile	CNH, ou a frente do RG.
`document_back` Opcional	filefile	Verso do RG. Obrigatório quando o tipo é RG.
`document_type` Obrigatório	stringquery	Tipo do documento enviado. Exemplo: `CNH`

1curl --request POST 'https://api.apifordevs.com/api/v1/oracle/document/identify?document_type=CNH' \
2  --user "afd_live_pk_...:$AFD_SECRET_KEY" \
3  --header "X-Project-Id: $AFD_PROJECT_ID" \
4  --form 'document_front=@./document_front.jpg'

1import os
2import requests
3
4document_front = open("./document_front.jpg", "rb")
5response = requests.request(
6    "POST",
7    "https://api.apifordevs.com/api/v1/oracle/document/identify?document_type=CNH",
8    auth=("afd_live_pk_...", os.environ["AFD_SECRET_KEY"]),
9    headers={"X-Project-Id": os.environ["AFD_PROJECT_ID"]},
10    files={"document_front": document_front},
11    timeout=30,
12)
13response.raise_for_status()
14print(response.json())
15document_front.close()

1import { readFile } from "node:fs/promises";
2const form = new FormData();
3form.append("document_front", new Blob([await readFile("./document_front.jpg")]), "document_front.jpg");
4
5const response = await fetch("https://api.apifordevs.com/api/v1/oracle/document/identify?document_type=CNH", {
6  method: "POST",
7  headers: {
8    Authorization: "Basic " + Buffer.from(
9      "afd_live_pk_...:" + process.env.AFD_SECRET_KEY
10    ).toString("base64"),
11    "X-Project-Id": process.env.AFD_PROJECT_ID,
12  },
13  body: form,
14  signal: AbortSignal.timeout(30000),
15});
16if (!response.ok) throw new Error(`HTTP ${response.status}`);
17console.log(await response.json());

Campos de resposta

Campos e tipos publicados no catálogo desta API.

Tipo solicitadorequested_document_typestring
Tipo identificadodocument_typestring
Arquivo (frente)filenamestring
Arquivo (verso)filename_2string
Campos extraídosanalysis_resultobject
Documento reconhecidoanalysis_result.is_validboolean
Nomeanalysis_result.nomestring
Filiação 1analysis_result.filiacao1string
Filiação 2analysis_result.filiacao2string
Cidade de nascimentoanalysis_result.birth_citystring
UFanalysis_result.ufstring

Exemplo de resposta

1{
2  "success": true,
3  "code": 200,
4  "code_message": "A requisição foi processada com sucesso.",
5  "errors": [],
6  "header": null,
7  "data_count": 1,
8  "data": [
9    {
10      "requested_document_type": "RG-FRONT",
11      "document_type": "RG-TOTAL",
12      "filename": "rg-frente.jpg",
13      "filename_2": "rg-verso.jpg",
14      "analysis_result": {
15        "is_valid": true,
16        "nome": "FULANO DE TAL DA SILVA",
17        "filiacao1": "JOSE DE TAL DA SILVA",
18        "filiacao2": "MARIA DE TAL DA SILVA",
19        "birth_city": "SAO PAULO",
20        "uf": "SP"
21      }
22    }
23  ]
24}

Respostas e cobrança

HTTP	Descrição	Cobrança
`200`	Sucesso.	Sujeita à cobrança
`400` `bad_request` `live_key_cannot_use_dev_mode`	Arquivo ou parâmetro que a rota não consegue processar, projeto inválido, ou `dev_mode=true` com chave de produção.	Sem cobrança
`401` `unauthorized`	Credencial ausente, inválida ou revogada.	Sem cobrança
`402` `payment_required`	Saldo insuficiente ou limite de gasto diário atingido.	Sem cobrança
`403` `forbidden` `ip_not_allowed` `test_key_cannot_run_live`	E-mail da conta não verificado, chave sem escopo para o serviço, IP fora da allowlist do projeto ou chave de teste sem `dev_mode=true`.	Sem cobrança
`409` `conflict`	Requisição com a mesma `Idempotency-Key` ainda em andamento.	Sem cobrança
`413` `payload_too_large`	Arquivo acima de 20 MB.	Sem cobrança
`422` `validation_error`	Parâmetro obrigatório ausente ou fora do formato, ou `Idempotency-Key` repetida com outro conteúdo.	Sem cobrança
`429` `rate_limit_exceeded`	Limite de requisições por minuto da chave atingido.	Sem cobrança
`500` `internal_error`	Falha interna.	Sem cobrança
`503` `service_unavailable`	Serviço desativado ou temporariamente indisponível.	Sem cobrança

Casos de uso

KYC com RG

Ler os dois lados do RG numa chamada só, com a orientação conferida — o usuário fotografa na ordem que quiser.

Identificação no onboarding

Confirmar nome e filiação do titular no primeiro passo do cadastro, antes da comparação facial.

Leitura de documentos de identidade