Saltar para o conteúdo principal
GET
curl
Consulte uma exportação iniciada com Exportar ficheiros.
  • PENDING e PROCESSING: o ZIP está a ser preparado. Consulte a exportação novamente dentro de alguns segundos.
  • READY: download_url é uma ligação assinada para o ZIP, válida durante um curto período. Consulte a exportação novamente para obter uma nova ligação até expires_at.
  • FAILED: não foi possível preparar o ZIP. Inicie uma nova exportação.
  • EXPIRED: o ZIP foi eliminado. Inicie uma nova exportação.
Cada consulta que devolve uma ligação de transferência é registada no registo de auditoria da sessão. Uma exportação de uma sessão eliminada devolve 404.

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 (o session_id retornado por POST /v3/session/). Aceita IDs de sessão de Verificação de utilizadores (KYC) e de Verificação de empresas (KYB). Uma sessão eliminada retorna 404.

Exemplo:

"11111111-2222-3333-4444-555555555555"

exportId
string<uuid>
obrigatório

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

Exemplo:

"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

Resposta

A exportação.

Um ZIP com todos os ficheiros de uma sessão, na qualidade original.

export_id
string<uuid>
obrigatório

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

session_id
string<uuid>
obrigatório

A sessão da qual os ficheiros são provenientes.

status
enum<string>
obrigatório

PENDING e PROCESSING enquanto o ZIP está a ser preparado, READY assim que puder ser descarregado, FAILED quando não foi possível prepará-lo (solicite uma nova exportação), EXPIRED assim que o ZIP for eliminado.

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

Ficheiros no ZIP. Definido apenas enquanto status for READY.

size_bytes
integer<int64> | null
obrigatório

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

download_url
string<uri> | null
obrigatório

URL assinado do ZIP, válido por um curto período de tempo. Definido apenas enquanto status for READY; leia a exportação novamente para obter um novo.

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

Quando o ficheiro ZIP é eliminado, 24 horas após ficar pronto. Definido apenas enquanto o status for READY.

error
string | null
obrigatório

O motivo pelo qual a exportação falhou, quando status é FAILED.

created_at
string<date-time>
obrigatório

Quando a exportação foi pedida.

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

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

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