Documentos e biometria

OCR de Documentos KYC PF

Extração de dados de documentos via OCR para validação de identidade via KYC.

Quando usar

Descrição

O serviço de OCR de Documentos KYC PF realiza a extração automatizada de informações a partir de imagens de documentos, convertendo o conteúdo visual em dados estruturados e legíveis.

São identificados e extraídos dados relevantes, como nome, número de documento, data de nascimento, filiação e demais informações presentes no documento analisado.

Como utilizar

Envie as URLs públicas das imagens do documento (frente obrigatória, verso opcional). As imagens devem estar hospedadas em ambiente acessível ou no S3 da plataforma.

Requisição

Autenticação por chave de API (cabeçalho Authorization: Bearer), criada no painel com esta consulta no escopo.

POST /api/v1/{tenant}/pessoas/ocr-de-documentos-kyc-pf

Campo	Obrigatório	Descrição
`document`	sim	CPF da pessoa, com ou sem máscara.
`document_img`	sim	Imagem do documento em base64

{
  "document": "000.000.000-00",
  "document_img": "valor"
}

Campos de retorno

Campos dentro de data. [] indica lista.

Campo	Tipo
`InputParams.doc_img_a_url`	texto
`InputParams.doc_img_b_url`	texto
`InputParams.doc_type`	texto
`InputParams.document`	texto
`InputParams.person_name`	texto
`DocInfo.BIRTHDATE`	texto
`DocInfo.CATEGORY`	texto
`DocInfo.CNHNUMBER`	texto
`DocInfo.CPF`	texto
`DocInfo.DOCTYPE`	texto
`DocInfo.EXPEDITIONDATE`	texto
`DocInfo.FATHERNAME`	texto
`DocInfo.FIRSTQUALIFICATIONDATE`	texto
`DocInfo.IDENTIFICATIONNUMBER`	texto
`DocInfo.IDENTIFICATIONUF`	texto
`DocInfo.MOTHERNAME`	texto
`DocInfo.NAME`	texto
`DocInfo.ORGEMISSION`	texto
`DocInfo.PLACEOFBIRTH`	texto
`DocInfo.SIDE`	texto
`DocInfo.VALIDDATE`	texto

Exemplo de resposta

Estrutura real da resposta, com valores fictícios.

{
  "execution_id": "00000000-0000-0000-0000-000000000000",
  "status": "success",
  "message": "Consulta realizada com sucesso",
  "query_name": "OCR de Documentos KYC PF",
  "query_slug": "ocr-de-documentos-kyc-pf",
  "data": {
    "InputParams": {
      "doc_img_a_url": "texto",
      "doc_img_b_url": "texto",
      "doc_type": "texto",
      "document": "texto",
      "person_name": "texto"
    },
    "DocInfo": {
      "BIRTHDATE": "texto",
      "CATEGORY": "texto",
      "CNHNUMBER": "texto",
      "CPF": "texto",
      "DOCTYPE": "texto",
      "EXPEDITIONDATE": "texto",
      "FATHERNAME": "texto",
      "FIRSTQUALIFICATIONDATE": "texto",
      "IDENTIFICATIONNUMBER": "texto",
      "IDENTIFICATIONUF": "texto",
      "MOTHERNAME": "texto",
      "NAME": "texto",
      "ORGEMISSION": "texto",
      "PLACEOFBIRTH": "texto",
      "SIDE": "texto",
      "VALIDDATE": "texto"
    }
  },
  "consulted_at": "2026-01-01T12:00:00Z",
  "query_cost": "0.300"
}

Cobrança e respostas

O valor é cobrado por consulta bem-sucedida.
200 — consulta processada (veja status no corpo da resposta)
401 — token ausente, inválido, inativo ou expirado
403 — serviço fora do escopo da chave, IP não autorizado ou limite de consumo excedido
422 — campo obrigatório ausente/inválido ou payload acima do limite do serviço
429 — limite de requisições por minuto da chave excedido
504 — tempo máximo de execução do serviço excedido