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.

Corpo

application/json
counterparty
string<uuid>
obrigatório

O id da entrada do diretório.

email
string<email>
obrigatório
Maximum string length: 254
name
string

Etiqueta opcional.

Maximum string length: 255

Resposta

O contacto foi adicionado.

Um endereço de conformidade para o qual o canal EMAIL escreve relativamente a uma entrada do diretório.

uuid
string<uuid>
counterparty
string<uuid>

O id da entrada do diretório, conforme apresentado por GET /v3/travel-rule/vasps/.

counterparty_name
string
email
string<email>
name
string

Etiqueta opcional, por exemplo, o nome da equipa.

source
enum<string>

staff: com curadoria da Didit. learned: um endereço num dos próprios domínios do VASP que respondeu a um pedido através da respetiva ligação de resposta. application: adicionado pela sua aplicação.

Opções disponíveis:
staff,
application,
learned
scope
enum<string>

platform: com curadoria da Didit ou obtido a partir de uma resposta verificada, utilizado para todos os clientes da Didit, só de leitura para si. application: privado da sua aplicação.

Opções disponíveis:
platform,
application
created_by
string

Vazio para contactos da plataforma e para contactos adicionados por uma chave de API.

verified_at
string<date-time> | null

Quando este endereço respondeu pela última vez a um pedido através da sua ligação de resposta.

is_invalid
boolean

true assim que o endereço for devolvido (bounce) ou apresentar reclamação; a via EMAIL ignora-o.

invalid_reason
enum<string>
Opções disponíveis:
,
hard_bounce,
soft_bounce,
spam_complaint,
suppressed
invalid_detail
string

O motivo do servidor de correio destinatário, quando fornecido.

invalid_at
string<date-time> | null
created_at
string<date-time>
Última modificação em 7 de novembro de 2026