Saltar para o conteúdo principal
POST
curl

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 de transação estável da Didit proprietário da transferência.

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 ficheiro esteja anexado.

Maximum string length: 5000
requested_documents
string[]

Obrigatório (pelo menos um) para um DOCUMENT_REQUEST, e só é permitido nesse caso.

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

Uma mensagem da mesma transferência. Uma resposta que inclua um documento satisfaz o pedido de documento a que responde.

files
file[]

Apenas multipart. Até 5 ficheiros 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 recolha, a direção é definida a partir do lado da contraparte.

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

Quem o escreveu do seu próprio lado: o e-mail de um utilizador da consola ou uma etiqueta de chave de API, ou o nome do outro VASP.

body
string
requested_documents
string[]

O que um DOCUMENT_REQUEST solicita, pelas palavras do requerente.

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

Definido num DOCUMENT_REQUEST assim que uma resposta ao mesmo incluir 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 7 de novembro de 2026