> ## 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 obtener una transacción: detalle KYT
> Obtén una transacción KYT de Didit: partes, métodos de pago, alertas, reglas activadas, Travel Rule, enlaces de remediación e instantáneas de red.
Prompt de la API para obtener una transacción
Copiar el prompt al portapapeles
\
\`Fetch the full detail of a Didit monitored transaction through the Management API.
Endpoint:
GET https://verification.didit.me/v3/transactions/{transaction_id}/
Authentication:
Use the x-api-key header with my Didit API key.
Goal:
\- Retrieve every detail of a transaction — linked parties, payment methods, alerts, rule matches, travel-rule checks, remediation links, network snapshots, cost breakdown — so I can render a detail screen or feed a downstream decision.
Path parameter:
\- transaction_id - Didit's transaction uuid (the uuid returned by POST /v3/transactions/).
Your own txn_id is not accepted here and returns 404.
Example call:
curl -X GET "https://verification.didit.me/v3/transactions/{transaction_id}/" \
-H "x-api-key: YOUR_API_KEY"
What to read from the response:
\- uuid, transaction_number, txn_id — identifiers.
\- status, score, severity, decision_reason_code, decision_reason_label — current verdict.
\- direction, amount, currency, currency_type, action_type, payment_details, payment_txn_id - the submitted details as top-level fields (there is no transaction_details object, and currency_type carries the currency_kind you sent).
\- parties - party records with role APPLICANT (the subject) or COUNTERPARTY (the other side) and kind USER, BUSINESS or EXTERNAL, each with entity_type, vendor_data, full_name, address and device.
\- payment_methods - the linked payment methods, each with payment_method_type, account_id and role (for example SOURCE or DESTINATION).
\- cost_breakdown — provider-by-provider cost detail for this transaction.
\- rule_runs / alerts — which rules fired and their outcomes.
\- provider_results - crypto screening (blockchain analytics) results, when a screening ran.
\- travel_rule - the Travel Rule transfer (uuid, status, protocol, required, obligations_count, originator_data, beneficiary_data, metadata, direction, rail, counterparty_vasp, delivery, discovery, reason, next_actions), or null when the transaction has none.
For a COUNTERPARTY_VASP_NOT_FOUND or COUNTERPARTY_VASP_NOT_REACHABLE transfer, reason says why it is stuck and next_actions what moves it on: email_undeliverable offers update_compliance_email then resend, delivery_failed offers resend, and a discovery reason (awaiting_end_user, directory_match_no_route, picked_member_without_proven_wallet, no_directory_match) offers select_counterparty_vasp, declare_self_hosted, add_vasp_hint and resend.
delivery is the newest message the transfer owes the other side (kind, status, rail, attempts, last_error, next_attempt_at, delivered_at), or null; discovery is the trace of where Didit looked for the counterparty.
On an inbound transfer, the counterparty's originator_data and beneficiary_data stay masked (data_masked: true) until wallet ownership is confirmed.
\- tags — Console tags (uuid, name, color).
\- assigned_to_name (the Console reviewer) is not part of this response; the list endpoint GET /v3/transactions/ returns it.
Use cases:
\- Render the Console-equivalent "Transaction detail" screen in your back-office.
\- Reconcile rule outcomes against your own ledger.
\- Poll after a transaction.status.updated webhook to fetch the fresh verdict.
Failure modes:
\- 403 - missing x-api-key (a wrong, revoked or expired key gets 401), or a key without permission for this action ({ "detail": "..." } envelope).
\- 404 - transaction not found in this application, including a transaction that belongs to another application (or deleted via the Console).
\- 429 — rate limited; back off and retry.
Side effects: none. This is a pure read.
For the full integration shape, see /integration/integration-prompt.`
\
Pegar en
## OpenAPI
````yaml es/openapi-25.json GET /v3/transactions/{transaction_id}/
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/transactions/{transaction_id}/:
get:
tags:
- Transactions
summary: Obtener transacción
description: >-
Obtén el registro de monitorización completo de una transacción: partes,
puntuación/gravedad, ejecuciones de reglas, alertas, resultado de Travel
Rule y sesión de remediación.
operationId: getTransaction
parameters:
- name: transaction_id
in: path
required: true
description: >-
UUID estable de Didit de la transacción (el `uuid` devuelto al crear
o listar, **no** tu `txn_id`).
schema:
type: string
format: uuid
example: abcdef12-3456-7890-abcd-ef1234567890
responses:
'200':
description: Detalle completo de la transacción.
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionDetail'
examples:
In review with an alert:
value:
uuid: abcdef12-3456-4890-abcd-ef1234567890
environment: live
transaction_number: 4123
txn_id: your-txn-2026-05-17-001
txn_date: '2026-05-17T08:42:00Z'
zone_id: Europe/Madrid
transaction_type: finance
action_type: withdrawal
direction: OUTBOUND
status: IN_REVIEW
source: LIVE
amount: '1500'
currency: EUR
currency_type: fiat
amount_in_default_currency: '1620.45'
default_currency_code: USD
preferred_currency_amount: '1620.45'
preferred_currency_code: USD
payment_details: Withdrawal to crypto wallet
payment_txn_id: null
score: 78
severity: HIGH
decision_reason_code: WALLET_HIGH_RISK
decision_reason_label: Destination wallet flagged as high risk
vendor_data: user-12345
metadata:
subject:
entity_type: individual
vendor_data: user-12345
full_name: Maria Garcia
address: {}
institution_details: {}
device_context: {}
counterparty: {}
props:
order_id: ord-9988
tags: []
parties:
- uuid: b1111111-2222-4333-8444-555555555555
role: APPLICANT
entity_type: individual
kind: USER
vendor_data: user-12345
full_name: Maria Garcia
first_name: null
last_name: null
country_code: null
dob: null
address: {}
institution_info: {}
device: {}
external_party_snapshot: null
payment_methods: []
documents: []
activities: []
alerts:
- uuid: a7b8c9d0-1234-4abc-9def-567890abcdef
title: Destination wallet flagged as high risk
description: Provider risk score exceeded the configured threshold.
severity: HIGH
status: OPEN
source: RULE
metadata: {}
created_at: '2026-05-17T08:42:12Z'
due_at: null
rule_runs: []
provider_results: []
travel_rule: null
network_snapshot: null
remediation: null
action_required: null
cost_breakdown: null
'403':
description: >-
Falta la clave de API, no es válida o fue revocada, o la clave no
puede leer las transacciones de esta aplicación. Si falta la clave,
se devuelve `403`; si es incorrecta, fue revocada o expiró, se
devuelve `401`.
content:
application/json:
examples:
Forbidden:
value:
detail: You do not have permission to perform this action.
'404':
description: >-
No existe ninguna transacción con este UUID para la aplicación (se
eliminó, nunca se creó, pertenece a otra aplicación o el segmento de
la ruta no es un UUID válido).
content:
application/json:
examples:
Not found:
value:
detail: Not found.
'429':
description: >-
Límite de solicitudes superado; espera y reintenta cuando haya
pasado el intervalo indicado en `Retry-After`.
content:
application/json:
examples:
Throttled:
value:
detail: Request was throttled. Expected available in 30 seconds.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: >-
curl -X GET
'https://verification.didit.me/v3/transactions/abcdef12-3456-7890-abcd-ef1234567890/'
\
-H 'x-api-key: YOUR_API_KEY'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.transactions.retrieve(
"abcdef12-3456-7890-abcd-ef1234567890",
)
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.transactions.retrieve("abcdef12-3456-7890-abcd-ef1234567890");
console.log(result);
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Retrieve(ctx, \"abcdef12-3456-7890-abcd-ef1234567890\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
- lang: java
label: Java
source: >-
import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result =
client.transactions().retrieve("abcdef12-3456-7890-abcd-ef1234567890");
System.out.println(result);
- lang: php
label: PHP
source: >-
transactions->retrieve('abcdef12-3456-7890-abcd-ef1234567890');
print_r($result->toArray());
- lang: ruby
label: Ruby
source: >-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result =
didit.transactions.retrieve("abcdef12-3456-7890-abcd-ef1234567890")
puts result.to_h
- lang: csharp
label: .NET
source: >-
using System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await
client.Transactions.RetrieveAsync("abcdef12-3456-7890-abcd-ef1234567890");
Console.WriteLine(JsonSerializer.Serialize(result));
components:
schemas:
TransactionDetail:
type: object
description: >-
Registro de monitorización completo de una transacción, tal como lo
devuelven `GET /v3/transactions/{transaction_id}/` y `POST
/v3/transactions/`.
properties:
uuid:
type: string
format: uuid
description: >-
Identificador estable de Didit de la transacción. Úsalo como
`{transaction_id}` en las llamadas posteriores.
environment:
type: string
enum:
- live
- sandbox
description: >-
Entorno de la aplicación a la que pertenece la transacción. Una
transacción de `sandbox` se almacena, pero nunca se evalúa, analiza,
notifica ni factura, por lo que un `rule_runs` vacío significa "no
evaluada".
transaction_number:
type: integer
description: >-
Número secuencial de transacción dentro de la aplicación que se
muestra en la consola (p. ej., `4123`).
txn_id:
type: string
description: >-
El `transaction_id` que proporcionaste al crearla (máx. 128
caracteres). Único por aplicación.
txn_date:
type: string
format: date-time
description: >-
Cuándo se produjo la transacción (a partir de `transaction_at`; por
defecto, el momento del envío).
zone_id:
type: string
nullable: true
description: Identificador de zona horaria IANA proporcionado al crear.
transaction_type:
type: string
description: >-
Categoría de nivel superior tal como se almacena: `finance`, `kyc`,
`travelRule`, `userPlatformEvent`, `gamblingBet`,
`gamblingLimitChange`, `gamblingBonusChange`, `auditTrailEvent`. Ten
en cuenta que los valores de varias palabras se devuelven en
camelCase aunque se envíen en snake_case.
action_type:
type: string
description: >-
Subtipo dentro de la categoría (p. ej., `deposit`, `withdrawal`,
`transfer`). Si no se indica, toma por defecto el valor de la
categoría.
direction:
type: string
enum:
- INBOUND
- OUTBOUND
description: >-
Sentido respecto al sujeto. Se almacena en mayúsculas
independientemente de cómo se envíe (en la entrada se aceptan
`in`/`out`/`inbound`/`outbound`).
status:
type: string
enum:
- APPROVED
- IN_REVIEW
- DECLINED
- AWAITING_USER
description: >-
Veredicto de monitorización actual. Las transacciones se crean como
`APPROVED`; las reglas pueden cambiarlas a `IN_REVIEW`/`DECLINED` de
forma síncrona.
source:
type: string
enum:
- LIVE
- IMPORTED
description: >-
Cómo se originó el registro: `LIVE` para las transacciones enviadas
mediante la API o el SDK, `IMPORTED` para las transacciones cargadas
mediante la importación de la consola.
amount:
type: string
description: >-
Importe de la transacción como cadena decimal sin ceros finales (p.
ej., `"1500"`, `"0.5"`, `"0.123456789012345678"`). Hasta 18
decimales.
currency:
type: string
description: >-
Código de moneda de `amount`. Se acepta cualquier código alfabético
ISO 4217 (p. ej. `EUR`, `USD`, `NGN`), así como el símbolo de un
criptoactivo (p. ej. `BTC`). Es preferible un código actualmente en
circulación. No todos los códigos aceptados tienen tipo de cambio.
Cuando no hay ninguno disponible para el código, la conversión
automática falla. Es el caso, por ejemplo, de la unidad contable ISO
`XSU` o de un símbolo cripto al que Didit no asigna precio. Entonces
`preferred_currency_amount` se devuelve como null, salvo que la
solicitud haya incluido un `amount_in_default_currency` ya
convertido.
currency_type:
type: string
nullable: true
description: '`fiat` o `crypto`, tal como se envió en `currency_kind`.'
amount_in_default_currency:
type: string
nullable: true
description: >-
Importe ya convertido que proporcionaste, como cadena decimal sin
ceros finales.
default_currency_code:
type: string
nullable: true
preferred_currency_amount:
type: string
nullable: true
description: >-
`amount` convertido a la moneda preferida de la aplicación, cuando
está disponible.
preferred_currency_code:
type: string
nullable: true
payment_details:
type: string
nullable: true
description: Referencia o concepto de pago en texto libre del envío.
payment_txn_id:
type: string
nullable: true
description: >-
Referencia del sistema de pago externo (p. ej., el hash de la
transacción en blockchain) procedente de `payment_reference_id`.
score:
type: integer
description: >-
Puntuación de riesgo acumulada por las reglas (normalmente de 0 a
100). Cuanto más alta, mayor riesgo.
severity:
type: string
nullable: true
enum:
- UNKNOWN
- LOW
- MEDIUM
- HIGH
- CRITICAL
description: >-
Gravedad categórica del riesgo establecida por reglas o proveedores
(`UNKNOWN`, `LOW`, `MEDIUM`, `HIGH`, `CRITICAL`). `null` hasta que
algo la establezca.
decision_reason_code:
type: string
nullable: true
description: Motivo legible por máquina del `status` actual.
decision_reason_label:
type: string
nullable: true
description: Etiqueta legible de `decision_reason_code`.
vendor_data:
type: string
nullable: true
description: Copia de conveniencia del `vendor_data` del solicitante.
metadata:
type: object
description: >-
Instantánea de los payloads `subject` y `counterparty` tal como se
enviaron en el momento de la creación.
props:
type: object
description: >-
Las `custom_properties` que proporcionaste al crearlo. En las
condiciones de las reglas, cada clave se referencia como
`custom_values.`.
tags:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
name:
type: string
color:
type: string
description:
type: string
nullable: true
source:
type: string
enum:
- didit
- custom
description: >-
Si la etiqueta es un preajuste de Didit o una etiqueta
personalizada.
description: >-
Etiquetas asociadas a la transacción (manualmente o mediante
reglas).
parties:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
role:
type: string
enum:
- APPLICANT
- REMITTER
- BENEFICIARY
- COUNTERPARTY
description: >-
Rol de la parte. El endpoint de creación asigna `APPLICANT`
(el sujeto) y `COUNTERPARTY`.
entity_type:
type: string
enum:
- individual
- company
- external
- unhostedWallet
kind:
type: string
enum:
- USER
- BUSINESS
- EXTERNAL
description: >-
Las partes `USER`/`BUSINESS` se vinculan a una entidad
propiedad de Didit mediante `vendor_data`. Las partes
`EXTERNAL` no tienen ninguna entidad de Didit detrás.
vendor_data:
type: string
nullable: true
description: Tu identificador interno de usuario o empresa.
full_name:
type: string
nullable: true
first_name:
type: string
nullable: true
last_name:
type: string
nullable: true
country_code:
type: string
nullable: true
description: >-
Código de país del `address.country` enviado (normalmente ISO
3166-1 alfa-3).
dob:
type: string
format: date
nullable: true
description: Fecha de nacimiento del `date_of_birth` enviado.
address:
type: object
description: Objeto de dirección tal como se envió. `{}` cuando se omite.
institution_info:
type: object
description: >-
Datos de la institución tal como se enviaron. `{}` si se
omiten.
device:
type: object
description: >-
Contexto del dispositivo normalizado, incluido el
enriquecimiento de IP del lado del servidor en network_context
(geolocalización, indicadores de VPN o centro de datos) cuando
se proporcionó una IP.
properties:
fingerprint:
type: string
description: Huella única del dispositivo.
persistent_device_id:
type: string
description: >-
Identificador de dispositivo estable entre sesiones
(esquema de huella digital v2).
user_agent:
type: string
description: Cadena del user agent del navegador o de la aplicación.
browser_family:
type: string
description: Familia del navegador (p. ej., Chrome, Firefox, Safari).
browser_version:
type: string
description: Cadena de la versión del navegador.
platform:
type: string
description: >-
Identificador de la plataforma (web, ios, android, macos,
windows, linux).
os_family:
type: string
description: >-
Familia del sistema operativo (p. ej., iOS, Android,
Windows).
os_version:
type: string
description: Cadena de versión del sistema operativo.
accept_language:
type: string
description: Valor del encabezado Accept-Language.
session_id:
type: string
description: Identificador de la sesión (almacenado en los metadatos).
session_age_ms:
type: number
description: Antigüedad de la sesión en milisegundos.
network_context:
type: object
description: Contexto de red con dirección IP y geolocalización.
properties:
ip_address:
type: string
description: Dirección IP del cliente.
ip_country_code:
type: string
description: >-
País de la IP resuelto por geolocalización (ISO 3166-1
alfa-3).
latitude:
type: number
description: Latitud geográfica de la IP.
longitude:
type: number
description: Longitud geográfica de la IP.
external_party_snapshot:
type: object
nullable: true
description: >-
Copia fija de los datos de la parte para las partes
`EXTERNAL`. `null` mientras la parte esté vinculada a un
usuario o una empresa de Didit.
description: Partes de la transacción (solicitante, contraparte).
payment_methods:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
payment_method_type:
type: string
enum:
- bank_card
- bank_account
- e_wallet
- crypto_wallet
- unhosted_wallet
- other
label:
type: string
nullable: true
fingerprint:
type: string
nullable: true
description: >-
SHA-256 sobre `type:account_id:issuing_country`: identificador
estable para correlacionar la reutilización del mismo
instrumento.
account_id:
type: string
nullable: true
description: >-
Identificador de la cuenta (IBAN, dirección de wallet, token
de tarjeta, …).
issuing_country:
type: string
nullable: true
owner_kind:
type: string
enum:
- USER
- BUSINESS
- EXTERNAL
vendor_data:
type: string
nullable: true
description: Tu identificador para el usuario o la empresa propietarios.
owner_name:
type: string
nullable: true
institution_info:
type: object
details:
type: object
description: Objeto `payment_method` sin procesar tal como se envió.
external_owner_snapshot:
type: object
nullable: true
role:
type: string
enum:
- SOURCE
- DESTINATION
- FUNDING
- BENEFICIARY
description: >-
Cómo se usó este método en la transacción. El endpoint de
creación asigna `SOURCE`/`DESTINATION` según el sentido
(saliente: sujeto = SOURCE; entrante: sujeto = DESTINATION).
description: Métodos de pago vinculados a la transacción.
documents:
type: array
description: >-
Archivos adjuntados a la transacción desde la consola. `[]` cuando
no hay ninguno.
items:
type: object
properties:
uuid:
type: string
format: uuid
label:
type: string
nullable: true
note:
type: string
nullable: true
uploaded_by:
type: string
nullable: true
created_at:
type: string
format: date-time
files:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
file_url:
type: string
format: uri
nullable: true
description: >-
URL de descarga firmada de corta duración; obtenla
cuando la necesites en lugar de guardarla.
original_filename:
type: string
nullable: true
file_size:
type: integer
nullable: true
activities:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
activity_type:
type: string
description: >-
Por ejemplo, `TRANSACTION_CREATED`, `TRANSACTION_NOTE_ADDED`,
`TRANSACTION_STATUS_CHANGED`.
source:
type: string
status:
type: string
nullable: true
title:
type: string
nullable: true
description:
type: string
nullable: true
metadata:
type: object
occurred_at:
type: string
format: date-time
description: >-
Entradas del registro de actividad (creación, notas, revisiones
manuales, cambios de estado).
alerts:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
title:
type: string
description:
type: string
nullable: true
severity:
type: string
enum:
- UNKNOWN
- LOW
- MEDIUM
- HIGH
- CRITICAL
status:
type: string
enum:
- OPEN
- INVESTIGATING
- AWAITING_USER
- PENDING_SAR
- SAR_FILED
- RESOLVED
- DISMISSED
source:
type: string
enum:
- RULE
- PROVIDER
- MANUAL
metadata:
type: object
created_at:
type: string
format: date-time
due_at:
type: string
format: date-time
nullable: true
description: >-
Actualmente siempre vacío. Una alerta abierta es una transacción con
estado `IN_REVIEW` o `AWAITING_USER`.
rule_runs:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
rule:
type: string
format: uuid
description: UUID de la regla que se ejecutó.
rule_title:
type: string
rule_description:
type: string
nullable: true
rule_category:
type: string
matched:
type: boolean
description: >-
Si las condiciones de la regla coincidieron con esta
transacción. Solo se registra una ejecución para las reglas
que coinciden, por lo que las evaluaciones en producción
siempre tienen `true`.
is_test:
type: boolean
description: >-
True cuando la regla se ejecutó en modo TEST (sin efecto en el
estado ni en la puntuación).
mode:
type: string
enum:
- ACTIVE
- DISABLED
- TEST
severity:
type: string
nullable: true
score_delta:
type: integer
description: Puntuación añadida por las acciones `add_score` de esta regla.
status_target:
type: string
nullable: true
description: Estado establecido por una acción `change_status`, si la hay.
action_summary:
type: string
nullable: true
description: >-
Resumen de las acciones que ejecutó la regla, unidas con `; `
(p. ej., `score +30; change_status:IN_REVIEW;
add_tag:high_risk_country`). Partes: `score +N`,
`change_status:`, `add_tag:`, `add_note`,
`add_to_list`, `open_case`. `null` cuando la regla no ejecutó
ninguna acción.
metadata:
type: object
description: >-
Detalle de la evaluación: `scope_match`, `conditions[]` y
`aggregations[]`. Cada entrada de condición incluye `field`,
`operator`, `expected_value`, el `current_value` leído de la
transacción, `matched`, `group_index` y `group_logic`. Cada
entrada de agregación (velocidad / recuento / suma) incluye
`metric`, `field`, `operator`, `expected_value`, el
`computed_value` que dio como resultado el agregado, `window`,
`filters`, `matched` y `sample_references`; las agregaciones
asíncronas diferidas tienen `computed_value: null` y
`deferred: true`. Un grupo de condiciones anidado es una única
entrada de `conditions[]` con `operator` `any_of` o `all_of`,
`field` nulo y los resultados de sus miembros en su propio
`conditions`.
created_at:
type: string
format: date-time
description: >-
Resultados de ejecución por regla: qué regla se activó y con qué
impacto en la puntuación.
provider_results:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
provider:
type: string
result_type:
type: string
enum:
- FIAT_MONITORING
- WALLET_SCREENING
- TRANSACTION_SCREENING
- TRAVEL_RULE
- NETWORK_GRAPH
- CUSTOM
status:
type: string
severity:
type: string
nullable: true
score:
type: integer
summary:
type: string
nullable: true
payload:
type: object
description: Payload de respuesta del proveedor sin procesar.
created_at:
type: string
format: date-time
description: >-
Payloads sin procesar de los proveedores (análisis AML, analítica de
blockchain, etc.).
travel_rule:
nullable: true
allOf:
- $ref: '#/components/schemas/TransactionTravelRule'
description: >-
Transferencia o comprobación de Travel Rule. Se rellena cuando se
envió `travel_rule_details`, y también cuando Travel Rule está
habilitada y la transacción se creó con `transaction_category:
travelRule` (Didit inicia el intercambio por sí mismo, incluso sin
`travel_rule_details`). `null` cuando no existe ninguna
transferencia ni comprobación. En una transferencia entrante, los
`originator_data` y `beneficiary_data` de la contraparte permanecen
enmascarados (`data_masked: true`) hasta que se confirma la
propiedad de la wallet.
network_snapshot:
type: object
nullable: true
description: >-
Instantánea del grafo de transacciones/partes relacionadas que usa
el motor de reglas. Es el `network_snapshot` enviado con la
transacción o el grafo que Didit construye a partir de un análisis
AML de wallet exitoso (que reemplaza al enviado). `null` cuando no
existe ninguno.
properties:
uuid:
type: string
format: uuid
nodes:
type: array
items:
type: object
edges:
type: array
items:
type: object
metrics:
type: object
remediation:
type: object
nullable: true
description: >-
Sesión de corrección que se ofrece al usuario cuando se requiere una
reverificación. Ha sido reemplazada por `action_required`, que es el
bloque canónico; se mantiene por compatibilidad con versiones
anteriores.
properties:
session_id:
type: string
session_token:
type: string
url:
type: string
format: uri
status:
type: string
action_required:
type: object
nullable: true
description: >-
Acción pendiente del usuario final necesaria para completar esta
transacción, o null cuando no hay ninguna. Los SDK de Didit abren la
acción automáticamente de forma predeterminada y actualizan la
transacción cuando termina. Hay dos variantes, que se distinguen por
`type`: `verification_session` (una sesión de verificación alojada
creada por la acción de una regla) y `wallet_ownership` (una sesión
del widget de propiedad de la wallet generada automáticamente para
una transferencia de la Travel Rule que requiere probar el control
de la wallet, sujeta a la configuración `auto_wallet_verification`
de la Travel Rule). Cuando ambas podrían aplicarse,
`wallet_ownership` tiene prioridad porque bloquea el intercambio de
la Travel Rule.
oneOf:
- $ref: '#/components/schemas/TransactionVerificationSessionAction'
- $ref: '#/components/schemas/TransactionWalletOwnershipAction'
discriminator:
propertyName: type
mapping:
verification_session: '#/components/schemas/TransactionVerificationSessionAction'
wallet_ownership: '#/components/schemas/TransactionWalletOwnershipAction'
cost_breakdown:
type: object
nullable: true
description: >-
Coste de esta transacción: `total_price` e `items`, uno por cargo,
cada uno con `usage_type`, `price`, `details` y `created_at`. Un
nuevo análisis de la misma transacción es un ítem nuevo.
TransactionTravelRule:
type: object
description: >-
La transferencia Travel Rule de una transacción, tal como la devuelven
`GET /v3/transactions/{transaction_id}/`, la respuesta `201` de `POST
/v3/transactions/` y cada fila de `GET /v3/transactions/`. `direction`,
`rail`, `counterparty_vasp`, `delivery`, `discovery`, `reason` y
`next_actions` tienen la misma forma que en `PATCH
/v3/transactions/{transaction_id}/travel-rule/`, de modo que una sola
lectura de una transacción indica por qué su transferencia está
bloqueada y qué la hace avanzar.
properties:
uuid:
type: string
format: uuid
status:
type: string
protocol:
type: string
nullable: true
required:
type: boolean
obligations_count:
type: integer
originator_data:
type: object
description: >-
Parte ordenante. 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:
type: object
nullable: true
description: >-
La comparación de nombres que decidió la transferencia (puntuación y
nivel de exigencia). Null hasta que se haya ejecutado una. Los
nombres comparados se enmascaran junto con las partes.
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.
metadata:
type: object
direction:
type: string
enum:
- INBOUND
- OUTBOUND
description: Qué lado del intercambio representa esta transferencia.
rail:
type: string
nullable: true
description: >-
La vía por la que pasó la transferencia: `INTERNAL`, `TRP`, `GTR`,
`TRUST`, `VERIFYVASP`, `SYGNA` o `EMAIL` (`TEST_VASP` en una
aplicación de sandbox, cuando respondió el VASP de prueba de Didit),
o `null` hasta que se elige una vía.
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.
description: >-
La entrada del directorio de la contraparte, o `null` cuando la
transferencia no vincula ninguna.
delivery:
nullable: true
allOf:
- $ref: '#/components/schemas/TravelRuleDelivery'
description: >-
El mensaje más reciente que la transferencia debe a otra parte.
`null` cuando no ha debido ninguno, por ejemplo por debajo de
`threshold_amount` o para una wallet sin custodia declarada.
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'
TransactionVerificationSessionAction:
title: Verification session
type: object
properties:
type:
type: string
enum:
- verification_session
url:
type: string
format: uri
description: URL de verificación alojada que se debe abrir para el usuario final.
session_id:
type: string
format: uuid
description: ID de la sesión de verificación.
session_token:
type: string
description: >-
Token de sesión que usan los SDK móviles para iniciar el flujo de
forma nativa.
status:
type: string
description: Estado de la sesión de verificación.
required:
- type
- url
TransactionWalletOwnershipAction:
title: Wallet ownership
type: object
properties:
type:
type: string
enum:
- wallet_ownership
url:
type: string
format: uri
description: >-
URL del widget alojado de propiedad de la wallet. Ábrela en un
navegador real: en dispositivos móviles usa SFSafariViewController o
una Chrome Custom Tab, nunca una webview integrada.
widget_session_id:
type: string
format: uuid
description: ID de sesión del widget de propiedad de la wallet.
expires_at:
type: string
format: date-time
description: Cuándo expira la sesión del widget.
required:
- type
- url
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`).
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.
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.