Pular para o conteúdo principal
POST
curl

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. 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

Rótulo opcional.

Maximum string length: 255

Resposta

O contato foi adicionado.

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

uuid
string<uuid>
counterparty
string<uuid>

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

counterparty_name
string
email
string<email>
name
string

Rótulo opcional, por exemplo o nome da equipe.

source
enum<string>

staff: curado pela Didit. learned: um endereço em um dos próprios domínios do VASP que respondeu a uma requisição pelo link de resposta. application: adicionado pela sua aplicação.

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

platform: curado pela Didit ou aprendido a partir de uma resposta verificada, usado para todos os clientes da Didit, somente leitura para você. application: privado da sua aplicação.

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

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

verified_at
string<date-time> | null

Quando este endereço respondeu pela última vez a uma requisição por meio do seu link de resposta.

is_invalid
boolean

true depois que o endereço gerou bounce ou reclamação; o canal EMAIL o ignora.

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

O motivo informado pelo servidor de e-mail destinatário, quando houver.

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