> ## 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 de listagem de transações: monitorização KYT > Obtenha as transações monitorizadas no Didit com pontuações de risco, gravidade, contrapartes, etiquetas e estado de triagem. KYT por chamada, sem contratos. Prompt da API para listar transações Copiar o prompt para a área de transferência \

\`List monitored transactions for my Didit application through the Management API.

Endpoint:
GET https://verification.didit.me/v3/transactions/

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

Goal:
\- Retrieve a paginated list of high-level transaction summaries (score, severity, status, parties, tags, decision metadata) — suitable for back-office review screens, fraud dashboards, and audit exports.

Query parameters:
\- limit - page size (default 50, min 1).
\- offset — zero-based offset (default 0). Prefer following the next URL from the previous page.

Ordering & pagination:
\- Ordered by txn_date descending (most recent first), with created_at as a tie-breaker.
\- count is a bounded counter (exact up to 100, capped above). Use total_transactions when present for the true count.
\- Transactions deleted via the Console are not returned.

Filtering:
\- Besides limit / offset, this endpoint accepts travel_rule_status, an exact Travel Rule status (for example ON_HOLD), and then returns only transactions whose Travel Rule transfer is in that status.
count follows this filter, but total_transactions always counts every transaction in the application.
\- It also accepts assignee, a comma-separated list where any value matches: me (the calling reviewer, with a user token), unassigned, rules (decided by the rules alone, no reviewer involved), or a member email.
\- For other filtering (party, status, severity, date range), use the Console UI.

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

What to read from each row:
\- uuid — stable Didit transaction id; use as {transaction_id} in GET /v3/transactions/{transaction_id}/.
\- transaction_number — application-scoped sequential number shown in Console.
\- txn_id — the identifier you supplied at create time (max 128 chars, unique per application).
\- status, score, severity, decision_reason_code, decision_reason_label — live monitoring verdict.
\- direction, amount, currency — raw submission. amount is a decimal string.
\- subject_name / subject_vendor_data / subject_country — denormalized APPLICANT party fields.
\- counterparty_name / counterparty_vendor_data / counterparty_country — denormalized COUNTERPARTY fields (may be null).
\- tags — Console tags (uuid, name, color).
\- assigned_to_name — Console reviewer who owns the transaction.
\- travel_rule_status - the status of the transaction's Travel Rule transfer (for example COMPLETED), or null when it has none.
\- travel_rule - the same Travel Rule block as GET /v3/transactions/{transaction_id}/ (status, direction, rail, counterparty_vasp, delivery, discovery, reason, next_actions and the rest), or null when the transaction has none.
Read reason and next_actions to see why each COUNTERPARTY_VASP_NOT_FOUND or COUNTERPARTY_VASP_NOT_REACHABLE transfer is stuck without one read per transaction.

Failure modes:
\- 403 - missing x-api-key (a wrong, revoked or expired key gets 401), or a key without permission for this action; the body is a { "detail": "..." } envelope.
\- 429 — rate limited; back off and retry.

Side effects: none. This is a pure read.

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

\
Colar em ## OpenAPI ````yaml pt/openapi-25.json GET /v3/transactions/ 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/: get: tags: - Transactions summary: Listar transações description: >- Lista paginada de transações monitorizadas, as mais recentes primeiro (`txn_date` desc). `count` está limitado a 100; utilize `total_transactions` para obter o número real de linhas. Este endpoint não suporta parâmetros de filtragem ou de pesquisa. operationId: listTransactions parameters: - name: limit in: query schema: type: integer default: 50 minimum: 1 maximum: 1000000 description: >- Tamanho da página. A predefinição é 50 quando omitido. Não existe um limite máximo imposto, mas mantenha as páginas pequenas para reduzir a latência. - name: offset in: query schema: type: integer maximum: 1000000 minimum: 0 default: 0 description: >- Offset de base zero do primeiro registo a devolver. Prefira seguir o URL `next` da página anterior. - name: travel_rule_status in: query required: false schema: type: string description: >- Devolve apenas as transações cuja transferência da Travel Rule esteja neste estado exato (por exemplo, `ON_HOLD` ou `AWAITING_COUNTERPARTY`). O `count` segue este filtro; o `total_transactions` continua a contabilizar todas as transações na aplicação. - name: assignee in: query required: false schema: type: string description: >- Separados por vírgulas; uma transação corresponde quando cumpre qualquer valor. `unassigned` é o que ninguém atribuiu ainda, `rules` é o que as regras decidiram por si próprias sem um revisor, e um e-mail de membro corresponde ao revisor atribuído a ela. `me` é o revisor com sessão iniciada na Consola, pelo que uma chave de API que envie `me` recebe `400`. responses: '200': description: Lista paginada de resumos de transações, os mais recentes primeiro. content: application/json: schema: type: object properties: count: type: integer description: >- Contagem limitada de transações correspondentes (exata até 100, limitada a partir daí). Utilize `total_transactions` para obter a contagem real ao paginar. next: type: string nullable: true description: >- URL absoluto da página seguinte, ou `null` na última página. previous: type: string nullable: true description: >- URL absoluto da página anterior, ou `null` na primeira página. total_transactions: type: integer description: >- Contagem total exata de transações (não eliminadas) para a aplicação. Presente em respostas paginadas. results: type: array items: type: object properties: uuid: type: string format: uuid description: >- Identificador Didit estável da transação. Utilize como `{transaction_id}` em chamadas de detalhes/notas/relacionadas. transaction_number: type: integer description: >- Número sequencial da transação no âmbito da aplicação apresentado na Consola (ex.: `4123`). txn_id: type: string description: >- Identificador fornecido pelo cliente a partir da chamada de criação (máx. 128 carateres). Único por aplicação. transaction_type: type: string description: >- Categoria de nível superior tal como armazenada: `finance`, `kyc`, `travelRule`, `userPlatformEvent`, `gamblingBet`, `gamblingLimitChange`, `gamblingBonusChange`, `auditTrailEvent`. Tenha em atenção que os valores com várias palavras são devolvidos em camelCase, mesmo quando enviados em snake_case. action_type: type: string description: >- Subtipo dentro da categoria (p. ex. `deposit`, `withdrawal`, `transfer`). status: type: string enum: - APPROVED - IN_REVIEW - DECLINED - AWAITING_USER description: Veredito atual de monitorização. direction: type: string enum: - INBOUND - OUTBOUND description: >- Direção em relação ao sujeito. Armazenada em maiúsculas independentemente da capitalização submetida. amount: type: string description: >- Montante da transação como uma string decimal sem zeros à direita (por exemplo, `"1500"`, `"0.5"`, `"0.123456789012345678"`). Até 18 casas decimais. currency: type: string description: >- Código de moeda de `amount`. Qualquer código alfabético ISO 4217 é aceite (por exemplo, `EUR`, `USD`, `NGN`), bem como um símbolo de ativo criptográfico (por exemplo, `BTC`). Dê preferência a um código atualmente em circulação. Nem todos os códigos aceites têm uma taxa de câmbio: quando nenhuma estiver disponível para o código (por exemplo, a unidade contabilística ISO `XSU`, ou um símbolo criptográfico que a Didit não precifique), a conversão automática falha e `preferred_currency_amount` é devolvido a null, a menos que o pedido tenha fornecido um `amount_in_default_currency` pré-convertido. preferred_currency_amount: type: string nullable: true description: >- `amount` convertido para a moeda preferida da aplicação, quando disponível. preferred_currency_code: type: string nullable: true description: >- Código de moeda preferencial utilizado para `preferred_currency_amount` - a moeda base da aplicação, qualquer código ISO 4217 atualmente em circulação. Um código sem taxa de câmbio disponível deixa `preferred_currency_amount` como null, a menos que o pedido tenha fornecido um `amount_in_default_currency` pré-convertido. payment_details: type: string nullable: true description: >- Referência ou memorando de pagamento em texto livre proveniente do envio. score: type: integer description: >- Pontuação de risco (normalmente 0–100). Mais alta = maior risco. severity: type: string nullable: true enum: - UNKNOWN - LOW - MEDIUM - HIGH - CRITICAL description: >- Gravidade de risco categórica definida por regras/fornecedores (`UNKNOWN`, `LOW`, `MEDIUM`, `HIGH`, `CRITICAL`). `null` até que algo a defina. subject_name: type: string nullable: true description: Nome completo da parte `APPLICANT`. subject_vendor_data: type: string nullable: true description: >- O seu identificador interno de utilizador/empresa para o requerente. subject_country: type: string nullable: true description: >- Código do país do requerente, a partir do `address.country` submetido (normalmente ISO 3166-1 alpha-3). counterparty_name: type: string nullable: true description: Nome completo da parte `COUNTERPARTY`, se existir. counterparty_vendor_data: type: string nullable: true description: O seu identificador interno para a contraparte. counterparty_country: type: string nullable: true description: >- Código do país da contraparte, a partir do `address.country` submetido. tags: type: array items: type: object properties: uuid: type: string format: uuid name: type: string color: type: string description: type: string nullable: true source: type: string enum: - didit - custom description: >- Se a etiqueta é uma predefinição da Didit ou uma etiqueta personalizada. description: >- Etiquetas associadas à transação (manualmente ou por regras). txn_date: type: string format: date-time description: >- Quando a transação ocorreu (a partir de `transaction_at` no momento da criação). created_at: type: string format: date-time description: Quando a Didit registou a submissão. decision_reason_code: type: string nullable: true description: >- Motivo legível por máquina para o `status` atual (por exemplo, `WALLET_HIGH_RISK`). decision_reason_label: type: string nullable: true description: Rótulo legível para `decision_reason_code`. assigned_to_name: type: string nullable: true description: >- Nome de apresentação do revisor da Console atribuído a esta transação. travel_rule_status: type: string nullable: true description: >- Estado da transferência da Travel Rule da transação (por exemplo, `COMPLETED`), ou `null` caso não tenha nenhuma. travel_rule: nullable: true allOf: - $ref: '#/components/schemas/TransactionTravelRule' description: >- A transferência de Travel Rule da transação, o mesmo bloco que `travel_rule` em `GET /v3/transactions/{transaction_id}/`, ou `null` quando a transação não tem nenhuma. examples: Single transaction: value: count: 1 next: null previous: null total_transactions: 1 results: - uuid: abcdef12-3456-4890-abcd-ef1234567890 transaction_number: 4123 txn_id: your-txn-2026-05-17-001 transaction_type: finance action_type: withdrawal status: IN_REVIEW direction: OUTBOUND amount: '1500' currency: EUR preferred_currency_amount: '1620.45' preferred_currency_code: USD payment_details: Withdrawal to crypto wallet txn_date: '2026-05-17T08:42:00Z' created_at: '2026-05-17T08:42:11Z' score: 78 severity: HIGH decision_reason_code: WALLET_HIGH_RISK decision_reason_label: Destination wallet flagged as high risk tags: - uuid: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d name: Manual review color: '#F59E0B' description: null source: custom subject_name: Maria Garcia subject_vendor_data: user-12345 counterparty_name: null counterparty_vendor_data: null counterparty_country: null subject_country: null assigned_to_name: Alex Reviewer travel_rule_status: null travel_rule: null '403': description: >- Chave de API em falta, inválida ou revogada, ou a chave não pode listar transações para esta aplicação. Uma chave em falta devolve `403`; uma chave incorreta, revogada ou expirada devolve `401`. content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. '429': description: >- Limite de pedidos excedido; reduza a frequência e tente novamente após o intervalo indicado em `Retry-After`. content: application/json: examples: Throttled: value: detail: Request was throttled. Expected available in 30 seconds. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X GET 'https://verification.didit.me/v3/transactions/?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(): 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.list()) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Transactions.ListAutoPaging(ctx, didit.TransactionsListParams{})\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().list()) { System.out.println(item); } - lang: php label: PHP source: |- transactions->list() as $item) { print_r($item->toArray()); } - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.transactions.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.Transactions.ListAsync()) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: TransactionTravelRule: type: object description: >- A transferência de Travel Rule de uma transação, tal como `GET /v3/transactions/{transaction_id}/`, o `201` de `POST /v3/transactions/` e cada linha de `GET /v3/transactions/` a devolvem. `direction`, `rail`, `counterparty_vasp`, `delivery`, `discovery`, `reason` e `next_actions` têm o mesmo formato que em `PATCH /v3/transactions/{transaction_id}/travel-rule/`, para que uma leitura de uma transação indique por que motivo a transferência está retida e o que fazer para prosseguir. properties: uuid: type: string format: uuid status: type: string protocol: type: string nullable: true required: type: boolean obligations_count: type: integer originator_data: type: object description: >- Parte ordenante. Para uma transferência de entrada, os valores da contraparte são ocultados até que a propriedade seja confirmada. beneficiary_data: type: object description: >- Parte beneficiária. Para uma transferência de entrada, os valores da contraparte são ocultados até que a propriedade seja confirmada. name_match: type: object nullable: true description: >- A comparação de nomes que decidiu a transferência (pontuação e rigor). Nulo até que uma seja executada. Os nomes comparados são mascarados em conjunto com as partes. data_match: $ref: '#/components/schemas/TravelRuleDataMatch' mismatched_fields: type: array items: type: string description: >- Atalho para `data_match.mismatched_fields`. Vazio quando nada difere. data_unmasked: $ref: '#/components/schemas/TravelRuleDataUnmasked' data_masked: type: boolean description: >- Verdadeiro enquanto os dados pessoais da contraparte estiverem mascarados nesta resposta. metadata: type: object direction: type: string enum: - INBOUND - OUTBOUND description: A que lado da troca pertence esta transferência. rail: type: string nullable: true description: >- O canal através do qual a transferência ocorreu: `INTERNAL`, `TRP`, `GTR`, `TRUST`, `VERIFYVASP`, `SYGNA` ou `EMAIL` (`TEST_VASP` numa aplicação sandbox, quando o Didit Test VASP respondeu), ou `null` até que um canal seja escolhido. counterparty_vasp: type: object nullable: true properties: name: type: string lei: type: string dd_score: type: integer description: >- Pontuação de diligência devida de 0 a 100, onde quanto mais alto, melhor. Mesma escala que no diretório VASP. dd_score_breakdown: type: object description: >- Contribuições por componente para dd_score, um objeto por componente como no diretório VASP (jurisdiction, verification, protocol, lei, history, essentials, responsiveness), cada um com {points, max, reason, detail}. {} até que a contraparte tenha sido avaliada. additionalProperties: type: object properties: points: type: number description: Pontos atribuídos a este componente. max: type: integer description: Pontos máximos que este componente pode atribuir. reason: type: string description: Código legível por máquina do veredito do componente. detail: type: string description: Motivo legível por humanos para os pontos atribuídos. dd_assessed_at: type: string format: date-time nullable: true description: >- Quando a avaliação de diligência devida foi executada pela última vez. Nulo até que a contraparte tenha sido avaliada. description: >- O registo de diretório da contraparte, ou `null` quando a transferência não associa nenhum. delivery: nullable: true allOf: - $ref: '#/components/schemas/TravelRuleDelivery' description: >- A mensagem mais recente que a transferência deve a outra parte. `null` quando não deve nenhuma, por exemplo abaixo de `threshold_amount` ou para uma carteira autocustodiada declarada. discovery: type: array description: >- Como a Didit procurou a contraparte, uma entrada por passo executado. Vazio quando não foi executada qualquer deteção, por exemplo, numa transferência recebida. items: $ref: '#/components/schemas/TravelRuleDiscoveryStep' reason: type: string description: >- O motivo pelo qual uma transferência `COUNTERPARTY_VASP_NOT_FOUND` ou `COUNTERPARTY_VASP_NOT_REACHABLE` está bloqueada; `""` para qualquer outro estado. Uma falha na entrega determina-o primeiro, apenas em `COUNTERPARTY_VASP_NOT_REACHABLE`: `email_undeliverable` (o fornecedor de e-mail recusou o e-mail de conformidade e não resta nenhum endereço para tentar: quando foi enviado, num lembrete ou como uma devolução permanente comunicada posteriormente) ou `delivery_failed` (o canal que estava a efetuar a entrega falhou definitivamente: um canal de rede recusou a mensagem ou esgotou as tentativas, um host de identidade `TRP` não respondeu, ou o host `TRP` da contraparte não aceitou a consulta). Caso contrário, o rastreio de `discovery` determina-o: `awaiting_end_user` (nenhum passo identificou uma contraparte que a Didit consiga contactar), `directory_match_no_route` (um passo identificou um VASP de diretório que não tem rota), `picked_member_without_proven_wallet` (o utilizador final escolheu um cliente Didit que não comprovou o controlo da carteira), ou `no_directory_match` quando o rastreio não fornece outro motivo. Um novo envio faz avançar a transferência, pelo que o motivo é limpo. Consulte [Por que motivo uma transferência está bloqueada](/pt/transaction-monitoring/travel-rule#por-que-motivo-uma-transferência-está-bloqueada). next_actions: type: array description: >- O que faz a transferência avançar; `[]` para qualquer estado exceto `COUNTERPARTY_VASP_NOT_FOUND` ou `COUNTERPARTY_VASP_NOT_REACHABLE`. `email_undeliverable` disponibiliza `update_compliance_email` e, em seguida, `resend`. `delivery_failed` disponibiliza `resend`. Um motivo de descoberta disponibiliza `select_counterparty_vasp`, `declare_self_hosted`, `add_vasp_hint` e `resend`. items: $ref: '#/components/schemas/TravelRuleNextAction' chain_details: $ref: '#/components/schemas/TravelRuleChainDetails' TravelRuleDataMatch: type: object nullable: true description: >- Comparação campo a campo dos dados das partes da transferência com o que a outra parte sabe sobre o titular da carteira. Indica campos e resultados, nunca valores, para que permaneça legível enquanto os dados da contraparte estiverem mascarados. Null até que uma comparação tenha sido executada. properties: matched: type: boolean description: True quando nenhum campo comparado difere. mismatched_fields: type: array items: type: string enum: - name - date_of_birth - address - account description: Os campos que diferem. fields: type: object description: >- Uma entrada por campo comparado para o tipo de entidade da parte (`name`, `date_of_birth`, `address`, `account`; uma empresa não tem `date_of_birth`). additionalProperties: type: object properties: result: type: string enum: - matched - mismatched - not_compared description: >- `not_compared` quando a regra é `NONE` ou um dos lados não tem valor para o campo. strictness: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY TravelRuleDataUnmasked: type: object nullable: true description: >- Registo de auditoria do momento em que os dados da contraparte foram desmascarados. Nulo enquanto os dados ainda estiverem mascarados e para transferências de saída. properties: at: type: string format: date-time reason: type: string enum: - ownership_confirmed - wallet_proof - address_book_match - own_verified_wallet - inquiry_approved - known_payment_method - travel_address description: >- O que confirmou a propriedade: ownership_confirmed (a sua confirmação através da consola ou da API), wallet_proof (uma prova de carteira no widget, ou uma transferência de entrada INTERNAL, definida quando é criada), address_book_match (uma carteira verificada do livro de endereços), own_verified_wallet (a carteira própria verificada do seu utilizador), inquiry_approved (a sua aprovação de um pedido TRP de entrada ou de uma mensagem GTR ou Sygna), known_payment_method (uma carteira com a qual o seu utilizador já pagou) ou travel_address (o Travel Address por carteira que nomeou a carteira). actor: type: string description: >- Quem o confirmou: o e-mail do utilizador da consola ou a etiqueta da chave de API. Em branco para uma decisão automática. TravelRuleDelivery: type: object description: >- O estado em que se encontra a mensagem mais recente que a transferência deve à outra parte. A Didit contacta a contraparte após o pedido que criou ou alterou a transferência ter retornado, pelo que este objeto indica se essa mensagem chegou ao destino: em fila, a ser enviada, a aguardar nova tentativa após um erro, entregue ou com falha. Uma falha da qual a rede ainda possa recuperar (sem resposta a tempo, ligação falhada, HTTP `408`, `429` ou `5xx`) é tentada novamente após 30 segundos, 2 minutos, 10 minutos, 30 minutos e 1 hora. Quando uma primeira mensagem (`kind: SEND`) falha definitivamente, porque a rede a recusou ou a sexta tentativa também falhou, a transferência transita para `COUNTERPARTY_VASP_NOT_REACHABLE` com `last_error` na sua `timeline`; qualquer outra mensagem que falhe definitivamente é anotada na `timeline`. O `status` da transferência permanece a fonte da verdade para o intercâmbio em si. required: - kind - status - rail - attempts - last_error - next_attempt_at - delivered_at properties: kind: type: string enum: - SEND - ANSWER - TXID - CANCEL - POLL description: >- O que a mensagem transporta. `SEND`: a primeira mensagem da transferência para a contraparte (de saída; o canal é escolhido quando é enviada). `ANSWER`: a sua aceitação ou recusa, devida à rede requerente (de entrada). `TXID`: o hash da transação on-chain, após concluir a transferência. `CANCEL`: o cancelamento, após cancelá-la. `POLL`: uma consulta de estado a uma rede que o disponibilize, repetida a cada 5 minutos enquanto a transferência aguarda a contraparte. status: type: string enum: - QUEUED - SENDING - RETRYING - DELIVERED - FAILED description: >- `QUEUED`: a aguardar envio. `SENDING`: tentativa em curso. `RETRYING`: uma tentativa falhou e a próxima será executada em `next_attempt_at`. `DELIVERED`: o outro lado aceitou a mensagem. `FAILED`: o outro lado recusou-a, ou a última tentativa falhou. rail: type: string enum: - INTERNAL - TRP - GTR - TRUST - VERIFYVASP - SYGNA - EMAIL - '' description: >- O canal que transporta a mensagem. Vazio até que a Didit escolha um para uma primeira mensagem. attempts: type: integer minimum: 0 description: >- Tentativas efetuadas até ao momento para esta mensagem. Uma mensagem que não seja uma sondagem de estado é tentada no máximo 6 vezes. last_error: type: string description: >- O tipo de falha ocorrida na última tentativa, `""` se não tiver ocorrido nenhuma: por exemplo `email undeliverable`, `trp identity endpoint unreachable` ou `trp transfer inquiry delivery failed`. Nunca inclui a resposta da própria contraparte, que permanece na `timeline` da transferência. Quando a GTR responde com um erro, o respetivo código de estado e mensagem são incluídos. Os corpos de resposta nunca são incluídos. example: email undeliverable next_attempt_at: type: string format: date-time nullable: true description: >- Quando a próxima tentativa é executada enquanto a mensagem estiver em `QUEUED` ou `RETRYING`. delivered_at: type: string format: date-time nullable: true description: Quando a outra parte recebeu a mensagem. TravelRuleDiscoveryStep: type: object description: >- Um passo da deteção de contraparte que a Didit executou para uma transferência de saída, na ordem em que foram executados. O primeiro passo que identifique um VASP com uma rota termina a cadeia. properties: step: type: string enum: - internal_address_book - wallet_attribution - network_lookup - customer_hint - end_user description: >- `internal_address_book`: outro cliente da Didit que provou o controlo da carteira de destino. `wallet_attribution`: a atribuição da carteira na análise de blockchain. `network_lookup`: uma rede que pode indicar qual VASP detém o endereço. `customer_hint`: o nome do VASP, LEI ou jurisdição que enviou em `beneficiary_data`. `end_user`: a contraparte que o utilizador final (ou você) escolheu, ou o pedido para escolher uma. outcome: type: string enum: - match - miss - skipped description: >- `match`: o passo indicou uma contraparte. `miss`: foi executado e não encontrou nenhuma. `skipped`: não pôde ser executado, e `reason` indica o motivo. reason: type: string description: >- Motivo legível por máquina, `""` numa correspondência: `no_proven_internal_wallet`, `attribution_disabled`, `already_attributed`, `no_attributed_entity`, `directory_match_no_route`, `gtr_address_lookup_runs_on_dispatch`, `no_membership`, `network_switched_off`, `no_network_address_lookup`, `no_directory_match`, `awaiting_end_user` ou `picked_member_without_proven_wallet`. vasp: type: string format: uuid nullable: true description: >- O VASP do diretório indicado pelo passo, quando este tiver indicado um. rail: type: string nullable: true description: O canal que alcança essa contraparte, quando o passo encontrou um. at: type: string format: date-time TravelRuleNextAction: type: object description: >- Um elemento que faz avançar uma transferência com `COUNTERPARTY_VASP_NOT_FOUND` ou `COUNTERPARTY_VASP_NOT_REACHABLE`. Consulte [Por que motivo uma transferência está bloqueada](/pt/transaction-monitoring/travel-rule#por-que-motivo-uma-transferência-está-bloqueada). properties: action: type: string enum: - select_counterparty_vasp - declare_self_hosted - add_vasp_hint - update_compliance_email - resend description: >- `select_counterparty_vasp`: o utilizador final escolhe o VASP de destino no widget de titularidade da carteira, ou você envia um PATCH com `action=beneficiary_vasp`. `declare_self_hosted`: o utilizador final declara a carteira como autocustodiada no widget. `add_vasp_hint`: indique à Didit quem é a contraparte, com um nome de VASP, LEI ou Travel Address (por exemplo, um `travel_address` na entrada do livro de endereços da carteira de destino) e, em seguida, reenvie. `update_compliance_email` e `resend` são valores de `action` de `PATCH /v3/transactions/{transaction_id}/travel-rule/`: forneça novamente o e-mail de conformidade da contraparte e execute o encaminhamento outra vez. url: type: string format: uri description: >- A ligação do widget de titularidade da carteira, em `select_counterparty_vasp` e `declare_self_hosted` enquanto a transferência tem uma sessão do widget aberta. required: - action TravelRuleChainDetails: type: object description: >- Como a blockchain da transferência designa as suas duas carteiras, quando se trata de mais do que um endereço a pagar a outro. Vazio (`{}`) para uma transferência numa blockchain baseada em contas (EVM, Solana, Tron), onde os dois endereços são as carteiras. A correspondência, o encaminhamento e o livro de endereços leem primeiro as carteiras a partir daqui. properties: chain: type: string description: >- Blockchain canónica, por exemplo, `BTC`, `XRP` ou `LIGHTNING` para uma transferência Lightning. shape: type: string enum: - utxo - memo - lightning originator: $ref: '#/components/schemas/TravelRuleChainSide' beneficiary: $ref: '#/components/schemas/TravelRuleChainSide' utxo: type: object description: >- Numa transferência UTXO: as entradas e saídas conforme armazenadas (quantias como cadeias decimais) e quais saídas a Didit interpretou como o quê. properties: inputs: type: array items: $ref: '#/components/schemas/TravelRuleUtxoEntry' outputs: type: array items: $ref: '#/components/schemas/TravelRuleUtxoEntry' change_output_indexes: type: array items: type: integer description: Saídas que pagam de volta a um endereço de entrada. beneficiary_output_index: type: integer nullable: true description: >- A saída que paga ao beneficiário; null quando não foi possível distingui-la. lightning: type: object description: >- Numa transferência Lightning: o conteúdo do pedido de pagamento. Sempre `kind` (`bolt11`, `bolt12_offer`, `bolt12_invoice`, `bolt12_invoice_request`, `lnurl`, `lightning_address`, `node_id` ou `unknown`); uma fatura BOLT11 adiciona `network`, `payee_node_id`, `payment_hash`, `amount_msat`, `created_at` e `expires_at`; uma cadeia BOLT12 adiciona `blinded_paths` e `payee_node_id`; um LNURL ou um Lightning Address adiciona o seu `domain`. Nada é resolvido através da rede: o pedido é apenas descodificado. additionalProperties: true warnings: type: array items: type: string enum: - declared_originator_not_an_input - declared_beneficiary_not_an_output - beneficiary_output_ambiguous - beneficiary_output_amount_differs description: >- Inconsistências de UTXO que merecem atenção: o ordenante declarado não é uma entrada, o beneficiário declarado não é uma saída, nenhuma saída individual de beneficiário pôde ser identificada ou a saída do beneficiário paga um montante diferente do indicado na transação. not_applicable_reason: type: string enum: - LIGHTNING_NO_PAYEE_IDENTIFIER - LIGHTNING_BOLT12_BLINDED_PAYEE - LIGHTNING_LNURL_NAMES_NO_PAYEE description: >- Numa transferência Lightning de saída cujo pedido de pagamento não indique um beneficiário: o motivo pelo qual a transferência é `NOT_APPLICABLE`. `LIGHTNING_NO_PAYEE_IDENTIFIER` (o pedido não indica o nó do beneficiário ou não pôde ser descodificado), `LIGHTNING_BOLT12_BLINDED_PAYEE` (a oferta oculta o seu beneficiário através de caminhos ocultos), `LIGHTNING_LNURL_NAMES_NO_PAYEE` (um LNURL indica um serviço, não um beneficiário). O mesmo código abre a última entrada de `timeline` da transferência. TravelRuleChainSide: type: object description: >- A carteira de uma das partes, conforme a Didit a resolveu a partir dos dados da blockchain. properties: address: type: string description: >- A carteira. Numa rede memo, o endereço clássico (um endereço X do XRP é dividido no seu endereço clássico e na respetiva etiqueta); na Lightning, o ID do nó do beneficiário ou o Lightning Address. memo: type: string description: >- A tag ou memo de destino que faz parte da carteira; `""` quando não existe nenhum memo. source: type: string enum: - declared - x_address - largest_input - only_non_change_output - amount_match - invoice_payee - updated description: >- Origem da carteira: `declared` (o seu pedido), `x_address` (dividido a partir de um X-address de XRP), `largest_input` (o endereço de entrada UTXO que mais contribuiu), `only_non_change_output` (a única saída UTXO que não é troco), `amount_match` (a única saída UTXO que paga o montante da transferência), `invoice_payee` (o beneficiário indicado por um pedido de pagamento Lightning), `updated` (definido posteriormente com `action: update_originator_wallet`). TravelRuleUtxoEntry: type: object description: >- Uma entrada ou saída de uma transação UTXO, tal como a blockchain a registou. required: - address properties: address: type: string maxLength: 128 amount: type: string nullable: true description: >- String decimal na própria unidade da moeda (BTC, não satoshis). Opcional. example: '0.0125' txid: type: string maxLength: 128 description: Opcional. A transação que um input gasta. vout: type: integer nullable: true minimum: 0 description: Opcional. O índice do output que é gasto por um input. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.