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

# API para listar transações relacionadas

> Liste outras transações da aplicação Didit que compartilham o vendor_data de uma parte com uma transação monitorada, da mais recente, com paginação.



Prompt da API para listar transações relacionadas
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`List the transactions related to one Didit monitored transaction through the Management API.

Endpoint:
GET https://verification.didit.me/v3/transactions/{transaction_id}/related/

Authentication:
Use the x-api-key header with my Didit API key. A scoped key needs transactions: read. Keys limited to specific workflows or to approved sessions cannot call this endpoint.

Goal:
\- See the other transactions that involve the same people or companies as this one (same applicant, or this transaction's counterparty appearing elsewhere) so I can review a transaction in context.

Path parameter:
\- transaction_id: the Didit transaction uuid, not my own txn_id.

Behavior:
\- A transaction is related when one of its parties, in any role, has the same vendor_data as one of this transaction's parties. Matching uses vendor_data only, within my application.
\- The transaction itself is never returned. Parties without vendor_data are ignored, so if none of this transaction's parties has a vendor_data the result is always empty.
\- Ordered by txn_date, newest first, then created_at.
\- Paginated with limit (default 50) and offset. count is exact up to 100 and capped at 100 above that, so keep following next until it is null.

Example call:
curl -X GET "https://verification.didit.me/v3/transactions/{transaction_id}/related/?limit=50" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- results[].uuid: use it with GET /v3/transactions/{transaction_id}/ for the full detail.
\- results[].txn_id, status, score, severity, amount, currency, txn_date: the summary of each related transaction.
\- results[].subject_vendor_data and counterparty_vendor_data: which party links it to this transaction.
\- next: URL of the next page, null on the last page.

Failure modes:
\- 400: limit or offset above 1000000.
\- 401: the API key has expired.
\- 403: missing API key (a wrong, revoked or expired key gets 401) ({"detail": "You do not have permission to perform this action."}), a scoped key without transactions: read, a key with workflow or status limits, or a request from outside the key's IP allowlist.
\- 404: no transaction with this uuid in my application ({"detail": "No Transaction matches the given query."}).
\- 429: more than 600 GET requests per minute with this key; wait Retry-After seconds and retry.

Side effects: none. This is a pure read.

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

Colar em

As transações relacionadas são vinculadas pelo `vendor_data` que você envia em cada parte ao [enviar uma transação](https://docs.didit.me/pt-br/transaction-monitoring/transactions.md#titular-e-contraparte). Envie sempre o mesmo `vendor_data` para a mesma pessoa ou empresa, e este endpoint retorna o histórico completo dela em relação a qualquer transação: a mesma lista que os revisores veem em **Transações relacionadas** no [detalhe da transação](https://docs.didit.me/pt-br/transaction-monitoring/console.md#detalhes-da-transação) no Console.Cada resultado tem o mesmo formato resumido de [Listar transações](https://docs.didit.me/pt-br/management-api/transactions/list.md). Chame [Obter transação](https://docs.didit.me/pt-br/management-api/transactions/get.md) com o `uuid` de um resultado para ver as partes, os alertas e as execuções de regras dele.


## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/transactions/{transaction_id}/related/
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/transactions/{transaction_id}/related/:
    get:
      tags:
        - Transactions
      summary: Listar transações relacionadas
      description: >-
        Lista as outras transações da sua aplicação que envolvem as mesmas
        pessoas ou empresas desta. Uma transação é considerada relacionada
        quando qualquer uma de suas partes, em qualquer função, tem o mesmo
        `vendor_data` que uma das partes desta transação. A própria transação
        nunca é retornada, e partes sem `vendor_data` são ignoradas: quando
        nenhuma das partes desta transação tem um, o resultado é sempre vazio.


        Os resultados usam o formato resumido de `GET /v3/transactions/`, dos
        mais recentes para os mais antigos (`txn_date`, depois `created_at`). A
        paginação usa `limit` e `offset`. `count` é exato até 100 e fica
        limitado a 100 acima disso, então siga `next` até que seja `null`.


        Uma chave de API com escopo precisa de `transactions: read`. Uma chave
        limitada a alguns fluxos ou a sessões aprovadas não pode chamar este
        endpoint. Envie o mesmo `vendor_data` para a mesma pessoa ou empresa em
        toda
        [transação](https://docs.didit.me/pt-br/transaction-monitoring/transactions#titular-e-contraparte)
        para que esta lista fique completa.
      operationId: list_related_transactions
      parameters:
        - name: transaction_id
          in: path
          required: true
          description: >-
            UUID da transação na Didit: o `uuid` retornado por `POST
            /v3/transactions/` e `GET /v3/transactions/`. O seu próprio `txn_id`
            não é aceito.
          schema:
            type: string
            format: uuid
          example: abcdef12-3456-7890-abcd-ef1234567890
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
          description: >-
            Número de transações por página. O padrão é 50. Um valor que não
            seja um inteiro positivo volta para 50; um valor acima de 1000000
            retorna `400`.
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            maximum: 1000000
            minimum: 0
            default: 0
          description: >-
            Posição, a partir de zero, da primeira transação a retornar. Prefira
            seguir `next`. Um valor que não seja um número inteiro passa a ser
            0; um valor acima de 1000000 retorna `400`.
      responses:
        '200':
          description: >-
            Uma página de transações relacionadas, da mais recente para a mais
            antiga.
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - next
                  - previous
                  - results
                properties:
                  count:
                    type: integer
                    description: >-
                      Número de transações relacionadas: exato até 100 e
                      limitado a 100 acima disso. Siga `next` em vez de calcular
                      páginas a partir dele.
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      URL absoluta da próxima página, ou `null` na última
                      página.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      URL absoluta da página anterior, ou `null` na primeira
                      página.
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/TransactionSummary'
              examples:
                One related transaction:
                  value:
                    count: 1
                    next: null
                    previous: null
                    results:
                      - uuid: abcdef99-3456-4890-abcd-ef1234567890
                        transaction_number: 4087
                        txn_id: your-txn-2026-10-02-017
                        transaction_type: finance
                        action_type: deposit
                        status: APPROVED
                        source: LIVE
                        direction: INBOUND
                        amount: '250'
                        currency: EUR
                        currency_type: fiat
                        preferred_currency_amount: '270.08'
                        preferred_currency_code: USD
                        payment_details: Card top-up
                        txn_date: '2026-10-02T14:10:00Z'
                        created_at: '2026-10-02T14:10:03.512244Z'
                        score: 12
                        severity: LOW
                        decision_reason_code: null
                        decision_reason_label: null
                        tags: []
                        subject_name: Maria Garcia
                        subject_vendor_data: user-12345
                        subject_type: user
                        subject_uuid: e1111111-2222-4333-8444-555555555555
                        counterparty_name: null
                        counterparty_vendor_data: null
                        counterparty_country: null
                        subject_country: ESP
                        assigned_to_name: null
                        travel_rule_status: null
                        application_id: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
                        application_name: Production app
                        organization_id: 11111111-2222-3333-4444-555555555555
                        organization_name: Example Org
                No party has vendor_data:
                  value:
                    count: 0
                    next: null
                    previous: null
                    results: []
        '400':
          description: >-
            `limit` ou `offset` é maior que 1000000. O corpo é um array JSON de
            mensagens, não um objeto.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
              examples:
                Limit too large:
                  value:
                    - limit must not exceed 1000000.
                Offset too large:
                  value:
                    - offset must not exceed 1000000.
        '401':
          description: >-
            A chave de API expirou. Somente uma chave criada com data de
            validade pode expirar; após essa data, toda requisição feita com ela
            responde `401`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Expired key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            A requisição não é permitida. Uma chave ausente recebe a mensagem
            genérica; uma chave incorreta, revogada ou expirada recebe `401`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Missing or invalid key:
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without transactions read:
                  value:
                    detail: This API key has no read access to transactions.
                Key limited to workflows or approved sessions:
                  value:
                    detail: >-
                      This API key only reaches sessions inside its workflow or
                      status limits, so it can't use this endpoint.
                Outside the key's IP list:
                  value:
                    detail: This API key can't be used from this IP address.
        '404':
          description: >-
            Não existe nenhuma transação com este UUID na aplicação (nunca
            criada, excluída ou pertencente a outra aplicação). Um
            `transaction_id` que não seja um UUID não chega à API: ele retorna
            uma página HTML `404` em vez deste corpo JSON.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Not found:
                  value:
                    detail: No Transaction matches the given query.
        '429':
          description: >-
            Mais de 600 requisições GET por minuto com esta chave de API.
            Aguarde o número de segundos indicado em `Retry-After` e tente
            novamente.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Throttled:
                  value:
                    detail: >-
                      GET request rate limit exceeded. You can make up to 600
                      requests per minute.
          headers:
            Retry-After:
              description: Segundos até a janela atual de um minuto ser reiniciada.
              schema:
                type: integer
                example: 23
            X-RateLimit-Limit:
              description: Requisições permitidas por minuto nesta cota.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requisições restantes na janela atual.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Horário Unix em que a janela é reiniciada.
              schema:
                type: integer
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/transactions/abcdef12-3456-7890-abcd-ef1234567890/related/?limit=50'
            \
              -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.transactions.list_related(
                "abcdef12-3456-7890-abcd-ef1234567890",
            ):
                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.transactions.listRelated("abcdef12-3456-7890-abcd-ef1234567890"))
            {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Transactions.ListRelatedAutoPaging(ctx, \"abcdef12-3456-7890-abcd-ef1234567890\", didit.TransactionsListRelatedParams{})\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.transactions().listRelated("abcdef12-3456-7890-abcd-ef1234567890"))
            {
                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->transactions->listRelated('abcdef12-3456-7890-abcd-ef1234567890')
            as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            didit.transactions.list_related("abcdef12-3456-7890-abcd-ef1234567890").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.Transactions.ListRelatedAsync("abcdef12-3456-7890-abcd-ef1234567890"))

            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    TransactionSummary:
      type: object
      description: >-
        Resumo de uma transação monitorada, no formato listado por `GET
        /v3/transactions/`. Chame `GET /v3/transactions/{transaction_id}/` com
        `uuid` para obter partes, alertas e execuções de regras.
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            UUID da transação na Didit. Use-o como `{transaction_id}` nos
            endpoints de transação.
        transaction_number:
          type: integer
          nullable: true
          description: Número sequencial no escopo da aplicação exibido no Console.
        txn_id:
          type: string
          nullable: true
          description: >-
            Seu próprio identificador da chamada de criação. Único por
            aplicação.
        transaction_type:
          type: string
          description: >-
            Categoria conforme armazenada: `finance`, `kyc`, `travelRule`,
            `userPlatformEvent`, `gamblingBet`, `gamblingLimitChange`,
            `gamblingBonusChange` ou `auditTrailEvent`.
        action_type:
          type: string
          description: Subtipo dentro da categoria, por exemplo `withdrawal`.
        status:
          type: string
          enum:
            - APPROVED
            - IN_REVIEW
            - DECLINED
            - AWAITING_USER
          description: Veredito de monitoramento atual.
        source:
          type: string
          enum:
            - LIVE
            - IMPORTED
          description: >-
            `LIVE` para transações enviadas para monitoramento, `IMPORTED` para
            importações históricas.
        direction:
          type: string
          enum:
            - INBOUND
            - OUTBOUND
          description: Direção em relação ao titular.
        amount:
          type: string
          description: >-
            Valor como string decimal sem zeros à direita (até 18 casas
            decimais).
        currency:
          type: string
          description: Código da moeda ou símbolo do criptoativo de `amount`.
        currency_type:
          type: string
          nullable: true
          description: '`fiat` ou `crypto`, quando conhecido.'
        preferred_currency_amount:
          type: string
          nullable: true
          description: >-
            `amount` convertido para a moeda preferida da aplicação, quando
            havia uma taxa disponível.
        preferred_currency_code:
          type: string
          nullable: true
          description: Moeda de `preferred_currency_amount`.
        payment_details:
          type: string
          nullable: true
          description: Referência de pagamento em texto livre.
        txn_date:
          type: string
          format: date-time
          description: Quando a transação ocorreu.
        created_at:
          type: string
          format: date-time
          description: Quando a Didit o registrou.
        score:
          type: integer
          description: Pontuação de risco. Quanto maior, mais arriscado.
        severity:
          type: string
          nullable: true
          enum:
            - UNKNOWN
            - LOW
            - MEDIUM
            - HIGH
            - CRITICAL
            - null
          description: Gravidade do risco, `null` até que algo a defina.
        decision_reason_code:
          type: string
          nullable: true
          description: Motivo legível por máquina do `status` atual.
        decision_reason_label:
          type: string
          nullable: true
          description: Rótulo legível de `decision_reason_code`.
        tags:
          type: array
          description: Tags da transação.
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
                description: Cor hexadecimal, por exemplo, `#F59E0B`.
              description:
                type: string
                nullable: true
              source:
                type: string
                enum:
                  - didit
                  - custom
                description: Tag predefinida da Didit ou personalizada.
        subject_name:
          type: string
          nullable: true
          description: Nome completo da parte `APPLICANT`.
        subject_vendor_data:
          type: string
          nullable: true
          description: Seu `vendor_data` do solicitante.
        subject_type:
          type: string
          nullable: true
          enum:
            - user
            - business
            - null
          description: >-
            Se o solicitante está vinculado a um usuário ou a uma empresa da
            Didit; `null` quando não está vinculado a nenhum dos dois.
        subject_uuid:
          type: string
          format: uuid
          nullable: true
          description: >-
            UUID do usuário ou da empresa Didit ao qual o solicitante está
            vinculado.
        subject_country:
          type: string
          nullable: true
          description: Código do país do solicitante.
        counterparty_name:
          type: string
          nullable: true
          description: Nome completo da parte `COUNTERPARTY`, se houver.
        counterparty_vendor_data:
          type: string
          nullable: true
          description: Seu `vendor_data` da contraparte.
        counterparty_country:
          type: string
          nullable: true
          description: Código do país da contraparte.
        assigned_to_name:
          type: string
          nullable: true
          description: Nome do revisor do Console atribuído à transação.
        travel_rule_status:
          type: string
          nullable: true
          description: >-
            Status da transferência de Travel Rule da transação, ou `null`
            quando ela não tem nenhuma.
        application_id:
          type: string
          format: uuid
          description: Aplicação à qual a transação pertence.
        application_name:
          type: string
          nullable: true
          description: Nome dessa aplicação.
        organization_id:
          type: string
          format: uuid
          description: Organização proprietária da aplicação.
        organization_name:
          type: string
          nullable: true
          description: Nome dessa organização.
  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.