Saltar para o conteúdo principal
GET
Python
A API assíncrona de relatórios da Didit devolve uma tarefa de exportação e a lista atual de falhas. failed_count é igual ao número de itens em failed_item_ids; as sessões eliminadas são excluídas. Encontre o relatório com Listar relatórios assíncronos e, em seguida, siga as orientações para tentar novamente ou tente novamente a exportação.

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

organization_id
string<uuid>
obrigatório

Identificador da organização.

application_id
string<uuid>
obrigatório

Identificador da aplicação.

report_uuid
string<uuid>
obrigatório

UUID do relatório.

Resposta

Obter relatório assíncrono.

uuid
string<uuid>
obrigatório

Identificador do relatório.

report_type
enum<string>
obrigatório

Tipo de exportação ou de relatório de conformidade.

Opções disponíveis:
SESSION_EXPORT,
TRANSACTION_EXPORT,
BUSINESS_EXPORT,
VENDOR_USER_EXPORT,
VENDOR_BUSINESS_EXPORT,
CASE_EXPORT,
CASE_SLA_EXPORT,
LIST_ENTRY_EXPORT,
EVENT_EXPORT,
COMPLIANCE_KYC_KYB,
COMPLIANCE_AML_LOG,
COMPLIANCE_TRAVEL_RULE,
COMPLIANCE_SANCTIONS_PEP,
COMPLIANCE_RISK_SUMMARY,
COMPLIANCE_SAR_STR_DRAFT,
COMPLIANCE_CTR,
COMPLIANCE_CASE_SUMMARY
report_type_display
string
obrigatório

Rótulo apresentado para o tipo de relatório.

status
enum<string>
obrigatório

Estado da geração. READY pode incluir falhas individuais; verifique failed_count.

Opções disponíveis:
PENDING,
PROCESSING,
READY,
FAILED
status_display
string
obrigatório

Rótulo apresentado para o estado da geração.

parameters
object
obrigatório

Opções originais da exportação; as chaves dependem de report_type.

requested_by_user_id
string<uuid> | null
obrigatório

Identidade original do requerente, ou null para chamadores sem identidade de utilizador.

requested_by_email
string | null
obrigatório

E-mail do requerente, quando disponível.

requested_by_name
string | null
obrigatório

Nome de apresentação do requerente, quando disponível.

row_count
integer | null
obrigatório

Número de registos exportados, ou null antes da geração.

failed_item_ids
string<uuid>[]
obrigatório

UUIDs das sessões de produção que falharam nesta exportação de verificação. As sessões eliminadas são excluídas. Utilize estes IDs para uma nova tentativa seletiva.

failed_count
integer
obrigatório

Número de entradas em failed_item_ids.

Intervalo necessário: x >= 0
file_size
integer<int64> | null
obrigatório

Tamanho total do ficheiro gerado em bytes, ou null antes da geração.

files
object[]
obrigatório

Metadados do ficheiro gerado; não contém URLs de transferência.

scheduled_report
string<uuid> | null
obrigatório

Identificador do agendamento, ou null para um relatório não agendado.

error_message
string | null
obrigatório

Erro de geração, quando disponível.

deletion_pending
boolean
obrigatório

Indica se uma eliminação solicitada ainda está em curso.

eta_seconds
integer | null
obrigatório

Tempo estimado, em segundos, até à conclusão de um relatório pendente ou em processamento; nulo sem histórico ou quando concluído.

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

Data e hora de início da geração.

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

Data e hora de conclusão da geração.

expires_at
string<date-time>
obrigatório

Hora de expiração do relatório.

created_at
string<date-time>
obrigatório

Data e hora de criação.

updated_at
string<date-time>
obrigatório

Data e hora da última atualização.

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