> ## 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.

# List Counterparty Contacts

> List the compliance addresses the Travel Rule email rail may write to for your application: Didit's platform contacts plus your own private ones.



List Counterparty Contacts API Prompt
        Copy prompt to clipboard



      
      

\<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>



      
      

Paste into



## OpenAPI

````yaml GET /v3/travel-rule/counterparty-contacts/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: Identity verification API. Authenticate with x-api-key header.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/travel-rule/counterparty-contacts/:
    get:
      tags:
        - Travel Rule
      summary: List counterparty contacts
      description: >-
        The compliance addresses the EMAIL rail may write to for your
        application: Didit's platform contacts plus your application's own
        private ones, bounced ones included, newest first. Paginated with
        `limit` (default 50) and `offset`; `count` stops at 100, so 100 means
        100 or more.
      operationId: listTravelRuleCounterpartyContacts
      parameters:
        - name: counterparty
          in: query
          schema:
            type: string
            format: uuid
          description: >-
            Only the contacts of this directory entry. Must be a UUID; an empty
            value means no filter.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
          description: Page size, default 50.
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
          description: Rows to skip.
      responses:
        '200':
          description: The contacts.
          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` is not a 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'
components:
  schemas:
    TravelRuleCounterpartyContact:
      type: object
      description: A compliance address the EMAIL rail writes to for one directory entry.
      properties:
        uuid:
          type: string
          format: uuid
        counterparty:
          type: string
          format: uuid
          description: The directory entry's `id`, as GET /v3/travel-rule/vasps/ shows it.
        counterparty_name:
          type: string
        email:
          type: string
          format: email
        name:
          type: string
          description: Optional label, for example the team name.
        source:
          type: string
          enum:
            - staff
            - application
            - learned
          description: >-
            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.
        scope:
          type: string
          enum:
            - platform
            - application
          description: >-
            platform: curated by Didit or learned from a verified answer, used
            for every Didit customer, read-only for you. application: private to
            your application.
        created_by:
          type: string
          description: Empty for platform contacts and for contacts an API key added.
        verified_at:
          type: string
          format: date-time
          nullable: true
          description: When this address last answered a request through its response link.
        is_invalid:
          type: boolean
          description: >-
            true once the address bounced or complained; the EMAIL rail skips
            it.
        invalid_reason:
          type: string
          enum:
            - ''
            - hard_bounce
            - soft_bounce
            - spam_complaint
            - suppressed
        invalid_detail:
          type: string
          description: The receiving mail server's reason, when it gave one.
        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: >-
        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.

````

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