Pular para o conteúdo principal
GET
cURL

Suporte a KYC e KYB

Funciona tanto para sessões de Verificação de Usuário (KYC) quanto de Verificação de Empresas (KYB). A Didit direciona automaticamente cada sessão ao modelo de PDF adequado:
  • Sessão de Verificação de Usuário (KYC) → relatório com seções de verificação de identidade, prova de vida, correspondência facial, AML e comprovante de endereço.
  • Sessão de Verificação de Empresas (KYB) → relatório com seções de registro de empresas, pessoas-chave (UBOs/administradores), documentos, AML, questionário, telefone, e-mail e análise de IP, quando esses recursos fazem parte do fluxo de verificação (workflow).
Ambos usam o mesmo pipeline de geração de PDF e oferecem personalização de marca própria (logotipo, URL da política de privacidade).

Convenção de nomes de arquivo

Retornado pelo cabeçalho Content-Disposition: attachment; filename=....

Requisito de status

A sessão precisa estar em APPROVED, DECLINED ou IN_REVIEW para gerar um PDF. Sessões em andamento ou não iniciadas retornam 403.

Exemplos

Marca própria

Quando a aplicação tem a personalização de marca própria ativada, o PDF usa o seu logotipo e a URL da sua política de privacidade. Configure em Console → Customization.

Permissão

Requer read:sessions. O mesmo escopo para os dois tipos.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

sessionId
string<uuid>
obrigatório

UUID da sessão de Verificação de usuários (KYC) ou de Verificação de empresas (KYB) a ser renderizada: o session_id retornado por POST /v3/session/. O mesmo caminho funciona para os dois tipos de sessão; use o nome de arquivo do Content-Disposition na resposta para saber qual tipo de relatório você recebeu.

Deve ser um UUID bem formado e em letras minúsculas. A rota só corresponde a UUIDs válidos, então um valor malformado é rejeitado pelo roteador de URLs antes de qualquer código da aplicação ser executado, e a resposta é uma página HTML de 404 em vez do envelope JSON {"detail": ...} mostrado abaixo. O conversor de UUID da rota só corresponde à forma canônica em minúsculas: UUIDs com hexadecimais em maiúsculas são rejeitados com o 404 em HTML.

Exemplo:

"11111111-2222-3333-4444-555555555555"

Resposta

O documento PDF renderizado, retornado diretamente como binário application/pdf: não há wrapper JSON nem indireção por URL de download. O corpo começa com os bytes mágicos %PDF (PDF 1.7). Salve-o em um arquivo .pdf ou transmita-o diretamente para quem fez a chamada.

The response is of type file.

Última modificação em 1 de novembro de 2026