Pular para o conteúdo principal
POST
curl

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 estável da transação na Didit à qual a transferência pertence.

Corpo

Envie como JSON ou como multipart/form-data com os anexos em files.

kind
enum<string>
padrão:MESSAGE
Opções disponíveis:
MESSAGE,
DOCUMENT_REQUEST
body
string

Obrigatório para uma MESSAGE, a menos que um arquivo seja anexado.

Maximum string length: 5000
requested_documents
string[]

Obrigatório (pelo menos um) para um DOCUMENT_REQUEST, e permitido somente nele.

Maximum array length: 10
Maximum string length: 255
reply_to
string<uuid> | null

Uma mensagem da mesma transferência. Uma resposta que traz um documento atende à solicitação de documento à qual responde.

files
file[]

Somente multipart. Até 5 arquivos de 10 MB cada.

Maximum array length: 5

Resposta

A mensagem armazenada.

id
string<uuid>
kind
enum<string>
Opções disponíveis:
MESSAGE,
DOCUMENT_REQUEST
direction
enum<string>

OUTBOUND é o que o próprio lado do leitor enviou. No portal de retirada, a direção é a partir do lado da contraparte.

Opções disponíveis:
INBOUND,
OUTBOUND
author
string

Quem o escreveu do próprio lado: o e-mail de um usuário do console ou o rótulo de uma chave de API, ou o nome do outro VASP.

body
string
requested_documents
string[]

O que um DOCUMENT_REQUEST solicita, nas palavras do solicitante.

reply_to
string<uuid> | null
fulfilled_at
string<date-time> | null

Definido em um DOCUMENT_REQUEST assim que uma resposta a ele contém um documento.

attachment
object | null

O documento anexado a uma mensagem, armazenado como qualquer outro documento de transação.

created_at
string<date-time>
Última modificação em 1 de novembro de 2026