Pular para o conteúdo principal
POST
curl
Uma nota é contexto, não uma decisão: ela nunca altera o status, o score nem os alertas da transação. Os revisores a veem em Notas no detalhe da transação no Console, e as activities da transação ganham uma entrada TRANSACTION_NOTE_ADDED, que você pode ler com Obter transação. Como a nota vem de uma chave de API, ela não tem autor: actor_email e actor_name são null. Se você precisar mostrar quem a escreveu, inclua essa informação no texto da nota. Leia a linha do tempo completa com Listar notas da transação.

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.

Corpo

application/json
note
string
obrigatório

Nota em texto simples. Espaços em branco no início e no fim são removidos, e uma nota vazia é rejeitada. Sem limite de tamanho.

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

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

Resposta

A nota foi criada.

Uma nota na linha do tempo de revisão de uma transação monitorada.

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 usuário do Console que escreveu a nota ou alterou o status. null para notas criadas com uma chave de API e para notas que a Didit adiciona automaticamente.

actor_name
string | null
obrigatório

Nome de exibição do usuário do Console (o e-mail dele quando não tem nome). Rule Engine nas notas que a Didit adiciona automaticamente. null para notas criadas com uma chave de API.

metadata
object
obrigatório

Distingue os tipos de nota. Notas escritas pela API ou pelo Console trazem mentioned_emails. Uma mudança de status feita no Console traz type: status_change com previous_status, new_status, reason_code e reason_label. Notas adicionadas pela Didit trazem 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 usuário.

created_at
string<date-time>
obrigatório

Quando a nota foi armazenada.

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