> ## 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. # Registrar transferência sunrise recebida: API Travel Rule > Registre na Didit dados de Travel Rule de um depósito cripto já liquidado on-chain antes de qualquer troca de dados: o fluxo sunrise pós-depósito. Prompt da API de registro de transferência Sunrise de entrada Copiar o prompt para a área de transferência \

\`Register Travel Rule data for a crypto deposit that settled on-chain BEFORE any exchange took place - because the sending VASP was unreachable at the time (the sunrise problem), or when backfilling historical deposits.

Endpoint:
POST https://verification.didit.me/v3/travel-rule/inbound/

Authentication:
Use the x-api-key header with my Didit API key. You are the beneficiary VASP.

Request body (application/json):
\{
"chain": "ETH",                        // required; stored lowercased and matched case-insensitively against your address-book entries' chain
"txid": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060",   // dedupe key: same txid + wallet_address returns the existing transfer
"wallet_address": "0x8ba1f109551bD432803012645Ac136ddd64DBA72",   // an XRP X-address is split into its classic address and tag
"memo": "",                              // optional destination tag or memo: on a shared deposit address it names your customer
"amount": "500.00",
"currency": "USDC",
"originator_data": { "name": "Origin CASP SL" },      // flat originator details from the sender, if known (name or full_name, first_name, last_name, vendor_data)
"beneficiary_data": { "name": "Ana Diaz" },           // flat beneficiary details (your customer); name is matched against the entry's holder_name
"originating_vasp": { "name": "Origin CASP SL", "lei": "984500ABCDEF12345634", "travel_address": "taHg7hkTmJ4mTpdQxn61H9cyx6RreB2jrDHeB3pkioRRBgKQaSAGUzp73FVsmEXXJVxdAuCCWiBEFMkcB4MCtcyjnpbyEbTeSHwym394NMS7ev" },  // optional sender identity
"utxo": { "inputs": [ { "address": "bc1q...", "amount": "0.5" } ], "outputs": [ { "address": "bc1q...", "amount": "0.25" } ] }  // optional, BTC/LTC/BCH/DOGE only
}

Behavior:
\- Creates an inbound travelRule transaction (or reuses an unclaimed recorded deposit) and resolves it against your wallet address book, by the address and its memo (an entry with exactly that memo first, else one for the whole address; a deposit without a memo never reaches an entry that has one):
\- no matching entry -> ON_HOLD
\- entry exists, ownership unproven -> UNCONFIRMED_OWNERSHIP
\- name does not match the entry's holder_name -> COUNTERPARTY_MISMATCHED_DATA
\- verified entry + name match -> COMPLETED then immediately FINISHED (the deposit already settled).
\- The address-book match is chain-scoped: an entry matches when its chain equals the request chain (case-insensitive) or the entry's chain is blank, and "ethereum" does not match "ETH".
\- Resolve ON_HOLD (and UNCONFIRMED_OWNERSHIP) with POST /v3/transactions/{transaction_id}/travel-rule/ownership/.
\{"confirmed": true} registers or verifies the wallet entry and runs the name match; {"confirmed": false} declines the transfer.
ON_HOLD does not change the transaction status by itself; only a rule that acts on the Travel Rule status changes it (for example the opt-in library preset travel-rule-pending-action sets AWAITING_USER).
\- Naming originating_vasp keeps the sender's identity on this transfer (metadata.originating_vasp, and the transfer's originator VASP in GET /v3/travel-rule/transfers/); it never creates or changes a shared VASP directory entry.
originating_vasp.lei must be a valid 20-character LEI (ISO 17442) or blank, and originating_vasp.travel_address must be a valid travel address or blank.
An inbound TRP inquiry does not create or change its sender's directory entry either.
\- Webhooks: when a new transaction was created, transaction.created is sent first and travel_rule.status.updated follows for each status transition.
Each webhook is delivered and retried on its own, so do not rely on arrival order; key on transaction_id.
\- Billing: there is no base fee.
A newly created deposit is screened and charged the Wallet Verification & Screening rate only when crypto monitoring is enabled and chain is one Didit can screen (btc, eth, sol, trx, matic, bnb, ltc, xrp, bch, doge, or their full names such as bitcoin or ethereum).
Sandbox applications are never charged.
\- utxo: the sender's wallet is originator_data.wallet_address when you declare it, else the input address that contributed the most. The result is on travel_rule.chain_details.

What to read from the response:
\- transaction_id - the Didit transaction uuid, used in /v3/transactions/{transaction_id}/ calls.
\- txn_id - tr-in-{first 80 characters of txid}-{12 hex characters} for a new transaction, or the existing txn_id of a reused recorded deposit.
\- created - true (201) when this call registered the deposit, false (200) when the same txid + wallet_address was already registered.
\- travel_rule - the full transfer object: uuid, status, direction, rail, protocol, ivms_version, required, ownership_confirmed, deadline_at, timeline, counterparty_vasp, originator_data, beneficiary_data, delivery, discovery, reason, next_actions, created_at.
beneficiary_data includes the wallet_address and the lowercased chain.
originator_data and beneficiary_data stay masked in the response (data_masked: true) until wallet ownership is confirmed.
\- travel_rule.status - the resolved state (see above).

Failure modes:
\- 400 - a missing required field (chain, txid, wallet_address, amount, currency), an invalid originating_vasp.lei, or an invalid travel address ("Invalid travel address.").
\- 403 - missing x-api-key (a wrong, revoked or expired key gets 401).

Full guide: /transaction-monitoring/travel-rule#after-deposit-sunrise-registration.`

\
Colar em ## OpenAPI ````yaml pt-br/openapi-25.json POST /v3/travel-rule/inbound/ 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/inbound/: post: tags: - Travel Rule summary: Registrar uma transferência de entrada após o depósito (sunrise) description: >- Registre os dados da Travel Rule para um depósito de cripto que já foi liquidado on-chain antes de qualquer troca. Cria uma transação travelRule de entrada (ou reutiliza um depósito não reivindicado) e associa a transferência ao seu catálogo de endereços de carteiras. Para uma transação recém-criada, a Didit envia primeiro transaction.created e, depois, os webhooks travel_rule.status.updated. operationId: registerTravelRuleInbound requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TravelRuleInboundRequest' example: chain: ETH txid: 0xdeposit-hash wallet_address: 0xYourDepositWallet amount: '500.00' currency: USDC originator_data: name: Origin CASP SL beneficiary_data: name: Ana Diaz originating_vasp: name: Origin CASP SL lei: '' travel_address: >- ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC responses: '200': description: >- Uma transferência para este txid e wallet_address já foi registrada; a existente é retornada sem alterações (created é false). content: application/json: schema: $ref: '#/components/schemas/TravelRuleInboundResponse' '201': description: >- Uma nova transferência de Travel Rule foi registrada, em uma nova transação de entrada ou em um depósito existente não reivindicado (created é true). content: application/json: schema: $ref: '#/components/schemas/TravelRuleInboundResponse' '400': description: >- Um campo obrigatório (`chain`, `txid`, `wallet_address`, `amount`, `currency`) está ausente, `originating_vasp.lei` não é um LEI válido, `originating_vasp.travel_address` não é um travel address válido, um memo, X-address ou `utxo` que a chain não comporta, ou `originator_data` / `beneficiary_data` que não é um objeto. content: application/json: examples: Missing field: value: txid: - This field is required. Invalid LEI: value: originating_vasp: lei: - >- Invalid LEI: expected 20 alphanumeric characters (ISO 17442). security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: |- curl -X POST https://verification.didit.me/v3/travel-rule/inbound/ \ -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \ -d '{"chain":"ETH","txid":"0xdeposit-hash","wallet_address":"0xYourDepositWallet","amount":"500.00","currency":"USDC"}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.travel_rule.register_inbound( chain="ETH", txid="0xdeposit-hash", wallet_address="0xYourDepositWallet", amount="500.00", currency="USDC", originator_data={"name": "Origin CASP SL"}, beneficiary_data={"name": "Ana Diaz"}, originating_vasp={ "name": "Origin CASP SL", "lei": "", "travel_address": "ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC", }, ) print(result) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.travelRule.registerInbound({ chain: "ETH", txid: "0xdeposit-hash", wallet_address: "0xYourDepositWallet", amount: "500.00", currency: "USDC", originator_data: { name: "Origin CASP SL" }, beneficiary_data: { name: "Ana Diaz" }, originating_vasp: { name: "Origin CASP SL", lei: "", travel_address: "ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC", }, }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.RegisterInbound(ctx, didit.TravelRuleInboundRequest{\n\tChain: \"ETH\",\n\tTxid: \"0xdeposit-hash\",\n\tWalletAddress: \"0xYourDepositWallet\",\n\tAmount: \"500.00\",\n\tCurrency: \"USDC\",\n\tOriginatorData: didit.Some(map[string]any{\"name\": \"Origin CASP SL\"}),\n\tBeneficiaryData: didit.Some(map[string]any{\"name\": \"Ana Diaz\"}),\n\tOriginatingVASP: didit.Some(didit.TravelRuleInboundRequestOriginatingVASP{\n\t\tName: didit.String(\"Origin CASP SL\"),\n\t\tLei: didit.String(\"\"),\n\t\tTravelAddress: didit.String(\"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\"),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import java.util.Map; import me.didit.Didit; import me.didit.types.TravelRuleInboundRequest; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.travelRule().registerInbound(TravelRuleInboundRequest.builder() .chain("ETH") .txid("0xdeposit-hash") .walletAddress("0xYourDepositWallet") .amount("500.00") .currency("USDC") .originatorData(Map.of("name", "Origin CASP SL")) .beneficiaryData(Map.of("name", "Ana Diaz")) .originatingVasp(TravelRuleInboundRequest.OriginatingVasp.builder() .name("Origin CASP SL") .lei("") .travelAddress("ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC") .build()) .build()); System.out.println(result); - lang: php label: PHP source: |- travelRule->registerInbound([ 'chain' => 'ETH', 'txid' => '0xdeposit-hash', 'wallet_address' => '0xYourDepositWallet', 'amount' => '500.00', 'currency' => 'USDC', 'originator_data' => ['name' => 'Origin CASP SL'], 'beneficiary_data' => ['name' => 'Ana Diaz'], 'originating_vasp' => [ 'name' => 'Origin CASP SL', 'lei' => '', 'travel_address' => 'ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC', ], ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.travel_rule.register_inbound( chain: "ETH", txid: "0xdeposit-hash", wallet_address: "0xYourDepositWallet", amount: "500.00", currency: "USDC", originator_data: { name: "Origin CASP SL" }, beneficiary_data: { name: "Ana Diaz" }, originating_vasp: { name: "Origin CASP SL", lei: "", travel_address: "ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC", } ) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Collections.Generic; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.TravelRule.RegisterInboundAsync(new TravelRuleInboundRequest { Chain = "ETH", Txid = "0xdeposit-hash", WalletAddress = "0xYourDepositWallet", Amount = "500.00", Currency = "USDC", OriginatorData = new Dictionary { ["name"] = "Origin CASP SL" }, BeneficiaryData = new Dictionary { ["name"] = "Ana Diaz" }, OriginatingVasp = new TravelRuleInboundRequestOriginatingVasp { Name = "Origin CASP SL", Lei = "", TravelAddress = "ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC", }, }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: TravelRuleInboundRequest: type: object required: - chain - txid - wallet_address - amount - currency properties: chain: type: string description: >- Blockchain em que o depósito foi liquidado, por exemplo, `ETH`. É armazenado em minúsculas e comparado sem distinção entre maiúsculas e minúsculas com as entradas do seu catálogo de endereços de carteiras, portanto use o mesmo token de blockchain lá. maxLength: 32 txid: type: string description: >- Hash da transação on-chain. Desduplicado em conjunto com wallet_address. maxLength: 128 wallet_address: type: string description: >- A carteira de destino em que você recebeu o depósito. Um X-address XRP é dividido em seu endereço clássico e sua tag. maxLength: 128 amount: type: string description: >- Valor do depósito como string decimal, zero ou maior, com até 18 casas decimais. currency: type: string description: Ativo do depósito, por exemplo, "USDC". maxLength: 16 originator_data: type: object description: >- Dados do remetente fornecidos pelo VASP de envio, se conhecidos, como um objeto plano, por exemplo `{"name": "..."}`. A Didit lê dele name (ou full_name), first_name, last_name e vendor_data. additionalProperties: true beneficiary_data: type: object description: >- Dados do beneficiário (seu cliente), como um objeto simples, por exemplo `{"name": "..."}`. A Didit compara o nome com o holder_name da entrada correspondente do catálogo de endereços e define wallet_address e chain a partir da requisição. additionalProperties: true originating_vasp: type: object description: >- Descrição opcional da VASP remetente. Ela fica apenas nesta transferência (`metadata.originating_vasp` e a VASP remetente da transferência em GET /v3/travel-rule/transfers/); nunca cria, edita nem vincula uma entrada compartilhada do diretório de VASPs. properties: name: type: string maxLength: 255 lei: type: string maxLength: 20 description: Opcional. Um LEI ISO 17442 válido de 20 caracteres, ou vazio. travel_address: type: string description: >- O endereço de Travel Rule do remetente, registrado nesta transferência. maxLength: 512 memo: type: string maxLength: 256 description: >- Opcional. A destination tag ou memo do depósito em uma rede com memo: em um endereço de depósito compartilhado, é o que diferencia seus clientes, e a entrada do catálogo de endereços correspondente a esse memo é usada na correspondência. XRP: uma destination tag, um número inteiro de 0 a 4294967295 (um número JSON é aceito). XLM: um memo de texto de até 28 bytes, um ID de 64 bits ou um hash de 32 bytes em hexadecimal. EOS: até 256 bytes. ATOM: até 256 caracteres. HBAR: até 100 bytes. Carteiras Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin e Lightning não aceitam memo: informar um nelas retorna `400`. Alias: `destinationTag` ou `destination_tag`. utxo: allOf: - $ref: '#/components/schemas/TravelRuleUtxo' description: >- Opcional, apenas para blockchains UTXO. As entradas e saídas da transação de depósito: a carteira do remetente é o `originator_data.wallet_address` declarado ou, na ausência dele, a maior entrada. TravelRuleInboundResponse: type: object properties: transaction_id: type: string format: uuid description: UUID da transação na Didit para o depósito recebido. txn_id: type: string description: >- txn_id da transação de entrada: gerado pela Didit quando a Didit criou a transação, ou o seu próprio quando um depósito não reivindicado foi reutilizado. created: type: boolean description: >- true quando esta chamada registrou a transferência (HTTP 201); false quando já existia uma transferência para o mesmo txid e wallet_address (HTTP 200). travel_rule: $ref: '#/components/schemas/TravelRuleTransferDetail' TravelRuleUtxo: type: object description: >- As entradas e saídas de uma transferência UTXO (BTC, LTC, BCH, DOGE). Aceitas somente nessas blockchains: em qualquer outra blockchain, é retornado `400`. A partir delas, a Didit infere a carteira do remetente (a declarada; caso contrário, o endereço de entrada que mais contribuiu) e a saída do beneficiário (a declarada; caso contrário, a única saída que não devolve valor a um endereço de entrada como troco; caso contrário, a única saída que paga o valor da transferência). O resultado fica em `chain_details` da transferência. required: - outputs properties: inputs: type: array maxItems: 1000 items: $ref: '#/components/schemas/TravelRuleUtxoEntry' description: >- Opcional. Sem entradas, nenhum remetente é inferido e nenhuma saída de troco é reconhecida. outputs: type: array minItems: 1 maxItems: 1000 items: $ref: '#/components/schemas/TravelRuleUtxoEntry' TravelRuleTransferDetail: type: object description: >- Objeto de transferência completo retornado pelos endpoints de confirmação de propriedade e de finalização/cancelamento. Enquanto a propriedade da carteira de uma transferência recebida não for confirmada, os campos `originator_data` e `beneficiary_data` da contraparte são retornados mascarados (a primeira letra de cada palavra é mantida; a carteira, a blockchain e o roteamento do VASP continuam legíveis) e `data_masked` é true. properties: uuid: type: string format: uuid status: type: string enum: - AWAITING_COUNTERPARTY - ON_HOLD - COMPLETED - FINISHED - CANCELLED - EXPIRED - COUNTERPARTY_MISMATCHED_DATA - COUNTERPARTY_VASP_NOT_FOUND - COUNTERPARTY_VASP_NOT_REACHABLE - UNCONFIRMED_OWNERSHIP - COUNTERPARTY_VASP_GENERAL_DECLINE - NOT_ENOUGH_COUNTERPARTY_DATA - NOT_APPLICABLE direction: type: string enum: - INBOUND - OUTBOUND rail: type: string nullable: true enum: - INTERNAL - TRP - GTR - TRUST - VERIFYVASP - SYGNA - EMAIL - TEST_VASP - null description: >- O canal pelo qual a transferência foi roteada, ou null quando nenhum canal foi selecionado (por exemplo, abaixo do limiar, uma carteira autocustodiada da contraparte, um registro após o depósito ou nenhuma contraparte alcançável). INTERNAL significa que ambos os lados são aplicações da Didit; EMAIL significa que a contraparte foi alcançada por um link de retirada enviado por e-mail. TEST_VASP significa que o Didit Test VASP respondeu à transferência no sandbox. Em GTR, VERIFYVASP e SYGNA, a Didit lê a resposta da contraparte a partir da resposta da rede ou consultando-a a cada 5 minutos. TRUST apenas envia, portanto uma transferência TRUST permanece em AWAITING_COUNTERPARTY até expirar. Um canal de rede só é usado quando você conectou sua própria associação a essa rede. Ele é escolhido depois que a criação da transação retorna, por isso é null nessa resposta. protocol: type: string nullable: true ivms_version: type: string example: ivms101.2023 required: type: boolean ownership_confirmed: type: boolean nullable: true deadline_at: type: string format: date-time nullable: true timeline: type: array items: type: object properties: status: type: string at: type: string format: date-time detail: type: string name_match: allOf: - $ref: '#/components/schemas/TravelRuleNameMatch' nullable: true description: >- A comparação de nomes que esta entrada decidiu, ao lado de `detail`. Ausente nas entradas que não compararam nenhum nome. reason: type: string description: >- Presente somente na entrada de uma transição causada por uma falha de entrega: `email_undeliverable` ou `delivery_failed`, o valor que o `reason` da transferência informa. counterparty_vasp: type: object nullable: true properties: name: type: string lei: type: string dd_score: type: integer description: >- Pontuação de due diligence de 0 a 100, em que valores maiores são melhores. Mesma escala do diretório de VASPs. dd_score_breakdown: type: object description: >- Contribuições de cada componente para o dd_score, um objeto por componente, como no diretório de VASPs (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: Pontuação máxima que este componente pode conceder. reason: type: string description: Código legível por máquina do veredito do componente. detail: type: string description: Motivo legível dos pontos atribuídos. dd_assessed_at: type: string format: date-time nullable: true description: >- Quando a avaliação de devida diligência foi executada pela última vez. Nulo até que a contraparte tenha sido avaliada. originator_data: type: object description: >- Parte remetente. Em uma transferência de entrada, os valores da contraparte ficam mascarados até que a propriedade seja confirmada. beneficiary_data: type: object description: >- Parte beneficiária. Em uma transferência recebida, os valores da contraparte ficam mascarados até que a propriedade seja confirmada. name_match: allOf: - $ref: '#/components/schemas/TravelRuleNameMatch' nullable: true description: >- A comparação de nomes que decidiu a transferência, ou nula até que uma seja executada. Enquanto as partes estão mascaradas, e na cópia do outro cliente de uma troca INTERNAL, `transfer_name`, `compared_name`, `matched_names` e `mismatched_names` ficam ocultos. `score` e `matched` podem divergir: `matched` segue o rigor, enquanto `score` é a similaridade entre os dois nomes completos. 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: >- True enquanto os dados pessoais da contraparte estão mascarados nesta resposta. created_at: type: string format: date-time delivery: nullable: true allOf: - $ref: '#/components/schemas/TravelRuleDelivery' description: >- Situação da mensagem mais recente que esta transferência deve à outra parte. Nulo quando a transferência nunca deveu uma mensagem (por exemplo, abaixo de `threshold_amount`, em uma carteira autocustodiada declarada ou em um registro de sunrise). discovery: type: array description: >- Como a Didit procurou a contraparte, com uma entrada por etapa executada. Vazio quando nenhuma descoberta foi executada, por exemplo, em uma transferência de entrada. items: $ref: '#/components/schemas/TravelRuleDiscoveryStep' reason: type: string description: >- Motivo pelo qual uma transferência `COUNTERPARTY_VASP_NOT_FOUND` ou `COUNTERPARTY_VASP_NOT_REACHABLE` está parada; `""` para qualquer outro status. Uma falha de entrega decide primeiro, apenas em `COUNTERPARTY_VASP_NOT_REACHABLE`: `email_undeliverable` (o provedor de e-mail recusou o e-mail de conformidade e não resta nenhum endereço para tentar: no envio, em um lembrete ou como uma devolução permanente informada depois) ou `delivery_failed` (o canal que fazia a entrega falhou definitivamente: um canal de rede recusou a mensagem ou esgotou as novas tentativas, um host de identidade `TRP` não respondeu ou o host `TRP` da contraparte não aceitou a consulta). Caso contrário, o rastro de `discovery` decide: `awaiting_end_user` (nenhuma etapa indicou uma contraparte que a Didit consiga alcançar), `directory_match_no_route` (uma etapa indicou um VASP do diretório que não tem rota), `picked_member_without_proven_wallet` (o usuário final escolheu um cliente da Didit que não comprovou o controle da carteira) ou `no_directory_match` quando o rastro não indica nenhum outro motivo. Um reenvio faz a transferência avançar, e o motivo é então limpo. Veja [Por que uma transferência está parada](/pt-br/transaction-monitoring/travel-rule#por-que-uma-transferência-fica-travada). next_actions: type: array description: >- O que faz a transferência avançar; `[]` para qualquer status que não seja `COUNTERPARTY_VASP_NOT_FOUND` ou `COUNTERPARTY_VASP_NOT_REACHABLE`. `email_undeliverable` oferece `update_compliance_email` e depois `resend`. `delivery_failed` oferece `resend`. Um motivo de descoberta oferece `select_counterparty_vasp`, `declare_self_hosted`, `add_vasp_hint` e `resend`. items: $ref: '#/components/schemas/TravelRuleNextAction' chain_details: $ref: '#/components/schemas/TravelRuleChainDetails' TravelRuleUtxoEntry: type: object description: >- Uma entrada ou saída de uma transação UTXO, conforme registrada na blockchain. 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 uma entrada gasta. vout: type: integer nullable: true minimum: 0 description: Opcional. O índice da saída que uma entrada gasta. TravelRuleNameMatch: type: object nullable: true description: >- A comparação de nomes que decidiu a transferência, ou nula até que uma seja executada. Enquanto as partes estão mascaradas, e na cópia do outro cliente de uma troca INTERNAL, `transfer_name`, `compared_name`, `matched_names` e `mismatched_names` ficam ocultos. `score` e `matched` podem divergir: `matched` segue o rigor, enquanto `score` é a similaridade entre os dois nomes completos. properties: score: type: integer minimum: 0 maximum: 100 description: >- Similaridade entre os dois nomes completos, de 0 a 100. É 0 quando qualquer um dos nomes está em branco. matched: type: boolean description: >- Se os nomes atendem a `strictness`. O resultado da transferência segue `data_match`, que compara todos os campos, então uma transferência pode ser COUNTERPARTY_MISMATCHED_DATA mesmo quando este valor é verdadeiro. method: type: string enum: - none - exact_token - token_subset - token_containment - sequence_ratio description: >- Como `matched` foi decidido: none (`NONE`), exact_token (`STRICT`), token_subset (`DEFAULT`), token_containment (`CONTAINS`) ou sequence_ratio (`FUZZY`). strictness: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY compared_with: type: string enum: - wallet_holder - counterparty_vasp description: >- wallet_holder: o titular registrado para a carteira. counterparty_vasp: o nome que a contraparte informou na página de resposta por e-mail, ou a resposta do Didit Test VASP no sandbox. transfer_name: type: string description: O nome na transferência. compared_name: type: string description: O nome com o qual ele foi comparado. matched_names: type: array items: type: string description: Palavras de `transfer_name` encontradas em `compared_name`. mismatched_names: type: array items: type: string description: >- Palavras de `transfer_name` ausentes em `compared_name` e, em seguida, palavras de `compared_name` ausentes em `transfer_name`. TravelRuleDataMatch: type: object nullable: true description: >- Comparação campo a campo entre os dados das partes da transferência e o que o outro lado sabe sobre o titular da carteira. Ela indica campos e resultados, nunca valores, por isso continua legível enquanto os dados da contraparte estão mascarados. Nulo até que uma comparação seja executada. properties: matched: type: boolean description: True quando nenhum campo comparado é diferente. 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: >- Registro de auditoria do momento em que os dados da contraparte foram desmascarados. É nulo enquanto os dados ainda estão mascarados e em 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 (sua confirmação pelo console ou pela 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 catálogo de endereços), own_verified_wallet (a carteira verificada do próprio usuário), inquiry_approved (sua aprovação de uma consulta TRP de entrada ou de uma mensagem GTR ou Sygna), known_payment_method (uma carteira com a qual seu usuário já pagou) ou travel_address (o travel address por carteira identificou a carteira). actor: type: string description: >- Quem confirmou: o e-mail do usuário do console ou o rótulo da chave de API. Em branco para uma decisão automática. TravelRuleDelivery: type: object description: >- Situação da mensagem mais recente que a transferência deve à outra parte. A Didit contata a contraparte depois que a requisição que criou ou alterou a transferência retorna, então este objeto indica se essa mensagem foi entregue: na fila, em envio, aguardando nova tentativa após um erro, entregue ou com falha. Uma falha da qual a rede ainda pode se recuperar (sem resposta a tempo, falha de conexão, 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 porque a sexta tentativa também falhou, a transferência passa para `COUNTERPARTY_VASP_NOT_REACHABLE` com `last_error` em sua `timeline`; qualquer outra mensagem que falhe definitivamente é registrada na `timeline`. O `status` da transferência continua sendo a fonte da verdade sobre a troca 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 no momento do envio). `ANSWER`: sua aceitação ou recusa, devida à rede que fez a solicitação (de entrada). `TXID`: o hash da transação on-chain, depois que você conclui a transferência. `CANCEL`: o cancelamento, depois que você cancela a transferência. `POLL`: uma consulta de status a uma rede que oferece esse recurso, repetida a cada 5 minutos enquanto a transferência aguarda a contraparte. status: type: string enum: - QUEUED - SENDING - RETRYING - DELIVERED - FAILED description: >- `QUEUED`: aguardando envio. `SENDING`: uma tentativa está em andamento. `RETRYING`: uma tentativa falhou e a próxima será executada em `next_attempt_at`. `DELIVERED`: o outro lado recebeu a mensagem. `FAILED`: o outro lado a recusou, ou a última tentativa falhou. rail: type: string enum: - INTERNAL - TRP - GTR - TRUST - VERIFYVASP - SYGNA - EMAIL - '' description: >- O canal que transporta a mensagem. Fica vazio até que a Didit escolha um para uma primeira mensagem. attempts: type: integer minimum: 0 description: >- Tentativas feitas até agora para esta mensagem. Uma mensagem que não seja uma consulta de status é tentada no máximo 6 vezes. last_error: type: string description: >- O tipo de falha que a última tentativa encontrou, `""` quando não houve nenhuma: por exemplo `email undeliverable`, `trp identity endpoint unreachable` ou `trp transfer inquiry delivery failed`. Nunca inclui a resposta da própria contraparte, que fica na `timeline` da transferência. Quando o GTR responde com um erro, o código de status e a mensagem dele 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 está `QUEUED` ou `RETRYING`. delivered_at: type: string format: date-time nullable: true description: Quando o outro lado recebeu a mensagem. TravelRuleDiscoveryStep: type: object description: >- Uma etapa da descoberta de contraparte que a Didit executou para uma transferência de saída, na ordem em que as executou. A primeira etapa que identifica um VASP com rota encerra 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 comprovou o controle da carteira de destino. `wallet_attribution`: a atribuição da carteira feita por análise de blockchain. `network_lookup`: uma rede capaz de informar qual VASP detém o endereço. `customer_hint`: o nome do VASP, o LEI ou a jurisdição que você enviou em `beneficiary_data`. `end_user`: a contraparte que o usuário final (ou você) escolheu, ou o pedido para escolher uma. outcome: type: string enum: - match - miss - skipped description: >- `match`: a etapa identificou uma contraparte. `miss`: ela foi executada e não encontrou nenhuma. `skipped`: ela não pôde ser executada, e `reason` informa o motivo. reason: type: string description: >- Motivo legível por máquina, `""` quando há 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 pela etapa, quando ela indicou um. rail: type: string nullable: true description: O canal que alcança essa contraparte, quando a etapa encontrou um. at: type: string format: date-time TravelRuleNextAction: type: object description: >- Algo que faz avançar uma transferência `COUNTERPARTY_VASP_NOT_FOUND` ou `COUNTERPARTY_VASP_NOT_REACHABLE`. Consulte [Por que uma transferência está parada](/pt-br/transaction-monitoring/travel-rule#por-que-uma-transferência-fica-travada). properties: action: type: string enum: - select_counterparty_vasp - declare_self_hosted - add_vasp_hint - update_compliance_email - resend description: >- `select_counterparty_vasp`: o usuário final escolhe o VASP de destino no widget de propriedade da carteira, ou você faz um PATCH com `action=beneficiary_vasp`. `declare_self_hosted`: o usuário final declara no widget que a carteira é autocustodiada. `add_vasp_hint`: informe à Didit quem é a contraparte, com um nome de VASP, um LEI ou um travel address (por exemplo, um `travel_address` na entrada do catálogo de endereços da carteira de destino) e depois reenvie. `update_compliance_email` e `resend` são valores de `action` de `PATCH /v3/transactions/{transaction_id}/travel-rule/`: informe novamente o e-mail de conformidade da contraparte e execute o roteamento outra vez. url: type: string format: uri description: >- O link do widget de propriedade da carteira, em `select_counterparty_vasp` e `declare_self_hosted`, enquanto a transferência tiver uma sessão de widget aberta. required: - action TravelRuleChainDetails: type: object description: >- Como a blockchain da transferência identifica suas duas carteiras, quando isso vai além de um endereço pagando a outro. Vazio (`{}`) para uma transferência em blockchain baseada em contas (EVM, Solana, Tron), em que os dois endereços são as próprias carteiras. A correspondência, o roteamento e o catálogo de endereços leem as carteiras primeiro 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: >- Em uma transferência UTXO: as entradas e saídas conforme armazenadas (valores como strings decimais) e como a Didit interpretou cada saída. 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 o beneficiário; null quando nenhuma pôde ser distinguida. lightning: type: object description: >- Em uma transferência Lightning: o que a requisição de pagamento informa. Sempre `kind` (`bolt11`, `bolt12_offer`, `bolt12_invoice`, `bolt12_invoice_request`, `lnurl`, `lightning_address`, `node_id` ou `unknown`); uma fatura BOLT11 acrescenta `network`, `payee_node_id`, `payment_hash`, `amount_msat`, `created_at` e `expires_at`; uma string BOLT12, `blinded_paths` e `payee_node_id`; uma LNURL ou um Lightning Address, o respectivo `domain`. Nada é resolvido pela rede: a requisição é apenas decodificada. 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 remetente declarado não é uma entrada, o beneficiário declarado não é uma saída, não foi possível distinguir uma única saída do beneficiário, ou a saída do beneficiário paga um valor diferente do informado na transação. not_applicable_reason: type: string enum: - LIGHTNING_NO_PAYEE_IDENTIFIER - LIGHTNING_BOLT12_BLINDED_PAYEE - LIGHTNING_LNURL_NAMES_NO_PAYEE description: >- Em uma transferência Lightning de saída cuja requisição de pagamento não indica nenhum beneficiário: o motivo pelo qual a transferência é `NOT_APPLICABLE`. `LIGHTNING_NO_PAYEE_IDENTIFIER` (a requisição não indica nenhum nó beneficiário ou não pôde ser decodificada), `LIGHTNING_BOLT12_BLINDED_PAYEE` (a oferta oculta o beneficiário atrás de blinded paths), `LIGHTNING_LNURL_NAMES_NO_PAYEE` (uma 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. Em uma rede com memo, o endereço clássico (um X-address da XRP é dividido em endereço clássico e tag); na Lightning, o ID do nó do beneficiário ou o Lightning Address. memo: type: string description: >- A destination tag ou o memo que faz parte da carteira; `""` para nenhum. source: type: string enum: - declared - x_address - largest_input - only_non_change_output - amount_match - invoice_payee - updated description: >- Origem da carteira: `declared` (sua requisição), `x_address` (extraída de um X-address do 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 valor da transferência), `invoice_payee` (o beneficiário indicado em uma solicitação de pagamento Lightning), `updated` (definida posteriormente com `action: update_originator_wallet`). 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.