Saltar para o conteúdo principal
GET
cURL

Suporte a KYC e KYB

Funciona tanto para sessões de Verificação de utilizadores (KYC) como de Verificação de empresas (KYB). A Didit encaminha automaticamente para o modelo de PDF adequado:
  • Sessão de Verificação de utilizadores (KYC) → relatório com as secções de verificação de identidade, prova de vida, correspondência facial, AML e comprovativo de morada.
  • Sessão de Verificação de empresas (KYB) → relatório com as secções de registo de empresas, pessoas-chave (beneficiários efetivos/administradores), documentos, AML, questionário, telefone, e-mail e análise de IP, quando essas funcionalidades fazem parte do fluxo.
Ambos usam o mesmo pipeline de geração de PDF e suportam personalização em marca branca (logótipo, URL da política de privacidade).

Convenção de nomes de ficheiros

É devolvido através do cabeçalho Content-Disposition: attachment; filename=....

Requisito de estado

A sessão tem de estar em APPROVED, DECLINED ou IN_REVIEW para gerar um PDF. Sessões em curso ou não iniciadas devolvem 403.

Exemplos

Marca branca

Quando a aplicação tem a personalização em marca branca ativada, o PDF usa o seu logótipo e o URL da política de privacidade. Configure em Consola → Personalização.

Permissão

Requer read:sessions. O mesmo âmbito para ambos os tipos.

Conteúdos relacionados

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. 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 utilizadores (KYC) ou de Verificação de empresas (KYB) a gerar — o session_id devolvido por POST /v3/session/. O mesmo caminho funciona para ambos os tipos de sessão; utilize o nome de ficheiro em Content-Disposition na resposta para saber que tipo de relatório recebeu.

Tem de ser um UUID bem formatado e em minúsculas. A rota apenas aceita UUIDs válidos, pelo que um valor mal formatado é rejeitado pelo router de URLs antes de qualquer código da aplicação ser executado, e a resposta é uma página HTML de 404 em vez do formato JSON {"detail": ...} apresentado abaixo. O conversor de UUID da rota apenas aceita o formato canónico em minúsculas — UUIDs com carateres hexadecimais em maiúsculas são rejeitados com o 404 em HTML.

Exemplo:

"11111111-2222-3333-4444-555555555555"

Resposta

O documento PDF renderizado, devolvido diretamente como binário application/pdf — não há invólucro JSON nem redirecionamento por URL de descarregamento. O corpo começa com os bytes mágicos %PDF (PDF 1.7). Guarde-o num ficheiro .pdf ou transmita-o diretamente para o chamador.

The response is of type file.

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