Pular para o conteúdo principal
GET
curl
As notas formam a linha do tempo do analista de uma transação: a mesma lista que os revisores veem em Notas no detalhe da transação no Console. Adicione as suas com Criar nota de transação e consulte a própria transação, incluindo suas activities, com Obter transação. As notas com actor_name definido como Rule Engine são geradas pela Didit: pela ação add_note de uma regra ou por um problema na criação da sessão de verificação que exige ação do usuário 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

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

transaction_id
string<uuid>
obrigatório

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

Parâmetros de consulta

limit
integer
padrão:50

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

Intervalo obrigatório: 1 <= x <= 1000000
offset
integer
padrão:0

Posição, a partir de zero, da primeira nota a retornar. Prefira seguir next. Um valor que não seja um número inteiro passa a ser 0; um valor acima de 1000000 retorna 400.

Intervalo obrigatório: 0 <= x <= 1000000

Resposta

Uma página de notas, da mais recente para a mais antiga.

count
integer
obrigatório

Número de notas na transação: exato até 100 e limitado a 100 acima disso. Siga next em vez de calcular páginas a partir dele.

next
string<uri> | null
obrigatório

URL absoluta da próxima página, ou null na última página.

previous
string<uri> | null
obrigatório

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

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