Saltar para o conteúdo principal
POST
curl

Parâmetros de caminho

token
string
obrigatório

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