> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar contatos de contraparte: Travel Rule por e-mail

> Lista os endereços de conformidade que o canal de e-mail da Travel Rule pode usar na sua aplicação: contatos da plataforma Didit e os seus privados.



Prompt da API de listagem de contatos de contrapartes
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`List the compliance addresses Didit's Travel Rule EMAIL rail may write to for my application.

Endpoint:
GET https://verification.didit.me/v3/travel-rule/counterparty-contacts/

Authentication:
Use the x-api-key header with my Didit API key.

Query parameters:
\- counterparty (optional) - a directory entry id from GET /v3/travel-rule/vasps/. Must be a UUID; a value that is not one answers 400 {"counterparty": ["Must be a valid UUID."]}. An empty value means no filter.
\- limit (default 50), offset. The list is newest first; count stops at 100, so 100 means 100 or more.

What to read from each contact:
\- scope - platform (curated by Didit, or learned from an address at one of the VASP's own domains that answered; used for every Didit customer, read-only) or application (private to my application).
\- counterparty, counterparty_name, email, name.
\- source - staff (curated by Didit), learned (an address that answered a request through its response link: platform scope when it is at one of the VASP's own domains, otherwise application scope, private to the application whose request it answered) or application (added by my application).
\- verified_at - when the address last answered a request through its response link.
\- is_invalid, invalid_reason (hard_bounce | soft_bounce | spam_complaint | suppressed, empty while valid), invalid_detail, invalid_at - a bounced or complaining address is skipped by the EMAIL rail. A bounce marks only the contact it reached; suppressed marks every contact at an address Didit's email delivery stopped sending to (after a permanent bounce, a spam complaint or an unsubscribe), and those contacts are valid again once sending to the address resumes.
\- created_by - empty on platform contacts and on contacts an API key added.

Add a contact with POST /v3/travel-rule/counterparty-contacts/ and delete one of mine with DELETE /v3/travel-rule/counterparty-contacts/{contact_uuid}/.

Full guide: /transaction-monitoring/travel-rule#contacts.`

\</pre>



      
      

Colar em



## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/travel-rule/counterparty-contacts/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/travel-rule/counterparty-contacts/:
    get:
      tags:
        - Travel Rule
      summary: Listar contatos da contraparte
      description: >-
        Os endereços de conformidade para os quais o canal EMAIL pode escrever
        em nome da sua aplicação: os contatos da plataforma Didit mais os
        contatos privados da própria aplicação, incluindo os que retornaram com
        falha de entrega, do mais recente para o mais antigo. Paginado com
        `limit` (padrão 50) e `offset`; `count` para em 100, então 100 significa
        100 ou mais.
      operationId: listTravelRuleCounterpartyContacts
      parameters:
        - name: counterparty
          in: query
          schema:
            type: string
            format: uuid
          description: >-
            Somente os contatos desta entrada do diretório. Deve ser um UUID; um
            valor vazio significa nenhum filtro.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
          description: Tamanho da página, padrão 50.
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
          description: Linhas a ignorar.
      responses:
        '200':
          description: Os contatos.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/TravelRuleCounterpartyContact'
              example:
                count: 1
                next: null
                previous: null
                results:
                  - uuid: 6c1f9b8e-2d4a-4f7e-8b3c-5a9d0e1f2a3b
                    counterparty: 0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91
                    counterparty_name: Example Counterparty VASP
                    email: compliance@counterparty.example
                    name: Compliance desk
                    source: application
                    scope: application
                    created_by: ''
                    verified_at: null
                    is_invalid: false
                    invalid_reason: ''
                    invalid_detail: ''
                    invalid_at: null
                    created_at: '2026-10-19T09:00:00Z'
        '400':
          description: '`counterparty` não é um UUID.'
          content:
            application/json:
              example:
                counterparty:
                  - Must be a valid UUID.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/travel-rule/counterparty-contacts/?counterparty={vasp_id}'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            for item in client.travel_rule.counterparty_contacts.list():
                print(item)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            for await (const item of
            didit.travelRule.counterpartyContacts.list()) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.TravelRule.CounterpartyContacts.ListAutoPaging(ctx, didit.TravelRuleCounterpartyContactsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            for (var item : client.travelRule().counterpartyContacts().list()) {
                System.out.println(item);
            }
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            foreach ($didit->travelRule->counterpartyContacts->list() as $item)
            {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            didit.travel_rule.counterparty_contacts.list.auto_paging_each do
            |item|
              puts item.to_h
            end
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            await foreach (var item in await
            client.TravelRule.CounterpartyContacts.ListAsync())

            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    TravelRuleCounterpartyContact:
      type: object
      description: >-
        Um endereço de conformidade para o qual o canal EMAIL escreve, referente
        a uma entrada do diretório.
      properties:
        uuid:
          type: string
          format: uuid
        counterparty:
          type: string
          format: uuid
          description: >-
            O `id` da entrada do diretório, conforme exibido por GET
            /v3/travel-rule/vasps/.
        counterparty_name:
          type: string
        email:
          type: string
          format: email
        name:
          type: string
          description: Rótulo opcional, por exemplo o nome da equipe.
        source:
          type: string
          enum:
            - staff
            - application
            - learned
          description: >-
            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.
        scope:
          type: string
          enum:
            - platform
            - application
          description: >-
            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.
        created_by:
          type: string
          description: >-
            Vazio para contatos da plataforma e para contatos adicionados por
            uma chave de API.
        verified_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Quando este endereço respondeu pela última vez a uma requisição por
            meio do seu link de resposta.
        is_invalid:
          type: boolean
          description: >-
            true depois que o endereço gerou bounce ou reclamação; o canal EMAIL
            o ignora.
        invalid_reason:
          type: string
          enum:
            - ''
            - hard_bounce
            - soft_bounce
            - spam_complaint
            - suppressed
        invalid_detail:
          type: string
          description: >-
            O motivo informado pelo servidor de e-mail destinatário, quando
            houver.
        invalid_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.