> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# API para registrar transferencia entrante Sunrise
> Con la API de Didit, registra datos de Travel Rule de un depósito cripto ya liquidado on-chain sin intercambio previo: flujo sunrise posdepósito.
Prompt de la API para registrar transferencias entrantes Sunrise
Copiar el prompt al portapapeles
\
\`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.`
\
Pegar en
## OpenAPI
````yaml es/openapi-25.json POST /v3/travel-rule/inbound/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: API de verificación de identidad. Autentícate con el encabezado x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/travel-rule/inbound/:
post:
tags:
- Travel Rule
summary: Registrar una transferencia entrante posterior al depósito (sunrise)
description: >-
Registra los datos de Travel Rule de un depósito cripto que ya se
liquidó on-chain antes de que se produjera cualquier intercambio. Crea
una transacción travelRule entrante (o reutiliza un depósito no
reclamado) y resuelve la transferencia con tu libreta de direcciones de
wallets. En una transacción recién creada, Didit envía primero
transaction.created y después los 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: >-
Ya se había registrado una transferencia para este txid y
wallet_address; se devuelve la existente sin cambios (created es
false).
content:
application/json:
schema:
$ref: '#/components/schemas/TravelRuleInboundResponse'
'201':
description: >-
Se registró una nueva transferencia de Travel Rule, en una nueva
transacción entrante o en un depósito existente no reclamado
(created es true).
content:
application/json:
schema:
$ref: '#/components/schemas/TravelRuleInboundResponse'
'400':
description: >-
Falta un campo obligatorio (`chain`, `txid`, `wallet_address`,
`amount`, `currency`), `originating_vasp.lei` no es un LEI válido,
`originating_vasp.travel_address` no es una travel address válida,
hay un memo, una X-address o un `utxo` que la cadena no admite, o
`originator_data` / `beneficiary_data` no es un 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: >-
Cadena en la que se liquidó el depósito, por ejemplo `ETH`. Se
almacena en minúsculas y se compara sin distinguir mayúsculas y
minúsculas con las entradas de tu libreta de direcciones de wallets,
así que usa allí el mismo token de cadena.
maxLength: 32
txid:
type: string
description: >-
Hash de la transacción on-chain. Se deduplica junto con
wallet_address.
maxLength: 128
wallet_address:
type: string
description: >-
La wallet de destino en la que recibiste el depósito. Una X-address
de XRP se divide en su dirección clásica y su etiqueta.
maxLength: 128
amount:
type: string
description: >-
Importe del depósito como cadena decimal, igual o mayor que cero,
con hasta 18 decimales.
currency:
type: string
description: Activo del depósito, p. ej., "USDC".
maxLength: 16
originator_data:
type: object
description: >-
Datos del ordenante proporcionados por el VASP emisor, si se
conocen, como un objeto plano, por ejemplo `{"name": "..."}`. Didit
lee de él name (o full_name), first_name, last_name y vendor_data.
additionalProperties: true
beneficiary_data:
type: object
description: >-
Datos del beneficiario (tu cliente), como un objeto plano, por
ejemplo `{"name": "..."}`. Didit compara name con el holder_name de
la entrada coincidente de la libreta de direcciones y establece
wallet_address y chain a partir de la solicitud.
additionalProperties: true
originating_vasp:
type: object
description: >-
Descripción opcional del VASP emisor. Solo se conserva en esta
transferencia (`metadata.originating_vasp` y el VASP ordenante de la
transferencia en GET /v3/travel-rule/transfers/); nunca crea, edita
ni vincula una entrada del directorio compartido de VASP.
properties:
name:
type: string
maxLength: 255
lei:
type: string
maxLength: 20
description: Opcional. Un LEI ISO 17442 válido de 20 caracteres, o vacío.
travel_address:
type: string
description: >-
La dirección de Travel Rule del remitente, registrada en esta
transferencia.
maxLength: 512
memo:
type: string
maxLength: 256
description: >-
Opcional. La etiqueta de destino o memo del depósito en una red con
memo: en una dirección de depósito compartida, es lo que distingue a
tus clientes, y se busca la coincidencia con la entrada de la
libreta de direcciones para ese memo. XRP: una etiqueta de destino,
un número entero de 0 a 4294967295 (se acepta un número JSON). XLM:
un memo de texto de hasta 28 bytes, un ID de 64 bits o un hash de 32
bytes en hexadecimal. EOS: hasta 256 bytes. ATOM: hasta 256
caracteres. HBAR: hasta 100 bytes. Las wallets de Bitcoin, EVM,
Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin y Lightning no
admiten memo: si se incluye uno, se devuelve un `400`. Alias:
`destinationTag` o `destination_tag`.
utxo:
allOf:
- $ref: '#/components/schemas/TravelRuleUtxo'
description: >-
Opcional, solo para cadenas UTXO. Las entradas y salidas de la
transacción de depósito: la wallet del remitente es la declarada en
`originator_data.wallet_address` o, si no, la entrada de mayor
importe.
TravelRuleInboundResponse:
type: object
properties:
transaction_id:
type: string
format: uuid
description: UUID de transacción de Didit del depósito entrante.
txn_id:
type: string
description: >-
txn_id de la transacción entrante: generado por Didit cuando Didit
creó la transacción, o el tuyo propio cuando se reutilizó un
depósito no reclamado.
created:
type: boolean
description: >-
true cuando esta llamada registró la transferencia (HTTP 201); false
cuando ya existía una transferencia con el mismo txid y
wallet_address (HTTP 200).
travel_rule:
$ref: '#/components/schemas/TravelRuleTransferDetail'
TravelRuleUtxo:
type: object
description: >-
Las entradas y salidas de una transferencia UTXO (BTC, LTC, BCH, DOGE).
Solo se aceptan en esas cadenas: en cualquier otra cadena se devuelve un
`400`. A partir de ellas, Didit infiere la wallet del ordenante (la
declarada o, si no, la dirección de entrada que más aportó) y la salida
del beneficiario (la declarada o, si no, la única salida que no devuelve
fondos a una dirección de entrada como cambio o, si no, la única salida
que paga el importe de la transferencia). El resultado está en el
`chain_details` de la transferencia.
required:
- outputs
properties:
inputs:
type: array
maxItems: 1000
items:
$ref: '#/components/schemas/TravelRuleUtxoEntry'
description: >-
Opcional. Sin entradas, no se infiere ningún ordenante ni se
reconoce ninguna salida de cambio.
outputs:
type: array
minItems: 1
maxItems: 1000
items:
$ref: '#/components/schemas/TravelRuleUtxoEntry'
TravelRuleTransferDetail:
type: object
description: >-
Objeto de transferencia completo que devuelven los endpoints de
confirmación de propiedad y de finalizar/cancelar. Mientras la propiedad
de la wallet de una transferencia entrante no esté confirmada, los
`originator_data` y `beneficiary_data` de la contraparte se devuelven
enmascarados (se conserva la primera letra de cada palabra; la wallet,
la cadena y el enrutamiento del VASP siguen siendo legibles) y
`data_masked` es 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: >-
La vía por la que se enrutó la transferencia, o null cuando no se
seleccionó ninguna vía (por ejemplo, por debajo del umbral, con una
wallet sin custodia de la contraparte, con un registro posterior al
depósito o sin una contraparte alcanzable). INTERNAL significa que
ambas partes son aplicaciones de Didit; EMAIL significa que se llegó
a la contraparte mediante un enlace de recogida enviado por correo
electrónico. TEST_VASP significa que el VASP de prueba de Didit
respondió a la transferencia del sandbox. Por GTR, VERIFYVASP y
SYGNA, Didit lee la respuesta de la contraparte en la respuesta de
la red o consultándola cada 5 minutos. TRUST solo envía, por lo que
una transferencia por TRUST permanece en AWAITING_COUNTERPARTY hasta
que expira. Una vía de red solo se usa cuando has conectado tu
propia membresía a esa red. Se elige después de que la creación de
la transacción responde, por lo que es null en esa respuesta.
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: >-
La comparación de nombres que decidió esta entrada, junto a
`detail`. No aparece en las entradas que no compararon ningún
nombre.
reason:
type: string
description: >-
Presente solo en la entrada de una transición causada por una
entrega fallida: `email_undeliverable` o `delivery_failed`, el
valor que informa el `reason` de la transferencia.
counterparty_vasp:
type: object
nullable: true
properties:
name:
type: string
lei:
type: string
dd_score:
type: integer
description: >-
Puntuación de diligencia debida de 0 a 100, donde un valor más
alto es mejor. Usa la misma escala que el directorio de VASP.
dd_score_breakdown:
type: object
description: >-
Contribuciones de cada componente a dd_score, un objeto por
componente como en el directorio de VASP (jurisdiction,
verification, protocol, lei, history, essentials,
responsiveness), cada uno con {points, max, reason, detail}. {}
hasta que se haya evaluado la contraparte.
additionalProperties:
type: object
properties:
points:
type: number
description: Puntos otorgados a este componente.
max:
type: integer
description: Puntos máximos que puede otorgar este componente.
reason:
type: string
description: Código legible por máquina del veredicto del componente.
detail:
type: string
description: Motivo legible de los puntos asignados.
dd_assessed_at:
type: string
format: date-time
nullable: true
description: >-
Cuándo se ejecutó por última vez la evaluación de diligencia
debida. Nulo hasta que se haya evaluado la contraparte.
originator_data:
type: object
description: >-
Parte ordenante. En una transferencia entrante, los valores de la
contraparte están enmascarados hasta que se confirma la propiedad.
beneficiary_data:
type: object
description: >-
Parte beneficiaria. En una transferencia entrante, los valores de la
contraparte están enmascarados hasta que se confirma la propiedad.
name_match:
allOf:
- $ref: '#/components/schemas/TravelRuleNameMatch'
nullable: true
description: >-
La comparación de nombres que decidió la transferencia, o null hasta
que se haya ejecutado una. Mientras las partes están enmascaradas, y
en la copia del otro cliente de un intercambio INTERNAL,
`transfer_name`, `compared_name`, `matched_names` y
`mismatched_names` se ocultan. `score` y `matched` pueden no
coincidir: `matched` sigue el nivel de exigencia y `score` es la
similitud entre los dos nombres completos.
data_match:
$ref: '#/components/schemas/TravelRuleDataMatch'
mismatched_fields:
type: array
items:
type: string
description: >-
Atajo para `data_match.mismatched_fields`. Vacío cuando nada
difiere.
data_unmasked:
$ref: '#/components/schemas/TravelRuleDataUnmasked'
data_masked:
type: boolean
description: >-
True mientras los datos personales de la contraparte están
enmascarados en esta respuesta.
created_at:
type: string
format: date-time
delivery:
nullable: true
allOf:
- $ref: '#/components/schemas/TravelRuleDelivery'
description: >-
Estado del último mensaje que esta transferencia debe a la otra
parte. Es nulo cuando la transferencia nunca debió ninguno (por
ejemplo, por debajo de `threshold_amount`, una wallet sin custodia
declarada o un registro de sunrise).
discovery:
type: array
description: >-
Cómo buscó Didit la contraparte, con una entrada por cada paso
ejecutado. Vacío cuando no se ejecutó ningún descubrimiento, por
ejemplo, en una transferencia entrante.
items:
$ref: '#/components/schemas/TravelRuleDiscoveryStep'
reason:
type: string
description: >-
Por qué está bloqueada una transferencia
`COUNTERPARTY_VASP_NOT_FOUND` o `COUNTERPARTY_VASP_NOT_REACHABLE`;
`""` para cualquier otro estado. Primero lo determina una entrega
fallida, solo en `COUNTERPARTY_VASP_NOT_REACHABLE`:
`email_undeliverable` (el proveedor de correo rechazó el correo de
cumplimiento y no queda ninguna dirección que probar: al enviarlo,
en un recordatorio o como rebote permanente notificado más tarde) o
`delivery_failed` (el canal que realizaba la entrega falló de forma
definitiva: un canal de red rechazó el mensaje o agotó los
reintentos, un host de identidad `TRP` no respondió o el host `TRP`
de la contraparte no aceptó la consulta). En caso contrario, lo
determina la traza `discovery`: `awaiting_end_user` (ningún paso
indicó una contraparte a la que Didit pueda llegar),
`directory_match_no_route` (un paso indicó un VASP del directorio
que no tiene ruta), `picked_member_without_proven_wallet` (el
usuario final eligió un cliente de Didit que no ha demostrado el
control de la wallet) o `no_directory_match` cuando la traza no da
ningún otro motivo. Un reenvío hace avanzar la transferencia, por lo
que el motivo se borra. Consulta [Por qué está bloqueada una
transferencia](/es/transaction-monitoring/travel-rule#por-qué-una-transferencia-está-bloqueada).
next_actions:
type: array
description: >-
Qué hace avanzar la transferencia; `[]` para cualquier estado que no
sea `COUNTERPARTY_VASP_NOT_FOUND` o
`COUNTERPARTY_VASP_NOT_REACHABLE`. `email_undeliverable` ofrece
`update_compliance_email` y después `resend`. `delivery_failed`
ofrece `resend`. Un motivo de descubrimiento ofrece
`select_counterparty_vasp`, `declare_self_hosted`, `add_vasp_hint` y
`resend`.
items:
$ref: '#/components/schemas/TravelRuleNextAction'
chain_details:
$ref: '#/components/schemas/TravelRuleChainDetails'
TravelRuleUtxoEntry:
type: object
description: >-
Una entrada o salida de una transacción UTXO, tal como la registró la
cadena.
required:
- address
properties:
address:
type: string
maxLength: 128
amount:
type: string
nullable: true
description: >-
Cadena decimal en la unidad propia de la moneda (BTC, no satoshis).
Opcional.
example: '0.0125'
txid:
type: string
maxLength: 128
description: Opcional. La transacción que gasta una entrada.
vout:
type: integer
nullable: true
minimum: 0
description: Opcional. El índice de la salida que gasta una entrada.
TravelRuleNameMatch:
type: object
nullable: true
description: >-
La comparación de nombres que decidió la transferencia, o null hasta que
se haya ejecutado una. Mientras las partes están enmascaradas, y en la
copia del otro cliente de un intercambio INTERNAL, `transfer_name`,
`compared_name`, `matched_names` y `mismatched_names` se ocultan.
`score` y `matched` pueden no coincidir: `matched` sigue el nivel de
exigencia y `score` es la similitud entre los dos nombres completos.
properties:
score:
type: integer
minimum: 0
maximum: 100
description: >-
Similitud de los dos nombres completos, de 0 a 100. 0 cuando alguno
de los nombres está vacío.
matched:
type: boolean
description: >-
Si los nombres cumplen `strictness`. El resultado de la
transferencia depende de `data_match`, que compara todos los campos,
por lo que una transferencia puede ser COUNTERPARTY_MISMATCHED_DATA
aunque este valor sea true.
method:
type: string
enum:
- none
- exact_token
- token_subset
- token_containment
- sequence_ratio
description: >-
Cómo se decidió `matched`: none (`NONE`), exact_token (`STRICT`),
token_subset (`DEFAULT`), token_containment (`CONTAINS`) o
sequence_ratio (`FUZZY`).
strictness:
type: string
enum:
- NONE
- STRICT
- CONTAINS
- DEFAULT
- FUZZY
compared_with:
type: string
enum:
- wallet_holder
- counterparty_vasp
description: >-
wallet_holder: el titular registrado para la wallet.
counterparty_vasp: el nombre que respondió la contraparte en la
página de respuesta por correo electrónico, o la respuesta del Didit
Test VASP en sandbox.
transfer_name:
type: string
description: El nombre que figura en la transferencia.
compared_name:
type: string
description: El nombre con el que se comparó.
matched_names:
type: array
items:
type: string
description: Palabras de `transfer_name` que se encuentran en `compared_name`.
mismatched_names:
type: array
items:
type: string
description: >-
Palabras de `transfer_name` que faltan en `compared_name` y, a
continuación, palabras de `compared_name` que faltan en
`transfer_name`.
TravelRuleDataMatch:
type: object
nullable: true
description: >-
Comparación campo a campo de los datos de las partes de la transferencia
con lo que la otra parte sabe del titular de la wallet. Indica campos y
resultados, nunca valores, por lo que sigue siendo legible mientras los
datos de la contraparte están enmascarados. Es null hasta que se realiza
una comparación.
properties:
matched:
type: boolean
description: True cuando ningún campo comparado difiere.
mismatched_fields:
type: array
items:
type: string
enum:
- name
- date_of_birth
- address
- account
description: Los campos que difieren.
fields:
type: object
description: >-
Una entrada por campo comparado para el tipo de entidad de la parte
(`name`, `date_of_birth`, `address`, `account`; una empresa no tiene
`date_of_birth`).
additionalProperties:
type: object
properties:
result:
type: string
enum:
- matched
- mismatched
- not_compared
description: >-
`not_compared` cuando la regla es `NONE` o alguna de las dos
partes no tiene valor para el campo.
strictness:
type: string
enum:
- NONE
- STRICT
- CONTAINS
- DEFAULT
- FUZZY
TravelRuleDataUnmasked:
type: object
nullable: true
description: >-
Registro de auditoría del momento en que se desenmascararon los datos de
la contraparte. Es null mientras los datos siguen enmascarados, y en las
transferencias salientes.
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: >-
Qué confirmó la propiedad: ownership_confirmed (tu confirmación a
través de la consola o de la API), wallet_proof (una prueba de
wallet en el widget o una transferencia entrante INTERNAL; se
establece al crearla), address_book_match (una wallet verificada de
la libreta de direcciones), own_verified_wallet (la propia wallet
verificada de tu usuario), inquiry_approved (tu aprobación de una
consulta TRP entrante o de un mensaje GTR o Sygna),
known_payment_method (una wallet con la que tu usuario ya pagó) o
travel_address (la travel address propia de cada wallet identificó
la wallet).
actor:
type: string
description: >-
Quién lo confirmó: el correo electrónico del usuario de la consola o
la etiqueta de la clave de API. Vacío en una decisión automática.
TravelRuleDelivery:
type: object
description: >-
Estado del último mensaje que la transferencia debe a la otra parte.
Didit contacta con la contraparte después de que la solicitud que creó o
modificó la transferencia haya respondido, así que este objeto indica si
ese mensaje llegó: en cola, en envío, a la espera de reintentarse tras
un error, entregado o fallido. Un fallo del que la red aún puede
recuperarse (sin respuesta a tiempo, conexión fallida, HTTP `408`, `429`
o `5xx`) se reintenta a los 30 segundos, 2 minutos, 10 minutos, 30
minutos y 1 hora. Cuando un primer mensaje (`kind: SEND`) falla de forma
definitiva, porque la red lo rechazó o porque también falló el sexto
intento, la transferencia pasa a `COUNTERPARTY_VASP_NOT_REACHABLE` con
`last_error` en su `timeline`; cualquier otro mensaje que falle de forma
definitiva se registra en el `timeline`. El `status` de la transferencia
sigue siendo la fuente de verdad del intercambio en sí.
required:
- kind
- status
- rail
- attempts
- last_error
- next_attempt_at
- delivered_at
properties:
kind:
type: string
enum:
- SEND
- ANSWER
- TXID
- CANCEL
- POLL
description: >-
Qué transporta el mensaje. `SEND`: el primer mensaje de la
transferencia a la contraparte (saliente; el canal se elige al
enviarlo). `ANSWER`: tu aceptación o rechazo, que se debe a la red
que lo solicitó (entrante). `TXID`: el hash de la transacción
on-chain, después de que completes la transferencia. `CANCEL`: la
cancelación, después de que la canceles. `POLL`: una consulta de
estado a una red que la ofrece, repetida cada 5 minutos mientras la
transferencia espera a la contraparte.
status:
type: string
enum:
- QUEUED
- SENDING
- RETRYING
- DELIVERED
- FAILED
description: >-
`QUEUED`: en espera de envío. `SENDING`: hay un intento en curso.
`RETRYING`: un intento falló y el siguiente se ejecuta en
`next_attempt_at`. `DELIVERED`: la otra parte aceptó el mensaje.
`FAILED`: la otra parte lo rechazó, o falló el último intento.
rail:
type: string
enum:
- INTERNAL
- TRP
- GTR
- TRUST
- VERIFYVASP
- SYGNA
- EMAIL
- ''
description: >-
La vía que transporta el mensaje. Vacía hasta que Didit elige una
para un primer mensaje.
attempts:
type: integer
minimum: 0
description: >-
Intentos realizados hasta ahora para este mensaje. Un mensaje que no
es una consulta de estado se intenta como máximo 6 veces.
last_error:
type: string
description: >-
El tipo de fallo que tuvo el último intento, `""` si no hubo
ninguno: por ejemplo `email undeliverable`, `trp identity endpoint
unreachable` o `trp transfer inquiry delivery failed`. Nunca incluye
la respuesta de la propia contraparte, que permanece en el
`timeline` de la transferencia.
Cuando GTR responde con un error, se incluyen su propio código de
estado y su mensaje. Los cuerpos de respuesta nunca se incluyen.
example: email undeliverable
next_attempt_at:
type: string
format: date-time
nullable: true
description: >-
Fecha y hora del próximo intento mientras el mensaje está en
`QUEUED` o `RETRYING`.
delivered_at:
type: string
format: date-time
nullable: true
description: Fecha y hora en que el otro extremo aceptó el mensaje.
TravelRuleDiscoveryStep:
type: object
description: >-
Un paso del descubrimiento de contraparte que Didit ejecutó para una
transferencia saliente, en el orden en que los ejecutó. El primer paso
que identifica un VASP con una ruta finaliza la cadena.
properties:
step:
type: string
enum:
- internal_address_book
- wallet_attribution
- network_lookup
- customer_hint
- end_user
description: >-
`internal_address_book`: otro cliente de Didit que demostró tener el
control de la wallet de destino. `wallet_attribution`: la atribución
de la wallet según la analítica de blockchain. `network_lookup`: una
red que puede indicar qué VASP custodia la dirección.
`customer_hint`: el nombre, el LEI o la jurisdicción del VASP que
enviaste en `beneficiary_data`. `end_user`: la contraparte que
eligió el usuario final (o tú), o la solicitud para que se elija
una.
outcome:
type: string
enum:
- match
- miss
- skipped
description: >-
`match`: el paso identificó una contraparte. `miss`: se ejecutó y no
encontró ninguna. `skipped`: no se pudo ejecutar, y `reason` indica
el motivo.
reason:
type: string
description: >-
Motivo legible por máquina, `""` cuando hay coincidencia:
`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` o `picked_member_without_proven_wallet`.
vasp:
type: string
format: uuid
nullable: true
description: El VASP del directorio que indicó el paso, cuando indicó uno.
rail:
type: string
nullable: true
description: La vía que llega a esa contraparte, cuando el paso encontró una.
at:
type: string
format: date-time
TravelRuleNextAction:
type: object
description: >-
Algo que hace avanzar una transferencia en estado
`COUNTERPARTY_VASP_NOT_FOUND` o `COUNTERPARTY_VASP_NOT_REACHABLE`.
Consulta [Por qué una transferencia está
bloqueada](/es/transaction-monitoring/travel-rule#por-qué-una-transferencia-está-bloqueada).
properties:
action:
type: string
enum:
- select_counterparty_vasp
- declare_self_hosted
- add_vasp_hint
- update_compliance_email
- resend
description: >-
`select_counterparty_vasp`: el usuario final elige el VASP de
destino en el widget de propiedad de la wallet, o haces un PATCH con
`action=beneficiary_vasp`. `declare_self_hosted`: el usuario final
declara en el widget que la wallet es sin custodia. `add_vasp_hint`:
indica a Didit quién es la contraparte con un nombre de VASP, un LEI
o una travel address (por ejemplo, una `travel_address` en la
entrada de la libreta de direcciones de la wallet de destino) y
vuelve a enviarla. `update_compliance_email` y `resend` son valores
de `action` de `PATCH
/v3/transactions/{transaction_id}/travel-rule/`: vuelve a indicar el
correo electrónico de cumplimiento de la contraparte y vuelve a
ejecutar el enrutamiento.
url:
type: string
format: uri
description: >-
El enlace del widget de propiedad de la wallet, en
`select_counterparty_vasp` y `declare_self_hosted` mientras la
transferencia tiene una sesión de widget abierta.
required:
- action
TravelRuleChainDetails:
type: object
description: >-
Cómo identifica la cadena de la transferencia sus dos wallets, cuando no
se trata simplemente de una dirección que paga a otra. Vacío (`{}`) en
una transferencia de una cadena basada en cuentas (EVM, Solana, Tron),
donde las dos direcciones son las wallets. La coincidencia, el
enrutamiento y la libreta de direcciones leen las wallets primero de
aquí.
properties:
chain:
type: string
description: >-
Cadena canónica, p. ej., `BTC`, `XRP` o `LIGHTNING` para una
transferencia Lightning.
shape:
type: string
enum:
- utxo
- memo
- lightning
originator:
$ref: '#/components/schemas/TravelRuleChainSide'
beneficiary:
$ref: '#/components/schemas/TravelRuleChainSide'
utxo:
type: object
description: >-
En una transferencia UTXO: las entradas y salidas tal como se
almacenan (importes como cadenas decimales) y cómo interpretó Didit
cada salida.
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: Salidas que devuelven fondos a una dirección de entrada.
beneficiary_output_index:
type: integer
nullable: true
description: >-
La salida que paga al beneficiario; null cuando no se pudo
distinguir ninguna.
lightning:
type: object
description: >-
En una transferencia Lightning: lo que indica la solicitud de pago.
Siempre `kind` (`bolt11`, `bolt12_offer`, `bolt12_invoice`,
`bolt12_invoice_request`, `lnurl`, `lightning_address`, `node_id` o
`unknown`); una factura BOLT11 añade `network`, `payee_node_id`,
`payment_hash`, `amount_msat`, `created_at` y `expires_at`; una
cadena BOLT12, `blinded_paths` y `payee_node_id`; una LNURL o una
Lightning Address, su `domain`. No se resuelve nada a través de la
red: la solicitud solo se decodifica.
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: >-
Incoherencias UTXO que conviene revisar: el ordenante declarado no
es una entrada, el beneficiario declarado no es una salida, no se
pudo distinguir una única salida del beneficiario o la salida del
beneficiario paga un importe distinto del que indica la transacción.
not_applicable_reason:
type: string
enum:
- LIGHTNING_NO_PAYEE_IDENTIFIER
- LIGHTNING_BOLT12_BLINDED_PAYEE
- LIGHTNING_LNURL_NAMES_NO_PAYEE
description: >-
En una transferencia Lightning saliente cuya solicitud de pago no
indica ningún beneficiario: por qué la transferencia es
`NOT_APPLICABLE`. `LIGHTNING_NO_PAYEE_IDENTIFIER` (la solicitud no
indica ningún nodo beneficiario o no se pudo decodificar),
`LIGHTNING_BOLT12_BLINDED_PAYEE` (la oferta oculta su beneficiario
tras rutas cegadas), `LIGHTNING_LNURL_NAMES_NO_PAYEE` (una LNURL
indica un servicio, no un beneficiario). El mismo código abre la
última entrada del `timeline` de la transferencia.
TravelRuleChainSide:
type: object
description: >-
La wallet de una de las partes tal como Didit la resolvió a partir de
los datos de la cadena.
properties:
address:
type: string
description: >-
La wallet. En una red con memo, la dirección clásica (una X-address
de XRP se divide en su dirección clásica y su tag); en Lightning, el
ID de nodo del beneficiario o la Lightning Address.
memo:
type: string
description: >-
La etiqueta de destino o memo que forma parte de la wallet; `""` si
no hay ninguno.
source:
type: string
enum:
- declared
- x_address
- largest_input
- only_non_change_output
- amount_match
- invoice_payee
- updated
description: >-
Origen de la wallet: `declared` (tu solicitud), `x_address`
(extraída de una X-address de XRP), `largest_input` (la dirección de
entrada UTXO que más aportó), `only_non_change_output` (la única
salida UTXO que no es cambio), `amount_match` (la única salida UTXO
que paga el importe de la transferencia), `invoice_payee` (el
beneficiario que indica una solicitud de pago Lightning), `updated`
(establecida más tarde con `action: update_originator_wallet`).
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
La clave de API de tu aplicación, que encontrarás en Developers -> API
keys en la Business Console. La clave principal tiene acceso completo.
Una clave con nombre puede tener un alcance limitado: ninguno, lectura o
escritura por recurso, limitada a algunos flujos o a sesiones aprobadas,
a una lista de direcciones IP y a una fecha de caducidad. 401 significa
que la clave es incorrecta, se revocó o expiró; 403 significa que no se
envió ninguna clave, que la clave no tiene acceso a este recurso o
acción, o que la solicitud provino de una dirección fuera de su lista de
IP; 404 en una ruta de sesión significa que la sesión está fuera de los
flujos o estados de la clave. Una clave sin acceso a contenido
multimedia recibe las URL de imágenes, videos y PDF como null, y una
clave sin permiso de escritura en sesiones recibe los enlaces y tokens
de sesión como null. Consulta https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.