Integridade documental

Requisitos de autenticação:

• Os endpoints padrão usam OAuth2 autenticação com URL base: https://api.us.prd.caf.io
• Para maior segurança, alguns endpoints também podem oferecer suporte a mTLS autenticação com URL base: https://mtls.us.prd.caf.io
• Para obter informações sobre a implementação de mTLS, acesse Usando mTLS

Avalia cada imagem quanto a problemas de qualidade (borrão, reflexo, baixa resolução), dano físico, adulteração, flash e obstrução, além de uma verificação de completude da captura para a transação, comunicada por meio de reasonCodes.

• Completude de OCR: pontuação de completude dos campos extraídos pelo OCR Sync, retornada no ocrCompletenessScore campo.

Formatos de arquivo compatíveis: JPG, JPEG, PNG, BMP, PDF, HEIC. Arquivos PDF e HEIC são convertidos antes do processamento.

Somente URLs assinadas são aceitas. Payloads binários ou em base64 não são suportados. O host da URL do arquivo deve ser previamente aprovado pela equipe da Certta.

Imagens da frente e do verso são obrigatórias. Esta versão aceita apenas documentos de RG e CNH.

Evaluate the integrity of an identity document (RG/CNH)

post

/

Orchestrates OCR Sync and Quality Service (front and back) in parallel to evaluate the integrity of the submitted document. Only signed file URLs are accepted. Front and back are required in this version.

Supported formats: JPG, JPEG, PNG, BMP, PDF, HEIC. PDF and HEIC files are converted before processing.

The host of the file URL must be previously approved by the Certta team.

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Corpo

Respostas

200

Document evaluated successfully.

application/json

requestIdstringObrigatório

Unique request identifier generated by the service. Used for traceability and support correlation, and propagated to internal dependencies (OCR Sync and Quality Service).

Example: 550e8400-e29b-41d4-a716-446655440000

decisionstring · enumObrigatório

Public integrity outcome. APPROVED means the document passed the integrity policy. REPROVED means it failed.

Example: APPROVEDValores possíveis:

ocrCompletenessScorenumber · anulávelOpcional

OCR field-completeness score, rounded to two decimal places. Typical range is 0–100. Present only when OCR completeness is part of the assessment. null means the model did not produce a numeric completeness score for that request. Omitted when OCR completeness is not evaluated.

Example: 80.77

400

Invalid request: malformed payload, unsupported file format, or missing front or back of the document.

application/json

401

Unauthorized (missing or invalid credentials).

application/json

403

Forbidden (no permission or tenant not enabled for the product).

application/json

422

Document not supported by the AI models (for example: selfie, random image, or incompatible front/back pair). The response body contains only message (without ocrCompletenessScore, capabilities, or reasonCodes).

application/json

503

Error or unavailability in the OCR Sync or Quality Service response, for requests with a valid and supported document.

application/json

post/

POST /v1/document-integrity/ HTTP/1.1
Host: api.us.prd.caf.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "files": [
    {
      "type": "FRONT",
      "data": "https://example.com"
    }
  ]
}

{
  "requestId": "550e8400-e29b-41d4-a716-446655440000",
  "decision": "REPROVED",
  "capabilities": [
    "quality",
    "integrity"
  ],
  "reasonCodes": [
    {
      "code": "MISSING_SIDE"
    },
    {
      "code": "PARTIAL_CPF"
    },
    {
      "code": "SHARP_IMAGE"
    }
  ]
}