--- source_url: "https://dynadok.com/api-de-validacao-de-documentos/" title: "API de Validação de Documentos" generated_at: 2026-09-22T05:50:21Z host: dynadok.com type: page schema_types: [WebPage] generator: geostack/1.0.0 --- ## Structured data ```json { "@context": "https://schema.org", "@graph": [ { "@type": "WebPage", "@id": "https://dynadok.com/api-de-validacao-de-documentos/#webpage", "url": "https://dynadok.com/api-de-validacao-de-documentos/", "headline": "API de Validação de Documentos", "datePublished": "2026-08-10T17:30:25+00:00", "dateModified": "2026-08-10T17:30:28+00:00", "inLanguage": "pt-BR", "publisher": { "@type": "Organization", "name": "Dynadok", "url": "https://dynadok.com/" }, "description": "A Dynadok pode ser usada pela plataforma, pela API ou pelos dois. Para o time de tecnologia, o que importa é o seguinte: são dois endpoints para colocar a validação documental de pé — um POST que envia o arquivo e um GET que devolve os dados extraídos. Autenticação por chave de API, requisição HTTP […]" } ] } ``` # API de Validação de Documentos A Dynadok pode ser usada pela plataforma, pela API ou pelos dois. Para o time de tecnologia, o que importa é o seguinte: são **dois endpoints** para colocar a validação documental de pé — um `POST` que envia o arquivo e um `GET` que devolve os dados extraídos. Autenticação por chave de API, requisição HTTP comum, resposta em JSON. Atualizado em agosto de 2026 · Equipe Dynadok Resposta diretaA API da Dynadok tem URL base **https://api.dynadok.com** e autenticação pelo cabeçalho **x-api-key**. Você envia o documento em `POST /v1/api/documents`, recebe um `id` com status de processamento e consulta o resultado em `GET /v1/api/documents/{id}`. Não é preciso trocar o seu ERP nem o seu sistema acadêmico: a Dynadok se integra ao ambiente que já existe. [Acessar a documentação](https://doc.dynadok.com/docs/intro) [Ver os endpoints](https://doc.dynadok.com/docs/API/endpoints) Primeira integração## Do zero ao primeiro documento validado Três passos. Qualquer cliente HTTP serve: cURL, Postman ou a biblioteca da sua linguagem. 01### Obtenha a sua chave de API A autenticação é feita pelo cabeçalho `x-api-key`, com a chave fornecida pela Dynadok. Requisições sem chave, ou com chave incorreta ou expirada, retornam `401 Unauthorized`. URL base ``` https://api.dynadok.com ``` 02### Envie o documento Um `POST` multipart com o arquivo em `files` e o tipo do documento em `type`. A resposta traz o `id` e o status do processamento. cURL ``` curl --location 'https://api.dynadok.com/v1/api/documents' \ --header 'x-api-key: sua_chave_de_api' \ --form 'files=@"C:/caminho/arquivo.pdf"' \ --form 'type="RG"' ``` Resposta ``` { "id": "123456", "status": "processing" } ``` 03### Recupere os dados extraídos Com o `id` em mãos, consulte o documento processado. A resposta traz o status e os campos extraídos pela IA. cURL ``` curl -X GET "https://api.dynadok.com/v1/api/documents/{id}" \ --header 'x-api-key: sua_chave_de_api' ``` Resposta ``` { "id": "123456", "status": "processed", "data": { "nome": "João Silva", "documento": "123456789", "data_emissao": "2023-01-01" } } ``` Mesma coisa, na sua linguagem## Exemplo em Python Nada exótico: uma requisição HTTP com `requests`. O mesmo vale para axios ou fetch em JavaScript e HttpClient em Java ou C#. ``` import requests url = 'https://api.dynadok.com/v1/api/documents' payload = {'type': 'CERTIDAO_DE_NASCIMENTO'} files = [ ('files', ('nome_do_arquivo.pdf', open('nome_do_arquivo.pdf', 'rb'), 'application/pdf')) ] headers = { 'x-api-key': '••••••' } response = requests.request("POST", url, headers=headers, data=payload, files=files) print(response.text) ``` Referência## Endpoints MétodoRotaDescrição `POST` `/v1/api/documents` Envia um documento (imagem ou PDF) para processamento. Retorna o `id` e o status inicial. `GET` `/v1/api/documents/{id}` Obtém as informações extraídas de um documento já processado. A referência completa, com cabeçalhos, parâmetros e exemplos atualizados, fica na documentação técnica: [doc.dynadok.com](https://doc.dynadok.com/docs/API/endpoints). Fluxos, regras e integrações específicas do seu projeto são definidos no escopo da implantação. Parâmetro type## Exemplos de alguns tipos de documentos Cada tipo tem sua descrição e interface de retorno na documentação. A lista evolui conforme os projetos, e novos tipos podem ser configurados no escopo da implantação. RGRG CNHCNH CPFCPF Comprovante de residênciaCOMPROVANTE\_RESIDENCIA Cadastro ÚnicoCAD\_UNICO Carteira de trabalhoCARTEIRA\_DE\_TRABALHO Certidão de casamentoCERTIDAO\_DE\_CASAMENTO Certidão de nascimentoCERTIDAO\_DE\_NASCIMENTO Certificado de conclusão do ensino médioCERTIFICADO\_CONCLUSAO\_ENSINO\_MEDIO Comprovante de inscrição e situação cadastralCOMPROVANTE\_DE\_INSCRICAO\_E\_DE\_SITUACAO\_CADASTRAL Contrato socialCONTRATO\_SOCIAL DASN-SIMEIDASN\_SIMEI Declaração de IRPFDECLARACAO\_IMPOSTO\_RENDA\_PESSOA\_FISICA\_IRPF DECOREDECORE Histórico de crédito INSSHISCRED\_INSS Histórico escolarHISTORICO\_ESCOLAR HoleriteHOLERITE Ficha de inscrição do ProuniPROUNI\_FICHA\_INSCRICAO Recibo IRRFRECIBO\_IRRF Situação cadastral do CPFSITUACAO\_CADASTRAL\_CPF Além da extração## Regras de validação A documentação descreve as regras aplicáveis para aceitação de documentos. Cada regra tem propriedades que definem como o documento deve ser validado e aceito — é o que permite adaptar a análise ao processo de cada operação. - **Categoria da CNH** `CNH_CATEGORY` - **Situação cadastral do CNPJ** `CNPJ_REGISTRATION_STATUS` - **Porte da empresa** `COMPANY_SIZE` - **Competência** `COMPETENCY` - **Status do CPF** `CPF_STATUS` - **Data de emissão** `EMISSION_DATE` - **Data de vencimento** `EXPIRATION_DATE` - **Localização** `LOCATION` - **Data de abertura** `OPENING_DATE` - **Titularidade** `OWNERSHIP` - **Início de atividades** `START_OF_ACTIVITIES` - **Nível e status do histórico escolar** `STATUS_DEGREE_HISTORICO_ESCOLAR` - **Documentos substitutos** `SUBSTITUTE_DOCUMENTS` Regras como **data de vencimento**, **titularidade** e **documentos substitutos** são o que transforma extração de dados em validação de verdade: não basta ler o campo, é preciso decidir se aquele documento é aceito naquele processo, naquele momento e para aquela pessoa. Três formas de usar## Plataforma, API ou os dois 01### Somente plataforma As equipes trabalham na interface da Dynadok, com checklists e fluxos configurados. Terceiros e candidatos enviam documentos direto pela plataforma e recebem a notificação de não conformidade em segundos. 02### Somente API A validação acontece dentro dos seus sistemas: você envia os documentos por requisição HTTP e recebe os dados extraídos e o resultado das regras, sem que o usuário final saia do seu ambiente. 03### Plataforma + API O envio e a análise correm pela API, e a operação usa a plataforma para tratar exceções, acompanhar filas e auditar o que foi decidido. **Não é preciso trocar o ERP ou o sistema acadêmico.** A Dynadok se adapta ao ambiente atual e se integra aos sistemas existentes, mantendo o fluxo de trabalho. O acesso à plataforma e às APIs está incluído na contratação, dentro do escopo do projeto, sem cobrança adicional por usuário ou licença. Tratamento de resposta## Códigos de erro mais comuns CódigoCausa comumO que fazer `400` Bad RequestFormato de dados incorreto ou parâmetros obrigatórios ausentesConferir a estrutura e os parâmetros da requisição na documentação `401` UnauthorizedChave de API ausente, incorreta ou expiradaVerificar se a chave está correta e foi incluída no cabeçalho `403` ForbiddenPermissões insuficientes da chave de APIConferir se a chave tem permissão para o recurso solicitado `404` Not FoundURL do endpoint incorreta ou recurso inexistenteConfirmar a rota e a existência do recurso `405` Method Not AllowedMétodo HTTP incorreto para o recursoUsar o método previsto na documentação `429` Too Many RequestsMuitas requisições em um curto períodoImplementar retry com backoff exponencial `500` / `502` / `503` / `504`Erro interno, gateway inválido, indisponibilidade temporária ou timeoutRepetir a requisição mais tarde e, se persistir, acionar o suporte O que o seu time precisa## Requisitos da integração Nada além do que já existe em qualquer stack que consome uma API REST. - **Chave de API** fornecida pela Dynadok, enviada no cabeçalho `x-api-key` - **Cliente HTTP:** cURL, Postman ou biblioteca da linguagem - **Python:** `requests` - **JavaScript:** `axios` ou `fetch` - **Java e C#:** `HttpClient` - **Formato:** envio multipart do arquivo e resposta em JSON ### Segurança na integração Todo o tráfego entre os sistemas do cliente, navegadores e a plataforma Dynadok é protegido por **TLS 1.2 ou superior**. Documentos e dados extraídos são armazenados cifrados com **AES-256**, com segregação lógica entre clientes e trilhas de auditoria de acesso, download e exportação. Trate a chave de API como credencial: mantenha-a fora do repositório e do front-end, e prefira variáveis de ambiente ou um cofre de segredos. Perguntas frequentes## Dúvidas de quem vai integrar Onde fica a documentação técnica da Dynadok?Em doc.dynadok.com. A documentação cobre a integração com a API, os tipos de documento suportados com suas interfaces de retorno, as regras de validação, exemplos de uso e o tratamento dos erros mais comuns. Como funciona a autenticação?Por chave de API enviada no cabeçalho `x-api-key`, fornecida pela Dynadok. Requisições sem chave, com chave incorreta ou expirada retornam `401 Unauthorized`; chave sem permissão para o recurso retorna `403 Forbidden`. Quais formatos de arquivo posso enviar?O endpoint de envio aceita imagem ou PDF. A IA processa documentos estruturados, semi-estruturados, não estruturados e até escritos à mão, com OCR avançado e visão computacional, incluindo digitalizações e arquivos extensos. O processamento é síncrono?Não. O envio retorna imediatamente um `id` com status `processing`, e o resultado é consultado depois em `GET /v1/api/documents/{id}`, que retorna o status `processed` e os dados extraídos. Na prática, a validação leva segundos. E se o meu documento não estiver na lista de tipos?Os tipos mostrados aqui são apenas exemplos, e a lista documentada evolui conforme os projetos. Novos tipos de documento, regras e fluxos são avaliados e configurados dentro do escopo da implantação. Inclusões posteriores ao escopo original podem exigir nova avaliação técnica e comercial. As regras de validação são configuráveis?Sim. Cada regra tem propriedades que definem como o documento deve ser validado e aceito — data de emissão e vencimento, titularidade, localização, status cadastral, documentos substitutos, entre outras. Os checklists são montados por tipo de documento e por processo, com os critérios da sua operação. Preciso trocar o sistema que já uso?Não. A Dynadok se adapta ao ambiente atual e se integra aos sistemas existentes, mantendo o fluxo de trabalho. É possível usar apenas a API, apenas a plataforma ou os dois modelos combinados. O uso da API tem custo adicional?Não há cobrança adicional por usuário, acesso ou licença: o acesso à plataforma e às APIs está incluído na contratação, dentro do escopo do projeto. O valor recorrente é determinado pelo volume de páginas processadas pela IA. Como acionar o suporte técnico durante a integração?Os canais de dúvidas e suporte técnico estão listados na própria documentação, em doc.dynadok.com. Durante a implantação, o time de projetos da Dynadok acompanha o desenvolvimento das integrações previstas no escopo, os testes, a homologação e o go-live.