Pular para o conteúdo principal
GET
cURL

Visão geral

Retorna um único PDF com o histórico completo de verificações de uma entidade User, identificada por vendor_data. É o mesmo documento que o Console gera em User detail → Actions → Download PDF, para que as equipes de conformidade possam automatizar as exportações em vez de clicar uma vez por usuário. O relatório contém:
  • Uma página de capa com o resumo do perfil (nome, data de nascimento, estados emissores, e-mails e telefones aprovados), o status mais recente de cada recurso, os contadores de sessões e um índice das sessões incluídas.
  • Um relatório completo para cada sessão incluída, em ordem cronológica (da mais antiga para a mais recente). Cada um é o mesmo relatório que o Generate PDF retorna para aquela sessão individualmente.

Sessões elegíveis e limite

Somente sessões de Verificação de usuários (KYC) com status Approved, Declined, In Review ou Kyc Expired são incluídas. Sessões com qualquer outro status (Not Started, In Progress, Abandoned, Expired, …) são ignoradas. O relatório é limitado às 20 sessões mais recentes qualificadas para o relatório. Quando um usuário tem mais, as 20 mais recentes são incluídas e a página de capa informa quantas sessões mais antigas ficaram de fora. Use List sessions com filtro por vendor_data quando precisar da lista completa em JSON.

Resposta

O corpo é o próprio PDF (application/pdf), não um objeto JSON externo nem uma URL de download. O cabeçalho Content-Disposition é attachment; filename=user_<didit_internal_id>.pdf, em que didit_internal_id é o identificador estável do usuário na Didit.

Marca própria

Quando a personalização de marca própria está habilitada na sua aplicação, a capa e cada relatório de sessão exibem o seu logotipo e a URL da sua política de privacidade em vez da marca Didit, exatamente como no endpoint por sessão. Configure-a em Console → Customization.

Cache e latência

Nada fica em cache: cada chamada gera o relatório novamente a partir dos dados atuais, então um relatório solicitado após uma revisão manual reflete a decisão do revisor. Duas chamadas podem gerar arquivos diferentes byte a byte; arquive o arquivo baixado quando precisar de uma cópia imutável. A geração é síncrona e baixa todas as imagens armazenadas de todas as sessões incluídas, então a geração do relatório de um usuário com muitas sessões com grande volume de mídia pode levar dezenas de segundos. Use um timeout de leitura generoso no cliente (120 s recomendados) e grave o corpo em disco via streaming. A geração para ao atingir um limite de tempo no servidor, em vez de continuar até o seu cliente desistir: se esse limite for atingido, ainda é retornado um PDF válido com as sessões mais recentes e a capa informa quantas foram omitidas.

Barra final

A rota canônica termina com barra final (…/generate-pdf/). Uma requisição sem a barra é atendida diretamente com a mesma resposta: não há redirecionamento 301, então nenhum cliente precisa seguir redirecionamentos e o curl não precisa de -L. Use a URL com barra, como nos exemplos; é a forma que aparece na especificação OpenAPI e nos seus logs.

Erros

Exemplos

Permissões

Qualquer chave de API ativa da aplicação pode chamar este endpoint. As chaves de API da Didit têm escopo de aplicação, não de função: as funções e permissões do Console (read:users e as demais) definem o que uma pessoa pode fazer no Console e não são avaliadas no tráfego da Management API. Uma chave só pode exportar usuários da própria aplicação.

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

vendor_data
string
obrigatório

Seu identificador exclusivo do usuário: uma string livre (NÃO um UUID). É o mesmo valor que você passou como vendor_data ao criar as sessões do usuário, comparado exatamente como enviado. Codifique-o para URL; um valor que contenha / não pode ser endereçado por esta rota.

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. 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