Saltar para o conteúdo principal
GET
curl
As notas constituem a cronologia da transação para o analista: a mesma lista que os revisores veem em Notas no detalhe da transação na Consola. Adicione as suas próprias com Criar nota de transação, e consulte a própria transação, incluindo os respetivos activities, com Obter transação. As notas com actor_name definido como Rule Engine vêm da Didit: a ação add_note de uma regra, ou um problema ao criar a sessão de verificação da ação do utilizador para uma transação em AWAITING_USER (a sessão não pôde ser criada, ou a Didit recorreu a outro fluxo).

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

transaction_id
string<uuid>
obrigatório

UUID da transação Didit: o uuid devolvido por POST /v3/transactions/ e GET /v3/transactions/. O seu próprio txn_id não é aceite.

Parâmetros de consulta

limit
integer
padrão:50

Número de notas por página. O valor predefinido é 50. Um valor que não seja um número inteiro positivo reverte para 50; um valor acima de 1000000 devolve 400.

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

Posição de base zero da primeira nota a devolver. Prefira seguir next. Um valor que não seja um número inteiro reverte para 0; um valor superior a 1000000 devolve 400.

Intervalo necessário: 0 <= x <= 1000000

Resposta

Uma página de notas, as mais recentes primeiro.

count
integer
obrigatório

Número de notas na transação: exato até 100, limitado a 100 acima desse valor. Siga next em vez de calcular as páginas a partir deste valor.

next
string<uri> | null
obrigatório

URL absoluto da página seguinte, ou null na última página.

previous
string<uri> | null
obrigatório

URL absoluto da página anterior, ou null na primeira página.

results
object[]
obrigatório
Última modificação em 7 de novembro de 2026