Saltar para o conteúdo principal
POST
curl
Uma nota é contexto, não uma decisão: nunca altera o status, o score nem os alertas da transação. Os revisores veem-na em Notas no detalhe da transação na Consola, e as activities da transação passam a incluir uma entrada TRANSACTION_NOTE_ADDED, que pode consultar com Get transaction. Como a nota é criada com uma chave de API, não tem autor: actor_email e actor_name são null. Se precisar de indicar quem a escreveu, inclua essa informação no texto da nota. Consulte a cronologia completa com List transaction notes.

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.

Corpo

application/json
note
string
obrigatório

Nota em texto simples. Os espaços em branco no início e no fim são removidos e uma nota em branco é rejeitada. Sem limite de comprimento.

Minimum string length: 1
mentioned_emails
string<email>[]

E-mails de membros da sua organização a mencionar. Cada um tem de ser um e-mail válido de um membro da organização.

Resposta

A nota foi criada.

Uma nota na cronologia de revisão de uma transação monitorizada.

uuid
string<uuid>
obrigatório

Identificador da nota.

note
string
obrigatório

Corpo da nota em texto simples.

actor_email
string<email> | null
obrigatório

E-mail do utilizador da Consola que escreveu a nota ou alterou o estado. null para notas criadas com uma chave de API e para notas adicionadas automaticamente pela Didit.

actor_name
string | null
obrigatório

Nome de apresentação do utilizador da Console (o seu e-mail quando não tem nome). Rule Engine para as notas que a Didit adiciona automaticamente. null para notas criadas com uma chave de API.

metadata
object
obrigatório

Distingue os tipos de nota. As notas escritas através da API ou da Consola contêm mentioned_emails. Uma alteração de estado efetuada na Consola contém type: status_change com previous_status, new_status, reason_code e reason_label. As notas adicionadas pela Didit contêm source: rule_action (com rule_uuid) para a ação add_note de uma regra, ou remediation_session para um problema ao criar a sessão de verificação de ação do utilizador.

created_at
string<date-time>
obrigatório

Quando a nota foi guardada.

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