> ## 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. # Registar transferência recebida Sunrise: API Travel Rule > Registe dados da Travel Rule para um depósito de cripto já liquidado on-chain antes de qualquer troca. Fluxo sunrise pós-depósito. Didit. Prompt da API para registar 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/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: Registar uma transferência de entrada pós-depósito (sunrise) description: >- Registar dados da Travel Rule para um depósito de cripto que já foi liquidado on-chain antes de ocorrer qualquer troca. Cria uma transação de entrada da Travel Rule (ou reutiliza um depósito não reclamado) e resolve a transferência em relação ao seu livro de endereços de carteiras. Para uma transação recém-criada, o 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: >- Já foi registada uma transferência para este txid e wallet_address; a existente é devolvida sem alterações (created é false). content: application/json: schema: $ref: '#/components/schemas/TravelRuleInboundResponse' '201': description: >- Foi registada uma nova transferência Travel Rule, numa nova transação de entrada ou num depósito não reclamado existente (created é true). content: application/json: schema: $ref: '#/components/schemas/TravelRuleInboundResponse' '400': description: >- Falta um campo obrigatório (`chain`, `txid`, `wallet_address`, `amount`, `currency`), `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 blockchain não suporta, 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 na qual o depósito foi liquidado, por exemplo `ETH`. Armazenada em minúsculas e comparada de forma insensível a maiúsculas/minúsculas com as entradas do seu livro de endereços de carteiras, pelo que deve utilizar o mesmo token de blockchain aí. maxLength: 32 txid: type: string description: >- Hash da transação on-chain. Deduplicado em conjunto com wallet_address. maxLength: 128 wallet_address: type: string description: >- A carteira de destino na qual recebeu o depósito. Um endereço X-address de XRP é dividido no respetivo endereço clássico e tag. maxLength: 128 amount: type: string description: >- Montante do depósito como uma string decimal, igual ou superior a zero, 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 ordenante do VASP remetente, se conhecidos, como um objeto simples, tal como `{"name": "..."}`. A Didit lê name (ou full_name), first_name, last_name e vendor_data a partir dele. additionalProperties: true beneficiary_data: type: object description: >- Detalhes do beneficiário (o seu cliente), como um objeto simples tal como `{"name": "..."}`. A Didit compara o nome com o holder_name da entrada correspondente do livro de endereços e define wallet_address e chain a partir do pedido. additionalProperties: true originating_vasp: type: object description: >- Descrição opcional do VASP remetente. Permanece apenas nesta transferência (`metadata.originating_vasp`, e o VASP ordenante da transferência em GET /v3/travel-rule/transfers/); nunca cria, edita ou associa uma entrada no diretório partilhado de VASPs. properties: name: type: string maxLength: 255 lei: type: string maxLength: 20 description: Opcional. Um LEI ISO 17442 válido de 20 carateres, ou vazio. travel_address: type: string description: O Travel Address do remetente, registado nesta transferência. maxLength: 512 memo: type: string maxLength: 256 description: >- Opcional. A tag de destino ou memo do depósito numa rede que utilize memos: num endereço de depósito partilhado, é o que distingue os seus clientes, e é utilizada a entrada do livro de endereços correspondente a esse memo. XRP: uma tag de destino, um número inteiro de 0 a 4294967295 (um número JSON é aceite). XLM: um memo de texto até 28 bytes, um ID de 64 bits ou um hash de 32 bytes em hexadecimal. EOS: até 256 bytes. ATOM: até 256 carateres. HBAR: até 100 bytes. As carteiras Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin e Lightning não aceitam memo: incluir um devolve `400`. Pseudónimo: `destinationTag` ou `destination_tag`. utxo: allOf: - $ref: '#/components/schemas/TravelRuleUtxo' description: >- Opcional, apenas para cadeias UTXO. As entradas e saídas da transação de depósito: a carteira do remetente é o `originator_data.wallet_address` declarado; caso contrário, a maior entrada. TravelRuleInboundResponse: type: object properties: transaction_id: type: string format: uuid description: UUID da transação 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 identificador quando um depósito não reclamado foi reutilizado. created: type: boolean description: >- true quando esta chamada registou 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). Só são aceites nestas blockchains: em qualquer outra blockchain devolve um erro `400`. A partir delas, a Didit deduz a carteira do ordenante (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 troco a um endereço de entrada, caso contrário a única saída que paga o montante da transferência). O resultado encontra-se em `chain_details` da transferência. required: - outputs properties: inputs: type: array maxItems: 1000 items: $ref: '#/components/schemas/TravelRuleUtxoEntry' description: >- Opcional. Sem inputs, nenhum ordenante é inferido e nenhum output de troco é reconhecido. outputs: type: array minItems: 1 maxItems: 1000 items: $ref: '#/components/schemas/TravelRuleUtxoEntry' TravelRuleTransferDetail: type: object description: >- Objeto completo de transferência devolvido pelos endpoints de confirmação de propriedade e de finalização/cancelamento. Enquanto a propriedade da carteira de uma transferência recebida não estiver confirmada, os campos `originator_data` e `beneficiary_data` da contraparte são devolvidos mascarados (a primeira letra de cada palavra é mantida; a carteira, a blockchain e o encaminhamento do VASP permanecem 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 através do qual a transferência foi encaminhada, ou null quando nenhum canal foi selecionado (por exemplo, abaixo do limiar, uma carteira de contraparte autocustodiada, um registo pós-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 através de uma ligação de recolha enviada por e-mail. TEST_VASP significa que o Didit Test VASP respondeu à transferência em sandbox. Através de 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, pelo que uma transferência TRUST permanece AWAITING_COUNTERPARTY até expirar. Um canal de rede só é utilizado quando tiver associado a sua própria adesão a essa rede. É escolhido após o retorno da criação da transação, pelo que é 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 decidida por esta entrada, junto a `detail`. Ausente em entradas que não compararam qualquer nome. reason: type: string description: >- Presente apenas na entrada de uma transição causada por uma entrega com falha: `email_undeliverable` ou `delivery_failed`, o valor que `reason` da transferência reporta. 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. 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: allOf: - $ref: '#/components/schemas/TravelRuleNameMatch' nullable: true description: >- A comparação de nomes que decidiu a transferência, ou nulo até que uma seja executada. Enquanto as partes estiverem mascaradas, e na cópia do outro cliente de uma troca INTERNAL, `transfer_name`, `compared_name`, `matched_names` e `mismatched_names` são ocultados. `score` e `matched` podem divergir: `matched` segue o rigor, `score` é a semelhança dos 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: >- Verdadeiro enquanto os dados pessoais da contraparte estiverem mascarados nesta resposta. created_at: type: string format: date-time delivery: nullable: true allOf: - $ref: '#/components/schemas/TravelRuleDelivery' description: >- O estado em que se encontra a mensagem mais recente que esta transferência deve à outra parte. Nulo quando a transferência nunca deveu nenhuma (por exemplo, abaixo de `threshold_amount`, uma carteira autocustodiada declarada ou um registo sunrise). 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' 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. TravelRuleNameMatch: type: object nullable: true description: >- A comparação de nomes que decidiu a transferência, ou nulo até que uma seja executada. Enquanto as partes estiverem mascaradas, e na cópia do outro cliente de uma troca INTERNAL, `transfer_name`, `compared_name`, `matched_names` e `mismatched_names` são ocultados. `score` e `matched` podem divergir: `matched` segue o rigor, `score` é a semelhança dos dois nomes completos. properties: score: type: integer minimum: 0 maximum: 100 description: >- Semelhança dos dois nomes completos, de 0 a 100. 0 quando qualquer um dos nomes estiver em branco. matched: type: boolean description: >- Se os nomes cumprem `strictness`. O resultado da transferência segue `data_match`, que compara todos os campos, pelo que uma transferência pode ser COUNTERPARTY_MISMATCHED_DATA enquanto isto for verdadeiro. method: type: string enum: - none - exact_token - token_subset - token_containment - sequence_ratio description: >- Como `matched` foi decidido: nenhum (`NONE`), token exato (`STRICT`), subconjunto de tokens (`DEFAULT`), contenção de tokens (`CONTAINS`) ou proporção de sequência (`FUZZY`). strictness: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY compared_with: type: string enum: - wallet_holder - counterparty_vasp description: >- wallet_holder: o titular registado para a carteira. counterparty_vasp: o nome que a contraparte indicou na página de resposta por e-mail, ou a resposta do Didit Test VASP na sandbox. transfer_name: type: string description: O nome na transferência. compared_name: type: string description: O nome com o qual 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` em falta em `compared_name`, seguidas de palavras de `compared_name` em falta em `transfer_name`. 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`). 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.