Saltar para o conteúdo principal
GET
curl
Liste os relatórios em toda a aplicação, com os mesmos dados da página autónoma de Relatórios da Consola. Este é o endpoint a consultar periodicamente para obter uma fila de relatórios DRAFT a aguardar validação e finalização.

Relacionados

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

UUID da organização.

application_id
string<uuid>
obrigatório

UUID da aplicação.

Parâmetros de consulta

limit
integer
padrão:50

Tamanho da página.

Intervalo necessário: x >= 1
offset
integer
padrão:0

Offset de base zero.

Intervalo necessário: x >= 0
status
enum<string>

Filtrar por estado.

Opções disponíveis:
DRAFT,
VALIDATED,
FINALIZED
report_type
enum<string>

Filtrar por tipo de relatório.

Opções disponíveis:
SAR,
STR,
CTR,
TTR,
UTR,
IFT,
CBR,
TFR
case
string<uuid>

Filtrar para relatórios neste caso.

Resposta

200 - application/json

Relatórios paginados de toda a aplicação.

count
integer

Número de linhas correspondentes, limitado a 100 por motivos de desempenho.

next
string | null
previous
string | null
results
object[]
Última modificação em 7 de novembro de 2026