Pular para o conteúdo principal
GET
curl
Consulte uma exportação iniciada com Exportar arquivos.
  • PENDING e PROCESSING: o ZIP está sendo preparado. Leia a exportação novamente em alguns segundos.
  • READY: download_url é um link assinado para o ZIP que permanece válido por pouco tempo. Leia a exportação novamente para obter um novo link até expires_at.
  • FAILED: não foi possível preparar o ZIP. Inicie uma nova exportação.
  • EXPIRED: o ZIP foi excluído. Inicie uma nova exportação.
Cada consulta que fornece um link de download é gravada no registro de auditoria da sessão. A exportação de uma sessão excluída retorna 404.

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 (o session_id retornado por POST /v3/session/). Aceita IDs de sessão tanto de Verificação de usuários (KYC) quanto de Verificação de empresas (KYB). Uma sessão excluída retorna 404.

Exemplo:

"11111111-2222-3333-4444-555555555555"

exportId
string<uuid>
obrigatório

O export_id retornado por POST /v3/session/{sessionId}/files-export/.

Exemplo:

"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

Resposta

A exportação.

Um ZIP com todos os arquivos de uma sessão, em qualidade original.

export_id
string<uuid>
obrigatório

ID da exportação. Informe-o em GET /v3/session/{sessionId}/files-export/{exportId}/.

session_id
string<uuid>
obrigatório

A sessão de onde vêm os arquivos.

status
enum<string>
obrigatório

PENDING e PROCESSING enquanto o ZIP é preparado, READY quando ele já pode ser baixado, FAILED quando não foi possível prepará-lo (solicite uma nova exportação), EXPIRED depois que o ZIP foi excluído.

Opções disponíveis:
PENDING,
PROCESSING,
READY,
FAILED,
EXPIRED
file_count
integer | null
obrigatório

Arquivos no ZIP. Definido apenas enquanto status for READY.

size_bytes
integer<int64> | null
obrigatório

Tamanho do ZIP em bytes. Definido apenas enquanto status é READY.

download_url
string<uri> | null
obrigatório

URL assinada do ZIP, válida por pouco tempo. Definida somente enquanto status for READY; leia a exportação novamente para obter uma nova.

expires_at
string<date-time> | null
obrigatório

Quando o ZIP é excluído, 24 horas depois de ficar pronto. Definido apenas enquanto status for READY.

error
string | null
obrigatório

Por que a exportação falhou, quando status é FAILED.

created_at
string<date-time>
obrigatório

Quando a exportação foi solicitada.

completed_at
string<date-time> | null
obrigatório

Quando o ZIP ficou pronto ou a exportação falhou.

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