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.

Body

application/json
counterparty
string<uuid>
required

The directory entry's id.

email
string<email>
required
Maximum string length: 254
name
string

Optional label.

Maximum string length: 255

Response

The contact was added.

A compliance address the EMAIL rail writes to for one directory entry.

uuid
string<uuid>
counterparty
string<uuid>

The directory entry's id, as GET /v3/travel-rule/vasps/ shows it.

counterparty_name
string
email
string<email>
name
string

Optional label, for example the team name.

source
enum<string>

staff: curated by Didit. learned: an address at one of the VASP's own domains that answered a request through its response link. application: added by your application.

Available options:
staff,
application,
learned
scope
enum<string>

platform: curated by Didit or learned from a verified answer, used for every Didit customer, read-only for you. application: private to your application.

Available options:
platform,
application
created_by
string

Empty for platform contacts and for contacts an API key added.

verified_at
string<date-time> | null

When this address last answered a request through its response link.

is_invalid
boolean

true once the address bounced or complained; the EMAIL rail skips it.

invalid_reason
enum<string>
Available options:
,
hard_bounce,
soft_bounce,
spam_complaint,
suppressed
invalid_detail
string

The receiving mail server's reason, when it gave one.

invalid_at
string<date-time> | null
created_at
string<date-time>