Skip to main content
POST
curl

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

transaction_id
string<uuid>
required

Didit-stable transaction UUID that owns the transfer.

Body

Send as JSON, or as multipart/form-data with the attachments in files.

kind
enum<string>
default:MESSAGE
Available options:
MESSAGE,
DOCUMENT_REQUEST
body
string

Required for a MESSAGE unless a file is attached.

Maximum string length: 5000
requested_documents
string[]

Required (at least one) for a DOCUMENT_REQUEST, and only allowed there.

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

A message of the same transfer. A reply that carries a document fulfils the document request it answers.

files
file[]

Multipart only. Up to 5 files of 10 MB each.

Maximum array length: 5

Response

The stored message.

id
string<uuid>
kind
enum<string>
Available options:
MESSAGE,
DOCUMENT_REQUEST
direction
enum<string>

OUTBOUND is what the reader's own side sent. In the pickup portal the direction is from the counterparty's side.

Available options:
INBOUND,
OUTBOUND
author
string

Who wrote it on its own side: a console user's email or an API key label, or the other VASP's name.

body
string
requested_documents
string[]

What a DOCUMENT_REQUEST asks for, in the requester's words.

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

Set on a DOCUMENT_REQUEST once a reply to it carries a document.

attachment
object | null

The document attached to a message, stored like any other transaction document.

created_at
string<date-time>