Saltar para o conteúdo principal
POST
curl
Prepara um único ZIP com todos os ficheiros de uma sessão de Verificação de utilizadores (KYC) ou de Verificação de empresas (KYB): frentes e versos dos documentos, selfies, vídeos de prova de vida e documentos carregados, na qualidade original. O ZIP é preparado em segundo plano. A chamada responde com 202 e com a exportação; consulte-a com Obter exportação de ficheiros até que status seja READY, e depois transfira download_url.
  • Enquanto uma exportação da mesma sessão ainda estiver a ser preparada, a chamada devolve essa exportação em vez de iniciar uma nova.
  • O ZIP é eliminado 24 horas depois de ficar pronto e imediatamente quando a sessão for eliminada.
  • Não é possível exportar uma sessão eliminada: a chamada devolve 404.
  • Cada exportação fica registada no registo de auditoria da sessão.
  • Uma chave de API com âmbito restrito precisa de media: read e decisions: read.

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"

Resposta

A exportação, a ser preparada.

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