Valida documento (DocValid)

POST

/v1/docvalid

Última modificação:2026-09-01 18:50:45

Valida documento (CNH, RG, passaporte) via provedor DocValid. tipoDocumento aceita Url ou Base64. Payloads Base64 são apagados antes de logs e auditoria.

Requisição

Authorization

API Key

Adicionar parâmetro em header

Authorization

Exemplo:

Authorization: ********************

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Documento validado com sucesso

Bodyapplication/json

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/docvalid' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "cpf": "12345678901",
    "conversation-id": "conv-dv-001",
    "documento": "https://storage.example.com/doc-frente.jpg",
    "tipoDocumento": "Url",
    "veritifcaFace": false,
    "verificaTexto": [
        {
            "nome": "nome",
            "valor": "JOAO DA SILVA"
        }
    ]
}'

Response Example

200 - sucesso

{
    "data": {
        "verificaTexto": {
            "nome": true
        },
        "verificaFace": false,
        "comparaFace": false
    },
    "codigo_retorno": 200,
    "mensagem": "Documento validado com sucesso"
}

Modificado em 2026-09-01 18:50:45

Página anterior

Valida dados de conta bancária (Paraná Pay)

Próxima página

Classifica tipo de documento e extrai campos (OCR)