{ "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" } ], "tags": [], "paths": { "/system/healthcheck": { "get": { "summary": "Healthcheck del servicio (público, sin autenticación)", "description": "Sonda de liveness pública y sin autenticación. Devuelve `HTTP 200` con `{status: \"ok\", timestamp}` cuando el servicio, la base de datos, la caché y el broker funcionan correctamente.", "operationId": "get_system_healthcheck", "x-didit-sdk": { "resource": "system", "method": "healthcheck", "auth": "public", "server": false }, "tags": [ "System" ], "security": [ {} ], "parameters": [], "responses": { "200": { "description": "El servicio funciona correctamente y acepta solicitudes. El cuerpo es siempre `{\"status\": \"ok\", \"timestamp\": \"\"}`.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "timestamp" ], "properties": { "status": { "type": "string", "enum": [ "ok" ], "description": "Indicador de liveness. Siempre es la cadena literal `\"ok\"` en una respuesta 200.", "example": "ok" }, "timestamp": { "type": "string", "format": "date-time", "description": "Hora del servidor en la que se evaluó el healthcheck, en formato ISO 8601 con precisión de milisegundos y sufijo `Z` (UTC).", "example": "2026-04-21T16:42:50.445Z" } } }, "examples": { "Healthy": { "summary": "El servicio está activo", "value": { "status": "ok", "timestamp": "2026-04-21T16:42:50.445Z" } } } } } }, "503": { "description": "El servicio no está en buen estado: uno de los plugins de comprobación de estado configurados (base de datos, caché, broker) está fallando. El cuerpo de la respuesta es mínimo a propósito; el código de estado HTTP es la señal que importa. Reintenta con backoff exponencial." }, "5XX": { "description": "El servicio de verificación está degradado o no está disponible. Trata cualquier respuesta que no sea 2xx como \"no disponible\" y reintenta con backoff exponencial." } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -i https://verification.didit.me/system/healthcheck" }, { "lang": "Python", "label": "Python (requests)", "source": "import requests\n\nresp = requests.get(\"https://verification.didit.me/system/healthcheck\", timeout=5)\nresp.raise_for_status()\nprint(resp.json()) # {'status': 'ok', 'timestamp': '2026-04-21T16:42:50.445Z'}" }, { "lang": "JavaScript", "label": "Node.js (fetch)", "source": "const res = await fetch(\"https://verification.didit.me/system/healthcheck\");\nif (!res.ok) throw new Error(`Didit unhealthy: ${res.status}`);\nconst body = await res.json();\nconsole.log(body); // { status: 'ok', timestamp: '2026-04-21T16:42:50.445Z' }" } ] } }, "/v3/email/risk/": { "post": { "summary": "Calcular la puntuación de riesgo de una dirección de correo electrónico", "description": "Devuelve señales de entregabilidad, de direcciones desechables, de filtraciones, de coincidencia entre sesiones y de inteligencia de riesgo normalizada sin enviar un OTP. El endpoint crea una sesión de API y devuelve su id como `request_id`.\n\n**Decisión.** El `status` de nivel superior refleja `email.status`. Normalmente es `Approved`; la evaluación de riesgo puede producir `In Review` o `Declined`.\n\n**Alias de compatibilidad.** Las respuestas en producción exponen el objeto de inteligencia normalizado como `email.email_intelligence` y también como `email.enrichment`. Los valores son idénticos. Las nuevas integraciones pueden leer `email.enrichment`. Ambas claves están ausentes cuando no se devolvieron datos de inteligencia utilizables.\n\n**Facturación.** Las llamadas en producción usan los precios de la Email Risk API. La solicitud es facturable en cuanto comienza la consulta, aunque algunos campos que se obtienen en la medida de lo posible no estén disponibles.\n\n**Sandbox.** Las claves de sandbox validan la solicitud y devuelven datos aprobados deterministas sin enviar ningún correo electrónico, consumir créditos, crear una sesión ni contribuir a Networks.\n\n**Autenticación.** Envía la clave de API de tu aplicación en `x-api-key`. Si las credenciales faltan o no son válidas, se devuelve `403`: esta API nunca devuelve `401`.\n\n**Límite de solicitudes.** Cupo de escritura compartido de 300 solicitudes por minuto por clave de API entre todos los endpoints POST/PATCH/DELETE.\n\n**Huella social.** Establece `enable_social` en `true` para añadir un bloque `email_social`: las plataformas en línea en las que está registrada esta dirección, con recuentos por categoría y los detalles de perfil disponibles. `profiles_registered: 0` significa que se comprobaron las plataformas y que la dirección no se encontró en ninguna de ellas, lo cual es una respuesta válida y facturable. El bloque está ausente cuando no se solicitó el complemento o no se pudo completar la comprobación, y en ese caso no se factura. La facturación añade una unidad de `email_social` por solicitud, además del precio propio de este endpoint.", "operationId": "post_v3email_risk", "x-didit-sdk": { "resource": "email", "method": "assess_risk", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/email/risk/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"email\": \"alice@example.com\",\n \"country_code\": \"US\",\n \"vendor_data\": \"lead-123\",\n \"metadata\": {\"source\": \"signup_prescreen\"}\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.email.assess_risk(\n email=\"alice@example.com\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.email.assessRisk({\n email: \"alice@example.com\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Email.AssessRisk(ctx, didit.EmailRiskRequest{\n\tEmail: \"alice@example.com\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.EmailRiskRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.email().assessRisk(EmailRiskRequest.builder()\n .email(\"alice@example.com\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "email->assessRisk([\n 'email' => 'alice@example.com',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.email.assess_risk(email: \"alice@example.com\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Email.AssessRiskAsync(new EmailRiskRequest\n{\n Email = \"alice@example.com\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRiskRequest" }, "examples": { "Minimal": { "summary": "Puntuar una dirección con los valores predeterminados", "value": { "email": "alice@example.com" } }, "Full context": { "summary": "Puntuar con señales, indicación de país e identificadores de correlación", "value": { "email": "alice@example.com", "country_code": "US", "signals": { "ip": "192.0.2.1", "device_id": "8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2", "device_platform": "web", "os_version": "14.4", "app_version": "1.2.34", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.4 Safari/605.1.15" }, "vendor_data": "lead-123", "metadata": { "source": "signup_prescreen" } } } } } } }, "responses": { "200": { "description": "La evaluación de riesgo se completó. Consulta `status` para ver la decisión; el código HTTP siempre es `200` en las consultas completadas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRiskResponse" }, "examples": { "Clean address": { "summary": "Dirección entregable sin exposición a filtraciones", "value": { "request_id": "82397be9-5921-4970-a979-2d5b43e08b33", "status": "Approved", "email": { "status": "Approved", "email": "alice@example.com", "is_breached": false, "breaches": [], "is_disposable": false, "is_undeliverable": false, "verification_attempts": 0, "verified_at": null, "warnings": [], "lifecycle": [], "matches": [], "email_intelligence": { "score": 4.0, "deliverable": "high", "breach_risk_level": "Low", "breach_risk_index": 4, "is_recent_breach": false, "is_frequent_breached": false, "is_disposable": false, "is_free_domain": false, "is_breached": false, "no_of_breaches": 0, "reason_codes": [] }, "enrichment": { "score": 4.0, "deliverable": "high", "breach_risk_level": "Low", "breach_risk_index": 4, "is_recent_breach": false, "is_frequent_breached": false, "is_disposable": false, "is_free_domain": false, "is_breached": false, "no_of_breaches": 0, "reason_codes": [] } }, "vendor_data": "lead-123", "metadata": { "source": "signup_prescreen" }, "created_at": "2026-09-01T10:30:00.123456+00:00" } }, "Breached address": { "summary": "Dirección encontrada en filtraciones conocidas", "value": { "request_id": "d1e5c2a8-6f30-4c1a-8b2d-3e4f5a6b7c8d", "status": "In Review", "email": { "status": "In Review", "email": "bob@example.org", "is_breached": true, "breaches": [ { "name": "ExampleBreach2023", "domain": "example.org", "breach_date": "2023-06-01", "breach_emails_count": 1200000, "description": "A data breach affecting example.org accounts.", "logo_path": "https://logos.example.org/example.png", "data_classes": [ "email_addresses", "passwords" ], "is_verified": true } ], "is_disposable": false, "is_undeliverable": false, "verification_attempts": 0, "verified_at": null, "warnings": [], "lifecycle": [], "matches": [], "email_intelligence": { "score": 58.0, "deliverable": "high", "breach_risk_level": "High", "breach_risk_index": 72, "is_recent_breach": true, "is_frequent_breached": true, "is_disposable": false, "is_free_domain": true, "is_breached": true, "no_of_breaches": 4, "reason_codes": [ { "code": "IR-F784B630", "direction": "risk", "message": "Email's digital footprint diversity is Very Low", "impact_level": "low" } ] }, "enrichment": { "score": 58.0, "deliverable": "high", "breach_risk_level": "High", "breach_risk_index": 72, "is_recent_breach": true, "is_frequent_breached": true, "is_disposable": false, "is_free_domain": true, "is_breached": true, "no_of_breaches": 4, "reason_codes": [ { "code": "IR-F784B630", "direction": "risk", "message": "Email's digital footprint diversity is Very Low", "impact_level": "low" } ] } }, "vendor_data": "lead-125", "metadata": null, "created_at": "2026-09-01T10:30:00.123456+00:00" } } } } } }, "400": { "$ref": "#/components/responses/EmailRiskValidationError" }, "403": { "$ref": "#/components/responses/RiskPermissionDenied" }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/ip/risk/": { "post": { "summary": "Calcular la puntuación de riesgo de una dirección IP", "description": "Devuelve la geolocalización, la propiedad de la red, los indicadores de VPN/Tor y de centro de datos, datos de amenazas y `country_mismatch` para una dirección IP proporcionada. El endpoint crea una sesión de API y devuelve su id como `request_id`.\n\n**Decisión.** `status` es `In Review` cuando el país resuelto no coincide con `claimed_country`, o cuando la dirección está asociada a infraestructura de VPN, Tor o centros de datos. En caso contrario, es `Approved`.\n\n**En la medida de lo posible.** El enriquecimiento de IP se realiza en la medida de lo posible. Si ninguna fuente de enriquecimiento devuelve datos utilizables, el endpoint devuelve una respuesta aprobada con `ip.ip_address: null`, `ip.country_mismatch: null` y un objeto `ip.threat` vacío.\n\n**Facturación.** Las llamadas en producción usan los precios de la IP Risk API. La solicitud es facturable en cuanto comienza la consulta.\n\n**Sandbox.** Las claves de sandbox validan la solicitud y devuelven datos aprobados deterministas sin consumir créditos, crear una sesión ni contribuir a Networks.\n\n**Autenticación.** Envía la clave de API de tu aplicación en `x-api-key`. Si las credenciales faltan o no son válidas, se devuelve `403`: esta API nunca devuelve `401`.\n\n**Límite de solicitudes.** Cupo de escritura compartido de 300 solicitudes por minuto por clave de API entre todos los endpoints POST/PATCH/DELETE.", "operationId": "post_v3ip_risk", "x-didit-sdk": { "resource": "ip", "method": "assess_risk", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/ip/risk/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"ip_address\": \"8.8.8.8\",\n \"claimed_country\": \"ESP\",\n \"user_agent\": \"Mozilla/5.0\",\n \"vendor_data\": \"lead-123\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.ip.assess_risk(\n ip_address=\"8.8.8.8\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.ip.assessRisk({\n ip_address: \"8.8.8.8\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IP.AssessRisk(ctx, didit.IPRiskRequest{\n\tIPAddress: \"8.8.8.8\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.IPRiskRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.ip().assessRisk(IPRiskRequest.builder()\n .ipAddress(\"8.8.8.8\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "ip->assessRisk([\n 'ip_address' => '8.8.8.8',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.ip.assess_risk(ip_address: \"8.8.8.8\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Ip.AssessRiskAsync(new IPRiskRequest\n{\n IpAddress = \"8.8.8.8\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPRiskRequest" }, "examples": { "Minimal": { "summary": "Puntuar una dirección con los valores predeterminados", "value": { "ip_address": "8.8.8.8" } }, "With claimed country": { "summary": "Puntuar con un país declarado para detectar discrepancias", "value": { "ip_address": "8.8.8.8", "claimed_country": "ESP", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.4 Safari/605.1.15", "vendor_data": "lead-123" } } } } } }, "responses": { "200": { "description": "La evaluación de riesgo se completó. Consulta `status` para ver la decisión; el código HTTP siempre es `200` en las consultas completadas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPRiskResponse" }, "examples": { "Clean residential IP": { "summary": "Dirección de residencia; el país declarado coincide", "value": { "request_id": "9a96ed2a-721e-4b86-8cbf-d61eda529279", "status": "Approved", "ip": { "status": "Approved", "ip_address": "192.0.2.10", "ip_country": "Spain", "ip_country_code": "ES", "ip_state": "Madrid", "ip_city": "Madrid", "latitude": 40.4168, "longitude": -3.7038, "isp": "Example Telecom", "organization": "Example Telecom SA", "is_vpn_or_tor": false, "is_data_center": false, "time_zone": "Europe/Madrid", "time_zone_offset": "+0200", "asn_number": 3352, "asn_organization": "EXAMPLE-TELECOM", "connection_type": "broadband", "carrier": "Example Telecom", "proxy_type": null, "claimed_country": "ESP", "country_mismatch": false, "threat": {} }, "vendor_data": "lead-123", "metadata": null, "created_at": "2026-09-01T10:30:00.123456+00:00" } }, "Datacenter mismatch": { "summary": "Dirección de centro de datos que no coincide con el país declarado", "value": { "request_id": "5b1d4e9a-3c7b-4f8e-9a2d-1b0c9d8e7f6a", "status": "In Review", "ip": { "status": "In Review", "ip_address": "8.8.8.8", "ip_country": "United States", "ip_country_code": "US", "ip_state": "California", "ip_city": "Mountain View", "latitude": 37.386, "longitude": -122.0838, "isp": "Google", "organization": "Google LLC", "is_vpn_or_tor": true, "is_data_center": true, "time_zone": "America/Los_Angeles", "time_zone_offset": "-0700", "asn_number": 15169, "asn_organization": "GOOGLE, US", "connection_type": "hosting", "carrier": null, "proxy_type": "VPN", "claimed_country": "ESP", "country_mismatch": true, "threat": { "is_proxy": true, "is_data_center": true, "is_tor": false } }, "vendor_data": "lead-126", "metadata": null, "created_at": "2026-09-01T10:30:00.123456+00:00" } } } } } }, "400": { "$ref": "#/components/responses/IPRiskValidationError" }, "403": { "$ref": "#/components/responses/RiskPermissionDenied" }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/phone/risk/": { "post": { "summary": "Calcular la puntuación de riesgo de un número de teléfono", "description": "Resuelve un número de teléfono y devuelve señales de operador, tipo de línea, portabilidad, número desechable, coincidencias entre sesiones e inteligencia de riesgo normalizada sin enviar un OTP. El endpoint crea una sesión de API y devuelve su id como `request_id`.\n\n**Decisión.** El `status` de nivel superior replica `phone.status`. Normalmente es `Approved`; la evaluación de riesgo puede dar como resultado `In Review` o `Declined`.\n\n**Alias de compatibilidad.** Las respuestas en producción exponen el objeto de inteligencia normalizado tanto en `phone.phone_intelligence` como en `phone.enrichment`. Los valores son idénticos. Las integraciones nuevas pueden leer `phone.enrichment`. Ambas claves están ausentes cuando no se devolvieron datos de inteligencia utilizables.\n\n**Facturación.** Las llamadas en producción usan los precios de Phone Risk API. La solicitud se factura en cuanto comienza la consulta, aunque algunos campos que se obtienen en la medida de lo posible no estén disponibles.\n\n**Sandbox.** Las claves de sandbox validan la solicitud y devuelven datos aprobados deterministas sin enviar un OTP, consumir créditos, crear una sesión ni contribuir a Networks.\n\n**Autenticación.** Envía la clave de API de tu aplicación en `x-api-key`. Las credenciales ausentes o no válidas devuelven `403`; esta API nunca devuelve `401`.\n\n**Límite de solicitudes.** Presupuesto de escritura compartido de 300 solicitudes por minuto por clave de API entre todos los endpoints POST/PATCH/DELETE.\n\n**Huella social.** Establece `enable_social` en `true` para añadir un bloque `phone_social`: las plataformas en línea en las que está registrado este número, con recuentos por categoría y los detalles de perfil disponibles. `profiles_registered: 0` significa que se comprobaron las plataformas y el número no se encontró en ninguna de ellas, una respuesta válida y facturable. El bloque está ausente cuando no se solicitó el complemento o no se pudo completar la comprobación, y en ese caso no se factura. La facturación añade una unidad de `phone_social` por solicitud además del precio propio de este endpoint.", "operationId": "post_v3phone_risk", "x-didit-sdk": { "resource": "phone", "method": "assess_risk", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/phone/risk/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"phone_number\": \"+14155552671\",\n \"country_code\": \"US\",\n \"vendor_data\": \"lead-123\",\n \"metadata\": {\"source\": \"signup_prescreen\"}\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.phone.assess_risk(\n phone_number=\"+14155552671\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.phone.assessRisk({\n phone_number: \"+14155552671\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Phone.AssessRisk(ctx, didit.PhoneRiskRequest{\n\tPhoneNumber: \"+14155552671\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.PhoneRiskRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.phone().assessRisk(PhoneRiskRequest.builder()\n .phoneNumber(\"+14155552671\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "phone->assessRisk([\n 'phone_number' => '+14155552671',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.phone.assess_risk(phone_number: \"+14155552671\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Phone.AssessRiskAsync(new PhoneRiskRequest\n{\n PhoneNumber = \"+14155552671\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneRiskRequest" }, "examples": { "Minimal": { "summary": "Puntuar un número con los valores predeterminados", "value": { "phone_number": "+14155552671" } }, "Full context": { "summary": "Puntuar con señales, indicación de país e identificadores de correlación", "value": { "phone_number": "+14155552671", "country_code": "US", "signals": { "ip": "192.0.2.1", "device_id": "8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2", "device_platform": "ios", "device_model": "iPhone17,2", "os_version": "18.0.1", "app_version": "1.2.34", "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_0_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.0 Mobile/15E148 Safari/604.1" }, "vendor_data": "lead-123", "metadata": { "source": "signup_prescreen" } } } } } } }, "responses": { "200": { "description": "La evaluación de riesgo se completó. Consulta `status` para ver la decisión; el código HTTP siempre es `200` en las consultas completadas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneRiskResponse" }, "examples": { "Clean mobile number": { "summary": "Número móvil limpio con cobertura de inteligencia", "value": { "request_id": "4fd09d2e-9bc9-4c4e-9c46-7f625ac0ab62", "status": "Approved", "phone": { "status": "Approved", "phone_number_prefix": "+1", "phone_number": "4155552671", "full_number": "+14155552671", "country_code": "US", "country_name": "United States", "carrier": { "name": "Example Mobile", "type": "mobile" }, "is_disposable": false, "is_virtual": false, "verification_method": null, "verification_attempts": 0, "verified_at": null, "warnings": [], "lifecycle": [], "matches": [], "phone_intelligence": { "score": 3.0, "phone_type_risk": "Low", "phone_trust_index": 97, "network_stability_index": 95, "is_disposable": false, "is_ported": false, "is_recently_ported": false, "carrier_type": "mobile", "reason_codes": [] }, "enrichment": { "score": 3.0, "phone_type_risk": "Low", "phone_trust_index": 97, "network_stability_index": 95, "is_disposable": false, "is_ported": false, "is_recently_ported": false, "carrier_type": "mobile", "reason_codes": [] } }, "vendor_data": "lead-123", "metadata": { "source": "signup_prescreen" }, "created_at": "2026-09-01T10:30:00.123456+00:00" } }, "Number in review": { "summary": "Número desechable o virtual marcado para revisión", "value": { "request_id": "8c22e1f0-4b3d-4a3a-9d1e-2f6b7c8d9e0f", "status": "In Review", "phone": { "status": "In Review", "phone_number_prefix": "+44", "phone_number": "7700900123", "full_number": "+447700900123", "country_code": "GB", "country_name": "United Kingdom", "carrier": { "name": "Example VoIP", "type": "voip" }, "is_disposable": true, "is_virtual": true, "verification_method": null, "verification_attempts": 0, "verified_at": null, "warnings": [], "lifecycle": [], "matches": [], "phone_intelligence": { "score": 72.0, "phone_type_risk": "High", "phone_trust_index": 28, "network_stability_index": 40, "is_disposable": true, "is_ported": true, "is_recently_ported": true, "carrier_type": "voip", "reason_codes": [ { "code": "IR-5AC67A32", "direction": "risk", "message": "Phone type identified as non-mobile", "impact_level": "medium" } ] }, "enrichment": { "score": 72.0, "phone_type_risk": "High", "phone_trust_index": 28, "network_stability_index": 40, "is_disposable": true, "is_ported": true, "is_recently_ported": true, "carrier_type": "voip", "reason_codes": [ { "code": "IR-5AC67A32", "direction": "risk", "message": "Phone type identified as non-mobile", "impact_level": "medium" } ] } }, "vendor_data": "lead-124", "metadata": null, "created_at": "2026-09-01T10:30:00.123456+00:00" } } } } } }, "400": { "$ref": "#/components/responses/PhoneRiskValidationError" }, "403": { "$ref": "#/components/responses/RiskPermissionDenied" }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/": { "post": { "summary": "Crear una sesión de verificación", "description": "Crea una sesión de Verificación de usuarios (KYC) o de Verificación de empresas (KYB) y recibe una `url` de verificación alojada y un `session_token` para redirigir a tu usuario final o integrarla en tu aplicación. El `workflow_id` determina qué pasos de verificación se ejecutan y si la sesión es KYC o KYB.\n\nLlama a este endpoint desde tu backend (nunca desde el navegador, ya que la clave de API es secreta) cada vez que necesites verificar a un usuario o una empresa: en el registro, antes de una acción sensible o cuando se requiera una reverificación. Requisitos previos: un flujo de verificación (workflow) publicado (creado en la página [Workflows](https://docs.didit.me/es/console/workflows) de la consola) y una clave de API de la aplicación con créditos disponibles. Las aplicaciones sandbox omiten la comprobación de créditos.\n\n**Idempotencia:** si se proporciona `vendor_data` y ya existe una sesión sin finalizar (`Not Started`, `In Progress`, `Resubmitted` o `Awaiting User`) con el mismo `vendor_data` en la **versión publicada más reciente actual** del flujo (y esa sesión ya tiene una URL de verificación alojada), se devuelve la sesión existente (igualmente con `201`) en lugar de crear un duplicado, con su `callback` y su `metadata` actualizados a los nuevos valores proporcionados. Una sesión sin finalizar creada en una versión anterior del flujo (que se haya vuelto a publicar desde entonces) **no** se reutiliza; en su lugar, se crea una nueva sesión fijada a la versión publicada más reciente. Las sesiones en estado `Approved`, `Declined`, `In Review`, `Expired`, `Abandoned` o `Kyc Expired` nunca se reutilizan.\n\n**Efectos secundarios:** se genera y almacena la URL de verificación alojada; si `contact_details.send_notification_emails` es `true` y se proporciona un correo electrónico, se envía un correo de invitación a la verificación. La sesión expira una vez transcurrido el tiempo de expiración de sesión configurado en el flujo. En los flujos KYB, se ignoran `contact_details.phone` y `expected_details`.", "operationId": "post_v3_session_create", "x-didit-sdk": { "resource": "sessions", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "responses": { "201": { "description": "Sesión creada (o devuelta, si ya existe una sesión sin terminar con el mismo `vendor_data` en la última versión publicada del flujo). La respuesta es la sesión serializada, incluida la `url` de la verificación alojada a la que debes redirigir al usuario.", "content": { "application/json": { "schema": { "type": "object", "required": [ "session_id", "session_number", "session_token", "url", "vendor_data", "metadata", "status", "workflow_id", "workflow_version", "callback" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Identificador único de la sesión de verificación. Usa este id al llamar a `GET /v3/session/{sessionId}/decision/`.", "example": "11111111-2222-3333-4444-555555555555" }, "session_number": { "type": "integer", "description": "Número secuencial y fácil de leer asignado a la sesión dentro de tu aplicación. Útil para soporte y paneles.", "example": 43762 }, "session_token": { "type": "string", "description": "Token de 12 caracteres seguro para URL que autoriza al usuario final a acceder al flujo de verificación alojado en `url`. Es válido hasta que la sesión expira. Trátalo como un secreto: cualquiera que lo tenga puede abrir el flujo de verificación de esta sesión.", "example": "3FaJ9wLqX2Mz" }, "url": { "type": "string", "format": "uri", "description": "URL de verificación alojada a la que debes redirigir al usuario final. La URL incluye el `session_token` y, si está configurado, usa tu dominio de marca blanca. Cuando la solicitud incluye `language`, la URL contiene un segmento de ruta con el idioma: `https://verify.didit.me/{language}/session/{session_token}` (p. ej., `/es/session/...`); sin `language`, el segmento se omite.", "example": "https://verify.didit.me/session/3FaJ9wLqX2Mz" }, "vendor_data": { "type": "string", "nullable": true, "description": "Identificador que pasaste en la solicitud para vincular la sesión con un usuario o una empresa de tu propio sistema. Se devuelve tal cual. Null si no se proporciona.", "example": "user-123" }, "metadata": { "description": "Payload JSON arbitrario que guardaste con la sesión al crearla. Se devuelve literalmente: cualquier valor JSON que hayas enviado (objeto, cadena, número, array) se devuelve tal cual, aunque se recomienda un objeto JSON. No se muestra al usuario final. Siempre está presente en las respuestas; es `null` si no se proporcionó al crearla.", "example": { "user_type": "premium", "account_id": "ABC123" } }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Las etiquetas de la sesión, por nombre.", "example": [ "VIP", "ONBOARDING Q4" ] }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Estado actual de la sesión. Las sesiones recién creadas devuelven `Not Started`. Si ya existía una sesión no finalizada para el mismo `vendor_data` en la última versión publicada del flujo, el estado devuelto refleja esa sesión existente.", "example": "Not Started" }, "callback": { "type": "string", "format": "uri", "nullable": true, "description": "URL de redirección final a la que se envía al usuario después de completar el flujo. Didit añade `?verificationSessionId={session_id}&status={status}` a esta URL. Si no se proporciona en la solicitud, se usa la URL de callback configurada en el flujo; es `null` cuando no se ha definido ninguna de las dos. Cuando la aplicación tiene dominios permitidos y esta URL es una URL web fuera de ellos (por ejemplo, un valor predeterminado del flujo definido antes de que cambiara la lista), el flujo alojado no redirige al usuario a ella.", "example": "https://example.com/verification/callback" }, "workflow_id": { "type": "string", "format": "uuid", "description": "Identificador estable del flujo en el que se ejecuta esta sesión. Siempre es el identificador de grupo estable del flujo: aunque en la solicitud hayas indicado el UUID de una versión concreta del flujo (búsqueda compatible con versiones anteriores), la respuesta incluye el `workflow_id` estable. Úsalo para relacionar la sesión con el flujo que configuraste en la consola.", "example": "11111111-2222-3333-4444-555555555555" }, "workflow_version": { "type": "integer", "description": "Número de la versión publicada del flujo a la que quedó fijada la sesión al crearse. Didit resuelve `workflow_id` a la última versión publicada del flujo cuando se crea la sesión, y la sesión sigue ejecutando esa versión aunque el flujo se vuelva a publicar más adelante.", "example": 3 } } }, "examples": { "KYC session": { "summary": "Sesión KYC creada", "value": { "session_id": "11111111-2222-3333-4444-555555555555", "session_number": 43762, "session_token": "3FaJ9wLqX2Mz", "url": "https://verify.didit.me/en/session/3FaJ9wLqX2Mz", "vendor_data": "user-123", "metadata": { "user_type": "premium", "account_id": "ABC123" }, "status": "Not Started", "workflow_id": "11111111-2222-3333-4444-555555555555", "workflow_version": 3, "callback": "https://example.com/verification/callback" } }, "KYB session": { "summary": "Sesión KYB creada", "value": { "session_id": "22222222-3333-4444-5555-666666666666", "session_number": 43763, "session_token": "Yk7pQ2vN8aBc", "url": "https://verify.didit.me/en/session/Yk7pQ2vN8aBc", "vendor_data": "company-acme-001", "metadata": { "tier": "enterprise" }, "status": "Not Started", "workflow_id": "33333333-4444-5555-6666-777777777777", "workflow_version": 1, "callback": "https://example.com/kyb/callback" } } } } } }, "400": { "description": "Solicitud incorrecta: el payload no superó la validación (`workflow_id` ausente o desconocido, `language` no válido, `vendor_data` en la lista de bloqueo, `portrait_image` con formato incorrecto, `address` sin `country`/`poa_country`, `sandbox_scenario` no válido, documentos `sign`, campos o valores que rechaza el paso de Firma electrónica del flujo, como `signature_document_not_supported`, `signature_document_conversion_failed`, `field_anchor_not_found` o `field_value_missing`, etc.) o tu organización no tiene suficientes créditos para iniciar la sesión.\n\nEl cuerpo es un objeto cuyas claves son el nombre del campo problemático (o `detail` para los errores que no son de un campo). Los valores son un **array de cadenas** en los fallos de validación de la entrada (p. ej., falta un campo obligatorio, idioma no válido, imagen de retrato demasiado grande) y una **cadena simple** en los fallos detectados al crear la sesión (`workflow_id` desconocido, `vendor_data` en la lista de bloqueo, ningún rostro de referencia disponible para un flujo de Coincidencia facial). Gestiona ambas formas.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "detail": { "type": "string", "description": "Mensaje de error legible para errores no asociados a un campo (p. ej., créditos insuficientes). En los fallos a nivel de campo, la clave es el nombre del campo, con un valor de tipo cadena o array de cadenas.", "example": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } }, "examples": { "Missing workflow_id": { "summary": "Campo obligatorio omitido (forma de array de cadenas)", "value": { "workflow_id": [ "This field is required." ] } }, "Invalid workflow_id": { "summary": "workflow_id desconocido (formato de cadena simple)", "value": { "workflow_id": "Invalid workflow_id." } }, "Insufficient credits": { "summary": "La organización no tiene créditos", "value": { "detail": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } }, "Blocklisted vendor_data": { "summary": "vendor_data está en la lista de bloqueo", "value": { "vendor_data": "This user or business has been blocked and cannot create new verification sessions." } }, "Portrait image too large": { "summary": "portrait_image no supera la validación de tamaño", "value": { "portrait_image": [ "Image size exceeds 2MB." ] } }, "No stored face for vendor_data": { "summary": "Flujo de Coincidencia facial sin portrait_image y sin rostro almacenado para el usuario de vendor_data", "value": { "portrait_image": "No stored face image was found for this user. Send a portrait_image, or complete an approved verification with face liveness or an ID document for this vendor_data first." } }, "Portrait image required without vendor_data": { "summary": "Flujo de Coincidencia facial sin portrait_image y sin vendor_data", "value": { "portrait_image": "A portrait image is required to perform face match for this workflow. Send a portrait_image, or provide the vendor_data of a user with a previously stored face image to reuse it." } } } } } }, "403": { "description": "Falló la autenticación o la autorización. Una clave incorrecta, revocada o expirada devuelve `401`. El endpoint devuelve `403` cuando falta el encabezado `x-api-key` o cuando la clave de API es válida pero el cliente no tiene permiso para crear sesiones en esta aplicación (por ejemplo, la clave de API pertenece a otra organización). Estos fallos comparten el cuerpo `{\"detail\": \"You do not have permission to perform this action.\"}`. Comprueba que el encabezado `x-api-key` esté presente y pertenezca a la aplicación prevista, vuelve a obtener la clave de API de la aplicación mediante la [API de autenticación](/es/auth-api/get-credentials) si es necesario y vuelve a intentarlo.\n\n**Aplicación eliminada:** durante unos minutos después de eliminar una aplicación, una solicitud hecha con una de sus claves de API puede responder `{\"detail\": \"This application was deleted.\", \"code\": \"application_deleted\"}`. No vuelvas a intentarlo: la aplicación y sus claves de API ya no existen. Pasados esos minutos, la clave se rechaza como cualquier otra clave no válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You do not have permission to perform this action." }, "code": { "type": "string", "description": "Motivo legible por máquina, presente solo en algunos fallos. `application_deleted`: la clave de API pertenece a una aplicación que se eliminó.", "example": "application_deleted" } }, "required": [ "detail" ] }, "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key` o la clave de API no es válida", "value": { "detail": "You do not have permission to perform this action." } }, "No permission": { "summary": "El cliente no puede crear sesiones", "value": { "detail": "You do not have permission to perform this action." } }, "Application deleted": { "summary": "Clave de API de una aplicación eliminada", "value": { "detail": "This application was deleted.", "code": "application_deleted" } } } } } }, "429": { "description": "Límite de solicitudes superado: más de 600 solicitudes de creación de sesión en una ventana de 60 segundos desde la misma clave de API o IP. Consulta `Retry-After` y espera antes de reintentar.\n\n**Nota:** El código fuente también define un `FREE_SESSION_RATE_LIMIT` de 10 llamadas por minuto junto con `PAID_SESSION_RATE_LIMIT=600` (`sessions/serializers/session.py`), pero ese tope del plan gratuito **no se aplica a este endpoint V3**: el middleware de límite de solicitudes aplica el `SESSION_CREATE_RATE_LIMIT` de 600 por minuto independientemente del plan. 600 por minuto es el único límite que puedes alcanzar aquí.", "headers": { "Retry-After": { "description": "Segundos que quien llama debe esperar antes de reintentar la solicitud.", "schema": { "type": "integer", "minimum": 1, "example": 42 } }, "X-RateLimit-Limit": { "description": "Número máximo de solicitudes permitidas en la ventana actual de 60 segundos para el límite que se superó (600 para la creación de sesiones). No aparece en la variante de cuota del sandbox.", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Número de solicitudes que aún se permiten en la ventana actual para el límite superado. No aparece en la variante de cuota de sandbox.", "schema": { "type": "integer", "minimum": 0, "example": 0 } }, "X-RateLimit-Reset": { "description": "Segundos de época Unix (UTC) en los que se restablece la ventana actual del límite de solicitudes. Ausente en la variante de cuota de sandbox.", "schema": { "type": "integer", "minimum": 0, "example": 1747497600 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Explicación legible de la superación del límite de solicitudes. Usa este mensaje para distinguir cuál de los tres límites se alcanzó.", "example": "Session creation rate limit exceeded. You can make up to 600 requests per minute." } } }, "examples": { "Session-create limit": { "summary": "Más de 600 solicitudes de creación de sesión por minuto", "value": { "detail": "Session creation rate limit exceeded. You can make up to 600 requests per minute." } }, "Sandbox session quota": { "summary": "La aplicación sandbox superó las 500 sesiones en 24 horas", "value": { "detail": "Sandbox session quota exceeded (500 sessions per 24h). Wait for the window to reset. Expected available in 3600 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/session/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"workflow_id\": \"11111111-2222-3333-4444-555555555555\",\n \"vendor_data\": \"user-123\",\n \"callback\": \"https://example.com/verification/callback\",\n \"callback_method\": \"both\",\n \"metadata\": {\"user_type\": \"premium\", \"account_id\": \"ABC123\"},\n \"language\": \"en\",\n \"contact_details\": {\n \"email\": \"john.doe@example.com\",\n \"send_notification_emails\": true,\n \"email_lang\": \"en\",\n \"phone\": \"+14155552671\"\n },\n \"expected_details\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1990-05-15\",\n \"id_country\": \"USA\",\n \"expected_document_types\": [\"P\", \"ID\"]\n }\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.create(\n workflow_id=\"11111111-2222-3333-4444-555555555555\",\n vendor_data=\"user-123\",\n callback=\"https://example.com/verification/callback\",\n callback_method=\"both\",\n metadata={\"user_type\": \"premium\", \"account_id\": \"ABC123\"},\n language=\"en\",\n contact_details={\n \"email\": \"john.doe@example.com\",\n \"send_notification_emails\": True,\n \"email_lang\": \"en\",\n \"phone\": \"+14155552671\",\n },\n expected_details={\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1990-05-15\",\n \"nationality\": \"USA\",\n \"id_country\": \"USA\",\n \"expected_document_types\": [\"P\", \"ID\"],\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.create({\n workflow_id: \"11111111-2222-3333-4444-555555555555\",\n vendor_data: \"user-123\",\n callback: \"https://example.com/verification/callback\",\n callback_method: \"both\",\n metadata: { user_type: \"premium\", account_id: \"ABC123\" },\n language: \"en\",\n contact_details: {\n email: \"john.doe@example.com\",\n send_notification_emails: true,\n email_lang: \"en\",\n phone: \"+14155552671\",\n },\n expected_details: {\n first_name: \"John\",\n last_name: \"Doe\",\n date_of_birth: \"1990-05-15\",\n nationality: \"USA\",\n id_country: \"USA\",\n expected_document_types: [\"P\", \"ID\"],\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Create(ctx, didit.SessionsCreateParams{\n\tWorkflowID: \"11111111-2222-3333-4444-555555555555\",\n\tVendorData: didit.String(\"user-123\"),\n\tCallback: didit.String(\"https://example.com/verification/callback\"),\n\tCallbackMethod: didit.Some(didit.SessionsCreateParamsCallbackMethod(\"both\")),\n\tMetadata: didit.Some[any](map[string]any{\"user_type\": \"premium\", \"account_id\": \"ABC123\"}),\n\tLanguage: didit.Some(didit.SessionsCreateParamsLanguage(\"en\")),\n\tContactDetails: didit.Some(didit.SessionsCreateParamsContactDetails{\n\t\tEmail: didit.String(\"john.doe@example.com\"),\n\t\tSendNotificationEmails: didit.Bool(true),\n\t\tEmailLang: didit.Some(didit.SessionsCreateParamsContactDetailsEmailLang(\"en\")),\n\t\tPhone: didit.String(\"+14155552671\"),\n\t}),\n\tExpectedDetails: didit.Some(didit.SessionsCreateParamsExpectedDetails{\n\t\tFirstName: didit.String(\"John\"),\n\t\tLastName: didit.String(\"Doe\"),\n\t\tDateOfBirth: didit.String(\"1990-05-15\"),\n\t\tNationality: didit.String(\"USA\"),\n\t\tIDCountry: didit.String(\"USA\"),\n\t\tExpectedDocumentTypes: didit.Some([]didit.SessionsCreateParamsExpectedDetailsExpectedDocumentTypes{\"P\", \"ID\"}),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().create(SessionsCreateParams.builder()\n .workflowId(\"11111111-2222-3333-4444-555555555555\")\n .vendorData(\"user-123\")\n .callback(\"https://example.com/verification/callback\")\n .callbackMethod(SessionsCreateParams.CallbackMethod.of(\"both\"))\n .metadata(Map.of(\"user_type\", \"premium\", \"account_id\", \"ABC123\"))\n .language(SessionsCreateParams.Language.of(\"en\"))\n .contactDetails(SessionsCreateParams.ContactDetails.builder()\n .email(\"john.doe@example.com\")\n .sendNotificationEmails(true)\n .emailLang(SessionsCreateParams.ContactDetails.EmailLang.of(\"en\"))\n .phone(\"+14155552671\")\n .build())\n .expectedDetails(SessionsCreateParams.ExpectedDetails.builder()\n .firstName(\"John\")\n .lastName(\"Doe\")\n .dateOfBirth(LocalDate.parse(\"1990-05-15\"))\n .nationality(\"USA\")\n .idCountry(\"USA\")\n .expectedDocumentTypes(List.of(SessionsCreateParams.ExpectedDetails.ExpectedDocumentTypes.of(\"P\"), SessionsCreateParams.ExpectedDetails.ExpectedDocumentTypes.of(\"ID\")))\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->create([\n 'workflow_id' => '11111111-2222-3333-4444-555555555555',\n 'vendor_data' => 'user-123',\n 'callback' => 'https://example.com/verification/callback',\n 'callback_method' => 'both',\n 'metadata' => ['user_type' => 'premium', 'account_id' => 'ABC123'],\n 'language' => 'en',\n 'contact_details' => [\n 'email' => 'john.doe@example.com',\n 'send_notification_emails' => true,\n 'email_lang' => 'en',\n 'phone' => '+14155552671',\n ],\n 'expected_details' => [\n 'first_name' => 'John',\n 'last_name' => 'Doe',\n 'date_of_birth' => '1990-05-15',\n 'nationality' => 'USA',\n 'id_country' => 'USA',\n 'expected_document_types' => ['P', 'ID'],\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.create(\n workflow_id: \"11111111-2222-3333-4444-555555555555\",\n vendor_data: \"user-123\",\n callback: \"https://example.com/verification/callback\",\n callback_method: \"both\",\n metadata: { user_type: \"premium\", account_id: \"ABC123\" },\n language: \"en\",\n contact_details: {\n email: \"john.doe@example.com\",\n send_notification_emails: true,\n email_lang: \"en\",\n phone: \"+14155552671\",\n },\n expected_details: {\n first_name: \"John\",\n last_name: \"Doe\",\n date_of_birth: \"1990-05-15\",\n nationality: \"USA\",\n id_country: \"USA\",\n expected_document_types: [\"P\", \"ID\"],\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.CreateAsync(new SessionsCreateParams\n{\n WorkflowId = \"11111111-2222-3333-4444-555555555555\",\n VendorData = \"user-123\",\n Callback = \"https://example.com/verification/callback\",\n CallbackMethod = new SessionsCreateParamsCallbackMethod(\"both\"),\n Metadata = new Dictionary { [\"user_type\"] = \"premium\", [\"account_id\"] = \"ABC123\" },\n Language = new SessionsCreateParamsLanguage(\"en\"),\n ContactDetails = new SessionsCreateParamsContactDetails\n {\n Email = \"john.doe@example.com\",\n SendNotificationEmails = true,\n EmailLang = new SessionsCreateParamsContactDetailsEmailLang(\"en\"),\n Phone = \"+14155552671\",\n },\n ExpectedDetails = new SessionsCreateParamsExpectedDetails\n {\n FirstName = \"John\",\n LastName = \"Doe\",\n DateOfBirth = \"1990-05-15\",\n Nationality = \"USA\",\n IdCountry = \"USA\",\n ExpectedDocumentTypes = new SessionsCreateParamsExpectedDetailsExpectedDocumentTypes[] { \"P\", \"ID\" },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "workflow_id" ], "properties": { "workflow_id": { "type": "string", "format": "uuid", "description": "Identificador estable del flujo de verificación (workflow) que define qué pasos de verificación ejecutará la sesión. Los flujos se crean y gestionan en la página [Workflows](/es/console/workflows) de la consola. El `workflow_id` también determina de forma implícita si la sesión es de KYC o de KYB.", "example": "11111111-2222-3333-4444-555555555555", "x-readme-id": "0.0" }, "vendor_data": { "type": "string", "description": "Un identificador único del usuario que se verifica, como un UUID, un correo electrónico o un ID de usuario interno. Este campo se usa para: (1) **Agrupación de usuarios**: las sesiones con el mismo vendor_data se vinculan al mismo perfil de usuario en la pestaña Users. (2) **Detección de duplicados entre sesiones**: al buscar rostros, documentos, números de teléfono, correos electrónicos, direcciones IP o huellas de dispositivo duplicados, las sesiones con el mismo vendor_data se tratan como el mismo usuario y se excluyen de las coincidencias. Sin vendor_data, cada sesión se trata como un usuario único y se muestran todos los posibles duplicados. Recomendamos encarecidamente proporcionar siempre un vendor_data para reducir el ruido en la detección de duplicados.", "example": "user-123", "x-readme-id": "0.1" }, "multi_account_segment": { "type": "string", "maxLength": 64, "description": "Ámbito opcional de detección de duplicados dentro de tu organización. Las comprobaciones de rostro duplicado comparan esta sesión solo con otras sesiones que llevan el mismo segmento, de modo que las bases de cuentas separadas (cuentas personales y de empresa, o una por cada subcliente B2B) no marcan a una persona que legítimamente tiene una cuenta en cada una. Omítelo para usar el ámbito predeterminado único, que es el que usan hoy todas las sesiones. La coincidencia con la lista de bloqueo y la lista de permitidos ignora este campo.", "example": "business-accounts" }, "callback": { "type": "string", "description": "URL a la que se redirige al usuario cuando finaliza la verificación. Didit añade automáticamente `verificationSessionId` y `status` (Approved, Declined, In Review) como parámetros de consulta. Se admiten esquemas de URL personalizados (p. ej., `myapp://`) para callbacks en aplicaciones móviles. Si se omite, se usa el `callback_url` predeterminado del flujo. Cuando la aplicación tiene dominios permitidos (`allowed_domains` en `PATCH /v3/webhook/`), un callback `http` o `https` debe pertenecer a uno de esos orígenes (mismo esquema, host y puerto); de lo contrario, la solicitud falla con un error 400 en `callback`: `callback must be on one of the application's allowed domains: https://app.example.com`. Los esquemas de URL personalizados siempre se aceptan.", "example": "https://example.com/verification/callback", "x-readme-id": "0.2" }, "callback_method": { "type": "string", "description": "Determina qué dispositivo debe gestionar la redirección a la URL de callback proporcionada. Usa `initiator` para redirigir solo el dispositivo que inició el flujo, `completer` para el dispositivo que lo finaliza, o `both` para que cualquiera de los dos dispositivos pueda activar el callback. Si notas que el callback no se activa de forma fiable, te recomendamos establecer este valor en `both`.", "enum": [ "initiator", "completer", "both" ], "default": "initiator", "example": "both", "x-readme-id": "0.3" }, "metadata": { "description": "JSON arbitrario que se guarda con la sesión y se devuelve en la respuesta y en los webhooks. Se acepta cualquier valor JSON (objeto, cadena, número, array), pero se recomienda un objeto JSON de pares clave/valor. No se muestra al usuario final. Úsalo para pasar tus propios ids de correlación, variantes A/B o contexto de negocio.", "example": { "user_type": "premium", "account_id": "ABC123" }, "x-readme-id": "0.4" }, "tags": { "type": "array", "items": { "type": "string", "maxLength": 50 }, "maxItems": 10, "description": "Etiquetas que se añaden a la sesión al crearla, por nombre. Hasta 10, cada una de hasta 50 caracteres. Los nombres no distinguen entre mayúsculas y minúsculas y se almacenan en mayúsculas. Un nombre que todavía no existe en la aplicación se crea como una etiqueta nueva. Las etiquetas aparecen en la sesión en la consola, donde puedes filtrar por ellas.", "example": [ "VIP", "ONBOARDING Q4" ] }, "language": { "type": "string", "description": "Código de idioma (ISO 639-1) para la interfaz del proceso de verificación. Controla el idioma que ve el usuario final durante la verificación. Si no se proporciona, se detecta y se usa automáticamente el idioma del navegador. Consulta todos los idiomas admitidos [aquí](/es/integration/supported-languages).", "enum": [ "en", "ar", "bg", "bn", "bs", "ca", "cnr", "cs", "da", "de", "el", "es", "et", "fa", "fi", "fr", "he", "hi", "hr", "hu", "hy", "id", "it", "ja", "ka", "kk", "ko", "ky", "lt", "lv", "mk", "mn", "ms", "nl", "no", "pl", "pt-BR", "pt", "ro", "ru", "sk", "sl", "so", "sq", "sr", "sv", "th", "tr", "uk", "uz", "vi", "zh-CN", "zh-TW", "zh" ], "example": "en", "x-readme-id": "0.5" }, "contact_details": { "type": "object", "description": "Información de contacto del usuario que puede usarse para notificaciones, para rellenar previamente los formularios de verificación y para la verificación de teléfono. Incluye la dirección de correo electrónico, el idioma preferido para las comunicaciones y el número de teléfono.", "example": { "email": "john.doe@example.com", "send_notification_emails": true, "email_lang": "en", "phone": "+14155552671" }, "properties": { "email": { "type": "string", "format": "email", "description": "Dirección de correo electrónico del usuario (p. ej., \"john.doe@example.com\") que se usará durante el paso de [Verificación de correo electrónico](/es/core-technology/email-verification/overview). Si no se proporciona, el usuario debe indicarla durante el flujo de verificación.", "example": "john.doe@example.com", "x-readme-id": "1.0" }, "send_notification_emails": { "type": "boolean", "default": false, "description": "Si es true y se proporciona un correo electrónico, Didit envía de forma asíncrona el correo inicial \"Verifica tu identidad\" al crear la sesión de Verificación de usuarios (KYC) o Verificación de empresas (KYB). Didit también envía a la dirección de correo electrónico proporcionada notificaciones del estado de la verificación de las sesiones que requieren revisión manual (p. ej., de 'In Review' a 'Approved' o 'Declined'). Así los usuarios pueden volver a tu aplicación una vez completada su verificación. Si tienes activada la marca blanca para la sesión, el correo enviado será de marca blanca.", "example": true, "x-readme-id": "1.1" }, "email_lang": { "type": "string", "description": "Código de idioma (ISO 639-1) para las notificaciones por correo electrónico. Controla el idioma de todas las comunicaciones por correo electrónico (p. ej., \"en\", \"es\", \"fr\"). No hay un valor predeterminado almacenado: si se omite, el correo de invitación a la verificación usa inglés (`en`) en el momento del envío. El enum siguiente es una instantánea; la fuente de verdad actualizada de los valores aceptados es la documentación de [idiomas admitidos](/es/integration/supported-languages). Consúltala siempre antes de depender de un código concreto.", "enum": [ "en", "ar", "bg", "bn", "bs", "ca", "cnr", "cs", "da", "de", "el", "es", "et", "fa", "fi", "fr", "he", "hi", "hr", "hu", "hy", "id", "it", "ja", "ka", "kk", "ko", "ky", "lt", "lv", "mk", "mn", "ms", "nl", "no", "pl", "pt-BR", "pt", "ro", "ru", "sk", "sl", "so", "sq", "sr", "sv", "th", "tr", "uk", "uz", "vi", "zh-CN", "zh-TW", "zh" ], "example": "en", "x-readme-id": "1.2" }, "phone": { "type": "string", "description": "Número de teléfono en formato E.164 (p. ej., \"+14155552671\") que se usará en el paso de [Verificación de teléfono](/es/core-technology/phone-verification/overview). Si no se indica, el usuario debe introducirlo durante el flujo de verificación. Se ignora en los flujos de Verificación de empresas (KYB). **Importante:** este número de teléfono solo se impone si es un número E.164 válido. Si el número indicado no es válido o no se puede interpretar, se ignorará y el usuario podrá introducir cualquier número de teléfono válido durante el paso de Verificación de teléfono.", "example": "+14155552671", "x-readme-id": "1.3" } }, "x-readme-id": "0.4" }, "expected_details": { "type": "object", "description": "Datos esperados del usuario que se usan para la validación cruzada con los datos extraídos del documento de identidad del usuario, de la Prueba de domicilio y de otros pasos de verificación. Las discrepancias se muestran como advertencias en la decisión; algunos campos (p. ej., `id_country`, `expected_document_types`) también modifican el flujo que ve el usuario. En los flujos de Verificación de empresas (KYB) solo se usan los campos de la empresa (`company_name`, `registry_country`, `registration_number`), que rellenan previamente la búsqueda en el registro de empresas para el usuario, y se ignoran todos los campos de la persona.", "example": { "first_name": "John", "last_name": "Doe", "date_of_birth": "1990-05-15", "nationality": "USA", "id_country": "USA", "expected_document_types": [ "P", "ID" ] }, "properties": { "first_name": { "type": "string", "description": "Nombre del usuario. Por ejemplo, `John`. La comparación es aproximada (fuzzy) y puedes ajustar su rigor configurando el umbral de puntuación de coincidencia del nombre en la consola, tanto para los flujos de documento de identidad como para los de prueba de domicilio.", "example": "John", "x-readme-id": "1.0" }, "last_name": { "type": "string", "description": "Apellido del usuario. Por ejemplo, `Doe`. La comparación es aproximada (fuzzy) y puedes ajustar su rigor configurando el umbral de puntuación de coincidencia del nombre en la consola, tanto para los flujos de documento de identidad como para los de prueba de domicilio.", "example": "Doe", "x-readme-id": "1.1" }, "date_of_birth": { "type": "string", "format": "date", "description": "Fecha de nacimiento del usuario con el formato YYYY-MM-DD. Por ejemplo, `1990-05-15`.", "example": "1990-05-15", "x-readme-id": "1.2" }, "gender": { "type": "string", "nullable": true, "enum": [ "M", "F" ], "default": null, "description": "Género del usuario. Debe ser 'M', 'F' o null.", "example": "M", "x-readme-id": "1.3" }, "nationality": { "type": "string", "description": "Código de país ISO 3166-1 alpha-3 que representa el país de origen del solicitante. Por ejemplo, `USA`. Consulta la [lista completa de códigos de país admitidos](https://docs.didit.me/es/core-technology/id-verification/supported-documents-id-verification#documentos-admitidos-por-país).", "example": "USA", "x-readme-id": "1.4" }, "country": { "type": "string", "description": "Código de país ISO 3166-1 alpha-3 que se usa como valor de respaldo en las comprobaciones de discrepancia de país tanto de Verificación de identidad como de Prueba de domicilio. Es obligatorio cuando se proporciona `address` y no se ha definido ni `id_country` ni `poa_country`.", "example": "USA", "x-readme-id": "1.4.1" }, "id_country": { "type": "string", "description": "Código de país ISO 3166-1 alpha-3 que representa el país esperado del documento de identidad del solicitante, que puede diferir de la nacionalidad. Por ejemplo, `GBR`. Tiene prioridad sobre `country` en las comprobaciones de discrepancia de país de la verificación de identidad. Consulta la [lista completa de códigos de país admitidos](https://docs.didit.me/es/core-technology/id-verification/supported-documents-id-verification#documentos-admitidos-por-país).", "example": "GBR", "x-readme-id": "1.5" }, "poa_country": { "type": "string", "description": "Código de país ISO 3166-1 alpha-3 que representa el país esperado del documento de prueba de domicilio. Por ejemplo, `USA`. Tiene prioridad sobre `country` en las comprobaciones de discrepancia de país de la prueba de domicilio. Consulta la [lista completa de códigos de país admitidos](https://docs.didit.me/es/core-technology/id-verification/supported-documents-id-verification#documentos-admitidos-por-país).", "example": "USA", "x-readme-id": "1.5.1" }, "address": { "type": "string", "description": "La dirección en un formato legible, con toda la información posible. Por ejemplo, `123 Main St, San Francisco, CA 94105, USA`. Si la proporcionas, también debes pasar `country` o `poa_country`; de lo contrario, la solicitud falla con `400`.", "example": "123 Main St, San Francisco, CA 94105, USA", "x-readme-id": "1.6" }, "identification_number": { "type": "string", "description": "El número de documento, número personal o número fiscal del usuario. Por ejemplo, `123456789`.", "example": "123456789", "x-readme-id": "1.7" }, "ip_address": { "type": "string", "description": "Dirección IP esperada para la sesión, en formato IPv4 o IPv6. Si la dirección IP real difiere de este valor, se registrará una advertencia. Por ejemplo, `192.168.1.100` o `2001:db8::1`.", "example": "192.168.1.100", "x-readme-id": "1.8" }, "expected_document_types": { "type": "array", "description": "Restringe los tipos de documento que el usuario puede presentar durante el paso de verificación de identidad (OCR). Cuando se define, la pantalla de selección de documentos solo muestra los tipos solicitados y el `documents_allowed` devuelto se filtra en consecuencia. Los valores no distinguen mayúsculas y minúsculas y se eliminan los duplicados; los valores desconocidos se rechazan con `400`. Códigos permitidos: `P` (pasaporte), `ID` (documento nacional de identidad), `DL` (licencia de conducir), `RP` (permiso de residencia), `HIC` (tarjeta de seguro médico), `TC` (tarjeta fiscal), `SSC` (tarjeta de seguridad social).", "items": { "type": "string", "enum": [ "P", "ID", "DL", "RP", "HIC", "TC", "SSC" ] }, "example": [ "P", "ID" ], "x-readme-id": "1.9" }, "company_name": { "type": "string", "maxLength": 255, "description": "Razón social esperada de la empresa que se verifica. Por ejemplo, `Tesco PLC`. Rellena previamente el campo del nombre de la empresa en la búsqueda del registro en los flujos de Verificación de empresas (KYB); cuando también se proporciona `registration_number`, la consulta al registro combina ambos identificadores. Se ignora en los flujos KYC.", "example": "Tesco PLC", "x-readme-id": "1.10" }, "registry_country": { "type": "string", "maxLength": 10, "description": "Código ISO 3166-1 alfa-2 del país en cuyo registro de empresas está inscrita la empresa. Por ejemplo, `GB`. Cuando los registros de empresas funcionan a nivel de estado o provincia, añade el código de subdivisión ISO 3166-2 con el formato `XX-YY`: `US-CA` corresponde al registro de California. Mismo formato que `country_code` en la [API de búsqueda en registros KYB](https://docs.didit.me/es/standalone-apis/kyb-registry-search). Preselecciona el país del registro en los flujos de Verificación de empresas (KYB); se ignora en los flujos de KYC.", "example": "US-CA", "x-readme-id": "1.11" }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro esperado de la empresa en el registro de empresas. Por ejemplo, `00445790`. Rellena previamente el campo del número de registro en la búsqueda del registro en los flujos de Verificación de empresas (KYB); cuando también se proporciona `company_name`, la consulta al registro combina ambos identificadores. Se ignora en los flujos KYC.", "example": "00445790", "x-readme-id": "1.12" } }, "x-readme-id": "0.5" }, "portrait_image": { "type": "string", "format": "byte", "description": "Imagen de retrato del rostro del usuario final codificada en base64 (máx. 2MB; JPEG, PNG, WebP o TIFF). Se usa como imagen de referencia para compararla con la captura de prueba de vida cuando el flujo es un flujo de `Biometric Authentication` con Coincidencia facial habilitada, o cualquier flujo de grafo en el que la Coincidencia facial se ejecute antes de la Verificación de identidad (OCR). Es opcional cuando el usuario de `vendor_data` ya tiene una imagen facial almacenada: Didit la reutiliza automáticamente, resuelta en este orden de prioridad: rostro de prueba de vida aprobada, foto del chip del pasaporte electrónico, retrato del documento de identidad, rostro de perfil registrado manualmente (solo se reutilizan rostros de sesiones aprobadas o rostros que hayas registrado tú). Cuando se proporciona, `portrait_image` siempre tiene prioridad sobre el rostro almacenado. Si se omite y no existe ningún rostro almacenado (o no se envía `vendor_data`), la creación de la sesión falla con `400`. Se ignora para otros tipos de flujo.", "example": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=", "x-readme-id": "0.6" }, "sandbox_scenario": { "type": "string", "description": "Slug de escenario exclusivo de sandbox. Solo se acepta cuando la clave de API pertenece a una aplicación en modo sandbox; se rechaza en aplicaciones de producción. Cuando se define, el flujo de creación aplica los valores mágicos incluidos en el escenario a los campos de entrada de la sesión (contact_details, expected_details), de modo que los proveedores simulados reproducen el resultado del escenario a través del pipeline real del flujo. Consulta el catálogo de escenarios en GET /v1/sandbox/scenarios/ o en [Sandbox y datos de prueba](/es/integration/sandbox-testing). También puedes activar (o volver a activar) un escenario después de la creación mediante POST /v3/session/{sessionId}/sandbox/arm/, siempre que la sesión siga en `Not Started`. Para la consulta sin documento, usa `lookup_partial_match`, `lookup_no_match` o `lookup_provider_error` para probar el número de intentos configurado y el mecanismo de respaldo. Para las wallets de identidad, usa `wallet_cancelled`, `wallet_timeout` o `wallet_provider_error`; `approve` simula una wallet verificada. Todas las wallets del catálogo se pueden probar en sandbox, incluidos los esquemas que no están disponibles en aplicaciones de producción. Los intentos simulados no se cobran.", "example": "decline_document_expired" }, "sign": { "type": "object", "description": "Datos de firma electrónica para esta sesión. `documents` son los documentos que se deben firmar, para un flujo cuyo paso de Firma electrónica toma los documentos de la sesión (`signature_documents_source` `session` o `both`): hasta 20 documentos y 50 MB en total. `field_values` rellena los campos cuyo `prefill` es `api.`, tanto en los documentos del flujo como en los de la sesión. Si vuelves a crear una sesión para el mismo `workflow_id` y `vendor_data`, se devuelve la sesión pendiente; si esa llamada envía `sign`, sus documentos, campos y valores deben ser idénticos a los primeros, y cualquier diferencia devuelve `400` con `{\"sign\": \"signature_document_changed\"}`. Consulta [Documentos de firma electrónica](/es/sessions-api/create-session#documentos-de-firma-electrónica).", "properties": { "documents": { "type": "array", "minItems": 1, "maxItems": 20, "items": { "$ref": "#/components/schemas/SessionSignDocument" } }, "field_values": { "type": "object", "description": "Valores indexados por la `` de cada fuente de prellenado `api.`: cadenas de 1 a 500 caracteres para los campos `text` y `data`, y booleanos para un `checkbox`. Devuelve `400` con `field_value_unknown` para una clave que ningún campo usa, `field_value_missing` para un campo obligatorio sin su valor y `field_value_invalid` para un valor que no supera la validación de su campo.", "additionalProperties": { "oneOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "boolean" } ] }, "example": { "credit_limit": "3,000 EUR" } } } }, "user_state": { "type": "string", "maxLength": 16, "description": "Lugar de residencia de la persona, cuando lo conoces: un código de subdivisión ISO 3166-2 (`US-IL`, `ES-M`) o un código o nombre de estado de EE. UU. (`IL`, `Illinois`). Un estado cuya ley exige consentimiento biométrico explícito (Illinois, Texas, Colorado) hace que el flujo de verificación lo solicite antes de capturar un rostro, con el disparador `declared_state`. Un valor no reconocido devuelve `400`. Consulta [Consentimiento biométrico](/es/getting-started/biometric-consent).", "example": "US-IL" }, "biometric_consent": { "type": "object", "description": "Consentimiento biométrico explícito que ya recopilaste de la persona. Cumple el requisito, por lo que el flujo de verificación no vuelve a pedirlo, y la decisión lo registra como `status: \"given\"` con el disparador `customer_collected`. Una respuesta que la persona ya dio en el flujo nunca se reemplaza. Consulta [Consentimiento biométrico](/es/getting-started/biometric-consent).", "required": [ "given_at", "text_version" ], "properties": { "given_at": { "type": "string", "format": "date-time", "description": "Fecha y hora en que la persona dio su consentimiento biométrico explícito (ISO 8601). No puede ser una fecha futura." }, "text_version": { "type": "string", "maxLength": 64, "description": "ID de la versión del texto de consentimiento que aceptó la persona, en tus propios registros." } } } }, "example": { "workflow_id": "11111111-2222-3333-4444-555555555555", "vendor_data": "user-123", "callback": "https://example.com/verification/callback", "callback_method": "both", "metadata": { "user_type": "premium", "account_id": "ABC123" }, "language": "en", "contact_details": { "email": "john.doe@example.com", "send_notification_emails": true, "email_lang": "en", "phone": "+14155552671" }, "expected_details": { "first_name": "John", "last_name": "Doe", "date_of_birth": "1990-05-15", "id_country": "USA", "expected_document_types": [ "P", "ID" ] } } }, "examples": { "Create KYC session": { "summary": "Payload completo del flujo sin incidencias de una sesión de Verificación de usuarios (KYC)", "description": "Llamada de creación realista que usa todos los campos que se suelen configurar: selección del flujo, vinculación con datos de vendor, enrutamiento del callback, metadatos, configuración regional, datos de contacto precargados y datos esperados del usuario. Cópiala y pégala directamente en el ejemplo de cURL de arriba.", "value": { "workflow_id": "11111111-2222-3333-4444-555555555555", "vendor_data": "user-123", "callback": "https://example.com/verification/callback", "callback_method": "both", "metadata": { "user_type": "premium", "account_id": "ABC123" }, "language": "en", "contact_details": { "email": "john.doe@example.com", "send_notification_emails": true, "email_lang": "en", "phone": "+14155552671" }, "expected_details": { "first_name": "John", "last_name": "Doe", "date_of_birth": "1990-05-15", "nationality": "USA", "id_country": "USA", "expected_document_types": [ "P", "ID" ] } } }, "Create KYB session": { "summary": "Payload del flujo exitoso para una sesión de Verificación de empresas (KYB)", "description": "Misma estructura que la llamada de KYC: el `workflow_id` es lo que convierte la sesión en KYB. `vendor_data` suele hacer referencia a la empresa en tu sistema y `contact_details.email` se dirige al representante legal que completará el flujo. `expected_details` acepta los campos de empresa (`company_name`, `registry_country`, `registration_number`), que rellenan de antemano la búsqueda en el registro de empresas; los campos de persona y `contact_details.phone` se ignoran en los flujos de KYB.", "value": { "workflow_id": "33333333-4444-5555-6666-777777777777", "vendor_data": "company-acme-001", "callback": "https://example.com/kyb/callback", "callback_method": "both", "metadata": { "tier": "enterprise", "company_id": "ACME-001" }, "expected_details": { "company_name": "Tesco PLC", "registry_country": "GB", "registration_number": "00445790" }, "language": "en", "contact_details": { "email": "legal-rep@acme.example.com", "send_notification_emails": true, "email_lang": "en" } } } } } } } } }, "/v3/session/imports/": { "post": { "summary": "Crear un trabajo de importación de verificaciones", "description": "Crea un trabajo de importación asíncrono para sesiones históricas de Verificación de usuarios, sesiones de Verificación de empresas, registros de monitorización de transacciones o reglas de estado personalizado de flujos. Establece `source=provider` para migrar desde otro proveedor. Didit lee Sumsub, Onfido, Persona y ComplyCube con tu clave de solo lectura. Lee los registros de Veriff, iDenfy y MetaMap a partir de los ID que subes en `file`. Para los demás proveedores, importa un archivo de exportación en el formato de Didit. Los ID de los registros llevan el proveedor como espacio de nombres (`sumsub:`), así que una nueva ejecución omite todo lo que ya está en Didit. Las importaciones están desactivadas por defecto y Didit debe activarlas para cada organización.", "operationId": "post_v3_session_imports_create", "x-didit-sdk": { "resource": "sessions.imports", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "import_type": { "type": "string", "enum": [ "user_verification", "business_verification", "status_rules", "transactions" ], "default": "user_verification", "description": "Qué importar: sesiones históricas de Verificación de usuarios, sesiones históricas de Verificación de empresas, reglas de estado personalizadas del flujo o registros históricos de monitorización de transacciones." }, "workflow_id": { "type": "string", "format": "uuid", "description": "UUID del flujo al que deben asociarse las sesiones importadas o las reglas de estado. Obligatorio para user_verification, business_verification y status_rules. Omítelo para transactions." }, "source_format": { "type": "string", "enum": [ "csv", "ndjson" ], "description": "Opcional. Si se omite, se deduce de la extensión del archivo subido." }, "file": { "type": "string", "format": "binary", "description": "Archivo CSV o NDJSON canónico. Usa NDJSON para importaciones grandes. Tamaño máximo de subida: 25 MB (usa `source_file_url` para archivos más grandes). Mutuamente excluyente con `source_file_url`." }, "source_file_url": { "type": "string", "format": "uri", "description": "Alternativa a la subida de un archivo. Debe ser una URL HTTPS que resuelva a una dirección pública (se rechazan las redes privadas y de loopback). Es mutuamente excluyente con `file`." }, "source": { "type": "string", "enum": [ "file", "provider" ], "description": "`provider` convierte esto en una migración desde otro proveedor de verificación de identidad. Omítelo para importar un archivo." }, "provider": { "type": "string", "enum": [ "sumsub", "jumio", "veriff", "onfido", "persona", "metamap", "socure", "idnow", "shufti", "idenfy", "ondato", "trulioo", "au10tix", "complycube", "other" ], "description": "Origen de la migración, obtenido de `GET /v3/session/imports/providers/`. Obligatorio cuando `source` es `provider`." }, "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "La clave de solo lectura del proveedor, con los nombres de campo que indica `credential_fields`. Se cifra en reposo, nunca se devuelve y se borra cuando termina la importación. Envíala como cadena JSON en multipart." }, "options": { "type": "object", "properties": { "region": { "type": "string", "description": "La región del proveedor, una de sus `regions` (Onfido: `eu`, `us`, `ca`)." } } }, "status_mapping": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Not Finished", "Abandoned" ] }, "description": "Cambios en la correspondencia de estados predeterminada del proveedor: del estado de origen al estado de Didit. `Not Finished` y `Abandoned` se omiten y se contabilizan, pero nunca se importan." }, "dry_run": { "type": "boolean", "default": false, "description": "Cuenta lo que importaría la migración (por estado, ya en Didit, misma persona, sin finalizar) sin escribir nada. El trabajo termina en `READY`. Inícialo con `POST /v3/session/imports/{importId}/start/`." }, "face_templates": { "type": "boolean", "default": false, "description": "Genera plantillas faciales a partir de las selfies importadas y búscalas entre los rostros y la lista de bloqueo de la aplicación. Las coincidencias solo se marcan para revisión. Requiere `lawful_basis_confirmed`." }, "lawful_basis_confirmed": { "type": "boolean", "default": false, "description": "Confirma que tienes una base legal para compartir estas selfies con Didit como encargado del tratamiento." } } } }, "application/json": { "schema": { "type": "object", "required": [ "source_file_url" ], "properties": { "import_type": { "type": "string", "enum": [ "user_verification", "business_verification", "status_rules", "transactions" ], "default": "user_verification", "description": "Qué importar: sesiones históricas de Verificación de usuarios, sesiones históricas de Verificación de empresas, reglas de estado personalizadas del flujo o registros históricos de monitorización de transacciones." }, "workflow_id": { "type": "string", "format": "uuid", "description": "UUID del flujo al que deben asociarse las sesiones importadas o las reglas de estado. Obligatorio para user_verification, business_verification y status_rules. Omítelo para transactions." }, "source_format": { "type": "string", "enum": [ "csv", "ndjson" ], "description": "Opcional. Si se omite, se deduce de la extensión del archivo de la URL." }, "source_file_url": { "type": "string", "format": "uri", "description": "Alternativa a la subida de un archivo. Debe ser una URL HTTPS que resuelva a una dirección pública (se rechazan las redes privadas y de loopback). Es mutuamente excluyente con `file`." }, "source": { "type": "string", "enum": [ "file", "provider" ], "description": "`provider` convierte esto en una migración desde otro proveedor de verificación de identidad. Omítelo para importar un archivo." }, "provider": { "type": "string", "enum": [ "sumsub", "jumio", "veriff", "onfido", "persona", "metamap", "socure", "idnow", "shufti", "idenfy", "ondato", "trulioo", "au10tix", "complycube", "other" ], "description": "Origen de la migración, obtenido de `GET /v3/session/imports/providers/`. Obligatorio cuando `source` es `provider`." }, "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "La clave de solo lectura del proveedor, con los nombres de campo que indica `credential_fields`. Se cifra en reposo, nunca se devuelve y se borra cuando termina la importación. Envíala como cadena JSON en multipart." }, "options": { "type": "object", "properties": { "region": { "type": "string", "description": "La región del proveedor, una de sus `regions` (Onfido: `eu`, `us`, `ca`)." } } }, "status_mapping": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Not Finished", "Abandoned" ] }, "description": "Cambios en la correspondencia de estados predeterminada del proveedor: del estado de origen al estado de Didit. `Not Finished` y `Abandoned` se omiten y se contabilizan, pero nunca se importan." }, "dry_run": { "type": "boolean", "default": false, "description": "Cuenta lo que importaría la migración (por estado, ya en Didit, misma persona, sin finalizar) sin escribir nada. El trabajo termina en `READY`. Inícialo con `POST /v3/session/imports/{importId}/start/`." }, "face_templates": { "type": "boolean", "default": false, "description": "Genera plantillas faciales a partir de las selfies importadas y búscalas entre los rostros y la lista de bloqueo de la aplicación. Las coincidencias solo se marcan para revisión. Requiere `lawful_basis_confirmed`." }, "lawful_basis_confirmed": { "type": "boolean", "default": false, "description": "Confirma que tienes una base legal para compartir estas selfies con Didit como encargado del tratamiento." } } }, "examples": { "URL-based import": { "value": { "import_type": "user_verification", "workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab", "source_file_url": "https://files.example.com/exports/sessions.ndjson" } } } } } }, "responses": { "201": { "description": "Trabajo de importación aceptado. Consulta el `uuid` devuelto hasta que `status` sea `COMPLETED` o `FAILED`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" }, "examples": { "Job accepted": { "value": { "uuid": "3f9c1a2b-4d5e-4f60-8a7b-9c0d1e2f3a4b", "status": "PENDING", "import_type": "user_verification", "source_format": "ndjson", "source_filename": "sessions.ndjson", "total_rows": 0, "processed_rows": 0, "checkpoint_row": 0, "created_count": 0, "updated_count": 0, "skipped_count": 0, "failed_count": 0, "total_media_bytes": 0, "last_error": null, "created_at": "2026-05-17T08:42:11Z", "updated_at": "2026-05-17T08:42:11Z", "started_at": null, "completed_at": null } } } } } }, "400": { "description": "Flujo, tipo de archivo, tamaño de archivo, URL de origen o combinación de selectores no válidos. Una migración cuya clave rechaza el proveedor responde con `code` (`invalid_credentials`, `missing_permission`, `wrong_region`, `provider_unavailable`, `rate_limited`, `ids_required`, `record_not_found`), `missing_permissions` y `suggested_region`.", "content": { "application/json": { "examples": { "Invalid workflow": { "value": { "workflow_id": [ "Invalid workflow_id." ] } }, "Workflow required": { "value": { "workflow_id": [ "This field is required for this import type." ] } }, "Wrong file type": { "value": { "file": [ "Only CSV and NDJSON files are supported." ] } }, "File too large": { "value": { "file": [ "Import file exceeds the maximum allowed size." ] } }, "No source": { "value": { "file": [ "Upload a file or provide source_file_url." ] } }, "Both sources": { "value": { "file": [ "Use either file or source_file_url, not both." ] } } } } } }, "403": { "description": "Importaciones no habilitadas, aplicación de sandbox o falta la clave de API (una clave incorrecta, revocada o expirada devuelve `401`). Las importaciones de verificaciones están deshabilitadas de forma predeterminada y Didit debe habilitarlas para cada organización.", "content": { "application/json": { "examples": { "Imports not enabled": { "value": { "detail": "Verification imports are not enabled for this organization." } }, "Sandbox": { "value": { "detail": "Verification imports are not enabled for sandbox applications." } }, "Bad API key": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "La aplicación ya tiene un trabajo de importación activo (PENDING/PROCESSING/PAUSED). Espera a que termine antes de iniciar otro.", "content": { "application/json": { "examples": { "Active job": { "value": { "detail": "This application already has an active import job. Wait for it to finish before starting another." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.create(\n import_type=\"user_verification\",\n workflow_id=\"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n source_file_url=\"https://files.example.com/exports/sessions.ndjson\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.create({\n import_type: \"user_verification\",\n workflow_id: \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n source_file_url: \"https://files.example.com/exports/sessions.ndjson\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Create(ctx, didit.SessionsImportsCreateParams{\n\tImportType: didit.Some(didit.SessionsImportsCreateParamsImportType(\"user_verification\")),\n\tWorkflowID: didit.String(\"9f9b1234-aaaa-bbbb-cccc-1234567890ab\"),\n\tSourceFileURL: didit.String(\"https://files.example.com/exports/sessions.ndjson\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsImportsCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().create(SessionsImportsCreateParams.builder()\n .importType(SessionsImportsCreateParams.ImportType.of(\"user_verification\"))\n .workflowId(\"9f9b1234-aaaa-bbbb-cccc-1234567890ab\")\n .sourceFileUrl(\"https://files.example.com/exports/sessions.ndjson\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->create([\n 'import_type' => 'user_verification',\n 'workflow_id' => '9f9b1234-aaaa-bbbb-cccc-1234567890ab',\n 'source_file_url' => 'https://files.example.com/exports/sessions.ndjson',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.create(\n import_type: \"user_verification\",\n workflow_id: \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n source_file_url: \"https://files.example.com/exports/sessions.ndjson\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.CreateAsync(new SessionsImportsCreateParams\n{\n ImportType = new SessionsImportsCreateParamsImportType(\"user_verification\"),\n WorkflowId = \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n SourceFileUrl = \"https://files.example.com/exports/sessions.ndjson\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/template/": { "get": { "summary": "Descargar la plantilla de importación de verificaciones", "description": "Descarga el encabezado CSV canónico para las importaciones de verificaciones. El conjunto de columnas depende de `import_type`. La primera columna de las plantillas de sesión es la clave de idempotencia `external_id`.", "operationId": "get_v3_session_imports_template", "x-didit-sdk": { "resource": "sessions.imports", "method": "retrieve_template", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "import_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "user_verification", "business_verification", "status_rules", "transactions" ], "default": "user_verification" } } ], "responses": { "200": { "description": "Archivo de plantilla CSV.", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Falta la clave de API, no es válida o fue revocada, o la clave no puede descargar plantillas de importación. Si falta la clave, se devuelve `403`; si es incorrecta, fue revocada o expiró, se devuelve `401`.", "content": { "application/json": { "examples": { "Forbidden": { "summary": "Clave de API ausente, no válida o revocada", "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.sessions.imports.retrieve_template()\nwith open(\"download.csv\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.sessions.imports.retrieveTemplate();\nawait writeFile(\"download.csv\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Sessions.Imports.RetrieveTemplate(ctx, didit.SessionsImportsRetrieveTemplateParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.csv\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.sessions().imports().retrieveTemplate()\n .writeTo(Path.of(\"download.csv\"));" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->retrieveTemplate();\n$content->saveTo('download.csv');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.sessions.imports.retrieve_template\nFile.binwrite(\"download.csv\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Sessions.Imports.RetrieveTemplateAsync();\nawait content.SaveToAsync(\"download.csv\");" } ] } }, "/v3/session/imports/{importId}/": { "get": { "summary": "Obtener un trabajo de importación de verificaciones", "description": "Obtén los contadores de progreso de la importación y el estado final de un trabajo. Consulta periódicamente hasta que `status` sea `COMPLETED` o `FAILED`; un `failed_count` > 0 significa que se rechazaron algunas filas: obtén la lista mediante el endpoint de errores.", "operationId": "get_v3_session_imports_retrieve", "x-didit-sdk": { "resource": "sessions.imports", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Estado del trabajo de importación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "404": { "description": "No se encontró el trabajo de importación para esta aplicación.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "403": { "description": "Falta la clave de API, no es válida o fue revocada, o la clave no puede leer los trabajos de importación 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": { "summary": "Clave de API ausente, no válida o revocada", "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/errors/": { "get": { "summary": "Listar errores de filas de importación de verificaciones", "description": "Lista los errores por fila de un trabajo de importación de verificaciones, ordenados por `row_number`. Usa este endpoint para generar un archivo de reintento corregido que contenga solo las filas que fallaron.", "operationId": "get_v3_session_imports_errors", "x-didit-sdk": { "resource": "sessions.imports", "method": "list_errors", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Tamaño de página. Si se omite, el valor predeterminado es 50." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Desplazamiento, empezando en cero, del primer registro que se devuelve." } ], "responses": { "200": { "description": "Errores de fila paginados.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de filas con error: exacto hasta 100, limitado a 100 a partir de ahí. Para detectar la última página, comprueba que `next` sea `null`." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta de la página siguiente, o `null` en la última página." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta de la página anterior, o `null` en la primera página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SessionImportError" } } } }, "examples": { "Row errors": { "value": { "count": 1, "next": null, "previous": null, "results": [ { "uuid": "5a6b7c8d-9e0f-4a1b-8c2d-3e4f5a6b7c8d", "row_number": 17, "external_id": "ext-000017", "error": "status: invalid value 'unknown_status'", "raw_row": { "external_id": "ext-000017", "status": "unknown_status", "first_name": "Jane" }, "created_at": "2026-05-17T08:44:02Z" } ] } } } } } }, "404": { "description": "No se encontró el trabajo de importación para esta aplicación.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "403": { "description": "Falta la clave de API, no es válida o fue revocada, o la clave no puede leer los trabajos de importación 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": { "summary": "Clave de API ausente, no válida o revocada", "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.sessions.imports.list_errors(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.sessions.imports.listErrors(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.Imports.ListErrorsAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsImportsListErrorsParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.sessions().imports().listErrors(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->listErrors('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.imports.list_errors(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Sessions.Imports.ListErrorsAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/session/{sessionId}/decision/": { "get": { "summary": "Obtener la decisión completa de una sesión de verificación", "description": "Obtén el informe de decisión completo de una sesión de verificación: el `status` agregado de la sesión más un informe por cada función de verificación que ejecutó el flujo. Es el endpoint de lectura canónico tanto para sesiones de Verificación de usuarios (KYC) como de Verificación de empresas (KYB). La misma ruta sirve para ambas, y el discriminador `session_kind` de nivel superior te indica qué estructura recibiste (`\"user\"` o `\"business\"`).\n\n**Cada informe de función es un array en plural.** Los flujos V3 son grafos que pueden ejecutar la misma función más de una vez. Por eso cada bloque (`id_verifications`, `nfc_verifications`, `liveness_checks`, `face_matches`, `poa_verifications`, `document_ai_documents`, `phone_verifications`, `email_verifications`, `aml_screenings`, `ip_analyses`, `database_validations`, `questionnaire_responses`) es un array JSON, y cada uno de sus elementos incluye un `node_id` que identifica el nodo del grafo del flujo que lo generó. Lee NFC como `response.nfc_verifications[0]`, nunca como un campo singular `nfc`. Un bloque es `null` hasta que el flujo haya ejecutado esa función al menos una vez. Las funciones que el flujo no incluye nunca aparecen con datos. Los resultados de Firma electrónica están en `signatures`, que solo está presente cuando el flujo tiene un paso de Firma electrónica.\n\n**Cuándo llamarlo.** El patrón recomendado se basa en eventos: espera el webhook `status.updated`, que se dispara cuando la sesión llega a una decisión (`Approved`, `Declined`, `In Review`), y luego llama a este endpoint una vez para obtener el informe completo. El sondeo (polling) también funciona, porque el endpoint se puede llamar en cualquier momento del ciclo de vida de la sesión y devuelve los datos generados hasta ese momento. Aun así, recibir el webhook y luego consultar es más barato y más rápido. Las URL de medios de la respuesta (imágenes de documentos, videos, PDF) son enlaces prefirmados de corta duración. Descárgalos sin demora o vuelve a solicitar la decisión para obtener enlaces nuevos, y no los guardes como referencias a largo plazo.\n\n**Estados.** El `status` de nivel superior es el estado del ciclo de vida de la sesión (`Not Started`, `In Progress`, `Awaiting User`, `In Review`, `Approved`, `Declined`, `Resubmitted`, `Expired`, `Kyc Expired`, `Abandoned`). Además, cada elemento de función tiene su propio `status` a nivel de función (`Not Finished`, `Approved`, `Declined`, `In Review`, ...). Según las reglas de decisión del flujo, una sesión puede estar `Approved` en conjunto mientras una función concreta está `In Review`.\n\n**Autenticación y visibilidad.** Autentícate con la clave de API de la aplicación en el encabezado `x-api-key`. También funciona un token Bearer de un usuario de la consola con el permiso `read:sessions`. Solo son visibles las sesiones que pertenecen a la aplicación autenticada. Si tu flujo restringe los atributos de la respuesta, los campos no permitidos dentro de los elementos de función se devuelven como `null`, mientras que `status`, `warnings` y `node_id` siempre se conservan.\n\n**Límites de solicitudes.** Las solicitudes GET están limitadas a 600 por minuto por clave de API. Si superas el límite, se devuelve `429` con los encabezados `Retry-After` y `X-RateLimit-*`.", "operationId": "get_v3_session_decision", "x-didit-sdk": { "resource": "sessions", "method": "retrieve_decision", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "responses": { "200": { "description": "Informe de decisión completo. `session_kind` distingue las dos estructuras: las sesiones `user` incluyen los arrays de funciones KYC que se muestran abajo; las sesiones `business`, en cambio, incluyen `registry_checks`, `document_verifications` y `key_people_checks` junto con los arrays compartidos. Los arrays de funciones son `null` hasta que el flujo ha ejecutado esa función; las URL de los archivos multimedia son enlaces prefirmados de corta duración.", "content": { "application/json": { "examples": { "Example": { "summary": "Ejemplo completo", "value": { "session_id": "11111111-2222-3333-4444-555555555555", "session_kind": "user", "session_number": 43762, "session_url": "https://verify.didit.me/session/11111111-2222-3333-4444-555555555555", "status": "In Review", "environment": "live", "workflow_id": "11111111-2222-3333-4444-555555555555", "features": [ "ID_VERIFICATION", "NFC", "LIVENESS", "FACE_MATCH", "POA", "PHONE", "DATABASE_VALIDATION", "AML", "IP_ANALYSIS" ], "vendor_data": "11111111-1111-1111-1111-111111111111", "metadata": { "user_type": "premium", "account_id": "ABC123" }, "expected_details": { "first_name": "Carmen", "last_name": "Española Española" }, "contact_details": { "email": "carmen@example.com", "email_lang": "es", "send_notification_emails": false, "phone": null }, "callback": "https://verify.didit.me/", "id_verifications": [ { "node_id": "feature_ocr_1", "status": "Approved", "document_type": "Identity Card", "document_subtype": "ID_CARD_GENERIC", "document_number": "CAA000000", "personal_number": "99999999R", "portrait_image": "https:///portrait.jpg", "front_image": "https:///front.jpg", "front_video": "https:///front.mp4", "back_image": "https:///back.jpg", "back_video": "https:///back.mp4", "full_front_image": "https:///full_front.jpg", "full_back_image": "https:///full_back.jpg", "front_image_camera_front": "https:///front_camera_front.jpg", "back_image_camera_front": "https:///back_camera_front.jpg", "date_of_birth": "1980-01-01", "age": 45, "expiration_date": "2031-06-02", "date_of_issue": "2021-06-02", "issuing_state": "ESP", "issuing_state_name": "Spain", "first_name": "Carmen", "last_name": "Española Española", "full_name": "Carmen Española Española", "gender": "F", "address": "Avda de Madrid 34, Madrid, Madrid", "formatted_address": "Avda de Madrid 34, Madrid, Madrid 28822, Spain", "place_of_birth": "Madrid", "marital_status": "Single", "nationality": "ESP", "extra_fields": { "dl_categories": [], "blood_group": null }, "mrz": { "surname": "ESPANOLA ESPANOLA", "name": "CARMEN", "country": "ESP", "nationality": "ESP", "birth_date": "800101", "expiry_date": "310602", "sex": "F", "document_type": "ID", "document_number": "CAA000000", "optional_data": "99999999R", "optional_data_2": "", "birth_date_hash": "4", "expiry_date_hash": "8", "document_number_hash": "4", "final_hash": "1", "personal_number": "99999999R", "warnings": [], "errors": [], "mrz_type": "TD1", "mrz_string": "IDESPCAA000000499999999R<<<<<<\n8001014F3106028ESP<<<<<<<<<<<1\nESPANOLA/match_face.jpg", "status": "Approved", "is_blocklisted": false, "is_allowlisted": false, "api_service": null, "source": "session" } ], "front_image_quality_score": { "focus_score": 85.3, "brightness_score": 92.1, "brightness_issue": "ok", "is_document_fully_visible": true, "resolution_score": 72.4, "overall_score": 88.7 }, "back_image_quality_score": { "focus_score": 79.1, "brightness_score": 90.5, "brightness_issue": "ok", "is_document_fully_visible": true, "resolution_score": 72.4, "overall_score": 85.2 }, "extra_files": [ "https:///extra_id_verification.jpg" ], "matches": [ { "session_id": "7d4f1f60-9c2e-4b8a-8f3d-2a1b5c6d7e8f", "session_number": 1234, "vendor_data": "user_ref_001", "verification_date": "2024-06-15T10:30:00Z", "user_details": { "name": "John Smith", "document_type": "ID", "document_number": "CLM148418" }, "status": "Approved", "is_blocklisted": false, "api_service": null, "front_image_url": "https:///document_front.jpg" }, { "session_id": "b2c8e4d1-6a3f-4e7b-95c0-1d8f2a6b4c9e", "session_number": 1235, "vendor_data": null, "verification_date": "2024-05-20T14:45:00Z", "user_details": { "name": "John Smith", "document_type": "ID", "document_number": "CLM148418" }, "status": "Declined", "is_blocklisted": true, "api_service": "ID_VERIFICATION", "front_image_url": "https:///document_front_2.jpg" } ], "warnings": [ { "feature": "ID_VERIFICATION", "risk": "QR_NOT_DETECTED", "additional_data": null, "log_type": "information", "short_description": "QR not detected", "long_description": "The system couldn't find or read the QR code on the document, which is necessary for document verification. This could be due to poor image quality or an unsupported document type.", "node_id": "feature_ocr_1" } ], "verification_method": "document", "assurance": "documentary", "wallet_provider": null, "fallback_from": null, "id_lookup": null, "wallet_verification": null, "document_liveness": { "portrait_replace": { "score": 96.46, "front": 96.46, "back": 98.2, "decline_threshold": 35, "review_threshold": 70, "bucket": "approve" }, "printed_copy": { "score": 91.2, "front": 91.2, "back": 93.7, "decline_threshold": 35, "review_threshold": 77, "bucket": "approve" }, "screen_replay": { "score": 99.9, "front": 99.9, "back": 99.5, "decline_threshold": 30, "review_threshold": 70, "bucket": "approve" } } }, { "node_id": "feature_ocr_2", "status": "Approved", "issuing_state": "ZAF", "issuing_state_name": "South Africa", "first_name": "Thabo", "last_name": "Mokoena", "full_name": "Thabo Mokoena", "date_of_birth": "1991-06-15", "personal_number": "9106155043088", "verification_method": "id_lookup", "assurance": "data_match", "wallet_provider": null, "fallback_from": null, "id_lookup": { "source": "Department of Home Affairs", "checked_at": "2026-09-04T09:12:44Z", "attempts": 1, "max_attempts": 2, "outcome": "match", "comparison": [ { "field": "identification_number", "label": "ID number", "provided": "9106155043088", "record": "9106155043088", "result": "match" }, { "field": "full_name", "label": "Full name", "provided": "Thabo Mokoena", "record": "Thabo Mokoena", "result": "match" }, { "field": "date_of_birth", "label": "Date of birth", "provided": "1991-06-15", "record": "1991-06-15", "result": "match" } ], "registry_portrait": "https:///registry_portrait.jpg", "face_match_score": 96.4, "source_errors": [] }, "wallet_verification": null, "warnings": [] }, { "node_id": "feature_ocr_3", "status": "Approved", "issuing_state": "DNK", "issuing_state_name": "Denmark", "first_name": "Freja", "last_name": "Nielsen", "full_name": "Freja Nielsen", "date_of_birth": "1988-03-02", "verification_method": "wallet", "assurance": "cryptographic", "wallet_provider": "mitid", "fallback_from": null, "id_lookup": null, "wallet_verification": { "provider": "mitid", "provider_name": "MitID", "issuing_authority": "Danish Agency for Digital Government", "issuing_country": "DNK", "credential_type": "person_identification", "level_of_assurance": "substantial", "verified_at": "2026-09-04T09:12:44Z", "signature_valid": true, "attributes": { "full_name": "Freja Nielsen", "date_of_birth": "1988-03-02", "cpr_alias": "b0f1c2d3-e4f5-4678-9abc-def012345678" }, "portrait": null, "face_match_score": null }, "warnings": [] } ], "nfc_verifications": [ { "node_id": "feature_nfc_1", "status": "In Review", "is_nfc_skipped": false, "skip_reason": null, "chip_protocol": "icao", "jpki": null, "portrait_image": "https:///portrait.jpg", "signature_image": "https:///signature.jpg", "chip_data": { "document_type": "ID", "issuing_country": "ESP", "document_number": "123456789", "expiration_date": "2030-01-01", "first_name": "John", "last_name": "Smith", "birth_date": "1990-05-15", "gender": "M", "nationality": "ESP", "address": "CALLE MAYOR 123 4B, MADRID, MADRID", "place_of_birth": "MADRID, MADRID" }, "authenticity": { "sod_integrity": true, "dg_integrity": true }, "certificate_summary": { "issuer": "Common Name: CSCA SPAIN, Serial Number: 3, Organization: DIRECCION GENERAL DE LA POLICIA, Country: ES", "subject": "Common Name: DS n-eID SPAIN 2, Organizational Unit: PASSPORT, Organization: DIRECCION GENERAL DE LA POLICIA, Country: ES", "serial_number": "118120836164494130086420187336801405660", "not_valid_after": "2031-02-18 10:21:11", "not_valid_before": "2020-11-18 10:21:11" }, "warnings": [ { "feature": "NFC", "risk": "DATA_INCONSISTENT", "additional_data": null, "log_type": "warning", "short_description": "OCR and NFC mrz code extracted are not the same", "long_description": "The Optical Character Recognition (OCR) data and the NFC chip data don't match, indicating potential document tampering or data inconsistency.", "node_id": "feature_nfc_1" } ] } ], "liveness_checks": [ { "node_id": "feature_liveness_1", "status": "Approved", "method": "ACTIVE_3D", "score": 89.92, "reference_image": "https:///reference.jpg", "video_url": "https:///video.mp4", "age_estimation": 24.3, "matches": [ { "session_id": "7d4f1f60-9c2e-4b8a-8f3d-2a1b5c6d7e8f", "session_number": 1234, "vendor_data": "user_ref_001", "verification_date": "2024-06-15T10:30:00Z", "user_details": { "full_name": "John Smith", "document_type": "ID", "document_number": "CLM148418" }, "status": "Approved", "is_blocklisted": false, "is_allowlisted": false, "api_service": null, "source": "session", "match_image_url": "https:///face_match.jpg", "similarity_percentage": 98.5 }, { "session_id": "3e9a7c21-5b48-4f0e-9c6a-8d2f4b1e0a35", "session_number": 1100, "vendor_data": "customer_xyz", "verification_date": "2024-04-10T09:15:00Z", "user_details": { "full_name": "John Smith", "document_type": "P", "document_number": "DZ8375806" }, "status": "Approved", "is_blocklisted": false, "is_allowlisted": false, "api_service": "PASSIVE_LIVENESS", "source": "session", "match_image_url": "https:///face_match_2.jpg", "similarity_percentage": 95.2 } ], "warnings": [ { "feature": "LIVENESS", "risk": "LOW_LIVENESS_SCORE", "additional_data": null, "log_type": "information", "short_description": "Low liveness score", "long_description": "The liveness check resulted in a low score, indicating potential use of non-live facial representations or poor-quality biometric data.", "node_id": "feature_liveness_1" } ], "face_quality": null, "face_luminance": null } ], "face_matches": [ { "node_id": "feature_face_match_1", "status": "In Review", "score": 65.43, "source_image_session_id": null, "source_image": "https:///source-image.jpg", "target_image": "https:///target-image.jpg", "warnings": [ { "feature": "FACEMATCH", "risk": "LOW_FACE_MATCH_SIMILARITY", "additional_data": null, "log_type": "warning", "short_description": "Low face match similarity", "long_description": "The facial features of the provided image don't closely match the reference image, suggesting a potential identity mismatch.", "node_id": "feature_face_match_1" } ] } ], "phone_verifications": [ { "node_id": "feature_phone_1", "status": "Approved", "phone_number_prefix": "+34", "phone_number": "600600600", "full_number": "+34600600600", "country_code": "ES", "country_name": "Spain", "carrier": { "name": "Orange", "type": "mobile" }, "is_disposable": false, "is_virtual": false, "verification_method": "sms", "verification_attempts": 1, "verified_at": "2024-07-28T06:47:35.654321Z", "lifecycle": [ { "type": "PHONE_VERIFICATION_MESSAGE_SENT", "timestamp": "2025-08-24T09:12:39.580554+00:00", "details": { "status": "Success", "reason": null, "channel": "sms", "actual_channel": "sms" }, "fee": 0.1 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2025-08-24T09:12:39.662157+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "PHONE_VERIFICATION_APPROVED", "timestamp": "2025-08-24T09:12:39.684292+00:00", "details": null, "fee": 0 } ], "warnings": [], "matches": [ { "session_id": null, "session_number": null, "vendor_data": null, "verification_date": null, "phone_number": "+34600000000", "status": null, "is_blocklisted": true, "api_service": null, "source": "list_entry" } ] } ], "email_verifications": [ { "node_id": "feature_email_1", "status": "Approved", "email": "test@example.com", "is_breached": true, "breaches": [ { "name": "TAPAirPortugal", "domain": "flytap.com", "logo_path": "https://logos.example.com/TAPAirPortugal.png", "breach_date": "2022-08-25", "description": "In August 2022, the Portuguese airline TAP Air Portugal was the target of a ransomware attack perpetrated by the Ragnar Locker gang who later leaked the compromised data via a public dark web site. Over 5M unique email addresses were exposed alongside other personal data including names, genders, DoBs, phone numbers and physical addresses.", "is_verified": true, "data_classes": [ "dates_of_birth", "email_addresses", "genders", "names", "nationalities", "phone_numbers", "physical_addresses", "salutations", "spoken_languages" ], "breach_emails_count": 6083479 } ], "is_disposable": false, "is_undeliverable": false, "verification_attempts": 1, "verified_at": "2025-09-15T17:36:19.963451Z", "warnings": [ { "feature": "EMAIL", "risk": "BREACHED_EMAIL_DETECTED", "additional_data": null, "log_type": "information", "short_description": "Breached email detected", "long_description": "This email address was found in one or more known data breaches.", "node_id": "feature_email_1" } ], "lifecycle": [ { "type": "EMAIL_VERIFICATION_MESSAGE_SENT", "timestamp": "2025-09-15T17:36:19.792684+00:00", "details": { "status": "Success", "reason": null }, "fee": 0.02 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2025-09-15T17:36:19.963427+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "EMAIL_VERIFICATION_DECLINED", "timestamp": "2025-09-15T17:36:20.081471+00:00", "details": { "reason": "BREACHED_EMAIL_DETECTED" }, "fee": 0 } ], "matches": [ { "session_id": null, "session_number": null, "vendor_data": null, "verification_date": null, "email": "test@example.com", "status": null, "is_blocklisted": true, "api_service": null, "source": "list_entry" } ] } ], "poa_verifications": [ { "node_id": "feature_poa_1", "status": "Declined", "document_file": "https:///poa_document.pdf", "issuing_state": "AR", "document_type": "UTILITY_BILL", "document_subtype": null, "document_language": "es", "document_metadata": { "file_size": 1000, "content_type": "application/pdf", "creation_date": "2021-01-01", "modified_date": "2021-01-01", "overlay_manipulation": null, "creator": null, "producer": "PDF Generator", "software": null, "encryption": null, "is_signed": false, "is_tampered": false, "signature_info": null, "exif_original_date": null, "exif_digitized_date": null, "processed_by_known_editor": false, "has_different_creation_mod_date": true }, "issuer": "Aguas del Norte", "issue_date": "2021-02-01", "expiration_date": null, "poa_address": "AVDA. MONSEÑOR TAVELLA N° 3396, SALTA", "poa_formatted_address": "Av. Monseñor Tavella 3396, A4400 Salta, Argentina", "poa_parsed_address": { "address_type": "Avenida", "street_1": "Avenida Monseñor Tavella 3396", "street_2": null, "city": "Salta", "region": "Salta", "country": "AR", "postal_code": "A4400", "document_location": { "latitude": -24.8208664, "longitude": -65.4131 } }, "name_on_document": "Fernando De Lima", "name_match_score_expected_details": null, "name_match_score_id_verification": 38.5, "expected_details_address": null, "expected_details_formatted_address": null, "expected_details_parsed_address": {}, "extra_fields": { "bank_account_number": "1234567890", "bank_iban": null, "bank_sort_code": null, "bank_routing_number": null, "bank_swift_bic": null, "bank_branch_name": null, "bank_branch_address": null, "document_phone_number": "+5491112345678", "additional_names": [] }, "extra_files": [ "https:///extra_poa.pdf" ], "detected_codes": [ { "type": "QR_CODE", "page_number": 1, "position": [ [ 820, 1120 ], [ 1002, 1120 ], [ 1002, 1302 ], [ 820, 1302 ] ], "x": 820, "y": 1120, "width": 182, "height": 182, "page_width": 1190, "page_height": 1684, "raw_payload": "aHR0cHM6Ly9hZ3Vhc2RlbG5vcnRlLmNvbS9mYWN0dXJhLzk5ODgxMQ==", "parsed_payload": "https://aguasdelnorte.com/factura/998811" }, { "type": "CODE_128", "page_number": 1, "position": [ [ 112, 1480 ], [ 560, 1480 ], [ 560, 1540 ], [ 112, 1540 ] ], "x": 112, "y": 1480, "width": 448, "height": 60, "page_width": 1190, "page_height": 1684, "raw_payload": "MDA5OTg4MTEwMDA0Mg==", "parsed_payload": "0099881100042" } ], "warnings": [] } ], "document_ai_documents": [ { "status": "Approved", "node_id": "feature_document_ai_1", "items": [ { "uuid": "c1a2b3c4-d5e6-7f80-9a1b-2c3d4e5f6071", "node_id": "feature_document_ai_1", "document_key": "proof_of_funds", "original_filename": "bank_statement.pdf", "file_size": 184320, "file_url": "https:///document_ai/proof_of_funds.pdf", "status": "Approved", "extracted_data": { "account_holder": "John Doe", "balance": 15230.55, "currency": "EUR", "statement_date": "2026-05-31" }, "detected_codes": [ { "type": "QR_CODE", "page_number": 2, "position": [ [ 124, 86 ], [ 306, 86 ], [ 306, 268 ], [ 124, 268 ] ], "x": 124, "y": 86, "width": 182, "height": 182, "page_width": 1190, "page_height": 1684, "raw_payload": "SU5WLTIwMjYtMDA0Mg==", "parsed_payload": "INV-2026-0042" } ], "fields": [ { "key": "account_holder", "name": "Account holder", "instruction": "Extract the full name of the account holder.", "type": "text", "required": true }, { "key": "balance", "name": "Closing balance", "instruction": "Extract the closing balance amount.", "type": "number", "required": true } ], "document_metadata": { "is_tampered": false }, "cross_check_result": null, "created_at": "2026-06-01T12:34:56Z" } ], "warnings": [] } ], "questionnaire_responses": [ { "node_id": "feature_questionnaire_1", "questionnaire_id": "9f7485e0-b00b-4d56-9d3e-7859b68d1213", "title": "Source of Funds", "description": "Reply to this questionnaire to help us understand the source of funds.", "languages": [ "en" ], "default_language": "en", "is_active": true, "is_simple_questionnaire": true, "questionnaire_group_id": "2b6a9d40-13a8-4b1e-9a6c-3f1d2e4b5a60", "version": 1, "published_at": "2025-11-02T09:14:55.000000Z", "sections": [ { "title": null, "description": null, "items": [ { "uuid": "618636d9-7d5c-41ce-b8d0-1ab2a4be20db", "value": "question_1", "element_type": "DROPDOWN", "is_required": true, "title": "What is your primary source of funds?", "description": null, "placeholder": null, "choices": [ { "label": "Salary", "value": "salary" }, { "label": "Business Income", "value": "business_income" }, { "label": "Savings", "value": "savings" }, { "label": "Investments", "value": "investments" }, { "label": "Sale of Asset", "value": "sale_of_asset" }, { "label": "Inheritance/Gift", "value": "inheritance_gift" }, { "label": "Pension", "value": "pension" }, { "label": "Crypto Proceeds", "value": "crypto_proceeds" }, { "label": "Other", "value": "other", "requires_text_input": true } ], "max_files": 1, "answer": { "value": "salary" }, "required_if": null, "repeatable_config": null }, { "uuid": "2d16b527-72be-42e0-8e96-b164b818386c", "value": "question_2", "element_type": "LONG_TEXT", "is_required": true, "title": "Provide details of the primary source.", "description": null, "placeholder": null, "choices": null, "max_files": 1, "answer": { "value": "Test answer" }, "required_if": null, "repeatable_config": null }, { "uuid": "a9239b7c-fbfb-4ea7-b7e4-c835cd4016e0", "value": "question_3", "element_type": "DROPDOWN", "is_required": true, "title": "What is your annual income range (pre-tax)?", "description": null, "placeholder": null, "choices": [ { "label": "Less than $25,000", "value": "<25k" }, { "label": "$25,000 - $50,000", "value": "25k-50k" }, { "label": "$50,001 - $100,000", "value": "50k-100k" }, { "label": "$100,001 - $250,000", "value": "100k-250k" }, { "label": "More than $250,000", "value": ">250k" } ], "max_files": 1, "answer": { "value": "<25k" }, "required_if": null, "repeatable_config": null }, { "uuid": "93dede62-6d0c-4a7f-934d-42175eb94011", "value": "question_4", "element_type": "DROPDOWN", "is_required": true, "title": "What is your approximate net worth (range)?", "description": null, "placeholder": null, "choices": [ { "label": "Less than $50,000", "value": "<50k" }, { "label": "$50,000 - $250,000", "value": "50k-250k" }, { "label": "$250,001 - $1,000,000", "value": "250k-1m" }, { "label": "$1,000,001 - $5,000,000", "value": "1m-5m" }, { "label": "More than $5,000,000", "value": ">5m" } ], "max_files": 1, "answer": { "value": "<50k" }, "required_if": null, "repeatable_config": null }, { "uuid": "2af60d6f-6961-4692-9ee7-24b3033610a6", "value": "question_5", "element_type": "LONG_TEXT", "is_required": true, "title": "For your initial deposit/funding, indicate the exact source and amount.", "description": null, "placeholder": null, "choices": null, "max_files": 1, "answer": { "value": "Test answer" }, "required_if": null, "repeatable_config": null }, { "uuid": "0ad9d1aa-736f-46cf-947b-9e1241b53e40", "value": "question_6", "element_type": "LONG_TEXT", "is_required": true, "title": "Breakdown of sources by percentage.", "description": null, "placeholder": null, "choices": null, "max_files": 1, "answer": { "value": "Test answer" }, "required_if": null, "repeatable_config": null }, { "uuid": "1bf8a2a3-14ee-48a8-bb3d-175481aae4aa", "value": "question_7", "element_type": "SINGLE_CHOICE", "is_required": true, "title": "Will any funds originate from third parties? If yes, please provide details.", "description": null, "placeholder": null, "choices": [ { "label": "Yes", "value": "yes", "requires_text_input": true }, { "label": "No", "value": "no" } ], "max_files": 1, "answer": { "text": "Additional details", "value": "yes" }, "required_if": null, "repeatable_config": null }, { "uuid": "e18d4dd3-b7bf-4883-ba18-d6046adbe313", "value": "question_8", "element_type": "SINGLE_CHOICE", "is_required": true, "title": "Do you hold or plan to use virtual assets (e.g., crypto) to fund this account? If yes, please provide details.", "description": null, "placeholder": null, "choices": [ { "label": "Yes", "value": "yes", "requires_text_input": true }, { "label": "No", "value": "no" } ], "max_files": 1, "answer": { "text": "Additional details", "value": "yes" }, "required_if": null, "repeatable_config": null }, { "uuid": "a90a073d-e098-404c-bbce-5130d8b12a13", "value": "question_9", "element_type": "FILE_UPLOAD", "is_required": true, "title": "Upload a proof of funds document", "description": "You can upload your three (3) most recent bank statements, three (3) most recent payslips, your most recent tax return, proof of company ownership, trading exchange statement, sale of property, or proof of inheritance.", "placeholder": null, "choices": null, "max_files": 3, "answer": { "files": [ "/media/ocr/", "/media/ocr/" ] }, "required_if": null, "repeatable_config": null }, { "uuid": "9503b486-7cb8-4c3b-a97d-4b64926a5a47", "value": "question_10", "element_type": "LONG_TEXT", "is_required": false, "title": "Would you like to add any details to help us expedite our review of the documents you submitted?", "description": null, "placeholder": null, "choices": null, "max_files": 1, "answer": { "value": "Test answer" }, "required_if": null, "repeatable_config": null } ] } ], "status": "Approved" } ], "aml_screenings": [ { "node_id": "feature_aml_1", "status": "In Review", "total_hits": 1, "entity_type": "person", "hits": [ { "id": "hit_7c1e9a40b2d35f86e0a4c912", "url": "https://news.example.org/articles/sample", "match": false, "score": 0.73, "target": null, "caption": "Javier Ejemplo Modelo", "datasets": [ "PEP" ], "features": null, "rca_name": "", "last_seen": "2025-06-13T00:00:00", "risk_view": { "crimes": { "score": 0, "weightage": 20, "risk_level": "Low", "risk_scores": {} }, "countries": { "score": 0, "weightage": 30, "risk_level": "Low", "risk_scores": {} }, "categories": { "score": 100, "weightage": 50, "risk_level": "High", "risk_scores": { "PEP": 100 } }, "custom_list": {} }, "first_seen": "2025-01-18T00:00:00", "properties": { "name": [ "Javier Ejemplo Modelo" ], "alias": [ "Javier Ejemplo Modelo", "David Azagra" ], "notes": [ "Spanish orchestra conductor" ], "title": null, "gender": [ "male" ], "height": null, "topics": null, "weight": null, "address": null, "country": null, "website": null, "eyeColor": null, "keywords": null, "lastName": [ "Ejemplo", "Modelo" ], "position": null, "religion": null, "birthDate": [ "1974" ], "education": [ "Tokyo Arts and Space (2012-2012)", "Saint Petersburg Conservatory (-2010)", "Comillas Pontifical University" ], "ethnicity": null, "firstName": [ "David" ], "hairColor": null, "weakAlias": null, "birthPlace": [ "Madrid" ], "modifiedAt": null, "wikidataId": null, "citizenship": null, "nationality": null }, "match_score": 98, "risk_score": 73, "review_status": "Unreviewed", "score_breakdown": { "name_score": 95, "name_weight": 60, "name_weight_normalized": 70.59, "name_contribution": 67.06, "dob_score": 100, "dob_weight": 25, "dob_weight_normalized": 29.41, "dob_contribution": 29.41, "country_score": 0, "country_weight": 15, "country_weight_normalized": 0, "country_contribution": 0, "document_number_match_type": "NEUTRAL", "document_number_effect": "No document number provided for screening", "total_score": 98 }, "pep_matches": [ { "aliases": [ "Javier Ejemplo Modelo", "David Azagra" ], "education": [ "Tokyo Arts and Space (2012-2012)", "Saint Petersburg Conservatory (-2010)", "Comillas Pontifical University" ], "list_name": "Wikidata", "publisher": "Wikidata", "source_url": "https://news.example.org/articles/sample", "description": "Wikidata is the structured data project of the Wikipedia community, providing fact-based information edited by humans and machines", "matched_name": "Javier Ejemplo Modelo", "pep_position": "", "date_of_birth": "1974", "other_sources": [], "place_of_birth": "Madrid" } ], "linked_entities": [ { "name": [ "Antonio Ejemplo" ], "active": [], "status": [], "details": [], "relation": [] } ], "warning_matches": [], "sanction_matches": [], "adverse_media_details": { "sentiment": "Moderately Negative", "entity_type": "person", "sentiment_score": -2, "adverse_keywords": { "fraud": 3, "juicio": 1, "delitos": 2, "imputado": 1, "impunidad": 1, "corruption": 2, "favoritism": 2, "privilegio": 1, "corrupción": 1, "persecution": 2, "desconfianza": 1, "desprestigio": 1, "fraude de ley": 2, "manipulación": 1, "investigación": 3, "prevaricación": 8, "trato de favor": 1, "irregularidades": 2, "crisis de confianza": 1, "tráfico de influencias": 8 } }, "adverse_media_matches": [ { "country": "spain", "summary": "Javier Ejemplo is implicated in legal violations related to favoritism and influence trafficking, leading to a negative portrayal in the article.", "headline": "La Diputación de Villaejemplo consolida la plaza a medida para el ex asesor de Moncloa amigo del \"hermanito\" de Ejemplo", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "fraud", "prevaricación", "tráfico de influencias", "irregularidades", "imputado" ], "sentiment_score": -2, "publication_date": "2025-06-10T20:46:38" }, { "country": "spain", "summary": "Javier Ejemplo is implicated in legal issues regarding favoritism and corruption, leading to a negative portrayal in the article.", "headline": "La Diputación de Villaejemplo consolida la plaza a medida para el ex asesor de Moncloa amigo del \"hermanito\" de Ejemplo", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "fraud", "prevaricación", "tráfico de influencias", "irregularidades", "trato de favor" ], "sentiment_score": -2, "publication_date": "2025-06-10T20:46:38" }, { "country": "spain", "summary": "Javier Ejemplo Modelo is mentioned in connection with Carlos Ficticio's corruption case, indicating his involvement in alleged influence peddling.", "headline": "España, paraíso del aforado", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "prevaricación", "tráfico de influencias", "corrupción", "impunidad", "privilegio", "desconfianza", "manipulación", "fraude de ley" ], "sentiment_score": -2, "publication_date": "2025-06-10T05:05:34" }, { "country": "spain", "summary": "Javier Ejemplo Modelo is implicated in the same investigation as Ficticio, which raises questions about his conduct and political ethics.", "headline": "Aforamientos: esa figura incómoda", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "prevaricación", "tráfico de influencias", "investigación", "juicio", "fraude de ley", "desprestigio", "crisis de confianza", "delitos" ], "sentiment_score": -2, "publication_date": "2025-06-08T06:01:00" }, { "country": "spain", "summary": "Javier Ejemplo is implicated in a legal investigation regarding irregularities in his hiring, which raises serious concerns about his conduct.", "headline": "La jueza del 'caso Javier Ejemplo' denuncia un «fraude de ley» en el aforamiento de Ficticio (Partido Ejemplo)", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "fraud", "irregularities", "prevaricación", "tráfico de influencias" ], "sentiment_score": -2, "publication_date": "2025-06-09T10:19:10" }, { "country": "spain", "summary": "Javier Ejemplo Modelo is mentioned in connection with legal allegations of corruption, contributing to a negative perception.", "headline": "'Caso aforamiento': la letrada mayor de la Asamblea certifica a la juez que Ficticio es diputado desde antes de prometer su cargo en el Pleno", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "prevaricación", "tráfico de influencias" ], "sentiment_score": -2, "publication_date": "2025-06-09T08:08:30" }, { "country": "spain", "summary": "Javier Ejemplo Modelo is implicated in the same investigation as Ficticio, raising concerns about political corruption and influence.", "headline": "Aforamientos: esa figura incómoda", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "prevaricación", "tráfico de influencias", "investigación" ], "sentiment_score": -2, "publication_date": "2025-06-08T06:01:00" }, { "country": "spain", "summary": "Javier Ejemplo Modelo is implicated in the same investigation as Ficticio, which raises concerns about political misconduct.", "headline": "Aforamientos: esa figura incómoda", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "prevaricación", "tráfico de influencias", "investigación", "delitos" ], "sentiment_score": -2, "publication_date": "2025-06-08T06:00:59" }, { "country": "spain", "summary": "Javier Ejemplo is implicated in a case of favoritism and corruption, which casts a negative light on his character and actions.", "headline": "'Caso Javier Ejemplo': las asociaciones judiciales salen en defensa de la juez Luisa Inventada ante las \"presiones externas\" que sufre", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "favoritism", "corruption", "persecution" ], "sentiment_score": -2, "publication_date": "2025-06-06T10:08:15" }, { "country": "spain", "summary": "Javier Ejemplo is implicated in a case of alleged favoritism and corruption, which casts a negative light on his character and actions.", "headline": "'Caso Javier Ejemplo': las asociaciones judiciales salen en defensa de la juez Luisa Inventada ante las \"presiones externas\" que sufre", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "favoritism", "corruption", "persecution" ], "sentiment_score": -2, "publication_date": "2025-06-06T08:08:15" } ], "additional_information": {} } ], "score": 80, "screened_data": { "full_name": "Javier Ejemplo Modelo", "nationality": "ES", "date_of_birth": "1974-01-01", "document_number": null }, "is_ongoing_monitoring_enabled": true, "next_ongoing_monitoring_bill_date": "2026-07-24", "last_ongoing_screening_at": "2026-09-12T04:03:11Z", "last_ongoing_screening_datasets_updated_at": "2026-09-11T06:00:00Z", "warnings": [ { "feature": "AML", "risk": "POSSIBLE_MATCH_FOUND", "additional_data": null, "log_type": "warning", "short_description": "Possible match found in AML screening", "long_description": "The Anti-Money Laundering (AML) screening process identified potential matches with watchlists or high-risk databases, requiring further review.", "node_id": "feature_aml_1" } ] } ], "ip_analyses": [ { "node_id": "feature_ip_1", "status": "Approved", "device_brand": "Apple", "device_model": "iPhone", "browser_family": "Mobile Safari", "os_family": "iOS", "platform": "mobile", "device_fingerprint": "didit-fp-a1b2c3d4e5f6g7h8", "ip_country": "Spain", "ip_country_code": "ES", "ip_state": "Barcelona", "ip_city": "Barcelona", "latitude": 41.4022, "longitude": 2.1407, "ip_address": "83.50.226.71", "isp": null, "organization": null, "is_vpn_or_tor": false, "is_data_center": false, "time_zone": "Europe/Madrid", "time_zone_offset": "+0100", "ip": { "location": { "latitude": 40.2206327, "longitude": 1.5770097 }, "distance_from_id_document": 23.4, "distance_from_poa_document": 12.3 }, "id_document": { "location": { "latitude": 41.2706327, "longitude": 1.9770097 }, "distance_from_ip": 23.4, "distance_from_poa_document": 18.7 }, "poa_document": { "location": { "latitude": 41.2706327, "longitude": 1.9770097 }, "distance_from_ip": 12.3, "distance_from_id_document": 18.7 }, "warnings": [], "matches": [ { "session_id": "99999999-8888-7777-6666-555555555555", "session_number": 41205, "vendor_data": "22222222-2222-2222-2222-222222222222", "verification_date": "2024-07-20T10:15:30Z", "match_type": "ip_address", "match_source": "ip_address", "matched_value": "83.50.226.71", "status": "Approved", "is_blocklisted": false, "api_service": null, "source": "session", "device_info": { "device_brand": "Apple", "device_model": "iPhone", "browser_family": "Mobile Safari", "os_family": "iOS", "platform": "mobile", "device_fingerprint": "didit-fp-f9e8d7c6b5a40312" }, "location_info": { "ip_address": "83.50.226.71", "ip_country": "Spain", "ip_country_code": "ES", "ip_state": "Barcelona", "ip_city": "Barcelona", "is_vpn_or_tor": false, "is_data_center": false }, "confidence": 0.0, "match_mode": "co_occurrence" }, { "session_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "session_number": 42830, "vendor_data": "33333333-3333-3333-3333-333333333333", "verification_date": "2024-06-30T18:22:05Z", "match_type": "device_fingerprint", "match_source": "recovered_high", "matched_value": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "status": "Declined", "is_blocklisted": false, "api_service": null, "source": "session", "device_info": { "device_brand": "Samsung", "device_model": "SM-G991B", "browser_family": "Chrome Mobile", "os_family": "Android", "platform": "mobile", "device_fingerprint": null }, "location_info": { "ip_address": "83.50.231.18", "ip_country": "Spain", "ip_country_code": "ES", "ip_state": "Madrid", "ip_city": "Madrid", "is_vpn_or_tor": false, "is_data_center": false }, "confidence": 1.0, "match_mode": "deterministic", "recovery_similarity": 0.9874, "tls_ja4_corroborated": true, "recovery_gate_reason": "hardware_root_match" } ] } ], "database_validations": [ { "node_id": "feature_db_validation_1", "issuing_state": "BRA", "validation_type": "one_by_one", "screened_data": { "last_name": "De Lima", "first_name": "Fernando", "tax_number": "01234567890", "date_of_birth": "1980-01-01", "document_type": "ID", "expiration_date": "2030-01-01" }, "validations": [ { "service_id": "bra_cpf", "service_name": "Brazil - CPF status check", "outcome_code": "MATCH", "validation": { "full_name": "full_match", "date_of_birth": "full_match", "identification_number": "full_match" }, "source_data": { "identification_number": "01234567890", "first_name": "FERNANDO", "last_name": "DE LIMA", "date_of_birth": "1980-01-01", "gender": "M", "nationality": "BRA" } } ], "match_type": "full_match", "status": "Approved", "warnings": [] } ], "reviews": [ { "user": "compliance@example.com", "new_status": "Declined", "comment": "Possible match found in AML screening", "created_at": "2024-07-18T13:29:00.366811Z" } ], "created_at": "2024-07-24T08:54:25.443172Z", "expires_at": "2025-07-24T08:54:25.443172Z", "biometric_consent": { "required": false, "trigger": null, "status": "not_required", "given_at": null, "declined_at": null, "text_version": null, "text_hash": null, "locale": null, "policy_url": null, "step": null, "node_id": null, "ip_address": null, "ip_country_code": null, "ip_state": null, "ip_city": null, "user_agent": null, "detected_ip_address": "83.50.226.71", "detected_country_code": "ES", "detected_state": "ES-B", "detected_city": "Barcelona", "declared_state": null, "document_state": null, "jurisdictions": [], "retention_months": null, "reason": null, "decline_reason": null, "face_data_deleted_at": null } } }, "BusinessExample": { "summary": "Ejemplo de sesión de empresa (KYB)", "description": "Una decisión con `session_kind = \"business\"`: las sesiones KYB sustituyen los arrays de funciones de KYC por `registry_checks`, `document_verifications` y `key_people_checks`, y comparten `aml_screenings`, `phone_verifications`, `email_verifications`, `questionnaire_responses`, `ip_analyses`, `reviews` y el envoltorio de la sesión.", "value": { "session_id": "66666666-7777-8888-9999-000000000000", "session_kind": "business", "session_number": 31415, "session_url": "https://verify.didit.me/session/business123", "status": "In Review", "environment": "live", "workflow_id": "abababab-cdcd-efef-0101-232323232323", "features": [ "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE" ], "vendor_data": "merchant-001234", "metadata": null, "callback": "https://example.com/verification/callback", "registry_checks": [ { "status": "Approved", "node_id": "feature_kyb_registry_1", "data_resolved": true, "company": { "uuid": "dddd4444-eeee-5555-ffff-666677778888", "node_id": "feature_kyb_registry_1", "status": "Approved", "registry_status": "active", "data_resolved": true, "company_name": "ACME HOLDINGS LTD", "registration_number": "12345678", "country_code": "GB", "region": null, "company_type": "Private Limited Company", "incorporation_date": "2015-03-12", "registered_address": "1 Example Street, London, EC1A 1AA", "tax_number": null, "risk_level": null, "verification_status": null, "is_from_registry": true, "fetch_status": "resolved", "alternative_names": null, "nature_of_business": "62012 - Business and domestic software development", "registered_capital": "100 GBP", "registered_capital_amount": "100.00", "registered_capital_currency": "GBP", "website": null, "email": null, "phone": null, "legal_entity_identifier": null, "location_of_registration": "England and Wales", "financial_summary": null, "officers": [ { "uuid": "aaaa1111-bbbb-2222-cccc-333344445555", "name": "Jane Smith", "designation": "Director", "role": "director", "nationality": "British", "is_active": true, "kyc_status": "Approved", "kyc_session_url": "https://verify.didit.me/session/abc123def456" } ], "beneficial_owners": [ { "uuid": "bbbb2222-cccc-3333-dddd-444455556666", "name": "John Doe", "first_name": "John", "last_name": "Doe", "entity_type": "person", "roles": [ "ubo", "shareholder" ], "ownership_min_shares": "50", "ownership_max_shares": "75", "is_active": true, "kyc_status": "Pending", "kyc_session_url": "https://verify.didit.me/session/def456ghi789", "effective_ownership_percent": 75.0 } ], "addresses": [ { "type": "registered", "address": "1 Example Street, London, EC1A 1AA", "country": "GB" } ], "industries": [ { "code": "62012", "description": "Business and domestic software development" } ], "accounts": null, "registry_data": {}, "user_provided_data": { "company_name": "ACME HOLDINGS", "registration_number": "12345678" }, "confirmed_by_user_at": "2026-06-10T12:01:30.000000Z", "last_console_edit_at": null, "is_editable": false }, "ownership_structure": { "shareholders": [ { "name": "John Doe", "first_name": "John", "last_name": "Doe", "date_of_birth": null, "country_of_birth": null, "company_name": null, "registration_number": null, "entity_type": "person", "nationality": null, "designation": null, "roles": [ "shareholder" ], "ownership_min_shares": "75", "ownership_max_shares": "75", "voting_min_shares": null, "voting_max_shares": null, "appointment_date": null, "is_active": true, "shareholding": { "share_class": "ORDINARY", "number_of_shares": 750.0, "currency": "GBP", "nominal_value": 1.0, "total_value": null, "percentage": 75.0 } } ], "beneficial_owners": [] }, "warnings": [] } ], "aml_screenings": null, "document_verifications": [ { "status": "In Review", "node_id": "feature_kyb_documents_1", "items": [ { "uuid": "eeee5555-ffff-6666-0000-777788889999", "document_type": "LEGAL_PRESENCE", "document_subtype": "CERTIFICATE_OF_INCORPORATION", "document_group": "LEGAL_PRESENCE", "file_url": "https:///kyb/certificate-of-incorporation.pdf", "original_filename": "certificate_of_incorporation.pdf", "file_size": 482133, "status": "Approved", "created_at": "2026-06-10T12:03:11.000000Z", "cross_check_result": { "critical": { "company_name": { "document": "ACME HOLDINGS LTD", "registry": "ACME HOLDINGS LTD", "score": 1.0, "match": true }, "registration_number": { "document": "12345678", "registry": "12345678", "match": true } }, "non_critical": {}, "people": {} }, "document_metadata": { "file_size": 482133, "content_type": "application/pdf", "creation_date": "2015-03-12T09:00:00", "modified_date": "2015-03-12T09:00:00", "creator": null, "producer": null, "software": null, "encryption": null, "is_signed": true, "is_tampered": false, "signature_info": null, "exif_original_date": null, "exif_digitized_date": null, "processed_by_known_editor": false, "has_different_creation_mod_date": false, "overlay_manipulation": null }, "description": null, "is_requested": false, "ocr_data": { "company_name": "ACME HOLDINGS LTD", "registration_number": "12345678", "incorporation_date": "2015-03-12" }, "is_console_upload": false, "is_confirmed": true }, { "uuid": "ffff6666-0000-7777-1111-888899990000", "document_type": "OWNERSHIP_STRUCTURE", "document_subtype": null, "document_group": "OWNERSHIP_STRUCTURE", "file_url": null, "original_filename": null, "file_size": null, "status": "Not Finished", "created_at": "2026-06-10T15:40:02.000000Z", "cross_check_result": null, "document_metadata": null, "description": "Please upload an up-to-date shareholder registry", "is_requested": true, "ocr_data": null, "is_console_upload": false, "is_confirmed": true } ], "groups": { "LEGAL_PRESENCE": { "total": 1, "approved": 1, "pending": 0, "declined": 0, "in_review": 0, "other": 0, "missing": 0 }, "OWNERSHIP_STRUCTURE": { "total": 1, "approved": 0, "pending": 0, "declined": 0, "in_review": 0, "other": 0, "missing": 1 } }, "required_groups": [ "LEGAL_PRESENCE", "OWNERSHIP_STRUCTURE" ], "warnings": [] } ], "key_people_checks": [ { "status": "In Review", "node_id": "feature_kyb_key_people_1", "registry": { "officers": [ { "uuid": "aaaa1111-bbbb-2222-cccc-333344445555", "name": "Jane Smith", "designation": "Director", "role": "director", "nationality": "British", "appointment_date": "2015-03-12", "termination_date": null, "is_active": true, "address": "1 Example Street, London, EC1A 1AA", "aml_status": "Approved", "kyc_status": "Approved", "kyc_session_url": "https://verify.didit.me/session/abc123def456", "kyc_session_id": "77777777-8888-9999-aaaa-bbbbbbbbbbbb", "verification_workflow_type": "kyc", "verification_workflow_id": "12121212-3434-5656-7878-909090909090", "verification_workflow_label": "Key People KYC", "verification_workflow_features": [ { "feature": "ID_VERIFICATION", "status": "Approved" }, { "feature": "LIVENESS", "status": "Approved" }, { "feature": "AML", "status": "Approved" } ], "didit_internal_id": "99999999-0000-1111-2222-333333333333", "kyc_document_type": "P", "kyc_nationality": "GBR", "kyc_liveness_passed": true, "kyc_verified_at": "2026-06-10T14:22:31.123456Z", "kyc_aml_categories": { "sanctions": "clear", "pep": "clear", "adverse_media": "clear", "warnings": "clear" }, "kyc_notification_sent_at": "2026-06-09T09:00:00.000000Z" } ], "beneficial_owners": [ { "uuid": "bbbb2222-cccc-3333-dddd-444455556666", "name": "John Doe", "first_name": "John", "last_name": "Doe", "date_of_birth": "1980-05-04", "country_of_birth": null, "email": null, "company_name": null, "registration_number": null, "entity_type": "person", "nationality": "British", "designation": null, "roles": [ "ubo", "shareholder" ], "ownership_min_shares": "50", "ownership_max_shares": "75", "is_active": true, "aml_status": null, "kyc_status": "In Progress", "kyc_session_url": "https://verify.didit.me/session/def456ghi789", "kyc_session_id": "88888888-9999-aaaa-bbbb-cccccccccccc", "verification_workflow_type": "kyc", "verification_workflow_id": "12121212-3434-5656-7878-909090909090", "verification_workflow_label": "Key People KYC", "verification_workflow_features": [ { "feature": "ID_VERIFICATION", "status": "Not Finished" }, { "feature": "LIVENESS", "status": "Not Finished" }, { "feature": "AML", "status": "Not Finished" } ], "didit_internal_id": null, "kyc_document_type": null, "kyc_nationality": null, "kyc_liveness_passed": null, "kyc_verified_at": null, "kyc_aml_categories": null, "kyc_notification_sent_at": null, "child_beneficial_owners": [], "effective_ownership_percent": 75.0 } ] }, "submitted": { "parties": [ { "uuid": "cccc3333-dddd-4444-eeee-555566667777", "entity_type": "person", "source": "USER", "name": "John Doe", "first_name": "John", "last_name": "Doe", "company_name": null, "registration_number": null, "email": "john.doe@example.com", "nationality": "GBR", "phone_number": "+447700900123", "date_of_birth": "1980-05-04", "position": "Chief Executive Officer", "custom_fields": {}, "is_active": true, "is_skipped": false, "requires_verification": true, "roles": [ { "role": "ubo", "ownership_percent": 75.0, "voting_percent": 75.0 }, { "role": "director", "ownership_percent": null, "voting_percent": null } ], "kyc_session_id": "88888888-9999-aaaa-bbbb-cccccccccccc", "kyc_session_status": "In Progress", "kyc_session_url": "https://verify.didit.me/session/def456ghi789", "kyb_sub_session_id": null, "kyb_sub_session_status": null, "kyb_sub_session_url": null, "verification_workflow_type": "kyc", "verification_workflow_id": "12121212-3434-5656-7878-909090909090", "verification_workflow_label": "Key People KYC", "verification_workflow_features": [ { "feature": "ID_VERIFICATION", "status": "Not Finished" }, { "feature": "LIVENESS", "status": "Not Finished" }, { "feature": "AML", "status": "Not Finished" } ], "didit_internal_id": null } ] }, "ubo_kyc_summary": { "total": 1, "approved": 0, "flagged": 0, "pending": 1 }, "warnings": [] } ], "phone_verifications": null, "email_verifications": null, "questionnaire_responses": null, "ip_analyses": null, "reviews": [], "contact_details": null, "expected_details": { "company_name": "Tesco PLC", "registry_country": "GB", "registration_number": "00445790" }, "created_at": "2026-06-10T11:58:04.000000Z", "expires_at": "2026-06-24T11:58:04.000000Z" } } }, "schema": { "$ref": "#/components/schemas/SessionDecision" } } } }, "403": { "description": "Falló la autenticación o la autorización. Si falta la clave, se devuelve `403`; una clave incorrecta, revocada o expirada devuelve `401`. Dos cadenas de `detail` distinguen los modos de fallo:\n\n- `\"Authentication credentials were not provided or are invalid.\"` — no hay encabezado `x-api-key` (ni token `Authorization: Bearer`), o la credencial proporcionada no superó la introspección (revocada, expirada o con formato incorrecto).\n- `\"You do not have permission to perform this action.\"` — la credencial es válida, pero no tiene permiso para leer esta sesión: un token Bearer de usuario de la consola no tiene el permiso `read:sessions` o no puede acceder a la aplicación propietaria, o una clave de API pertenece a una organización distinta de la de la sesión.\n\nTen en cuenta que, para un `sessionId` totalmente desconocido, el endpoint resuelve la aplicación propietaria antes de validar las credenciales, por lo que una sesión inexistente devuelve `404` incluso cuando la credencial falta o no es válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Authentication credentials were not provided or are invalid." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la introspección", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Insufficient permissions": { "summary": "Credencial válida sin read:sessions o sin acceso a la aplicación propietaria", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Sesión no encontrada. Se devuelve cuando ninguna sesión activa coincide con el `sessionId` indicado, ni como sesión de Verificación de usuarios (KYC) ni como sesión de Verificación de empresas (KYB). Una sesión que se ha eliminado también termina aquí. El cuerpo es el envoltorio estándar `{\"detail\": ...}`.\n\n**Dos cadenas `detail` distintas.** Si el `sessionId` no se reconoce ni como sesión KYC ni como sesión KYB, la búsqueda del propietario previa a la autenticación falla y recibes `{\"detail\": \"Not found.\"}`. Esto ocurre antes de validar las credenciales, por lo que se devuelve incluso en llamadas no autenticadas. Si la sesión existe pero no se puede recuperar con la aplicación autenticada (por ejemplo, un registro obsoleto o recién eliminado), la vista devuelve `{\"detail\": \"Session not found.\"}`. Ambas indican el mismo resultado, que la sesión no es accesible, así que compara el código de estado `404` en lugar de la cadena.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Not found." } } }, "examples": { "Unknown session id": { "summary": "esta aplicación no conoce el sessionId", "value": { "detail": "Not found." } }, "Session not retrievable": { "summary": "La sesión existe, pero no se puede recuperar para esta aplicación", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Límite de solicitudes superado. Las solicitudes GET están limitadas a **600 por minuto por credencial** (clave de API, token Bearer o IP de origen cuando no hay autenticación). Consulta `Retry-After` / `X-RateLimit-Reset` y espera antes de reintentar. Si alcanzas este límite al consultar periódicamente las decisiones, cambia al webhook `status.updated` y obtén la decisión una vez por cada cambio de estado.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar la solicitud.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Número máximo de solicitudes permitidas en la ventana actual (600 para solicitudes GET).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Marca de tiempo Unix (segundos) en que se restablece la ventana actual.", "schema": { "type": "integer", "example": 1750000000 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Explicación legible de la superación del límite de solicitudes.", "example": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } }, "examples": { "Throttled": { "summary": "Más de 600 solicitudes GET en un minuto con la misma credencial", "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de verificación cuya decisión quieres obtener. Es el `session_id` que devuelve `POST /v3/session/`. La misma ruta sirve para sesiones de Verificación de usuarios (KYC) y de Verificación de empresas (KYB): el servidor resuelve el ID en ambos tipos de sesión.\n\n**Debe ser un UUID válido.** La ruta solo coincide con UUID bien formados, por lo que el enrutador de URL rechaza un valor mal formado antes de que se ejecute el código de la aplicación, y la respuesta es una página **HTML** `404` en lugar del envoltorio JSON `{\"detail\": ...}` que se muestra a continuación. Valida el formato del UUID en el cliente para poder distinguir un error de entrada de un `404` real por sesión inexistente.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "include", "in": "query", "required": false, "description": "Lista separada por comas de secciones adicionales del payload. Valores admitidos: `events` y `resubmissions`, por separado o juntos (`events,resubmissions`). Cuando se pasa `include=events`, la respuesta contiene además la cronología de eventos de la sesión (`events`, incluidos los eventos de enrutamiento `WORKFLOW_BRANCH_EVALUATED` / `WORKFLOW_STATUS_NODE_REACHED` descritos en la página Retrieve Session), el registro de actividad completo (`activity_reviews`), los indicadores de lista de bloqueo (`blocklisted`), un `cost_breakdown` por sesión, los metadatos del flujo (`workflow_type`, `workflow_version`, `workflow_version_id` y `workflow_terminal_node_id`: el último nodo de estado del flujo registrado que estableció un estado de sesión, o `null` si no se ha registrado ninguno; es una procedencia histórica que no se borra con aprobaciones, rechazos o reenvíos manuales, y que se reemplaza por un nodo de estado del flujo posterior) y los metadatos de la sesión (`api_service`: cadena o `null`, solo se establece en sesiones de API independiente; `session_type`: `API`, `HOSTED` o `MIGRATED`; `has_device_nfc_support`: booleano). Dos campos cambian respecto a la estructura simple: el discriminador de nivel superior `session_kind` se **omite** (la estructura con eventos solo existe para sesiones de usuario), y el array `features` pasa de cadenas simples a objetos `{feature, node_id}`, donde la función de correo electrónico se indica como `EMAIL` en lugar de `EMAIL_VERIFICATION`. Esta estructura ampliada la usa principalmente la Didit Console; la mayoría de las integraciones de API deberían omitir el parámetro. **Limitación de KYB:** `include=events` solo se aplica a sesiones de usuario (KYC). Las sesiones de empresa (`session_kind = \"business\"`) siempre devuelven la estructura estándar de decisión de empresa: `events`, `activity_reviews`, `blocklisted`, `cost_breakdown` y los metadatos adicionales `workflow_*` y de sesión nunca se devuelven para sesiones de empresa, y su array `features` sigue siendo un array de cadenas simples. Con `include=resubmissions` (tanto en sesiones de usuario como de empresa), la respuesta también contiene `resubmissions`: una entrada por cada solicitud de reenvío, de la más antigua a la más reciente, cada una con `number`, `created_at`, `previous_status`, `nodes`, `reasons`, `requested_by` y `results` (lo que devolvieron los pasos reenviados antes de la solicitud, con las mismas claves y la misma estructura que los resultados actuales). Cada elemento de `cost_breakdown` incluye `usage_type`, `price`, `details` y `created_at`: un paso reenviado que se vuelve a ejecutar se factura como un elemento nuevo.", "schema": { "type": "string", "enum": [ "events", "resubmissions", "events,resubmissions" ], "example": "events" } } ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/decision/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.retrieve_decision(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.retrieveDecision(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.RetrieveDecision(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsRetrieveDecisionParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().retrieveDecision(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->retrieveDecision('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.retrieve_decision(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.RetrieveDecisionAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/delete/": { "delete": { "summary": "Eliminar una sesión de verificación (KYC o KYB)", "description": "Elimina una única sesión de verificación, de Verificación de usuarios (KYC) o de Verificación de empresas (KYB), mediante su `session_id`. El id se busca primero entre las sesiones KYC y después entre las sesiones KYB, por lo que ambos tipos se eliminan con esta misma URL.\n\n**Qué se elimina:**\n- La sesión y todos los intentos de verificación que contiene, incluidos los resultados que sustituyó un reenvío: la decisión, los datos extraídos, todos los registros de funciones relacionados (verificación de identidad, rostro, prueba de vida, coincidencia facial, AML, comprobaciones en registros, análisis de IP, etc.), sus revisiones y su registro de actividad.\n- Todos los archivos almacenados que pertenecen a la sesión: fotos del anverso y reverso del documento (versiones completas, recortadas y difuminadas por privacidad), videos de captura del documento, recortes del retrato, imágenes del retrato y de la firma del chip NFC, imágenes faciales de referencia, videos de prueba de vida, imágenes de origen y destino de la coincidencia facial, documentos de Prueba de domicilio y cualquier archivo adicional subido (KYC); documentos de la empresa subidos y archivos adicionales (KYB). Documentos de Firma electrónica, PDF firmados, PDF de evidencias e imágenes de firma (KYC y KYB): sus rutas de descarga dejan de funcionar. Las URL de medios emitidas anteriormente (`https:///...`) dejan de resolverse.\n- Los datos faciales de la sesión. Su embedding facial también se elimina, salvo que elijas conservar una plantilla sin imágenes (consulta **Datos biométricos faciales**).\n- Las entregas de webhook que sigan en cola para la sesión y sus reintentos. Los webhooks ya entregados no se ven afectados.\n- En una sesión de Verificación de empresas (KYB): las verificaciones que creó para sus personas clave (KYC) y sus propietarios corporativos (KYB), de forma recursiva, que se indican en `deleted_child_verifications`. Una verificación a la que solo está vinculada, como un KYC aprobado existente que reutilizó, no se elimina.\n\nLa sesión desaparece de inmediato de todos los endpoints de lectura: `GET /v3/session/{sessionId}/decision/` devuelve `404` y `GET /v3/sessions/` deja de listarla. La Monitorización AML continua y la monitorización de registros KYB iniciadas por las verificaciones eliminadas se detienen.\n\n**Qué no se ve afectado:** las entradas de la lista de bloqueo creadas a partir de esta sesión (rostro o documento) **no** se eliminan; gestiónalas con los endpoints de la lista de bloqueo. Los tokens de compartición emitidos para la sesión no se revocan, pero ya no queda nada que importar con ellos: una importación con uno de ellos devuelve `400` con `{\"share_token\": [\"Original session does not exist.\"]}`. Los créditos ya consumidos **no** se reembolsan. La entidad principal de Usuario o Empresa **no** se elimina; para ello usa `POST /v3/users/delete/` o `POST /v3/businesses/delete/`. Si el retrato del perfil del Usuario procedía de esta sesión, el retrato se elimina con ella.\n\n**Datos biométricos faciales:** de forma predeterminada, el embedding facial de la sesión se elimina con la sesión (`face_retention_outcome: deleted`). Una aplicación que haya activado la retención de plantillas biométricas (`face_retention_policy: retain_until_user_deleted` en `PATCH /v3/webhook/`), o una solicitud con `retain_face_embeddings: true`, conserva una plantilla biométrica facial sin imágenes, gestionada por separado y vinculada al Usuario de la sesión (`retained_with_user`), para que la detección de duplicados, la Búsqueda facial y la autenticación biométrica sigan funcionando. La plantilla nunca contiene la imagen del rostro, medios, campos de identidad, la decisión ni el id de la sesión eliminada; es un dato biométrico que se elimina en `biometric_template_expires_at`, o antes si se elimina el Usuario, se realiza un borrado por privacidad o una purga explícita mediante `/v3/biometric-templates/`. Una sesión sin un Usuario vinculado no puede conservar una plantilla (`ineligible_no_vendor_user`). Envía `deletion_instruction: privacy_erasure` para las solicitudes de los interesados: purga todas las plantillas conservadas de ese Usuario y nunca conserva una nueva.\n\n**Irreversible:** la eliminación es permanente y no existe ningún endpoint de restauración. Exporta todo lo que necesites (por ejemplo, un PDF de la decisión) antes de llamarlo.\n\n**Efectos secundarios:** no se emite ningún webhook por las eliminaciones.\n\n**Respuesta:** `200 OK` una vez completada la eliminación, con un cuerpo JSON que indica el `face_retention_outcome`, la caducidad de la plantilla conservada y, en una sesión KYB, `deleted_child_verifications`. Las versiones anteriores de este endpoint devolvían `204 No Content`; actualiza los clientes que comprueban `204`. Guarda tu `instruction_id` en tu propio registro de borrados.\n\n**Idempotencia:** no es idempotente a nivel HTTP: la primera llamada devuelve `200`; repetirla devuelve `404` porque la sesión ya no se resuelve. Tras un `503`, la sesión sigue existiendo; repite la misma solicitud para terminar de eliminarla.\n\n**Autenticación:** envía la clave de API de tu aplicación en el encabezado `x-api-key`; la sesión debe pertenecer a esa aplicación. Los tokens de acceso de usuarios de la consola (`Authorization: Bearer ...`) también pueden llamar a este endpoint si tienen el permiso `delete:sessions`. Tanto los fallos de autenticación como los de permisos devuelven `403`; esta API nunca devuelve `401`.\n\n**Límite de solicitudes:** presupuesto de escritura compartido de 300 solicitudes/min por clave de API entre todos los endpoints POST/PATCH/DELETE; si se supera, se devuelve `429`.\n\nPara eliminar sesiones KYC de forma masiva por su `session_number` numérico, usa `POST /v3/sessions/delete/` en su lugar.\n\n**Informes regulatorios presentados:** si los datos seleccionados forman parte de un informe regulatorio finalizado, se rechaza toda la solicitud con `409` y no se elimina nada. El cuerpo usa `code: in_filed_report` e identifica cada informe con `uuid`, `report_number`, `report_type` y `case_uuid`. Elimina los informes y repite la solicitud.", "operationId": "delete_v3_session_by_id", "x-didit-sdk": { "resource": "sessions", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID (`session_id`) de la sesión de Verificación de usuarios (KYC) o Verificación de empresas (KYB) que se va a eliminar, tal como se devolvió al crear la sesión. Debe ser un UUID canónico con guiones: un valor que no sea un UUID no coincide con la ruta y devuelve `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "responses": { "200": { "description": "Sesión eliminada. El cuerpo indica qué ocurrió con los datos biométricos faciales de la sesión y, en una sesión KYB, cuántas de las verificaciones que creó se eliminaron junto con ella.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "La sesión eliminada." }, "session_number": { "type": "integer", "nullable": true, "description": "El número de la sesión eliminada." }, "face_retention_outcome": { "type": "string", "enum": [ "retained_with_user", "deleted", "none", "ineligible_no_vendor_user" ], "description": "Qué ocurrió con los datos biométricos faciales de la sesión. `deleted`: el embedding facial se eliminó junto con la sesión (valor predeterminado). `retained_with_user`: la sesión se elimina y se conserva una plantilla biométrica sin imágenes vinculada al User; consulta `biometric_template_uuid`. `none`: la sesión no tenía embedding facial (por ejemplo, una sesión KYB o una sesión KYC sin selfie de prueba de vida). `ineligible_no_vendor_user`: se solicitó la retención, pero la sesión no tiene ningún User vinculado, por lo que el embedding se eliminó junto con la sesión. Este endpoint nunca informa de un fallo del almacén biométrico a través de este campo: devuelve `503` y la sesión no se elimina." }, "biometric_template_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "ID de la plantilla biométrica conservada cuando `face_retention_outcome` es `retained_with_user`; `null` en caso contrario. Gestiónala a través de `/v3/biometric-templates/{template_uuid}/`." }, "biometric_template_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que se elimina la plantilla biométrica conservada, cuando `face_retention_outcome` es `retained_with_user`; `null` cuando no se conserva ninguna plantilla." }, "deleted_child_verifications": { "type": "integer", "description": "En una sesión de Verificación de empresas (KYB): cuántas de las verificaciones que creó (las sesiones KYC de sus personas clave y las sesiones KYB de sus propietarios corporativos, de forma recursiva) se eliminaron con ella. Siempre `0` en una sesión KYC." } } }, "examples": { "Deleted (default)": { "value": { "session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02", "session_number": 1024, "face_retention_outcome": "deleted", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 } }, "Retained with User": { "value": { "session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02", "session_number": 1024, "face_retention_outcome": "retained_with_user", "biometric_template_uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "biometric_template_expires_at": "2027-10-09T10:15:00Z", "deleted_child_verifications": 0 } }, "Ineligible: no User": { "summary": "Se solicitó retención en una sesión creada sin vendor_data", "value": { "session_id": "7a1e9c2d-5f4b-4c3a-8e2d-1b0a9f8e7d6c", "session_number": 1031, "face_retention_outcome": "ineligible_no_vendor_user", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 } }, "KYB session": { "value": { "session_id": "0f3c9b7e-2d1a-4e5f-8c6b-7a9d8e1f2c3b", "session_number": 88, "face_retention_outcome": "none", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 3 }, "summary": "Una verificación de empresa eliminada junto con las tres verificaciones que creó para sus personas clave" } } } } }, "400": { "description": "Error de validación: no se elimina nada.", "content": { "application/json": { "examples": { "Privacy erasure cannot retain": { "value": { "retain_face_embeddings": [ "Privacy erasure cannot retain biometric templates." ] } }, "No finite retention duration": { "summary": "Se solicitó retención sin face_retention_days en la solicitud ni en la aplicación", "value": { "detail": "A finite biometric-template retention duration is required." } } } } } }, "403": { "description": "Fallo de autenticación o de permisos. Si falta la clave, también se devuelve `403`; una clave incorrecta, revocada o expirada devuelve `401`. Excepción: cuando el `sessionId` no corresponde a una sesión activa, la búsqueda del propietario previa a la autenticación devuelve `404` primero, incluso con credenciales ausentes o no válidas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado x-api-key, o la clave no es válida", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Insufficient permission": { "summary": "Token de usuario sin delete:sessions, o credenciales de una aplicación que no es propietaria de la sesión", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ninguna sesión KYC o KYB activa con este `session_id`: el id es desconocido o la sesión ya se eliminó (repetir una eliminación correcta lleva a este caso).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not Found": { "summary": "Sesión desconocida o ya eliminada", "value": { "detail": "Not found." } } } } } }, "429": { "description": "Se superó el límite de solicitudes de escritura compartido (300 solicitudes POST/PATCH/DELETE por minuto por clave de API). Revisa `Retry-After` y los encabezados de respuesta `X-RateLimit-*` antes de reintentar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Presupuesto de escritura agotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } }, "503": { "description": "La eliminación no pudo completarse porque un servicio de almacenamiento, un almacén biométrico o un proveedor de monitorización no estaba disponible. La sesión sigue existiendo; repite la misma solicitud hasta que devuelva `200`. Es posible que algunos de sus archivos almacenados o su embedding facial ya se hayan eliminado, así que no confíes en ellos después de un `503`. Los reintentos convergen en una única plantilla.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Session deletion unavailable": { "summary": "Un servicio de almacenamiento o un proveedor de monitorización no estaba disponible", "value": { "detail": "The session could not be deleted because a storage service or a monitoring provider is unavailable. The session is still in place; repeat the request to finish deleting it." } }, "Biometric store unavailable": { "summary": "Un almacén biométrico no estaba disponible al conservar o purgar una plantilla", "value": { "detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable." } } } } } }, "409": { "description": "La sesión forma parte de un informe regulatorio finalizado. No se elimina nada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl (default policy)", "source": "curl -X DELETE \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/delete/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "curl", "label": "curl (retain template)", "source": "curl -X DELETE \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/delete/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"retain_face_embeddings\": true, \"face_retention_days\": 365}'" }, { "lang": "curl", "label": "curl (privacy erasure)", "source": "curl -X DELETE \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/delete/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"deletion_instruction\": \"privacy_erasure\", \"instruction_id\": \"dsar-2026-0142\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.delete(\n \"11111111-2222-3333-4444-555555555555\",\n retain_face_embeddings=True,\n face_retention_days=365,\n instruction_id=\"post-approval-cleanup-2026-08\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.delete(\"11111111-2222-3333-4444-555555555555\", {\n retain_face_embeddings: true,\n face_retention_days: 365,\n instruction_id: \"post-approval-cleanup-2026-08\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Delete(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsDeleteParams{\n\tRetainFaceEmbeddings: didit.Bool(true),\n\tFaceRetentionDays: didit.Int(365),\n\tInstructionID: didit.String(\"post-approval-cleanup-2026-08\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsDeleteParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().delete(\"11111111-2222-3333-4444-555555555555\", SessionsDeleteParams.builder()\n .retainFaceEmbeddings(true)\n .faceRetentionDays(365L)\n .instructionId(\"post-approval-cleanup-2026-08\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->delete('11111111-2222-3333-4444-555555555555', [\n 'retain_face_embeddings' => true,\n 'face_retention_days' => 365,\n 'instruction_id' => 'post-approval-cleanup-2026-08',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.delete(\n \"11111111-2222-3333-4444-555555555555\",\n retain_face_embeddings: true,\n face_retention_days: 365,\n instruction_id: \"post-approval-cleanup-2026-08\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.DeleteAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsDeleteParams\n{\n RetainFaceEmbeddings = true,\n FaceRetentionDays = 365,\n InstructionId = \"post-approval-cleanup-2026-08\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": false, "description": "Opcional. Omite el cuerpo por completo para seguir la política de retención de la aplicación con una eliminación operativa.", "content": { "application/json": { "schema": { "type": "object", "properties": { "retain_face_embeddings": { "type": "boolean", "nullable": true, "description": "Anula la `face_retention_policy` de la aplicación para esta eliminación. `true` conserva una plantilla biométrica facial sin imágenes vinculada al usuario de la sesión después de eliminar la sesión; `false` elimina el embedding facial junto con la sesión; omítelo o usa `null` para seguir la política de la aplicación. Se ignora en las sesiones KYB y en las sesiones sin embedding facial.", "example": true }, "face_retention_days": { "type": "integer", "minimum": 1, "maximum": 3650, "description": "Duración de retención finita, en días, de una plantilla conservada. Es obligatoria cuando se conserva una plantilla, salvo que la aplicación ya defina `face_retention_days`. El `expires_at` de la plantilla es el más temprano entre esta duración, el periodo general de retención de datos de la aplicación y `face_retention_deadline`.", "example": 365 }, "face_retention_deadline": { "type": "string", "format": "date-time", "description": "Caducidad estricta opcional para una plantilla retenida. Debe ser una fecha futura.", "example": "2027-08-28T00:00:00Z" }, "deletion_instruction": { "type": "string", "enum": [ "operational_session_delete", "privacy_erasure" ], "default": "operational_session_delete", "description": "El tipo de instrucción que das. `operational_session_delete` elimina la sesión y conserva una plantilla solo cuando la política o `retain_face_embeddings` lo indican. `privacy_erasure` purga todas las plantillas biométricas conservadas vinculadas al usuario de la sesión antes de eliminar la sesión, la política de la aplicación no puede anularla y no se puede combinar con `retain_face_embeddings: true` (`400`).", "example": "operational_session_delete" }, "instruction_id": { "type": "string", "maxLength": 255, "description": "Tu referencia permanente para esta instrucción de eliminación (por ejemplo, el ID de un ticket de supresión). Se registra en el registro de auditoría y en cualquier plantilla conservada. Didit la genera si se omite.", "example": "dsar-2026-0142" } } }, "examples": { "Retain a biometric template": { "summary": "Eliminar la sesión y conservar una plantilla sin imágenes durante 365 días", "value": { "retain_face_embeddings": true, "face_retention_days": 365, "instruction_id": "post-approval-cleanup-2026-08" } }, "Force deletion on an opted-in application": { "summary": "Eliminar el embedding facial independientemente de la política de la aplicación", "value": { "retain_face_embeddings": false } }, "Privacy erasure": { "summary": "Solicitud del interesado: elimina la sesión y purga todas las plantillas conservadas de esa persona", "value": { "deletion_instruction": "privacy_erasure", "instruction_id": "dsar-2026-0142" } } } } } } } }, "/v3/session/{sessionId}/generate-pdf/": { "get": { "summary": "Descargar un informe PDF de una sesión de verificación", "description": "Genera y descarga un informe PDF listo para cumplimiento normativo de una sesión de verificación finalizada. La misma ruta sirve tanto para sesiones de Verificación de usuarios (KYC) como de Verificación de empresas (KYB): el servidor busca el `sessionId` en ambos tipos de sesión y elige la plantilla de informe correspondiente.\n\n**Estados admitidos.** La sesión ya debe tener un estado final o revisable:\n\n- Sesiones KYC: `Approved`, `Declined`, `In Review` o `Kyc Expired`.\n- Sesiones KYB: `Approved`, `Declined` o `In Review`.\n\nCualquier otro estado (`Not Started`, `In Progress`, `Expired`, `Abandoned`, …) devuelve `403` con una cadena `detail` explicativa; consulta la respuesta `403` más abajo.\n\n**Qué contiene el informe.** El PDF refleja la vista de la sesión en la consola en el momento de la solicitud:\n\n- **KYC**: el estado consolidado de la sesión, la lista de advertencias y una sección por cada función ejecutada: Verificación de identidad (imágenes del documento y campos extraídos), NFC, Prueba de vida, Coincidencia facial, Verificación de correo electrónico, Verificación de teléfono, Prueba de domicilio, respuestas del cuestionario, Validación de base de datos, Análisis AML y Análisis de IP; seguido de las etiquetas de la sesión, la actividad de revisión en la consola (comentarios y cambios de estado) y la cronología de eventos de la sesión.\n- **KYB**: comprobaciones en el registro (datos de la empresa), análisis AML, verificaciones de documentos de la empresa, comprobaciones de personas clave, respuestas de cuestionarios, verificaciones de teléfono y correo electrónico, análisis de IP y la cronología de eventos de la sesión, seguido de las etiquetas y la actividad de revisión.\n\n**Marca.** Si tu aplicación tiene personalización de marca blanca, el informe se genera con tu logotipo y enlaza a la URL de tu política de privacidad; de lo contrario, lleva la marca Didit. Los informes se generan en inglés: no existe un parámetro de idioma.\n\n**Sin caché.** Cada llamada vuelve a generar el PDF a partir de los datos actuales de la sesión, por lo que un informe generado después de una revisión manual refleja la decisión del revisor. Dos llamadas para la misma sesión pueden producir archivos distintos byte a byte: archiva el archivo descargado si necesitas una copia inmutable.\n\n**Latencia.** Antes de componer el PDF, la generación descarga todas las imágenes almacenadas (caras del documento, selfies, archivos adicionales), por lo que las sesiones con mucho contenido multimedia pueden tardar varios segundos. Usa un tiempo de espera de lectura generoso en el cliente (se recomiendan 60 s) y escribe el cuerpo en disco por streaming.\n\n**Barra final.** La ruta canónica termina con una barra final (`…/generate-pdf/`). Una solicitud sin ella se atiende directamente con la misma respuesta: no hay redirección `301`, así que ningún cliente tiene que seguir redirecciones y `curl` no necesita `-L`. Usa la URL con barra, como en los ejemplos.\n\nSi necesitas los datos subyacentes en JSON en lugar de un informe generado, usa `GET /v3/session/{sessionId}/decision/`. Para obtener todas las sesiones con informe de un usuario en un único documento, usa `GET /v3/users/{vendor_data}/generate-pdf/`.", "operationId": "get_v3_session_generate_pdf", "x-didit-sdk": { "resource": "sessions", "method": "generate_pdf", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de Verificación de usuarios (KYC) o Verificación de empresas (KYB) que se va a generar: el `session_id` que devuelve `POST /v3/session/`. La misma ruta sirve para ambos tipos de sesión; usa el nombre de archivo de `Content-Disposition` en la respuesta para saber qué tipo de informe recibiste.\n\n**Debe ser un UUID bien formado y en minúsculas.** La ruta solo coincide con UUID válidos, por lo que el enrutador de URL rechaza un valor mal formado antes de que se ejecute cualquier código de la aplicación, y la respuesta es una página **HTML** `404` en lugar del sobre JSON `{\"detail\": ...}` que se muestra a continuación. El conversor de UUID de la ruta solo coincide con la forma canónica en minúsculas: los UUID con hexadecimales en mayúsculas se rechazan con el 404 en HTML.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "responses": { "200": { "description": "El documento PDF generado, devuelto directamente como binario `application/pdf`: no hay envoltorio JSON ni redirección a una URL de descarga. El cuerpo empieza con los bytes mágicos `%PDF` (PDF 1.7). Guárdalo en un archivo `.pdf` o transmítelo directamente a quien hizo la llamada.", "headers": { "Content-Disposition": { "description": "`attachment; filename=session_{sessionId}.pdf` para sesiones KYC y `attachment; filename=business_{sessionId}.pdf` para sesiones KYB: el prefijo indica qué plantilla de informe se generó.", "schema": { "type": "string", "example": "attachment; filename=session_11111111-2222-3333-4444-555555555555.pdf" } }, "Content-Length": { "description": "Tamaño total del PDF en bytes; el cuerpo no se envía en fragmentos.", "schema": { "type": "integer", "example": 25191 } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Fallo de autenticación, autorización o estado de la sesión. Si falta la clave, se devuelve `403`; una clave incorrecta, revocada o expirada devuelve `401`. Distingue los modos de fallo por la cadena de `detail`:\n\n- `\"Authentication credentials were not provided or are invalid.\"` — no hay encabezado `x-api-key` (ni token `Authorization: Bearer`), o la credencial proporcionada no superó la introspección (revocada, expirada o con formato incorrecto).\n- `\"You do not have permission to perform this action.\"` — la credencial es válida, pero no puede leer esta sesión: un token Bearer de usuario de la consola no tiene el permiso `read:sessions` o no puede acceder a la aplicación propietaria, o una clave de API pertenece a una organización distinta de la de la sesión.\n- `\"You can only generate a PDF for sessions in review, declined, approved or kyc expired\"` — la sesión de KYC existe, pero todavía no está en un estado apto (por ejemplo, `Not Started` o `In Progress`). Espera al webhook `status.updated` antes de solicitar el informe.\n- `\"You can only generate a PDF for sessions in review, declined or approved\"` — la misma condición para las sesiones de KYB.\n\nTen en cuenta que, para un `sessionId` totalmente desconocido, el endpoint resuelve la aplicación propietaria antes de validar las credenciales, por lo que una sesión inexistente devuelve `404` incluso cuando la credencial falta o no es válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You can only generate a PDF for sessions in review, declined, approved or kyc expired" } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la introspección", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Insufficient permissions": { "summary": "Credencial válida sin read:sessions o sin acceso a la aplicación propietaria", "value": { "detail": "You do not have permission to perform this action." } }, "KYC session not finished": { "summary": "Sesión KYC todavía en Not Started / In Progress", "value": { "detail": "You can only generate a PDF for sessions in review, declined, approved or kyc expired" } }, "KYB session not finished": { "summary": "Sesión KYB todavía en Not Started / In Progress", "value": { "detail": "You can only generate a PDF for sessions in review, declined or approved" } } } } } }, "404": { "description": "No existe ninguna sesión activa con este `sessionId`: nunca se creó o se ha eliminado. La resolución del propietario se realiza antes de validar las credenciales, por lo que este `404` se devuelve incluso en solicitudes no autenticadas. Según qué búsqueda falle, la cadena `detail` es `\"Not found.\"` (el caso habitual) o `\"Session not found.\"`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Not found." } } }, "examples": { "Unknown session": { "summary": "sessionId no coincide con ninguna sesión de KYC o KYB", "value": { "detail": "Not found." } }, "Recently deleted session": { "summary": "La sesión se eliminó entre una consulta y otra", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Límite de solicitudes superado. La generación de PDF tiene un límite propio de **50 solicitudes por minuto por credencial** (clave de API, token Bearer o IP de origen cuando no hay autenticación), además del límite global de 600 GET por minuto. Espera los segundos indicados en `Retry-After` (también reflejados en los encabezados `X-RateLimit-*`) y luego reintenta. Los informes no se almacenan en caché en el servidor, así que descarga cada informe una sola vez y guarda el archivo en lugar de volver a solicitarlo.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar la solicitud.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Número máximo de generaciones de PDF permitidas en la ventana actual (50).", "schema": { "type": "integer", "example": 50 } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Marca de tiempo Unix (segundos) en que se restablece la ventana actual.", "schema": { "type": "integer", "example": 1750000000 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Explicación legible de la superación del límite de solicitudes.", "example": "Session PDF generation rate limit exceeded. You can make up to 50 requests per minute." } } }, "examples": { "Throttled": { "summary": "Más de 50 generaciones de PDF en un minuto con la misma credencial", "value": { "detail": "Session PDF generation rate limit exceeded. You can make up to 50 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --fail \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/generate-pdf/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n --output report.pdf" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.sessions.generate_pdf(\n \"11111111-2222-3333-4444-555555555555\",\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.sessions.generatePdf(\"11111111-2222-3333-4444-555555555555\");\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Sessions.GeneratePDF(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.sessions().generatePdf(\"11111111-2222-3333-4444-555555555555\")\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "sessions->generatePdf('11111111-2222-3333-4444-555555555555');\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.sessions.generate_pdf(\"11111111-2222-3333-4444-555555555555\")\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Sessions.GeneratePdfAsync(\"11111111-2222-3333-4444-555555555555\");\nawait content.SaveToAsync(\"download.pdf\");" } ] } }, "/v3/session/{sessionId}/sandbox/arm/": { "post": { "summary": "Activar un escenario de sandbox en una sesión", "description": "Guarda un escenario de sandbox en una sesión con estado `Not Started` y aplica a la sesión sus valores mágicos asociados (correo electrónico, teléfono o campos de `expected_details`), para que los proveedores simulados reproduzcan el resultado del escenario cuando se ejecute el flujo. Este es el endpoint al que llama el selector de escenarios previo al flujo de la interfaz de verificación alojada de Didit cuando un tester elige un resultado antes de iniciar la captura. Crea tu propio selector con él o llámalo directamente desde un entorno de pruebas de sandbox.\n\nAutentícate con el `Session-Token` de la propia sesión (devuelto en `session_token` por [Create Session](/es/sessions-api/create-session)), no con el `x-api-key` de tu aplicación: este endpoint está pensado para llamarse desde el cliente, no desde tu backend. Solo se acepta un escenario mientras `status` sea `Not Started`. Si vuelves a llamarlo mientras sigue en `Not Started`, la sesión se vuelve a preparar: se aplican los valores mágicos del nuevo escenario y solo se borran los valores que escribió el escenario *anterior*, de modo que cualquier valor que el usuario ya haya escrito a mano (correo electrónico, nombre, etc.) se conserva. Se rechaza preparar una sesión que ya ha pasado de `Not Started` o que pertenece a una aplicación de producción (no sandbox).\n\nConsulta [Sandbox y datos de prueba](/es/integration/sandbox-testing) para ver el catálogo completo de escenarios y las otras dos formas de forzar un resultado: `sandbox_scenario` al crear la sesión y escribir directamente los valores mágicos.", "operationId": "post_v3_session_sandbox_arm", "x-didit-sdk": { "resource": "sessions", "method": "arm_sandbox", "auth": "device_token", "server": false }, "tags": [ "Sessions" ], "security": [ { "SessionTokenAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sesión de verificación de sandbox que se va a armar. Debe coincidir con la sesión codificada en el Session-Token que se usa para autenticarse.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "scenario" ], "properties": { "scenario": { "type": "string", "description": "Slug del escenario que se va a activar. Consulta el catálogo en GET /v1/sandbox/scenarios/ o la tabla de escenarios en [Sandbox y datos de prueba](/es/integration/sandbox-testing).", "example": "decline_document_expired" } } }, "examples": { "Arm": { "summary": "Activar el escenario de coincidencia PEP en el análisis AML", "value": { "scenario": "decline_aml_hit" } } } } } }, "responses": { "200": { "description": "Escenario activado. Sus valores mágicos ya están en la sesión. `status` refleja el estado actual de la sesión, que esta llamada nunca modifica: si la operación tiene éxito, siempre es `Not Started`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid" }, "scenario": { "type": "string", "description": "El slug del escenario activado (repite el de la solicitud)." }, "status": { "type": "string", "example": "Not Started" } } }, "examples": { "Armed": { "summary": "Escenario activado en una sesión en estado Not Started", "value": { "session_id": "11111111-2222-3333-4444-555555555555", "scenario": "decline_aml_hit", "status": "Not Started" } } } } } }, "400": { "description": "Error de validación: un slug de escenario desconocido, o la sesión ya ha avanzado más allá de `Not Started`.", "content": { "application/json": { "examples": { "Unknown Scenario": { "summary": "el escenario no está en el catálogo", "value": { "scenario": [ "Unknown sandbox scenario: 'not-a-real-scenario'." ] } }, "Already Started": { "summary": "La sesión ha salido del estado Not Started", "value": [ "Scenario can only be armed before the verification starts." ] } } } } }, "404": { "description": "El Session-Token no corresponde a este `session_id`, o la sesión pertenece a una aplicación de producción (no sandbox).", "content": { "application/json": { "examples": { "Not Found": { "summary": "Sesión de producción, o session_id / token no coinciden", "value": { "detail": "Not found." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/sandbox/arm/ \\\n -H 'Session-Token: YOUR_SESSION_TOKEN' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"scenario\": \"decline_aml_hit\"\n }'" }, { "lang": "python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/sandbox/arm/\",\n headers={\n \"Session-Token\": \"YOUR_SESSION_TOKEN\",\n \"Content-Type\": \"application/json\",\n },\n json={\"scenario\": \"decline_aml_hit\"},\n)\nresponse.raise_for_status()\nprint(response.json()) # {'session_id': '...', 'scenario': 'decline_aml_hit', 'status': 'Not Started'}" }, { "lang": "javascript", "label": "JavaScript", "source": "const response = await fetch(\n 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/sandbox/arm/',\n {\n method: 'POST',\n headers: {\n 'Session-Token': sessionToken,\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({ scenario: 'decline_aml_hit' }),\n },\n);\nif (!response.ok) throw new Error(`HTTP ${response.status}`);\nconst { session_id, scenario, status } = await response.json();" } ] } }, "/v3/session/{sessionId}/update-status/": { "patch": { "summary": "Aprobar, rechazar o solicitar un reenvío para una sesión de verificación", "description": "Anula manualmente la decisión final de una sesión de verificación KYC o KYB. Establece `new_status` en `Approved` o `Declined` para registrar una decisión manual, o en `Resubmitted` para borrar pasos de verificación concretos y permitir que el usuario los repita desde la misma URL de verificación. El endpoint acepta ID de sesión tanto de usuarios (KYC) como de empresas (KYB).\n\nLlámalo cuando la sesión haya llegado a un estado revisable: el estado actual debe ser `Approved`, `Declined`, `In Review`, `Kyc Expired`, `Abandoned` o `Resubmitted`. Las sesiones que siguen en `Not Started`, `In Progress` o `Awaiting User`, o que terminaron como `Expired`, devuelven `400`. Tu clave de API necesita el permiso `write:sessions` (una clave de API con alcance limitado necesita acceso de escritura a las decisiones). La comprobación del estado admisible se ejecuta antes de validar el cuerpo, por lo que una sesión no admisible devuelve el error `Wrong Current Status` aunque el payload también sea inválido.\n\nPara `Resubmitted`, pasa `nodes_to_resubmit` para elegir qué pasos del flujo debe repetir el usuario, u omítelo para seleccionar automáticamente los intentos de funciones existentes que estén en un estado reenviable (`Declined`, `In Review`, `Not Finished`, `Expired`). Las funciones que nunca se intentaron no se seleccionan automáticamente: inclúyelas de forma explícita en `nodes_to_resubmit`, o la solicitud devolverá `400` cuando ningún intento registrado necesite reenvío. Los resultados anteriores de los pasos seleccionados pasan al historial del reenvío (que devuelve Obtener decisión con `include=resubmissions`), los pasos se reordenan según el grafo del flujo, el periodo de expiración de la sesión se reinicia y la URL de verificación original vuelve a poder usarse. Los pasos que solo se ejecutan en el backend (`AML`, `DATABASE_VALIDATION`, `IP_ANALYSIS`) al principio de la lista se ejecutan de inmediato sin interacción del usuario; si todos los pasos reenviados son solo de backend, la sesión se vuelve a finalizar dentro de la misma solicitud. `KYB_REGISTRY` y `KYB_KEY_PEOPLE` no se pueden reenviar directamente: reenvía en su lugar las sesiones KYC hijas correspondientes y la sesión de empresa principal se recalcula automáticamente.\n\nCada llamada que cambia el estado dispara el [webhook](/es/integration/webhooks) `status.updated` una vez que el cambio se confirma, y añade una entrada de actividad (con la atribución del actor y tu `comment`) a los `reviews` de la sesión, visible en [Obtener decisión](#get-/v3/session/-sessionId-/decision/) y en la cronología de actividad de la consola. Los datos agregados del perfil de usuario vinculados al `vendor_data` de la sesión también se actualizan. Rechazar desactiva la monitorización AML continua de la sesión; volver a aprobar la reactiva (desde `Resubmitted`, `Declined` o `Kyc Expired`) cuando el flujo tiene la monitorización activada. Aprobar o rechazar una sesión KYC hija que pertenece a una comprobación de personas clave de KYB recalcula el estado de la sesión de empresa principal. Establece `send_email: true` (con `email_address`) para notificar al usuario: un aviso de estado para `Approved`/`Declined`, o un correo de reenvío con el enlace de verificación y los motivos de cada paso para `Resubmitted`. Para revisar el correo antes, obtén una vista previa con [Vista previa del correo de decisión](/es/sessions-api/preview-decision-email) (`Approved`, `Declined`) o [Vista previa del correo de reenvío](/es/sessions-api/preview-resubmission) (`Resubmitted`) y pasa su `preview_token` como `email_preview_token`: la actualización envía entonces exactamente el correo previsualizado, o devuelve `409` antes de cambiar nada si el correo o la sesión cambiaron desde la vista previa o si el comprobante tiene más de 15 minutos.\n\nRepetir `Approved` o `Declined` en una sesión que ya tiene ese estado no cambia nada y devuelve `200`: sin webhook, sin entrada de actividad y sin correo. Repetir `Resubmitted` devuelve `400` (`The new status is the same as the current status.`). Las credenciales ausentes o inválidas y la falta de permisos devuelven `403`; una clave de API con alcance limitado que ha expirado devuelve `401`.", "operationId": "patch_v3_session_update_status", "x-didit-sdk": { "resource": "sessions", "method": "update_status", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sesión de verificación que se va a actualizar. Acepta ID de sesión tanto de usuario (KYC) como de empresa (KYB): el servicio resuelve el ID en ambos tipos de sesión.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "new_status" ], "properties": { "new_status": { "type": "string", "description": "Estado de destino. `Approved` y `Declined` registran una decisión manual definitiva (cada una también puede revertir la otra). `Resubmitted` borra los pasos seleccionados y devuelve la sesión al usuario. Cualquier otro valor devuelve `400`.", "enum": [ "Approved", "Declined", "Resubmitted" ], "example": "Approved" }, "comment": { "type": "string", "description": "Motivo del cambio en texto libre, que se guarda en el historial de revisiones de la sesión y se devuelve en el array `reviews` de [Obtener decisión](#get-/v3/session/-sessionId-/decision/). Por ejemplo, `Duplicated user`.", "example": "All checks passed manual review" }, "nodes_to_resubmit": { "type": "array", "description": "Pasos del flujo que el usuario debe repetir. Solo se tienen en cuenta cuando `new_status` es `Resubmitted`. Con `Approved`/`Declined` las entradas se siguen validando contra el esquema (un valor de `feature` no válido devuelve `400`), pero las entradas válidas se ignoran a efectos de su significado. Si se omite, el servidor selecciona automáticamente los intentos existentes de OCR, Liveness, Face Match, POA, Phone, Email, AML, Database Validation y Questionnaire cuyo estado es `Declined`, `In Review`, `Not Finished` o `Expired` (los intentos de NFC, análisis de IP, estimación de edad, búsqueda facial y documentos KYB nunca se seleccionan automáticamente; los intentos faciales que no son de coincidencia facial se seleccionan como `LIVENESS`). Las funciones que el usuario nunca intentó (sin ningún intento registrado) NO se seleccionan, por lo que una sesión sin intentos devuelve `400` (\"No features found that need resubmission\") aunque no se haya aprobado nada; en ese caso, envía `nodes_to_resubmit` de forma explícita. Los pasos se ejecutan en el orden del grafo del flujo, sin importar el orden en que los envíes. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` y el alias `KYB` se rechazan con `400`: esas comprobaciones principales se recalculan a partir de sus sesiones KYC hijas.", "items": { "type": "object", "required": [ "node_id", "feature" ], "properties": { "node_id": { "type": "string", "description": "Identificador del nodo tal como aparece en la definición del flujo de la sesión (por ejemplo, `feature_ocr`, `feature_liveness`).", "example": "feature_ocr" }, "feature": { "type": "string", "description": "Tipo de función del nodo. El servidor normaliza los alias `ID_VERIFICATION`, `POA`, `PHONE` y `EMAIL` a `OCR`, `PROOF_OF_ADDRESS`, `PHONE_VERIFICATION` y `EMAIL_VERIFICATION`. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` y `KYB` superan la validación del esquema, pero siempre se rechazan con el `400` de regla de negocio que se muestra en los ejemplos.", "enum": [ "OCR", "OCR_BACK", "NFC", "AML", "FACE", "LIVENESS", "FACE_MATCH", "IP_ANALYSIS", "AGE_ESTIMATION", "PROOF_OF_ADDRESS", "PHONE_VERIFICATION", "EMAIL_VERIFICATION", "FACE_SEARCH", "DATABASE_VALIDATION", "QUESTIONNAIRE", "DOCUMENT_AI", "KYB_DOCUMENTS", "ID_VERIFICATION", "POA", "PHONE", "EMAIL", "KYB_REGISTRY", "KYB_KEY_PEOPLE", "KYB", "GEOLOCATION" ], "example": "OCR" } } } }, "send_email": { "type": "boolean", "description": "Indica si se envía un correo electrónico al usuario sobre el cambio. Requiere `email_address`. Con `Approved`/`Declined` el usuario recibe un aviso de estado; con `Resubmitted` el correo incluye el enlace de verificación y los motivos de reenvío de cada paso.", "default": false, "example": false }, "email_address": { "type": "string", "format": "email", "description": "Destinatario del correo electrónico de notificación. **Obligatorio cuando `send_email` es `true`**: si lo omites, se devuelve `400`.", "example": "user@example.com" }, "email_language": { "type": "string", "description": "Idioma del correo electrónico de notificación. El esquema acepta cualquier cadena; los códigos no admitidos pasan a inglés (`en`) sin avisar.", "default": "en", "example": "en" }, "email_preview_token": { "type": "string", "writeOnly": true, "minLength": 1, "maxLength": 512, "description": "Comprobante opcional de [Vista previa del correo de decisión](/es/sessions-api/preview-decision-email) (para `Approved` y `Declined`) o de [Vista previa del correo de reenvío](/es/sessions-api/preview-resubmission) (para `Resubmitted`): su `preview_token`. Solo es válido con `send_email: true`; sin este, la solicitud devuelve `400`. El destinatario, el idioma, el estado de la sesión, el remitente y el correo (y, en un reenvío, los pasos seleccionados) deben seguir coincidiendo con la vista previa, y el comprobante caduca a los 15 minutos. De lo contrario, la solicitud devuelve `409` antes de que cambie la sesión o se envíe ningún correo. Las integraciones existentes pueden omitir este campo." } } }, "examples": { "Approve Session": { "summary": "Aprobar una sesión tras la revisión manual", "value": { "new_status": "Approved", "comment": "All checks passed manual review" } }, "Decline Session": { "summary": "Rechazar una sesión", "value": { "new_status": "Declined", "comment": "Suspected fraud" } }, "Resubmit Specific Steps": { "summary": "Solicitar reenvío de los pasos elegidos, con correo electrónico", "value": { "new_status": "Resubmitted", "nodes_to_resubmit": [ { "node_id": "feature_ocr", "feature": "OCR" }, { "node_id": "feature_liveness", "feature": "LIVENESS" } ], "send_email": true, "email_address": "user@example.com", "email_language": "en" } }, "Resubmit Auto-select": { "summary": "Solicitar reenvío (selección automática de los pasos no aprobados)", "value": { "new_status": "Resubmitted" } }, "Approve With Previewed Email": { "summary": "Aprobar y enviar el correo electrónico devuelto por Preview Decision Email", "value": { "new_status": "Approved", "send_email": true, "email_address": "person@example.com", "email_language": "en", "email_preview_token": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } } } } } }, "responses": { "200": { "description": "Estado actualizado. La respuesta solo contiene el `session_id`; obtén la sesión actualizada con [Obtener decisión](#get-/v3/session/-sessionId-/decision/). El webhook `status.updated` se dispara una vez que se confirma el cambio. Repetir `Approved` o `Declined` devuelve el mismo cuerpo y no cambia nada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "UUID de la sesión actualizada." } } }, "examples": { "Updated": { "summary": "Se devuelve por igual para Approved, Declined y Resubmitted", "value": { "session_id": "3472fb7c-8f7c-4d1a-9cf4-cf3d74ce1a60" } } } } } }, "400": { "description": "Error de validación. Los errores de campo llegan como `{\"\": [\"\"]}` (algunos rechazos por reglas de negocio usan en su lugar un valor de cadena: `{\"nodes_to_resubmit\": \"\"}`), los errores entre estados como `{\"detail\": \"\"}`, y el error de mismo estado como un array JSON sin envolver.", "content": { "application/json": { "examples": { "Wrong Current Status": { "summary": "La sesión no está en un estado que permita actualizarla", "value": { "detail": "Only sessions with status Approved, Declined, In Review, Kyc Expired, Abandoned, Resubmitted can be updated. Current status: In Progress" } }, "Invalid Status Value": { "summary": "new_status es un estado de sesión real, pero no es Approved, Declined ni Resubmitted", "value": { "new_status": [ "You can only update the status to 'Approved', 'Declined', or 'Resubmitted'." ] } }, "Missing new_status": { "summary": "Campo obligatorio omitido", "value": { "new_status": [ "This field is required." ] } }, "Same Status": { "summary": "Se solicitó Resubmitted en una sesión que ya está en Resubmitted", "value": [ "The new status is the same as the current status." ] }, "Email Address Required": { "summary": "send_email es true sin email_address", "value": { "email_address": [ "Email address is required when send_email is true." ] } }, "Non-resubmittable Feature": { "summary": "El reenvío apunta a una comprobación principal de KYB", "value": { "nodes_to_resubmit": "The following features cannot be resubmitted directly: KYB_REGISTRY. Resubmit the relevant child KYC sessions instead; the parent will recompute automatically." } }, "Nothing To Resubmit": { "summary": "La selección automática no encontró funciones no aprobadas", "value": { "nodes_to_resubmit": "No features found that need resubmission. All features are already approved." } }, "Invalid Feature Choice": { "summary": "Función desconocida en nodes_to_resubmit", "value": { "nodes_to_resubmit": [ { "feature": [ "\"BOGUS\" is not a valid choice. Valid choices are: OCR, OCR_BACK, NFC, AML, FACE, LIVENESS, FACE_MATCH, IP_ANALYSIS, AGE_ESTIMATION, PROOF_OF_ADDRESS, PHONE_VERIFICATION, EMAIL_VERIFICATION, FACE_SEARCH, DATABASE_VALIDATION, QUESTIONNAIRE, KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE, ID_VERIFICATION, POA, PHONE, EMAIL, KYB" ] } ] } }, "Invalid Status Value (not a status at all)": { "summary": "new_status no es un valor válido de StatusChoices", "value": { "new_status": [ "\"Bogus\" is not a valid choice." ] } }, "Preview Receipt Without Email": { "summary": "Se envió email_preview_token sin send_email: true", "value": { "email_preview_token": [ "A preview receipt is only valid when the email is sent." ] } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Clave de API con alcance limitado con la fecha de caducidad vencida", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Faltan las credenciales o los permisos son insuficientes, o el `session_id` pertenece a otra aplicación.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente o no válido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La clave de API no tiene el permiso write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ninguna sesión KYC o KYB con este `session_id` (las sesiones eliminadas también devuelven `404`).", "content": { "application/json": { "examples": { "Not Found": { "summary": "session_id desconocido", "value": { "detail": "Not found." } } } } } }, "429": { "description": "Se repitió un reenvío dirigido solo a funciones exclusivas del backend (AML, DATABASE_VALIDATION, IP_ANALYSIS) dentro del periodo de espera de 30 segundos; una repetición inmediata no puede cambiar el resultado. Espera y reintenta pasado el intervalo indicado en `Retry-After`.", "content": { "application/json": { "examples": { "Backend-only resubmit throttled": { "value": { "detail": "This session was already resubmitted for backend-only features within the last 30 seconds; repeating it cannot change the outcome. Wait before resubmitting again." } } } } } }, "409": { "description": "La vista previa del correo electrónico cambió o expiró. Genera una nueva vista previa antes de confirmar; no se producen cambios en la sesión ni se realiza la entrega del correo electrónico.", "content": { "application/json": { "examples": { "Preview Changed": { "summary": "El comprobante ya no coincide o tiene más de 15 minutos", "value": { "detail": "This email preview changed or expired. Preview the message again before confirming." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-status/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"new_status\": \"Approved\",\n \"comment\": \"All checks passed manual review\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_status(\n \"11111111-2222-3333-4444-555555555555\",\n new_status=\"Approved\",\n comment=\"All checks passed manual review\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateStatus(\"11111111-2222-3333-4444-555555555555\", {\n new_status: \"Approved\",\n comment: \"All checks passed manual review\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateStatus(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsUpdateStatusParams{\n\tNewStatus: \"Approved\",\n\tComment: didit.String(\"All checks passed manual review\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsUpdateStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateStatus(\"11111111-2222-3333-4444-555555555555\", SessionsUpdateStatusParams.builder()\n .newStatus(SessionsUpdateStatusParams.NewStatus.of(\"Approved\"))\n .comment(\"All checks passed manual review\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateStatus('11111111-2222-3333-4444-555555555555', [\n 'new_status' => 'Approved',\n 'comment' => 'All checks passed manual review',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_status(\n \"11111111-2222-3333-4444-555555555555\",\n new_status: \"Approved\",\n comment: \"All checks passed manual review\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateStatusAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsUpdateStatusParams\n{\n NewStatus = \"Approved\",\n Comment = \"All checks passed manual review\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/id-verification/": { "post": { "summary": "Verificación de identidad (OCR del documento + controles de fraude)", "description": "Aplica OCR a un documento de identidad y ejecuta comprobaciones de fraude documental en una sola llamada: devuelve los campos extraídos del titular, la MRZ analizada, un `status` `Approved`/`Declined`/`In Review` y una lista `warnings` que explica cada problema detectado. Admite más de 14,000+ tipos de documentos de 220+ países y territorios.\n\n**Cómo funciona.** Envía la `front_image` del documento (obligatoria) y, en documentos de dos caras, la `back_image`. Sube fotos sin recortar en las que se vean las cuatro esquinas del documento: el servicio detecta, alinea y recorta el documento por sí mismo, así que no lo recortes previamente. El documento se clasifica automáticamente (nunca declaras el país ni el tipo de documento), la zona visual se lee con OCR y se decodifican la MRZ y cualquier código de barras. Después, una serie de comprobaciones cruzadas valida las fechas, los formatos de número y los dígitos de control de la MRZ, y compara la zona visual con la MRZ. Con `perform_document_liveness=true`, las imágenes se analizan además para detectar capturas de pantalla, copias impresas y manipulación del retrato.\n\n**Lógica de decisión.** El `status` es `Approved` salvo que al menos una advertencia derive en un rechazo. Los riesgos de fraude y de fallo grave siempre rechazan: `DOCUMENT_EXPIRED`, `SCREEN_CAPTURE_DETECTED`, `PRINTED_COPY_DETECTED`, `PORTRAIT_MANIPULATION_DETECTED`, `PUBLIC_DOCUMENT_IMAGE_DETECTED`, además de los fallos de extracción (`NAME_NOT_DETECTED`, `DATE_OF_BIRTH_NOT_DETECTED`, `DOCUMENT_NUMBER_NOT_DETECTED`). (`PORTRAIT_IMAGE_NOT_DETECTED`, `INVALID_DATE` y `MRZ_NOT_DETECTED` existen en las sesiones de flujo de verificación (workflow), pero este endpoint independiente nunca los genera. `COULD_NOT_DETECT_DOCUMENT_TYPE` se devuelve aquí cuando la imagen frontal no coincide con alta confianza con el diseño de un documento oficial conocido, y rechaza la solicitud). Tres grupos de riesgo se pueden configurar en cada solicitud mediante `invalid_mrz_action`, `inconsistent_data_action` y `expiration_date_not_detected_action` (`DECLINE` o `NO_ACTION`). Todas las demás advertencias (p. ej., `POSSIBLE_DUPLICATED_USER`) son informativas y nunca rechazan por sí solas. Cuando `perform_document_liveness=true` (el valor predeterminado) y la comprobación de falsificación no devuelve una puntuación utilizable (el proveedor falló, respondió con un código distinto de 200 o respondió HTTP 200 con `status=\"ERR\"`), la llamada devuelve `200` con `status: \"In Review\"` y una advertencia `DOCUMENT_LIVENESS_NOT_COMPUTED` (`log_type: \"warning\"`) en lugar de `Approved`: una comprobación que no se ejecutó no es prueba de que el documento sea auténtico. Esta escalada no es configurable y nunca anula un `Declined`; con `perform_document_liveness=false` la comprobación se omite y el estado depende de las demás advertencias, como antes. Un documento que no se puede procesar en absoluto devuelve `400` con `{\"error\": \"COULD_NOT_RECOGNIZE_DOCUMENT\"}`; un documento legible pero con problemas devuelve `200` con `status: \"Declined\"`. Revisa siempre `id_verification.status` y `id_verification.warnings`, no solo el código HTTP.\n\n**Facturación.** Cada respuesta `200` consume un crédito de la API de Verificación de identidad (se paga con el crédito de tu plan o con tu saldo de recarga). Cuando el saldo de la organización no alcanza para cubrir la llamada, el endpoint devuelve `403` con el error de créditos insuficientes antes de procesar ninguna imagen.\n\n**Persistencia de la sesión (`save_api_request`, valor predeterminado `true`).** Cuando es `true`, la llamada se guarda como una sesión de tipo API: aparece en la Business Console, el `request_id` devuelto es un ID de sesión real que puedes pasar a `GET /v3/session/{sessionId}/decision/`, las imágenes recortadas del documento y del retrato se almacenan y se devuelven como URL de medios de corta duración (`https:///ocr/...`), y se emite un webhook `status.updated` a los endpoints de webhook que tengas configurados. Cuando es `false`, no se almacena nada, `request_id` es un UUID de correlación de un solo uso y `portrait_image`/`front_image`/`back_image` se devuelven directamente como cadenas JPEG codificadas en base64.\n\n**Sandbox.** Las claves de API de sandbox omiten todo el procesamiento y la facturación: tras validar la solicitud (una entrada mal formada sigue devolviendo `400`), el endpoint devuelve un payload simulado estático `Approved` (una tarjeta de identidad ficticia de EE. UU. de \"Sandbox User\"), no se guarda ninguna sesión y no se consumen créditos.\n\n**Autenticación.** Envía la clave de API de tu aplicación en el encabezado `x-api-key`. Las credenciales ausentes o no válidas devuelven `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`): esta API nunca devuelve `401`.\n\n**Límite de solicitudes.** Presupuesto de escritura compartido de 300 solicitudes/min por clave de API entre todos los endpoints POST/PATCH/DELETE; si lo superas, se devuelve `429`.", "operationId": "post_v3id-verification", "x-didit-sdk": { "resource": "id_verification", "method": "verify", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "front_image" ], "properties": { "front_image": { "type": "string", "format": "binary", "description": "Anverso del documento de identidad. Extensiones permitidas: `tiff`, `jpg`, `jpeg`, `png`, `webp`, `pdf`. Tamaño máximo de carga: **10 MB** (los archivos más grandes se rechazan con `400`). Los PDF se convierten en imagen antes del OCR; los PDF cifrados requieren `front_image_password`. Las imágenes se comprimen automáticamente a ~0.5 MB y se aplica la orientación EXIF. Sube la captura completa, sin recortar, con las cuatro esquinas del documento visibles." }, "front_image_password": { "type": "string", "description": "Contraseña para descifrar `front_image` cuando es un PDF cifrado. Enviar un PDF cifrado sin contraseña (o con una incorrecta) devuelve `400`.", "writeOnly": true }, "back_image": { "type": "string", "format": "binary", "description": "Reverso del documento: envíalo siempre que el documento lo tenga (muchos documentos de identidad llevan la MRZ o un código de barras en el reverso; si lo omites, la MRZ y los campos del reverso simplemente quedan vacíos en la respuesta, y este endpoint no genera una advertencia por falta de MRZ). Mismo formato y límites de tamaño que `front_image`. Si se omite, `back_image` y los campos del reverso son `null` en la respuesta." }, "back_image_password": { "type": "string", "description": "Contraseña para descifrar `back_image` cuando es un PDF cifrado.", "writeOnly": true }, "perform_document_liveness": { "type": "boolean", "default": true, "description": "Analiza ambas imágenes en busca de fraude de presentación: reproducciones en pantalla (`SCREEN_CAPTURE_DETECTED`), copias impresas (`PRINTED_COPY_DETECTED`) y manipulación del retrato (`PORTRAIT_MANIPULATION_DETECTED`). Cualquiera de ellos provoca un rechazo automático. Está activado por defecto. Establécelo en `false` para omitir el análisis de fraude y reducir la latencia. Si está activado y el proveedor no devuelve una puntuación utilizable, la respuesta es `In Review` con una advertencia `DOCUMENT_LIVENESS_NOT_COMPUTED` en lugar de `Approved`.", "example": true }, "minimum_age": { "type": "integer", "nullable": true, "default": null, "minimum": 1, "maximum": 120, "description": "Se acepta y se valida (1–120), pero **actualmente este endpoint no lo aplica**: nunca genera una advertencia `MINIMUM_AGE_NOT_MET` a partir de este campo. Aplica las reglas de edad a partir de los valores `date_of_birth`/`age` devueltos, o usa un flujo de sesión de verificación con restricciones de edad." }, "expiration_date_not_detected_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Qué hacer cuando no se puede leer ninguna fecha de caducidad (`EXPIRATION_DATE_NOT_DETECTED`). El valor predeterminado es `NO_ACTION` porque muchos documentos de identidad no llevan impresa la fecha de caducidad. Nota: una fecha de caducidad *detectada y ya vencida* siempre provoca el rechazo (`DOCUMENT_EXPIRED`), independientemente de esta opción." }, "invalid_mrz_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "DECLINE", "description": "Qué hacer cuando la MRZ extraída no supera la validación de los dígitos de control (`MRZ_VALIDATION_FAILED`). Si falta la MRZ, este endpoint no genera ninguna advertencia. Solo aplica a documentos que incluyen MRZ. `REVIEW` no se admite en este endpoint y devuelve `400`." }, "inconsistent_data_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "DECLINE", "description": "Qué hacer cuando los datos extraídos son incoherentes entre sí: `DATA_INCONSISTENT`, `MRZ_AND_DATA_EXTRACTED_FROM_OCR_NOT_SAME` (la zona visual no coincide con la MRZ) o `DOCUMENT_NAME_DIFFERENT_FROM_OTHER_APPROVED_DOCUMENTS`." }, "critical_field_occlusion_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "DECLINE", "description": "Qué hacer cuando un campo impreso crítico estaba tapado físicamente en la captura (`CRITICAL_FIELD_OCCLUSION_DETECTED`): un número de identidad, un nombre, la fecha de nacimiento o la fecha de caducidad. Rechaza por defecto, como los demás riesgos de integridad del documento de este endpoint: tapar los números con los que se concilia un informe es justo el aspecto de un documento censurado. En cualquier caso, el valor leído de un campo tapado se elimina de la extracción, por lo que suele ir acompañado de la advertencia `*_NOT_DETECTED` correspondiente. `REVIEW` no es compatible con este endpoint y devuelve `400`." }, "document_or_personal_number_format_mismatch_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Qué hacer cuando un número no coincide con el formato que usa su autoridad emisora para ese tipo de documento (`DOCUMENT_NUMBER_FORMAT_MISMATCH`, `PERSONAL_NUMBER_FORMAT_MISMATCH`). El valor predeterminado es `NO_ACTION`, que informa de la advertencia sin cambiar el estado. `REVIEW` no es compatible con este endpoint y devuelve `400`." }, "preferred_characters": { "type": "string", "enum": [ "latin", "non_latin" ], "default": "latin", "description": "Alfabeto preferido para los campos de nombre y dirección en documentos que imprimen texto tanto latino como no latino (árabe, cirílico, CJK, …). `latin` devuelve valores transliterados o latinos; `non_latin` da preferencia al alfabeto nativo." }, "save_api_request": { "type": "boolean", "default": true, "description": "Cuando es `true` (valor predeterminado), guarda la llamada como una sesión de tipo API: visible en la Business Console, recuperable mediante `GET /v3/session/{sessionId}/decision/` con el `request_id` devuelto, notificada mediante un webhook `status.updated` y con las imágenes del documento devueltas como URL de archivos multimedia. Cuando es `false`, no se almacena nada, `request_id` es un UUID temporal y las imágenes se devuelven en la propia respuesta como cadenas JPEG en base64.", "example": true }, "vendor_data": { "type": "string", "description": "Cadena opaca opcional (tu ID de usuario interno, correo electrónico, UUID…) que se guarda en la sesión persistida y se devuelve en la respuesta. Úsala para relacionar las llamadas a la API con tus propios registros y para filtrar sesiones más adelante.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objeto JSON opcional que se almacena con la sesión (cuando `save_api_request=true`) y se devuelve en la respuesta. En solicitudes multipart, envíalo como un campo de cadena codificado en JSON (p. ej., `metadata={\"flow\":\"onboarding\"}`): se convierte en un objeto.", "example": { "flow": "onboarding" } } } }, "example": { "front_image": "(binary JPEG/PNG/PDF of the document front)", "back_image": "(binary JPEG/PNG/PDF of the document back)", "perform_document_liveness": true, "save_api_request": true, "vendor_data": "user-123", "metadata": { "flow": "onboarding" } } } } }, "responses": { "200": { "description": "Documento procesado. `id_verification.status` es `Approved`, `Declined` o `In Review`; cada problema detectado se detalla en `id_verification.warnings`. Se devuelve `In Review` cuando una comprobación de prueba de vida del documento solicitada no produjo un resultado utilizable (`DOCUMENT_LIVENESS_NOT_COMPUTED`). Un documento con problemas también devuelve `200` con `status: \"Declined\"`: revisa el cuerpo, no solo el código HTTP. Cuando `save_api_request=true`, `request_id` es el ID de la sesión guardada y los campos de imagen son URL de medios de corta duración; con `save_api_request=false` son cadenas JPEG en base64 incluidas en la respuesta.", "content": { "application/json": { "examples": { "Approved": { "summary": "Documento de identidad de dos caras leído correctamente (guardado: imágenes como URL de medios)", "value": { "request_id": "11d219ed-d59c-4b1d-8d65-9b933f12d5b8", "id_verification": { "status": "Approved", "document_type": "Identity Card", "document_subtype": "ID_CARD_GENERIC", "document_number": "CBX164224", "personal_number": "20446581H", "portrait_image": "https:///ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-portrait_image-8c2f.jpg?signature=...", "front_image": "https:///ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-front_image-4a1e.jpg?signature=...", "back_image": "https:///ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-back_image-77b0.jpg?signature=...", "front_image_camera_front": null, "back_image_camera_front": null, "front_image_camera_front_face_match_score": null, "back_image_camera_front_face_match_score": null, "front_image_quality_score": { "focus_score": 78.0, "brightness_score": 83.2, "brightness_issue": "ok", "is_document_fully_visible": true, "resolution_score": 40.7, "overall_score": 70.2 }, "back_image_quality_score": { "focus_score": 100.0, "brightness_score": 95.6, "brightness_issue": "ok", "is_document_fully_visible": true, "resolution_score": 43.0, "overall_score": 84.4 }, "date_of_birth": "1980-01-13", "age": 46, "expiration_date": "2032-03-31", "date_of_issue": "2022-03-31", "issuing_state": "ESP", "issuing_state_name": "Spain", "first_name": "Julio Francisco", "last_name": "Fores Sena", "full_name": "Julio Francisco Fores Sena", "gender": "M", "address": "Brda. Urb. El Cardonal 0052 52 Po3 B,Taco,San Cristobal De La Laguna,Santa Cruz De Tenerife", "formatted_address": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain", "place_of_birth": "Valencia, Valencia", "marital_status": "UNKNOWN", "nationality": "ESP", "extra_fields": { "first_surname": "Fores", "second_surname": "Sena" }, "mrz": { "surname": "FORES SENA", "name": "JULIO FRANCISCO", "country": "ESP", "nationality": "ESP", "birth_date": "800113", "expiry_date": "320331", "sex": "M", "document_type": "ID", "document_number": "CBX164224", "optional_data": "20446581H", "optional_data_2": "", "birth_date_hash": "9", "expiry_date_hash": "8", "document_number_hash": "3", "final_hash": "3", "personal_number": "20446581H", "warnings": [], "errors": [], "mrz_type": "TD1", "mrz_string": "IDESPCBX164224320446581H<<<<<<\n8001139M3203318ESP<<<<<<<<<<<3\nFORES/ocr/f61681b8-9422-4378-ac3e-04c6a247fb45-portrait_image-1d9a.jpg?signature=...", "front_image": "https:///ocr/f61681b8-9422-4378-ac3e-04c6a247fb45-front_image-5c2b.jpg?signature=...", "back_image": null, "front_image_camera_front": null, "back_image_camera_front": null, "front_image_camera_front_face_match_score": null, "back_image_camera_front_face_match_score": null, "front_image_quality_score": { "focus_score": 100.0, "brightness_score": 95.7, "brightness_issue": "ok", "is_document_fully_visible": true, "resolution_score": 22.2, "overall_score": 79.3 }, "back_image_quality_score": null, "date_of_birth": "1997-01-30", "age": 29, "expiration_date": "2025-11-26", "date_of_issue": null, "issuing_state": "ESP", "issuing_state_name": "Spain", "first_name": "Lucia", "last_name": "Marin Castro", "full_name": "Lucia Marin Castro", "gender": "F", "address": null, "formatted_address": null, "place_of_birth": null, "marital_status": "UNKNOWN", "nationality": "ESP", "extra_fields": { "first_surname": "Marin", "second_surname": "Castro" }, "mrz": {}, "parsed_address": null, "warnings": [ { "risk": "DOCUMENT_EXPIRED", "feature": "ID_VERIFICATION", "additional_data": null, "log_type": "error", "short_description": "Document expired", "long_description": "The document's expiration date has passed, rendering it no longer valid for use." } ], "barcodes": [] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T02:25:48.117204+00:00" } } }, "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sesión guardada cuando `save_api_request=true` (se puede usar con `GET /v3/session/{sessionId}/decision/`); en caso contrario, un UUID de correlación temporal." }, "id_verification": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "`Approved` cuando ninguna advertencia se resuelve en un rechazo y la comprobación de prueba de vida del documento solicitada produjo un resultado utilizable; `In Review` cuando esa comprobación solicitada no produjo ningún resultado utilizable (`DOCUMENT_LIVENESS_NOT_COMPUTED`); `Declined` cuando una advertencia se resuelve en un rechazo: la lista `warnings` explica el motivo." }, "document_type": { "type": "string", "nullable": true, "description": "Nombre visible del tipo de documento detectado: `Identity Card`, `Passport`, `Driver's License`, `Residence Permit`, `Health Insurance Card` o `Tax Card`. Es `null` cuando el documento no se pudo clasificar.", "example": "Identity Card" }, "document_subtype": { "type": "string", "nullable": true, "description": "Subtipo más detallado cuando está disponible (por ejemplo, `ID_CARD_GENERIC`, `EPASSPORT`).", "example": "ID_CARD_GENERIC" }, "document_number": { "type": "string", "nullable": true, "example": "CBX164224" }, "personal_number": { "type": "string", "nullable": true, "description": "Número personal/nacional secundario impreso en algunos documentos.", "example": "20446581H" }, "portrait_image": { "type": "string", "nullable": true, "description": "Foto de retrato recortada del documento. Es una URL de medios de corta duración (`https:///ocr/...`) cuando `save_api_request=true` (valor por defecto) y una cadena JPEG codificada en base64 en línea cuando `save_api_request=false`. `null` cuando no se detectó ningún retrato." }, "front_image": { "type": "string", "nullable": true, "description": "Recorte alineado del anverso del documento. URL del archivo multimedia si se guardó; en caso contrario, JPEG en base64 en línea." }, "back_image": { "type": "string", "nullable": true, "description": "Recorte alineado del reverso del documento. `null` si no se subió ninguna `back_image`." }, "front_image_camera_front": { "type": "string", "nullable": true, "description": "Siempre `null` en este endpoint (solo se rellena en sesiones de verificación con captura por cámara)." }, "back_image_camera_front": { "type": "string", "nullable": true, "description": "Siempre `null` en este endpoint." }, "front_image_camera_front_face_match_score": { "type": "number", "nullable": true, "description": "Siempre `null` en este endpoint." }, "back_image_camera_front_face_match_score": { "type": "number", "nullable": true, "description": "Siempre `null` en este endpoint." }, "front_image_quality_score": { "type": "object", "nullable": true, "description": "Diagnóstico de la calidad de captura de la imagen subida (`null` cuando no se proporcionó esa cara del documento o la puntuación falló). Todas las puntuaciones van de 0 a 100.", "properties": { "focus_score": { "type": "number", "format": "float", "description": "Nitidez del recorte del documento (cuanto más alto, más nítido)." }, "brightness_score": { "type": "number", "format": "float", "description": "Calidad de la exposición (cuanto mayor, mejor)." }, "brightness_issue": { "type": "string", "nullable": true, "description": "`ok` cuando la exposición es correcta; en caso contrario, el problema detectado (p. ej., demasiado oscura o demasiado clara)." }, "is_document_fully_visible": { "type": "boolean", "nullable": true, "description": "Indica si las cuatro esquinas del documento están dentro del encuadre." }, "resolution_score": { "type": "number", "format": "float", "description": "Resolución efectiva del área del documento." }, "overall_score": { "type": "number", "format": "float", "description": "Puntuación de calidad agregada." } } }, "back_image_quality_score": { "type": "object", "nullable": true, "description": "Diagnóstico de la calidad de captura de la imagen subida (`null` cuando no se proporcionó esa cara del documento o la puntuación falló). Todas las puntuaciones van de 0 a 100.", "properties": { "focus_score": { "type": "number", "format": "float", "description": "Nitidez del recorte del documento (cuanto más alto, más nítido)." }, "brightness_score": { "type": "number", "format": "float", "description": "Calidad de la exposición (cuanto mayor, mejor)." }, "brightness_issue": { "type": "string", "nullable": true, "description": "`ok` cuando la exposición es correcta; en caso contrario, el problema detectado (p. ej., demasiado oscura o demasiado clara)." }, "is_document_fully_visible": { "type": "boolean", "nullable": true, "description": "Indica si las cuatro esquinas del documento están dentro del encuadre." }, "resolution_score": { "type": "number", "format": "float", "description": "Resolución efectiva del área del documento." }, "overall_score": { "type": "number", "format": "float", "description": "Puntuación de calidad agregada." } } }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "example": "1980-01-13" }, "age": { "type": "integer", "nullable": true, "description": "Edad del titular en años, calculada a partir de `date_of_birth`.", "example": 46 }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "example": "2032-03-31" }, "date_of_issue": { "type": "string", "format": "date", "nullable": true, "example": "2022-03-31" }, "issuing_state": { "type": "string", "nullable": true, "description": "País emisor (ISO 3166-1 alpha-3).", "example": "ESP" }, "issuing_state_name": { "type": "string", "nullable": true, "example": "Spain" }, "first_name": { "type": "string", "nullable": true, "example": "Julio Francisco" }, "last_name": { "type": "string", "nullable": true, "example": "Fores Sena" }, "full_name": { "type": "string", "nullable": true, "example": "Julio Francisco Fores Sena" }, "gender": { "type": "string", "nullable": true, "description": "`M`, `F` o `null` cuando no está impreso o no se detectó.", "example": "M" }, "address": { "type": "string", "nullable": true, "description": "Dirección tal como aparece impresa en el documento." }, "formatted_address": { "type": "string", "nullable": true, "description": "Versión geocodificada y normalizada de `address`." }, "place_of_birth": { "type": "string", "nullable": true, "example": "Valencia, Valencia" }, "marital_status": { "type": "string", "nullable": true, "description": "`UNKNOWN`, salvo que el documento incluya el estado civil.", "example": "UNKNOWN" }, "nationality": { "type": "string", "nullable": true, "description": "Nacionalidad del titular (ISO 3166-1 alfa-3).", "example": "ESP" }, "extra_fields": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Datos adicionales propios del documento que no tienen una columna dedicada (por ejemplo, `first_surname`/`second_surname` en los documentos de identidad españoles o las clases de licencia en las licencias de conducir)." }, "mrz": { "type": "object", "description": "Zona de lectura mecánica analizada. Es un **objeto vacío** (`{}`) cuando el documento no tiene MRZ o no se pudo leer; en ese caso, revisa también la lista `warnings`. Las fechas dentro de la MRZ usan el formato sin procesar `YYMMDD`.", "properties": { "surname": { "type": "string", "example": "FORES SENA" }, "name": { "type": "string", "example": "JULIO FRANCISCO" }, "country": { "type": "string", "description": "País emisor (ISO 3166-1 alpha-3).", "example": "ESP" }, "nationality": { "type": "string", "description": "Nacionalidad del titular (ISO 3166-1 alfa-3).", "example": "ESP" }, "birth_date": { "type": "string", "description": "Fecha de nacimiento de la MRZ sin procesar (`YYMMDD`).", "example": "800113" }, "expiry_date": { "type": "string", "description": "Fecha de caducidad de la MRZ sin procesar (`YYMMDD`).", "example": "320331" }, "sex": { "type": "string", "example": "M" }, "document_type": { "type": "string", "description": "Código de tipo de documento de la MRZ (por ejemplo, `ID`, `P`).", "example": "ID" }, "document_number": { "type": "string", "example": "CBX164224" }, "optional_data": { "type": "string", "nullable": true, "example": "20446581H" }, "optional_data_2": { "type": "string", "nullable": true, "example": "" }, "birth_date_hash": { "type": "string", "description": "Dígito de control de la MRZ para la fecha de nacimiento.", "example": "9" }, "expiry_date_hash": { "type": "string", "description": "Dígito de control de la MRZ para la fecha de caducidad.", "example": "8" }, "document_number_hash": { "type": "string", "description": "Dígito de control de la MRZ para el número de documento.", "example": "3" }, "final_hash": { "type": "string", "description": "Dígito de control compuesto de la MRZ.", "example": "3" }, "personal_number": { "type": "string", "nullable": true, "example": "20446581H" }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Advertencias no críticas del análisis de la MRZ." }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Errores de dígitos de control o de análisis de la MRZ. Los errores no vacíos aparecen como una advertencia `MRZ_VALIDATION_FAILED`." }, "mrz_type": { "type": "string", "description": "Formato de la MRZ: `TD1` (documentos de identidad, 3 líneas), `TD2` o `TD3` (pasaportes, 2 líneas).", "example": "TD1" }, "mrz_string": { "type": "string", "description": "Texto de la MRZ sin procesar tal como se leyó, con las líneas separadas por `\\n`." }, "mrz_key": { "type": "string", "description": "Clave compuesta (número de documento + dígitos de control) que se usa en las verificaciones cruzadas." } } }, "parsed_address": { "type": "object", "nullable": true, "description": "Desglose estructurado y geocodificado de `address`. `null` cuando el documento no incluye ninguna dirección o no se pudo analizar.", "properties": { "street_1": { "type": "string", "nullable": true, "example": "Avenida el Cardonal 52" }, "street_2": { "type": "string", "nullable": true, "example": "b" }, "city": { "type": "string", "nullable": true, "example": "La Laguna" }, "region": { "type": "string", "nullable": true, "example": "Canarias" }, "country": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alfa-2.", "example": "ES" }, "postal_code": { "type": "string", "nullable": true, "example": "38108" }, "address_type": { "type": "string", "nullable": true, "example": "Avenida" }, "formatted_address": { "type": "string", "nullable": true, "description": "Cadena de dirección geocodificada canónica.", "example": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain" }, "raw_results": { "type": "object", "additionalProperties": true, "description": "Payload de geocodificación sin procesar (`address_components`, `geometry.location`, `place_id`, …) para usos avanzados." }, "document_location": { "type": "object", "nullable": true, "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "description": "Coordenadas geocodificadas de la dirección del documento." }, "label": { "type": "string", "nullable": true, "description": "De qué campo del documento se leyó la dirección.", "example": "Spain Identity Card Address" }, "is_verified": { "type": "boolean", "description": "Indica si la geocodificación confirmó que la dirección existe." }, "category": { "type": "string", "nullable": true, "description": "Categoría de la dirección (p. ej., `Residential`, `Commercial`).", "example": "Residential" } } }, "warnings": { "type": "array", "description": "Vacío en una aprobación sin incidencias. Cada entrada explica un riesgo detectado; las entradas con `log_type: \"error\"` establecen `status` en `Declined`, y `DOCUMENT_LIVENESS_NOT_COMPUTED` (`log_type: \"warning\"`) lo establece en `In Review`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "description": "Código de riesgo legible por máquina. Riesgos que siempre rechazan: `DOCUMENT_EXPIRED`, `MINIMUM_AGE_NOT_MET`, `PORTRAIT_IMAGE_NOT_DETECTED`, `SCREEN_CAPTURE_DETECTED`, `PRINTED_COPY_DETECTED`, `PORTRAIT_MANIPULATION_DETECTED`, `PUBLIC_DOCUMENT_IMAGE_DETECTED`, `INVALID_DATE`, `COULD_NOT_RECOGNIZE_DOCUMENT` (solo 400, nunca una advertencia), `DOCUMENT_NUMBER_NOT_DETECTED`, `COULD_NOT_DETECT_DOCUMENT_TYPE`, `NAME_NOT_DETECTED`, `DATE_OF_BIRTH_NOT_DETECTED`. Controlados por opciones de la solicitud: `MRZ_NOT_DETECTED` / `MRZ_VALIDATION_FAILED` (`invalid_mrz_action`), `DATA_INCONSISTENT` / `MRZ_AND_DATA_EXTRACTED_FROM_OCR_NOT_SAME` / `DOCUMENT_NAME_DIFFERENT_FROM_OTHER_APPROVED_DOCUMENTS` (`inconsistent_data_action`), `EXPIRATION_DATE_NOT_DETECTED` (`expiration_date_not_detected_action`). Los demás riesgos (p. ej., `POSSIBLE_DUPLICATED_USER`) son informativos. `DOCUMENT_LIVENESS_NOT_COMPUTED` se genera cuando `perform_document_liveness=true` pero la comprobación de falsificación no devolvió una puntuación utilizable; establece `status` en `In Review`. `COULD_NOT_DETECT_DOCUMENT_TYPE` también se devuelve cuando el anverso del documento no coincide con un diseño de documento oficial conocido con alta confianza, por ejemplo, un documento editado o generado por computadora, o un diseño que aún no es compatible.", "example": "DOCUMENT_EXPIRED" }, "feature": { "type": "string", "enum": [ "ID_VERIFICATION" ], "description": "Función que emitió la advertencia. En este endpoint siempre es `ID_VERIFICATION`." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Contexto adicional para algunos riesgos (p. ej., `POSSIBLE_DUPLICATED_USER` incluye `duplicated_session_id`); `null` para la mayoría." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravedad. Las advertencias `error` llevan `status` a `Declined`; `warning` (solo `DOCUMENT_LIVENESS_NOT_COMPUTED`, cuando la comprobación de falsificación solicitada no produjo una puntuación utilizable) lleva `status` a `In Review`; las entradas `information` son informativas y nunca cambian el estado." }, "short_description": { "type": "string", "description": "Resumen legible del riesgo en una línea." }, "long_description": { "type": "string", "description": "Explicación legible del riesgo." } } } }, "barcodes": { "type": "array", "description": "Códigos de barras decodificados del documento (PDF417, QR, …). Vacío cuando el documento no tiene ninguno o no se pudo leer ninguno.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Tipo de código de barras (p. ej., `PDF417`, `QR_CODE`, `UNKNOWN`)." }, "position": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ubicación del código de barras en la imagen, cuando está disponible." }, "data": { "type": "string", "description": "Payload decodificado." }, "data_raw": { "type": "string", "description": "Payload sin procesar (sin decodificar), cuando es distinto." }, "side": { "type": "string", "nullable": true, "description": "`front` o `back`." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste, o `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Devuelve el objeto `metadata` que enviaste, o `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de tiempo ISO 8601 (UTC) del momento en que se generó la respuesta." } } } } } }, "400": { "description": "Error de validación o de procesamiento. Los problemas a nivel de campo devuelven el formato estándar de DRF (un array de mensajes por cada campo afectado). Los problemas con PDF cifrados devuelven `{\"detail\": ...}`. Una imagen de documento en la que no se puede reconocer ningún documento devuelve `{\"error\": \"COULD_NOT_RECOGNIZE_DOCUMENT\"}`. Las cargas de PDF también pueden fallar con \"The submitted PDF file is corrupted or invalid.\" o con un error por ausencia de páginas.", "content": { "application/json": { "examples": { "Missing front image": { "summary": "`front_image` no se incluyó en los datos del formulario", "value": { "front_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Extensión de archivo distinta de tiff/jpg/jpeg/png/webp/pdf", "value": { "front_image": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp, pdf." ] } }, "File too large": { "summary": "El archivo supera el límite de 10 MB", "value": { "front_image": [ "File size should not exceed 10 MB" ] } }, "Invalid option value": { "summary": "Las opciones solo aceptan DECLINE o NO_ACTION", "value": { "invalid_mrz_action": [ "\"REVIEW\" is not a valid choice." ] } }, "Encrypted PDF": { "summary": "PDF subido sin la contraseña requerida", "value": { "detail": "The PDF is encrypted. Please upload a decrypted PDF or a photo instead." } }, "Wrong PDF password": { "summary": "`front_image_password` / `back_image_password` no descifra el PDF", "value": { "detail": "The PDF password is incorrect. Please provide the correct password." } }, "Document not recognized": { "summary": "No se pudo detectar ningún documento de identidad en la imagen", "value": { "error": "COULD_NOT_RECOGNIZE_DOCUMENT" } }, "PDF conversion failure": { "summary": "No se pudo convertir el PDF subido en una imagen", "value": { "error": "Failed to convert front image PDF." } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key` y también cuando el saldo de la organización que realiza la llamada no la cubre; una clave incorrecta, revocada o expirada devuelve `401`. Si falta la clave, se devuelve `403` con `{\"detail\": ...}`; una clave incorrecta, revocada o expirada devuelve `401`. La falta de créditos devuelve `403` con `{\"error\": ...}` antes de que se procese ninguna imagen.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de la organización no cubre la llamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/id-verification/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'front_image=@./id_front.jpg' \\\n -F 'back_image=@./id_back.jpg' \\\n -F 'perform_document_liveness=true' \\\n -F 'save_api_request=true' \\\n -F 'vendor_data=user-123'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_verification.verify(\n front_image=open(\"front_image.jpg\", \"rb\"),\n back_image=open(\"back_image.jpg\", \"rb\"),\n perform_document_liveness=True,\n save_api_request=True,\n vendor_data=\"user-123\",\n metadata={\"flow\": \"onboarding\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idVerification.verify({\n front_image: await fileFromPath(\"front_image.jpg\"),\n back_image: await fileFromPath(\"back_image.jpg\"),\n perform_document_liveness: true,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"onboarding\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDVerification.Verify(ctx, didit.IDVerificationVerifyParams{\n\tFrontImage: didit.FileFromPath(\"front_image.jpg\"),\n\tBackImage: didit.Some(didit.FileFromPath(\"back_image.jpg\")),\n\tPerformDocumentLiveness: didit.Bool(true),\n\tSaveAPIRequest: didit.Bool(true),\n\tVendorData: didit.String(\"user-123\"),\n\tMetadata: didit.Some(map[string]any{\"flow\": \"onboarding\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.IdVerificationVerifyParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idVerification().verify(IdVerificationVerifyParams.builder()\n .frontImage(Path.of(\"front_image.jpg\"))\n .backImage(Path.of(\"back_image.jpg\"))\n .performDocumentLiveness(true)\n .saveApiRequest(true)\n .vendorData(\"user-123\")\n .metadata(Map.of(\"flow\", \"onboarding\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idVerification->verify([\n 'front_image' => File::fromPath('front_image.jpg'),\n 'back_image' => File::fromPath('back_image.jpg'),\n 'perform_document_liveness' => true,\n 'save_api_request' => true,\n 'vendor_data' => 'user-123',\n 'metadata' => ['flow' => 'onboarding'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_verification.verify(\n front_image: Pathname(\"front_image.jpg\"),\n back_image: Pathname(\"back_image.jpg\"),\n perform_document_liveness: true,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"onboarding\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdVerification.VerifyAsync(new IdVerificationVerifyParams\n{\n FrontImage = FileUpload.FromPath(\"front_image.jpg\"),\n BackImage = FileUpload.FromPath(\"back_image.jpg\"),\n PerformDocumentLiveness = true,\n SaveApiRequest = true,\n VendorData = \"user-123\",\n Metadata = new Dictionary { [\"flow\"] = \"onboarding\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/face-match/": { "post": { "summary": "Coincidencia facial", "description": "Compara dos imágenes faciales (1:1) y obtén una `score` de similitud (0–100) junto con un `status` `Approved`/`Declined`.\n\n**Cómo funciona.** Ambas imágenes se decodifican y las analiza un modelo biométrico (configura `rotate_image=true` si las capturas pueden estar de lado o boca abajo); después se calcula una puntuación de similitud entre los dos rostros. Una puntuación **estrictamente superior** a `face_match_score_decline_threshold` (por defecto `30`) devuelve `status: \"Approved\"`; una puntuación igual o inferior devuelve `Declined` con una advertencia `LOW_FACE_MATCH_SIMILARITY`. Si no se puede puntuar ningún par de rostros, la llamada igualmente devuelve `200` con `status: \"Declined\"` y una advertencia `NO_REFERENCE_IMAGE`: `score` es `null` en la ruta de guardado predeterminada, o `0` con `save_api_request=false`. Para obtener los mejores resultados, envía un único rostro nítido y de frente por imagen.\n\n**Facturación.** Cada respuesta `200` consume un crédito de la API de Face Match (pagado con el crédito de tu plan o con tu saldo recargado). Cuando el saldo de la organización no alcanza para cubrir la llamada, el endpoint devuelve `403` con el error de créditos insuficientes antes de procesar ninguna imagen.\n\n**Persistencia de la sesión (`save_api_request`, por defecto `true`).** Cuando es `true`, la llamada se guarda como una sesión de tipo API: aparece en la Business Console, el `request_id` devuelto es un ID de sesión real que puedes pasar a `GET /v3/session/{sessionId}/decision/`, ambas imágenes se almacenan como las imágenes de origen y destino de la coincidencia facial de la sesión, y se emite un webhook `status.updated` a los endpoints de webhook que hayas configurado. Cuando es `false`, no se almacena nada y `request_id` es un UUID de correlación de un solo uso que no se puede consultar después.\n\n**Índice de búsqueda facial.** Este endpoint nunca inscribe rostros en tu índice de búsqueda facial y nunca ejecuta comprobaciones de lista de bloqueo ni de duplicados: usa `POST /v3/passive-liveness/` o `POST /v3/face-search/` para ello.\n\n**Sandbox.** Las claves de API de sandbox omiten todo el procesamiento y la facturación: tras la validación de la solicitud (una entrada mal formada sigue devolviendo `400`), el endpoint devuelve un payload simulado estático `Approved`, no se guarda ninguna sesión y no se consumen créditos.\n\n**Autenticación.** Envía la clave de API de tu aplicación en el encabezado `x-api-key`. Las credenciales ausentes o no válidas devuelven `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`): esta API nunca devuelve `401`.\n\n**Límite de solicitudes.** Cupo de escritura compartido de 300 solicitudes/min por clave de API entre todos los endpoints POST/PATCH/DELETE; si se supera, se devuelve `429`.", "operationId": "post_v3face-match", "x-didit-sdk": { "resource": "face_match", "method": "compare", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "user_image", "ref_image" ], "properties": { "user_image": { "type": "string", "format": "binary", "description": "Imagen del rostro real o candidato que se va a verificar (p. ej., una selfie). Envía una única foto de frente con el rostro de la persona claramente visible y bien iluminado. Extensiones permitidas: `tiff`, `jpg`, `jpeg`, `png`, `webp`. Tamaño máximo de subida: **5 MB** (los archivos más grandes se rechazan con `400`). Las imágenes se comprimen automáticamente a ~0.5 MB antes del procesamiento, por lo que las resoluciones muy altas no mejoran la precisión." }, "ref_image": { "type": "string", "format": "binary", "description": "Imagen facial de referencia con la que comparar (p. ej., el retrato de un documento de identidad o una foto registrada previamente). Tiene los mismos límites de formato y tamaño que `user_image`." }, "face_match_score_decline_threshold": { "type": "number", "format": "float", "default": 30, "minimum": 0, "maximum": 100, "description": "Umbral de similitud (0–100) que determina el `status` de la respuesta. Una puntuación calculada **igual o inferior** a este valor establece `status` en `Declined` y añade una advertencia `LOW_FACE_MATCH_SIMILARITY`; una puntuación estrictamente superior devuelve `Approved`. El valor predeterminado `30` es permisivo: súbelo (p. ej., `50`–`60`) para una verificación más estricta. Los valores fuera de 0–100 devuelven `400`.", "example": 50 }, "rotate_image": { "type": "boolean", "default": false, "description": "Si es `true`, el servicio prueba las imágenes de entrada en incrementos de 90 grados (0, 90, 180, 270) y usa la orientación que ofrece la mejor detección facial, algo útil para capturas desde el móvil sin orientación EXIF. Añade latencia, así que actívalo solo si no puedes garantizar imágenes en posición vertical.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Cuando es `true` (valor predeterminado), guarda la llamada como una sesión de tipo API: visible en la Business Console, recuperable mediante `GET /v3/session/{sessionId}/decision/` con el `request_id` devuelto y notificada mediante un webhook `status.updated`. Cuando es `false`, no se almacena nada y `request_id` es un UUID temporal que solo sirve para correlacionar la respuesta.", "example": true }, "vendor_data": { "type": "string", "description": "Cadena opaca opcional (tu ID de usuario interno, correo electrónico, UUID…) que se guarda en la sesión persistida y se devuelve en la respuesta. Úsala para relacionar las llamadas a la API con tus propios registros y para filtrar sesiones más adelante.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objeto JSON opcional que se almacena con la sesión (cuando `save_api_request=true`) y se devuelve en la respuesta. En solicitudes multipart, envíalo como un campo de cadena codificado en JSON (p. ej., `metadata={\"flow\":\"login\"}`): se convierte en un objeto.", "example": { "flow": "login", "device_id": "abc123" } } } }, "example": { "user_image": "(binary JPEG/PNG of the live selfie)", "ref_image": "(binary JPEG/PNG of the reference photo)", "face_match_score_decline_threshold": 50, "rotate_image": false, "save_api_request": true, "vendor_data": "user-123", "metadata": { "flow": "login" } } } } }, "responses": { "200": { "description": "Coincidencia facial calculada. `face_match.score` es un número decimal de 0 a 100 (dos decimales); `status` es `Approved` cuando la puntuación es estrictamente superior a `face_match_score_decline_threshold`; en caso contrario, es `Declined` con una advertencia explicativa. Una similitud baja o un par imposible de puntuar también devuelve `200`: revisa `face_match.status` y `face_match.warnings`, no solo el código HTTP. Cuando `save_api_request=true`, `request_id` es el ID de la sesión guardada.", "content": { "application/json": { "examples": { "Approved": { "summary": "Misma persona: puntuación por encima del umbral", "value": { "request_id": "f9f5a777-8002-44c6-baaf-128bcfd6e226", "face_match": { "status": "Approved", "score": 99.41, "user_image": { "entities": [ { "bbox": [ 661, 728, 1688, 2188 ], "confidence": 0.732973, "age": 26.91, "gender": "male", "race": null } ], "best_angle": 0 }, "ref_image": { "entities": [ { "bbox": [ 653, 745, 1691, 2185 ], "confidence": 0.722082, "age": 27.0, "gender": "male", "race": null } ], "best_angle": 0 }, "warnings": [] }, "vendor_data": "user-123", "metadata": { "flow": "login" }, "created_at": "2026-06-12T01:04:42.763237+00:00" } }, "Declined - low similarity": { "summary": "Puntuación igual o inferior al umbral de rechazo", "value": { "request_id": "7cdda24e-311a-46d3-a3bb-e5d9b564ce73", "face_match": { "status": "Declined", "score": 24.87, "user_image": { "entities": [ { "bbox": [ 661, 728, 1688, 2188 ], "confidence": 0.732973, "age": 26.91, "gender": "male", "race": null } ], "best_angle": 0 }, "ref_image": { "entities": [ { "bbox": [ 156, 234, 679, 898 ], "confidence": 0.717775, "age": 41.2, "gender": "male", "race": null } ], "best_angle": 0 }, "warnings": [ { "risk": "LOW_FACE_MATCH_SIMILARITY", "feature": "FACEMATCH", "additional_data": null, "log_type": "error", "short_description": "Low face match similarity", "long_description": "The facial features of the provided image don't closely match the reference image, suggesting a potential identity mismatch." } ] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T01:08:19.859116+00:00" } } }, "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sesión guardada cuando `save_api_request=true` (se puede usar con `GET /v3/session/{sessionId}/decision/`); en caso contrario, un UUID de correlación temporal." }, "face_match": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Approved` cuando la puntuación de similitud es estrictamente superior a `face_match_score_decline_threshold` y se pudo calcular una puntuación; `Declined` en caso contrario (una advertencia explica el motivo)." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Puntuación de similitud de 0 a 100: la confianza del modelo en que ambas imágenes muestran a la misma persona. Se redondea a dos decimales solo cuando `save_api_request` es true; con `save_api_request=false` se devuelve el float sin redondear. `null` cuando no se pudo puntuar ningún par de rostros (con el valor predeterminado `save_api_request=true`); con `save_api_request=false` la misma condición puede aparecer como `score: 0`. En cualquier caso, hay una advertencia `NO_REFERENCE_IMAGE` y `status` es `Declined`.", "example": 99.41 }, "user_image": { "type": "object", "description": "Resultados de la detección facial de las imágenes analizadas.", "properties": { "entities": { "type": "array", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Cuadro delimitador del rostro detectado, en coordenadas de píxeles `[x_min, y_min, x_max, y_max]` de la imagen procesada.", "example": [ 661, 728, 1688, 2188 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Confianza de la detección facial (0–1).", "example": 0.732973 }, "age": { "type": "number", "format": "float", "description": "Edad del rostro detectado estimada por el modelo, en años. Solo es informativa: no afecta a la decisión de coincidencia facial.", "example": 26.91 }, "gender": { "type": "string", "description": "Género del rostro detectado predicho por el modelo (`male` o `female`). Solo es informativo.", "example": "male" }, "race": { "type": "string", "nullable": true, "description": "Campo reservado: siempre es `null` en las respuestas de este endpoint.", "example": null } } }, "description": "Una entrada por rostro detectado." }, "best_angle": { "type": "integer", "description": "Rotación (en grados: 0, 90, 180 o 270) que produjo la mejor detección facial. Solo es distinta de cero cuando `rotate_image=true` corrigió la orientación.", "example": 0 } } }, "ref_image": { "type": "object", "description": "Resultados de la detección facial de la imagen de referencia, con la misma estructura que `user_image`.", "properties": { "entities": { "type": "array", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Cuadro delimitador del rostro detectado, en coordenadas de píxeles `[x_min, y_min, x_max, y_max]` de la imagen procesada.", "example": [ 661, 728, 1688, 2188 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Confianza de la detección facial (0–1).", "example": 0.732973 }, "age": { "type": "number", "format": "float", "description": "Edad del rostro detectado estimada por el modelo, en años. Solo es informativa: no afecta a la decisión de coincidencia facial.", "example": 26.91 }, "gender": { "type": "string", "description": "Género del rostro detectado predicho por el modelo (`male` o `female`). Solo es informativo.", "example": "male" }, "race": { "type": "string", "nullable": true, "description": "Campo reservado: siempre es `null` en las respuestas de este endpoint.", "example": null } } }, "description": "Una entrada por rostro detectado." }, "best_angle": { "type": "integer", "example": 0 } } }, "warnings": { "type": "array", "description": "Vacío en una aprobación sin incidencias. `NO_REFERENCE_IMAGE` (`error`): no se pudo puntuar ningún par de rostros; `LOW_FACE_MATCH_SIMILARITY` (`error`): puntuación igual o inferior al umbral de rechazo. Cualquiera de ellas establece `status` en `Declined`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "NO_REFERENCE_IMAGE", "LOW_FACE_MATCH_SIMILARITY" ], "description": "Código de riesgo legible por máquina." }, "feature": { "type": "string", "enum": [ "FACEMATCH" ], "description": "Función que emitió la advertencia. En este endpoint siempre es `FACEMATCH`." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Siempre `null` en las advertencias de coincidencia facial." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravedad. Las advertencias `error` llevan `status` a `Declined`; las entradas `warning` e `information` son informativas y nunca rechazan por sí solas." }, "short_description": { "type": "string", "description": "Resumen legible del riesgo en una línea." }, "long_description": { "type": "string", "description": "Explicación legible del riesgo." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste, o `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Devuelve el objeto `metadata` que enviaste, o `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de tiempo ISO 8601 (UTC) del momento en que se generó la respuesta, p. ej., `2026-06-12T01:04:42.763237+00:00`." } } } } } }, "400": { "description": "Error de validación. Se devuelve cuando falta una imagen obligatoria, supera los 5 MB o tiene una extensión no admitida, o cuando una opción está fuera de rango. El cuerpo es el formato estándar de errores de campo de DRF: un array de mensajes por cada campo con error.", "content": { "application/json": { "examples": { "Missing required image": { "summary": "`ref_image` (o `user_image`) no está incluido en los datos del formulario", "value": { "ref_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Extensión de archivo distinta de tiff/jpg/jpeg/png/webp", "value": { "user_image": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp." ] } }, "File too large": { "summary": "El archivo supera el límite de 5 MB", "value": { "user_image": [ "File size should not exceed 5 MB" ] } }, "Threshold out of range": { "summary": "`face_match_score_decline_threshold` fuera del rango 0–100", "value": { "face_match_score_decline_threshold": [ "Ensure this value is less than or equal to 100." ] } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key` y también cuando el saldo de la organización que realiza la llamada no la cubre; una clave incorrecta, revocada o expirada devuelve `401`. Si falta la clave, se devuelve `403` con `{\"detail\": ...}`; una clave incorrecta, revocada o expirada devuelve `401`. La falta de créditos devuelve `403` con `{\"error\": ...}` antes de que se procese ninguna imagen.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de la organización no cubre la llamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/face-match/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'user_image=@./selfie.jpg' \\\n -F 'ref_image=@./id_portrait.jpg' \\\n -F 'face_match_score_decline_threshold=50' \\\n -F 'save_api_request=true' \\\n -F 'vendor_data=user-123'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.face_match.compare(\n user_image=open(\"user_image.jpg\", \"rb\"),\n ref_image=open(\"ref_image.jpg\", \"rb\"),\n face_match_score_decline_threshold=50.0,\n rotate_image=False,\n save_api_request=True,\n vendor_data=\"user-123\",\n metadata={\"flow\": \"login\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.faceMatch.compare({\n user_image: await fileFromPath(\"user_image.jpg\"),\n ref_image: await fileFromPath(\"ref_image.jpg\"),\n face_match_score_decline_threshold: 50.0,\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"login\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.FaceMatch.Compare(ctx, didit.FaceMatchCompareParams{\n\tUserImage: didit.FileFromPath(\"user_image.jpg\"),\n\tRefImage: didit.FileFromPath(\"ref_image.jpg\"),\n\tFaceMatchScoreDeclineThreshold: didit.Float(50.0),\n\tRotateImage: didit.Bool(false),\n\tSaveAPIRequest: didit.Bool(true),\n\tVendorData: didit.String(\"user-123\"),\n\tMetadata: didit.Some(map[string]any{\"flow\": \"login\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.FaceMatchCompareParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.faceMatch().compare(FaceMatchCompareParams.builder()\n .userImage(Path.of(\"user_image.jpg\"))\n .refImage(Path.of(\"ref_image.jpg\"))\n .faceMatchScoreDeclineThreshold(50.0)\n .rotateImage(false)\n .saveApiRequest(true)\n .vendorData(\"user-123\")\n .metadata(Map.of(\"flow\", \"login\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "faceMatch->compare([\n 'user_image' => File::fromPath('user_image.jpg'),\n 'ref_image' => File::fromPath('ref_image.jpg'),\n 'face_match_score_decline_threshold' => 50.0,\n 'rotate_image' => false,\n 'save_api_request' => true,\n 'vendor_data' => 'user-123',\n 'metadata' => ['flow' => 'login'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.face_match.compare(\n user_image: Pathname(\"user_image.jpg\"),\n ref_image: Pathname(\"ref_image.jpg\"),\n face_match_score_decline_threshold: 50.0,\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"login\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.FaceMatch.CompareAsync(new FaceMatchCompareParams\n{\n UserImage = FileUpload.FromPath(\"user_image.jpg\"),\n RefImage = FileUpload.FromPath(\"ref_image.jpg\"),\n FaceMatchScoreDeclineThreshold = 50.0,\n RotateImage = false,\n SaveApiRequest = true,\n VendorData = \"user-123\",\n Metadata = new Dictionary { [\"flow\"] = \"login\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/age-estimation/": { "post": { "summary": "Estimación de edad (edad facial + prueba de vida pasiva)", "description": "Estima la edad de una persona a partir de una sola foto del rostro y ejecuta una prueba de vida pasiva en la misma llamada: devuelve la `age_estimation` predicha por el modelo (en años), una `score` de vida (0–100) y un `status` `Approved`/`Declined`. La edad la **predice el modelo a partir del rostro y no se verifica contra un documento**: úsala para controles de edad y comprobaciones de baja fricción, no como prueba legal de la edad.\n\n**Cómo funciona.** Se analiza la imagen en busca de rostros (establece `rotate_image=true` si las capturas pueden estar de lado o boca abajo); a cada rostro detectado se le asigna una edad estimada, y el rostro más grande del encuadre determina `age_estimation`. En paralelo, un modelo de prueba de vida pasiva puntúa si la foto muestra a una persona real (sin exigir ningún reto al usuario) y detecta ataques de presentación (fotos de fotos, pantallas, máscaras). Para obtener los mejores resultados, envía un único rostro nítido, de frente y bien iluminado por imagen.\n\n**Lógica de decisión.** Cualquier advertencia provoca el rechazo: `status` es `Approved` solo cuando el array `warnings` está vacío. Una `score` de vida igual o inferior a `face_liveness_score_decline_threshold` (por defecto `30`) añade `LOW_LIVENESS_SCORE`; un ataque detectado añade `LIVENESS_FACE_ATTACK`; si el modelo de prueba de vida no encuentra ningún rostro, se añade `NO_FACE_DETECTED`; si no se puede estimar la edad de ningún rostro, se añade `AGE_NOT_DETECTED` (`age_estimation` es `null`); una edad estimada inferior a `age_estimation_decline_threshold` (por defecto `18`) añade `AGE_BELOW_MINIMUM`. Para las edades límite cercanas a tu umbral conviene recurrir a una verificación basada en documentos: el error del modelo aumenta en los rostros próximos al límite.\n\n**Facturación.** Cada respuesta `200` consume un crédito de la API de Estimación de edad (pagado con el crédito de tu plan o con tu saldo de recarga). Cuando el saldo de la organización no alcanza para cubrir la llamada, el endpoint devuelve `403` con el error de créditos insuficientes antes de procesar ninguna imagen.\n\n**Persistencia de la sesión (`save_api_request`, por defecto `true`).** Cuando es `true`, la llamada se guarda como una sesión de tipo API: aparece en la Business Console, el `request_id` devuelto es un id de sesión real que puedes pasar a `GET /v3/session/{sessionId}/decision/` (el resultado se expone ahí en `liveness_checks[]`, con `features: [\"AGE_ESTIMATION\"]`), se almacenan el recorte del rostro y la imagen de referencia, el embedding facial se añade al índice facial de tu aplicación (que usan la búsqueda facial y la detección de duplicados) y se emite un webhook `status.updated`. Cuando es `false`, no se almacena nada y `request_id` es un UUID de correlación puntual que no se puede consultar después.\n\n**Sandbox.** Las claves de API de sandbox omiten todo el procesamiento y la facturación: tras validar la solicitud (una entrada mal formada sigue devolviendo `400`), el endpoint devuelve un payload simulado estático `Approved` (`age_estimation: 30`, sin advertencias), no se guarda ninguna sesión y no se consumen créditos.\n\n**Autenticación.** Envía la clave de API de tu aplicación en el encabezado `x-api-key`. Si faltan las credenciales o no son válidas, se devuelve `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`): esta API nunca devuelve `401`.\n\n**Límite de solicitudes.** Presupuesto de escritura compartido de 300 solicitudes/min por clave de API entre todos los endpoints POST/PATCH/DELETE; si se supera, se devuelve `429`.", "operationId": "post_v3age-estimation", "x-didit-sdk": { "resource": "age_estimation", "method": "estimate", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "user_image" ], "properties": { "user_image": { "type": "string", "format": "binary", "description": "Foto del rostro que se va a analizar (por ejemplo, una selfie). Envía una sola foto de frente en la que el rostro de la persona se vea con claridad y esté bien iluminado. Extensiones permitidas: `tiff`, `jpg`, `jpeg`, `png`, `webp` (no se admite PDF). Tamaño máximo de carga: **5 MB** (los archivos más grandes se rechazan con `400`). Las imágenes se comprimen automáticamente a unos 0,3 MB antes del procesamiento, por lo que las resoluciones muy altas no mejoran la precisión." }, "face_liveness_score_decline_threshold": { "type": "number", "format": "float", "default": 30, "minimum": 0, "maximum": 100, "description": "Umbral de prueba de vida (0–100). Un `score` de prueba de vida **igual o inferior** a este valor añade una advertencia `LOW_LIVENESS_SCORE` y rechaza. Súbelo para una protección antisuplantación más estricta; los valores fuera de 0–100 devuelven `400`.", "example": 30 }, "age_estimation_decline_threshold": { "type": "integer", "default": 18, "minimum": 0, "maximum": 100, "description": "Edad estimada mínima aceptable, en años. Una edad estimada **inferior** a este valor añade una advertencia `AGE_BELOW_MINIMUM` y rechaza la verificación. Establece `0` para desactivar la comprobación de edad (la llamada solo ejecuta entonces la prueba de vida y la estimación de edad, sin una decisión basada en la edad).", "example": 18 }, "rotate_image": { "type": "boolean", "default": false, "description": "Si es `true`, el servicio prueba la imagen de entrada en incrementos de 90 grados (0, 90, 180, 270) y usa la orientación que ofrece la mejor detección facial, algo útil para capturas desde el móvil sin orientación EXIF. Añade latencia, así que actívalo solo si no puedes garantizar imágenes en posición vertical.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Cuando es `true` (valor predeterminado), guarda la llamada como una sesión de tipo API: visible en la Business Console, recuperable mediante `GET /v3/session/{sessionId}/decision/` con el `request_id` devuelto, notificada mediante un webhook `status.updated` y con el rostro detectado añadido al índice facial de tu aplicación. Cuando es `false`, no se almacena nada y `request_id` es un UUID temporal que solo sirve para correlacionar la respuesta.", "example": true }, "vendor_data": { "type": "string", "description": "Cadena opaca opcional (tu ID de usuario interno, correo electrónico, UUID…) que se guarda en la sesión persistida y se devuelve en la respuesta. Úsala para relacionar las llamadas a la API con tus propios registros y para filtrar sesiones más adelante.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objeto JSON opcional que se almacena con la sesión (cuando `save_api_request=true`) y se devuelve en la respuesta. En solicitudes multipart, envíalo como un campo de cadena codificado en JSON (p. ej., `metadata={\"flow\":\"age-gate\"}`): se convierte en un objeto.", "example": { "flow": "age-gate" } } } }, "example": { "user_image": "(binary JPEG/PNG of the selfie)", "face_liveness_score_decline_threshold": 30, "age_estimation_decline_threshold": 18, "rotate_image": false, "save_api_request": true, "vendor_data": "user-123", "metadata": { "flow": "age-gate" } } } } }, "responses": { "200": { "description": "Estimación de edad y prueba de vida pasiva completadas. `age_estimation.age_estimation` es la edad en años que predice el modelo para el rostro más grande detectado (`null` si no hay ninguno); `age_estimation.score` es la puntuación de la prueba de vida pasiva (0–100); `status` es `Approved` solo cuando `warnings` está vacío. Una captura de un menor de edad o suplantada sigue devolviendo `200` con `status: \"Declined\"`: revisa el cuerpo, no solo el código HTTP. Cuando `save_api_request=true`, `request_id` es el id de la sesión guardada.", "content": { "application/json": { "examples": { "Approved": { "summary": "Rostro real de un adulto — ambas comprobaciones superadas", "value": { "request_id": "0c40ba43-64ab-4e2e-b4b8-7d1f12f81bc1", "age_estimation": { "status": "Approved", "method": "PASSIVE", "score": 97.5, "user_image": { "entities": [ { "age": 27.33, "bbox": [ 40, 40, 100, 100 ], "confidence": 0.7177750468254089, "gender": "male" } ], "best_angle": 0 }, "age_estimation": 27.33, "warnings": [] }, "vendor_data": "user-123", "metadata": { "flow": "age-gate" }, "created_at": "2026-06-12T02:24:11.512941+00:00" } }, "Declined - age below threshold": { "summary": "Edad estimada inferior a `age_estimation_decline_threshold`", "value": { "request_id": "9be41a6f-2f4e-4f57-92f4-b3a4f6f0a1c2", "age_estimation": { "status": "Declined", "method": "PASSIVE", "score": 95.0, "user_image": { "entities": [ { "age": 16.5, "bbox": [ 40, 40, 100, 100 ], "confidence": 0.7177750468254089, "gender": "female" } ], "best_angle": 0 }, "age_estimation": 16.5, "warnings": [ { "risk": "AGE_BELOW_MINIMUM", "feature": "LIVENESS", "additional_data": null, "log_type": "error", "short_description": "Age below minimum", "long_description": "The age of the face is below the minimum age threshold for the application." } ] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T02:26:40.118332+00:00" } }, "Declined - liveness too low": { "summary": "Puntuación de prueba de vida igual o inferior al umbral de rechazo (posible suplantación)", "value": { "request_id": "5f6f2f1f-7c4f-43b9-8d62-0a8f4c2d9e77", "age_estimation": { "status": "Declined", "method": "PASSIVE", "score": 5.0, "user_image": { "entities": [ { "age": 25.0, "bbox": [ 40, 40, 100, 100 ], "confidence": 0.7177750468254089, "gender": "male" } ], "best_angle": 0 }, "age_estimation": 25.0, "warnings": [ { "risk": "LOW_LIVENESS_SCORE", "feature": "LIVENESS", "additional_data": null, "log_type": "error", "short_description": "Low liveness score", "long_description": "The liveness check resulted in a low score, indicating potential use of non-live facial representations or poor-quality biometric data." } ] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T02:27:02.901547+00:00" } } }, "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sesión guardada cuando `save_api_request=true` (se puede usar con `GET /v3/session/{sessionId}/decision/`); en caso contrario, un UUID de correlación temporal." }, "age_estimation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Approved` cuando no se generó ninguna advertencia; `Declined` en caso contrario (todas las advertencias que produce este endpoint implican un rechazo)." }, "method": { "type": "string", "enum": [ "PASSIVE" ], "description": "Método de prueba de vida. Siempre `PASSIVE` en este endpoint (una sola imagen, sin desafío para el usuario)." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Puntuación de prueba de vida pasiva de 0 a 100: la confianza del modelo de que la foto muestra a una persona real. Se compara con `face_liveness_score_decline_threshold`; si es igual o inferior, la llamada se rechaza con `LOW_LIVENESS_SCORE`. Es `null` cuando el modelo de prueba de vida no devuelve ninguna confianza; aun así, la llamada se rechaza con `LOW_LIVENESS_SCORE`, porque null se trata como 0 en la comparación con el umbral.", "example": 97.5 }, "user_image": { "type": "object", "description": "Resultados de la detección facial de la imagen analizada.", "properties": { "entities": { "type": "array", "description": "Una entrada por rostro detectado. Vacío cuando no se encontró ningún rostro (en ese caso `age_estimation` es `null` y se añade una advertencia `AGE_NOT_DETECTED`).", "items": { "type": "object", "properties": { "age": { "type": "number", "format": "float", "description": "Edad de este rostro estimada por el modelo, en años.", "example": 27.33 }, "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Cuadro delimitador del rostro detectado, en coordenadas de píxeles `[x_min, y_min, x_max, y_max]` de la imagen procesada.", "example": [ 40, 40, 100, 100 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Confianza de la detección facial (0–1).", "example": 0.7177750468254089 }, "gender": { "type": "string", "description": "Género del rostro detectado predicho por el modelo (`male` o `female`). Solo es informativo.", "example": "male" } } } }, "best_angle": { "type": "integer", "nullable": true, "description": "Rotación (en grados: 0, 90, 180 o 270) que produjo la mejor detección facial. Solo es distinta de cero cuando `rotate_image=true` corrigió la orientación.", "example": 0 } } }, "age_estimation": { "type": "number", "format": "float", "nullable": true, "description": "Edad en años predicha por el modelo para el rostro detectado **más grande**. `null` cuando no se pudo estimar la edad de ningún rostro (se añade una advertencia `AGE_NOT_DETECTED` y la llamada se rechaza).", "example": 27.33 }, "warnings": { "type": "array", "description": "Vacío en una aprobación sin incidencias. Cualquier entrada establece `status` en `Declined`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "NO_FACE_DETECTED", "LOW_LIVENESS_SCORE", "LIVENESS_FACE_ATTACK", "AGE_NOT_DETECTED", "AGE_BELOW_MINIMUM" ], "description": "Código de riesgo legible por máquina. `NO_FACE_DETECTED`: el modelo de prueba de vida no encontró ningún rostro; `LOW_LIVENESS_SCORE`: la `score` de prueba de vida es igual o inferior a `face_liveness_score_decline_threshold`; `LIVENESS_FACE_ATTACK`: se detectó un ataque de presentación (foto/pantalla/máscara); `AGE_NOT_DETECTED`: no se pudo estimar la edad del rostro; `AGE_BELOW_MINIMUM`: la edad estimada es inferior a `age_estimation_decline_threshold`. `NO_FACE_DETECTED` y `LOW_LIVENESS_SCORE` son mutuamente excluyentes: cuando no se encuentra ningún rostro, solo se emite `NO_FACE_DETECTED`." }, "feature": { "type": "string", "enum": [ "LIVENESS" ], "description": "Función que emitió la advertencia. En este endpoint siempre es `LIVENESS`." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Siempre `null` en las advertencias de estimación de edad." }, "log_type": { "type": "string", "enum": [ "error" ], "description": "Gravedad. Todas las advertencias que produce este endpoint son de tipo `error` y establecen `status` en `Declined`." }, "short_description": { "type": "string", "description": "Resumen legible del riesgo en una línea." }, "long_description": { "type": "string", "description": "Explicación legible del riesgo." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste, o `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Devuelve el objeto `metadata` que enviaste, o `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de tiempo ISO 8601 (UTC) del momento en que se generó la respuesta." } } } } } }, "400": { "description": "Error de validación. Se devuelve cuando falta `user_image`, supera los 5 MB o tiene una extensión no admitida, o cuando un umbral está fuera de rango. El cuerpo es el formato estándar de errores de campo de DRF: un array de mensajes por cada campo con error.", "content": { "application/json": { "examples": { "Missing user image": { "summary": "`user_image` no incluido en los datos del formulario", "value": { "user_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Extensión de archivo distinta de tiff/jpg/jpeg/png/webp", "value": { "user_image": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp." ] } }, "File too large": { "summary": "El archivo supera el límite de 5 MB", "value": { "user_image": [ "File size should not exceed 5 MB" ] } }, "Threshold out of range": { "summary": "`face_liveness_score_decline_threshold` fuera del rango 0–100", "value": { "face_liveness_score_decline_threshold": [ "Ensure this value is less than or equal to 100." ] } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key` y también cuando el saldo de la organización que realiza la llamada no la cubre; una clave incorrecta, revocada o expirada devuelve `401`. Si falta la clave, se devuelve `403` con `{\"detail\": ...}`; una clave incorrecta, revocada o expirada devuelve `401`. La falta de créditos devuelve `403` con `{\"error\": ...}` antes de que se procese ninguna imagen.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de la organización no cubre la llamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/age-estimation/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'user_image=@./selfie.jpg' \\\n -F 'age_estimation_decline_threshold=18' \\\n -F 'face_liveness_score_decline_threshold=30' \\\n -F 'save_api_request=true' \\\n -F 'vendor_data=user-123'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.age_estimation.estimate(\n user_image=open(\"user_image.jpg\", \"rb\"),\n face_liveness_score_decline_threshold=30.0,\n age_estimation_decline_threshold=18,\n rotate_image=False,\n save_api_request=True,\n vendor_data=\"user-123\",\n metadata={\"flow\": \"age-gate\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.ageEstimation.estimate({\n user_image: await fileFromPath(\"user_image.jpg\"),\n face_liveness_score_decline_threshold: 30.0,\n age_estimation_decline_threshold: 18,\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"age-gate\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.AgeEstimation.Estimate(ctx, didit.AgeEstimationEstimateParams{\n\tUserImage: didit.FileFromPath(\"user_image.jpg\"),\n\tFaceLivenessScoreDeclineThreshold: didit.Float(30.0),\n\tAgeEstimationDeclineThreshold: didit.Int(18),\n\tRotateImage: didit.Bool(false),\n\tSaveAPIRequest: didit.Bool(true),\n\tVendorData: didit.String(\"user-123\"),\n\tMetadata: didit.Some(map[string]any{\"flow\": \"age-gate\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.AgeEstimationEstimateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.ageEstimation().estimate(AgeEstimationEstimateParams.builder()\n .userImage(Path.of(\"user_image.jpg\"))\n .faceLivenessScoreDeclineThreshold(30.0)\n .ageEstimationDeclineThreshold(18L)\n .rotateImage(false)\n .saveApiRequest(true)\n .vendorData(\"user-123\")\n .metadata(Map.of(\"flow\", \"age-gate\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "ageEstimation->estimate([\n 'user_image' => File::fromPath('user_image.jpg'),\n 'face_liveness_score_decline_threshold' => 30.0,\n 'age_estimation_decline_threshold' => 18,\n 'rotate_image' => false,\n 'save_api_request' => true,\n 'vendor_data' => 'user-123',\n 'metadata' => ['flow' => 'age-gate'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.age_estimation.estimate(\n user_image: Pathname(\"user_image.jpg\"),\n face_liveness_score_decline_threshold: 30.0,\n age_estimation_decline_threshold: 18,\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"age-gate\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.AgeEstimation.EstimateAsync(new AgeEstimationEstimateParams\n{\n UserImage = FileUpload.FromPath(\"user_image.jpg\"),\n FaceLivenessScoreDeclineThreshold = 30.0,\n AgeEstimationDeclineThreshold = 18,\n RotateImage = false,\n SaveApiRequest = true,\n VendorData = \"user-123\",\n Metadata = new Dictionary { [\"flow\"] = \"age-gate\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/poa/": { "post": { "summary": "Prueba de domicilio (OCR del documento + comprobaciones de dirección)", "description": "Extrae y valida un documento de prueba de domicilio (facturas de servicios, extractos bancarios y documentos emitidos por el gobierno) en una sola llamada. Devuelve el emisor, las fechas de emisión y caducidad, el nombre del titular, la dirección sin procesar y la dirección analizada y geocodificada, un `status` `Approved`/`Declined` y una lista `warnings` que explica cada problema detectado.\n\n**Latencia.** La extracción se basa en un LLM: las llamadas típicas tardan **5–15 segundos** y los PDF de varias páginas, hasta **~30 segundos**. Configura un tiempo de espera del cliente de **al menos 45 segundos** y no reintentes antes de que la llamada termine.\n\n**Cómo funciona.** El documento (imagen o PDF, hasta 15 MB; los PDF cifrados requieren `document_password`) se clasifica en un tipo y un subtipo de documento (p. ej., `UTILITY_BILL` / `WATER_BILL`), y el emisor, las fechas, el nombre del titular y la dirección se obtienen mediante extracción basada en LLM. La dirección se analiza y se geocodifica en `poa_parsed_address`. El análisis forense de PDF/EXIF detecta manipulaciones (modificaciones posteriores a la firma digital, editores de PDF conocidos, manipulación con texto superpuesto, reexportaciones sospechosas) y devuelve `SUSPECTED_DOCUMENT_MANIPULATION` o `DOCUMENT_METADATA_MISMATCH`. La antigüedad del documento se valida con `poa_document_age_months` y el idioma, con `poa_languages_allowed`. Si envías `expected_address`, `expected_country` o `expected_first_name`/`expected_last_name`, los valores extraídos se contrastan con ellos y se señalan las discrepancias.\n\n**Lógica de decisión.** `status` es `Approved` salvo que al menos una advertencia derive en un rechazo. Los fallos graves siempre provocan un rechazo: `MISSING_ADDRESS_INFORMATION`, `POA_DOCUMENT_EXPIRED`, `INVALID_DOCUMENT_TYPE`, `UNABLE_TO_VALIDATE_DOCUMENT_AGE`, además de `UNABLE_TO_EXTRACT_ISSUE_DATE` y `POA_NAME_NOT_DETECTED` (no configurables en este endpoint). Cinco grupos de riesgo se pueden configurar en cada solicitud con las opciones `poa_*_action` (`DECLINE` o `NO_ACTION`, todas con `DECLINE` por defecto). `POA_DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION` y `UNPARSABLE_OR_INVALID_ADDRESS` son informativas en este endpoint y nunca provocan un rechazo. Un documento que no se puede procesar en absoluto devuelve `400`; un documento legible pero con problemas devuelve `200` con `status: \"Declined\"`. Revisa siempre `poa.status` y `poa.warnings`, no solo el código HTTP.\n\n**Facturación.** Cada respuesta `200` consume un crédito de la API de prueba de domicilio (con cargo al crédito de tu plan o a tu saldo de recarga). Si el saldo de la organización no cubre la llamada, el endpoint devuelve `403` con el error de créditos insuficientes antes de procesar ningún documento.\n\n**Persistencia de la sesión (`save_api_request`, `true` por defecto).** Con `true`, la llamada se guarda como una sesión de tipo API: aparece en la Business Console, el documento subido se almacena, el `request_id` devuelto es un ID de sesión real que puedes pasar a `GET /v3/session/{sessionId}/decision/` (la decisión expone además `document_file` y el análisis forense `document_metadata`, que esta respuesta omite) y se emite un webhook `status.updated`. Con `false`, no se almacena nada y `request_id` es un UUID de correlación de un solo uso que no se puede consultar más adelante.\n\n**Sandbox.** Las claves de API de sandbox omiten todo el procesamiento y la facturación: tras validar la solicitud (una entrada mal formada sigue devolviendo `400`), el endpoint devuelve un payload simulado estático `Approved` (una factura de electricidad ficticia de \"Sandbox Power Co.\"), no se guarda ninguna sesión y no se consumen créditos.\n\n**Autenticación.** Envía la clave de API de tu aplicación en el encabezado `x-api-key`. Si faltan las credenciales o no son válidas, se devuelve `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`). Esta API nunca devuelve `401`.\n\n**Límite de solicitudes.** Presupuesto de escritura compartido de 300 solicitudes/min por clave de API entre todos los endpoints POST/PATCH/DELETE; si lo superas, se devuelve `429`.\n\nNota: `FUTURE_ISSUE_DATE` y `POOR_DOCUMENT_QUALITY` existen en las sesiones de flujo, pero este endpoint independiente nunca los genera. Aquí un documento con fecha futura no se rechaza automáticamente.", "operationId": "post_v3poa", "x-didit-sdk": { "resource": "proof_of_address", "method": "verify", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "document" ], "properties": { "document": { "type": "string", "format": "binary", "description": "El documento de prueba de domicilio. Extensiones permitidas: `tiff`, `jpg`, `jpeg`, `png`, `pdf`, `webp`. Tamaño máximo de carga: **15 MB** (los archivos más grandes se rechazan con `400`). Se admiten PDF de varias páginas (la latencia es mayor); los PDF cifrados requieren `document_password`. Las imágenes se comprimen automáticamente antes de procesarlas." }, "document_password": { "type": "string", "description": "Contraseña para descifrar `document` cuando es un PDF cifrado. Enviar un PDF cifrado sin contraseña (o con una incorrecta) devuelve `400`.", "writeOnly": true }, "expected_address": { "type": "string", "description": "Dirección que se verifica frente al documento. Se geocodifica y se compara con la dirección extraída; una discrepancia (o una dirección esperada que no se puede geocodificar o verificar) añade `ADDRESS_MISMATCH_WITH_PROVIDED`, que se rige por `poa_address_mismatch_action`. La forma geocodificada se devuelve en `expected_details_formatted_address` / `expected_details_parsed_address`.", "example": "Av. Monseñor Tavella 1291, Salta, Argentina" }, "expected_country": { "type": "string", "description": "País que se verifica contra el documento (código ISO 3166-1, p. ej., `ARG` o `AR`). Si no coincide con el país del documento, se añade `POA_COUNTRY_MISMATCH_WITH_PROVIDED`, que se rige por `poa_address_mismatch_action`.", "example": "ARG" }, "expected_first_name": { "type": "string", "description": "Nombre que se verifica contra `name_on_document` (coincidencia aproximada, con soporte de transliteración). Una puntuación inferior al umbral de coincidencia añade `NAME_MISMATCH_WITH_PROVIDED`, que se rige por `poa_address_mismatch_action`.", "example": "Sophia" }, "expected_last_name": { "type": "string", "description": "Apellido que se verifica contra `name_on_document`, combinado con `expected_first_name` para la puntuación de coincidencia.", "example": "Martinez" }, "poa_languages_allowed": { "type": "string", "description": "Lista separada por comas de los idiomas de documento aceptados, como códigos ISO 639-1 (por ejemplo, `en,es,fr`). Si se omite o se deja en blanco, se aceptan **los 51 idiomas admitidos**. Un documento en un idioma que no está en la lista añade `UNSUPPORTED_DOCUMENT_LANGUAGE` (regulado por `poa_unsupported_language_action`); un código desconocido en la lista devuelve `400` con el conjunto completo de códigos admitidos.", "example": "en,es" }, "poa_document_age_months": { "type": "string", "description": "Pares `key:value` separados por comas que fijan la antigüedad máxima del documento en meses por tipo de documento. Claves: `utility_bill`, `bank_statement`, `government_issued_document`, `other_poa_document`; valores: `1`–`120`, o `-1` para sin límite (sin comprobación de antigüedad). Valores predeterminados si se omite: `utility_bill:3,bank_statement:3,government_issued_document:12,other_poa_document:12`. Un documento con más antigüedad que su límite se rechaza con `POA_DOCUMENT_EXPIRED`. **Precaución:** cuando proporcionas este campo, indica *todos* los tipos que aceptas; los tipos omitidos se consideran no aceptados (`POA_DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION`, informativo) y se omite su comprobación de antigüedad.", "example": "utility_bill:3,bank_statement:6" }, "poa_name_mismatch_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Se acepta, pero **actualmente no se aplica**: las advertencias de discrepancia de nombre (`NAME_MISMATCH_WITH_PROVIDED`) siguen `poa_address_mismatch_action`. Configura `poa_address_mismatch_action` para controlar el comportamiento ante discrepancias tanto de nombre como de dirección." }, "poa_document_issues_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Qué hacer ante problemas de integridad del archivo; en la práctica, este endpoint solo genera `DOCUMENT_METADATA_MISMATCH`." }, "poa_document_authenticity_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Qué hacer cuando se sospecha una manipulación del documento (`SUSPECTED_DOCUMENT_MANIPULATION`); por ejemplo, el PDF se modificó después de la firma digital, se procesó con un editor de PDF conocido, muestra manipulación con texto superpuesto o tiene fechas EXIF incoherentes." }, "poa_unsupported_language_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Qué hacer cuando el idioma del documento no está en `poa_languages_allowed` (`UNSUPPORTED_DOCUMENT_LANGUAGE`)." }, "poa_address_mismatch_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Qué hacer cuando los datos extraídos no coinciden con los campos `expected_*`: `ADDRESS_MISMATCH_WITH_PROVIDED`, `NAME_MISMATCH_WITH_PROVIDED` y `POA_COUNTRY_MISMATCH_WITH_PROVIDED` siguen todos esta acción." }, "poa_issuer_not_identified_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Qué hacer cuando no se puede identificar ninguna empresa u organización emisora en el documento (`ISSUER_NOT_IDENTIFIED`)." }, "save_api_request": { "type": "boolean", "default": true, "description": "Cuando es `true` (valor predeterminado), guarda la llamada como una sesión de tipo API: visible en la Business Console, recuperable mediante `GET /v3/session/{sessionId}/decision/` con el `request_id` devuelto, notificada mediante un webhook `status.updated` y con el documento subido almacenado. Cuando es `false`, no se almacena nada y `request_id` es un UUID temporal que solo sirve para correlacionar la respuesta.", "example": true }, "vendor_data": { "type": "string", "description": "Cadena opaca opcional (tu ID de usuario interno, correo electrónico, UUID…) que se guarda en la sesión persistida y se devuelve en la respuesta. Úsala para relacionar las llamadas a la API con tus propios registros y para filtrar sesiones más adelante.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objeto JSON opcional que se almacena con la sesión (cuando `save_api_request=true`) y se devuelve en la respuesta. En solicitudes multipart, envíalo como un campo de cadena codificado en JSON (p. ej., `metadata={\"flow\":\"onboarding\"}`): se convierte en un objeto.", "example": { "flow": "onboarding" } } } }, "example": { "document": "(binary JPEG/PNG/PDF of the utility bill or bank statement)", "expected_address": "Av. Monseñor Tavella 1291, Salta, Argentina", "expected_country": "ARG", "expected_first_name": "Sophia", "expected_last_name": "Martinez", "poa_languages_allowed": "en,es", "save_api_request": true, "vendor_data": "user-123" } } } }, "responses": { "200": { "description": "Documento procesado. `poa.status` es `Approved` o `Declined`; cada problema detectado se detalla en `poa.warnings`. Un documento expirado, que no coincide o sospechoso también devuelve `200` con `status: \"Declined\"`: revisa el cuerpo, no solo el código HTTP. Cuando `save_api_request=true`, `request_id` es el ID de la sesión guardada.", "content": { "application/json": { "examples": { "Approved": { "summary": "Factura de servicios leída correctamente, sin comprobaciones de datos esperados", "value": { "request_id": "4b523a8d-ed32-45e4-8aa8-a89eda459d88", "poa": { "issuing_state": "ARG", "document_type": "UTILITY_BILL", "document_subtype": "WATER_BILL", "document_language": "es", "issuer": "Aguas del Norte", "issue_date": "2026-04-10", "expiration_date": null, "poa_address": "AVDA. MONSEÑOR TAVELLA N° 1291, B° VILLA LAVALLE CP: 4400, CAPITAL - SALTA", "poa_formatted_address": "Av. Monseñor Tavella 1291 b, A4400 Salta, Argentina", "poa_parsed_address": { "street_1": "Avenida Monseñor Tavella 1291", "street_2": "b", "city": "Salta", "region": "Salta", "country": "AR", "postal_code": "A4400", "document_location": { "latitude": -24.8208682, "longitude": -65.4130954 } }, "expected_details_address": null, "expected_details_formatted_address": null, "expected_details_parsed_address": null, "name_on_document": "OESTE EMBOTELLADORA S.A.", "extra_fields": { "bank_account_number": null, "bank_iban": null, "bank_sort_code": null, "bank_routing_number": null, "bank_swift_bic": null, "bank_branch_name": null, "bank_branch_address": null, "document_phone_number": null, "additional_names": [ "LA EMBOTELLADORA DEL NORTE SA" ] }, "detected_codes": [ { "type": "QR_CODE", "page_number": 1, "position": [ [ 820, 1120 ], [ 1002, 1120 ], [ 1002, 1302 ], [ 820, 1302 ] ], "x": 820, "y": 1120, "width": 182, "height": 182, "page_width": 1190, "page_height": 1684, "raw_payload": "aHR0cHM6Ly9hZ3Vhc2RlbG5vcnRlLmNvbS9mYWN0dXJhLzk5ODgxMQ==", "parsed_payload": "https://aguasdelnorte.com/factura/998811" }, { "type": "CODE_128", "page_number": 1, "position": [ [ 112, 1480 ], [ 560, 1480 ], [ 560, 1540 ], [ 112, 1540 ] ], "x": 112, "y": 1480, "width": 448, "height": 60, "page_width": 1190, "page_height": 1684, "raw_payload": "MDA5OTg4MTEwMDA0Mg==", "parsed_payload": "0099881100042" } ], "status": "Approved", "warnings": [] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T02:29:02.439655+00:00" } }, "Declined - document too old": { "summary": "Fecha de emisión anterior a lo permitido por `poa_document_age_months`", "value": { "request_id": "f61681b8-9422-4378-ac3e-04c6a247fb45", "poa": { "issuing_state": "ARG", "document_type": "UTILITY_BILL", "document_subtype": "WATER_BILL", "document_language": "es", "issuer": "Aguas del Norte", "issue_date": "2021-02-10", "expiration_date": null, "poa_address": "AVDA. MONSEÑOR TAVELLA N° 1291, B° VILLA LAVALLE CP: 4400, CAPITAL - SALTA", "poa_formatted_address": "Av. Monseñor Tavella 1291 b, A4400 Salta, Argentina", "poa_parsed_address": { "street_1": "Avenida Monseñor Tavella 1291", "street_2": "b", "city": "Salta", "region": "Salta", "country": "AR", "postal_code": "A4400", "document_location": { "latitude": -24.8208682, "longitude": -65.4130954 } }, "expected_details_address": null, "expected_details_formatted_address": null, "expected_details_parsed_address": null, "name_on_document": "OESTE EMBOTELLADORA S.A.", "extra_fields": { "bank_account_number": null, "bank_iban": null, "bank_sort_code": null, "bank_routing_number": null, "bank_swift_bic": null, "bank_branch_name": null, "bank_branch_address": null, "document_phone_number": null, "additional_names": [ "LA EMBOTELLADORA DEL NORTE SA" ] }, "status": "Declined", "warnings": [ { "risk": "POA_DOCUMENT_EXPIRED", "feature": "PROOF_OF_ADDRESS", "additional_data": { "expiration_reason": "age_window", "max_age_months": 3, "document_subtype": "WATER_BILL", "document_type": "UTILITY_BILL", "issue_date": "2021-02-10" }, "log_type": "error", "short_description": "Document expired", "long_description": "The submitted document is older than the maximum accepted age of 3 months from its issue date, which exceeds the acceptable time period for validity." } ] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T02:23:02.165493+00:00" } }, "Declined - name mismatch": { "summary": "`expected_first_name`/`expected_last_name` no coinciden con `name_on_document`", "value": { "request_id": "0a7f2f9c-58f1-4b8e-b1e3-2f6f9d4f7a21", "poa": { "issuing_state": "ARG", "document_type": "UTILITY_BILL", "document_subtype": "WATER_BILL", "document_language": "es", "issuer": "Aguas del Norte", "issue_date": "2021-02-10", "expiration_date": null, "poa_address": "AVDA. MONSEÑOR TAVELLA N° 1291, B° VILLA LAVALLE CP: 4400, CAPITAL - SALTA", "poa_formatted_address": "Av. Monseñor Tavella 1291 b, A4400 Salta, Argentina", "poa_parsed_address": { "street_1": "Avenida Monseñor Tavella 1291", "street_2": "b", "city": "Salta", "region": "Salta", "country": "AR", "postal_code": "A4400", "document_location": { "latitude": -24.8208682, "longitude": -65.4130954 } }, "expected_details_address": null, "expected_details_formatted_address": null, "expected_details_parsed_address": null, "name_on_document": "OESTE EMBOTELLADORA S.A.", "extra_fields": { "bank_account_number": null, "bank_iban": null, "bank_sort_code": null, "bank_routing_number": null, "bank_swift_bic": null, "bank_branch_name": null, "bank_branch_address": null, "document_phone_number": null, "additional_names": [ "LA EMBOTELLADORA DEL NORTE SA" ] }, "status": "Declined", "warnings": [ { "risk": "NAME_MISMATCH_WITH_PROVIDED", "feature": "PROOF_OF_ADDRESS", "additional_data": null, "log_type": "error", "short_description": "Name mismatch with provided information", "long_description": "The full name on the document does not match the name from the user's verified identity documents, or the full name sent by API." } ] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T02:27:21.330172+00:00" } } }, "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sesión guardada cuando `save_api_request=true` (se puede usar con `GET /v3/session/{sessionId}/decision/`); en caso contrario, un UUID de correlación temporal." }, "poa": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Approved` cuando ninguna advertencia se resuelve en un rechazo; `Declined` en caso contrario: la lista `warnings` explica el motivo." }, "issuing_state": { "type": "string", "nullable": true, "description": "País en el que se emitió el documento, tal como se extrae del documento; normalmente ISO 3166-1 alfa-3 (p. ej., `ARG`).", "example": "ARG" }, "document_type": { "type": "string", "enum": [ "UTILITY_BILL", "BANK_STATEMENT", "GOVERNMENT_ISSUED_DOCUMENT", "OTHER_POA_DOCUMENT", "UNKNOWN" ], "description": "Categoría de documento detectada. `UNKNOWN` significa que el documento no se pudo clasificar como una Prueba de domicilio aceptable y se rechaza automáticamente con `INVALID_DOCUMENT_TYPE`. Nunca es null: si la clasificación falla, el valor es `UNKNOWN`." }, "document_subtype": { "type": "string", "description": "Clasificación más detallada dentro de `document_type`, por ejemplo `ELECTRICITY_BILL`, `WATER_BILL`, `GAS_BILL`, `INTERNET_BILL`, `PHONE_BILL` (facturas de servicios); `ACCOUNT_STATEMENT`, `CREDIT_CARD_STATEMENT` (extractos bancarios); `TAX_ASSESSMENT`, `RESIDENCY_CERTIFICATE` (documentos gubernamentales). Es `UNKNOWN` cuando no se pudo determinar ningún subtipo. Nunca es null: los fallos de clasificación recurren a `UNKNOWN`.", "example": "WATER_BILL" }, "document_language": { "type": "string", "nullable": true, "description": "Idioma del documento detectado (ISO 639-1).", "example": "es" }, "issuer": { "type": "string", "nullable": true, "description": "Empresa u organización que emitió el documento. `null` añade `ISSUER_NOT_IDENTIFIED`.", "example": "Aguas del Norte" }, "issue_date": { "type": "string", "format": "date", "nullable": true, "description": "Fecha de expedición del documento (`YYYY-MM-DD`). `null` cuando no se pudo extraer; en este endpoint, eso provoca un rechazo con `UNABLE_TO_EXTRACT_ISSUE_DATE`.", "example": "2021-02-10" }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "description": "Fecha de caducidad o validez explícita impresa en el documento, cuando existe. Es independiente de la comprobación de antigüedad `poa_document_age_months`." }, "poa_address": { "type": "string", "nullable": true, "description": "Dirección tal como aparece impresa en el documento. `null` rechaza automáticamente con `MISSING_ADDRESS_INFORMATION`." }, "poa_formatted_address": { "type": "string", "nullable": true, "description": "Versión geocodificada y normalizada de `poa_address`.", "example": "Av. Monseñor Tavella 1291 b, A4400 Salta, Argentina" }, "poa_parsed_address": { "type": "object", "nullable": true, "description": "Desglose estructurado y geocodificado de la dirección del documento. `null` cuando no se pudo analizar la dirección.", "properties": { "street_1": { "type": "string", "nullable": true, "example": "Avenida Monseñor Tavella 1291" }, "street_2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true, "example": "Salta" }, "region": { "type": "string", "nullable": true, "example": "Salta" }, "country": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alfa-2.", "example": "AR" }, "postal_code": { "type": "string", "nullable": true, "example": "A4400" }, "document_location": { "type": "object", "nullable": true, "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "description": "Coordenadas geocodificadas de la dirección del documento." } } }, "expected_details_address": { "type": "string", "nullable": true, "description": "Devuelve el `expected_address` que enviaste, o `null`." }, "expected_details_formatted_address": { "type": "string", "nullable": true, "description": "Versión geocodificada y normalizada de `expected_address`; `null` cuando no se proporciona o no se puede geocodificar." }, "expected_details_parsed_address": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Resultado completo de geocodificación de `expected_address` (calle, ciudad, región, país y código postal, además de la salida sin procesar del geocodificador y un indicador `is_verified`). `null` cuando no se proporcionó `expected_address`." }, "name_on_document": { "type": "string", "nullable": true, "description": "Nombre del titular principal extraído del documento; se compara con `expected_first_name`/`expected_last_name` cuando se proporcionan. Un valor `null` provoca el rechazo con `POA_NAME_NOT_DETECTED` en este endpoint.", "example": "OESTE EMBOTELLADORA S.A." }, "extra_fields": { "type": "object", "description": "Datos adicionales propios del documento. Los campos bancarios se rellenan en los extractos bancarios cuando aparecen impresos en el documento; en caso contrario, `null`.", "properties": { "bank_account_number": { "type": "string", "nullable": true }, "bank_iban": { "type": "string", "nullable": true }, "bank_sort_code": { "type": "string", "nullable": true }, "bank_routing_number": { "type": "string", "nullable": true }, "bank_swift_bic": { "type": "string", "nullable": true }, "bank_branch_name": { "type": "string", "nullable": true }, "bank_branch_address": { "type": "string", "nullable": true }, "document_phone_number": { "type": "string", "nullable": true, "description": "Número de teléfono de contacto impreso en el documento." }, "additional_names": { "type": "array", "items": { "type": "string" }, "description": "Otros nombres de titulares que aparecen en el documento (p. ej., cotitulares de la cuenta, nombres anteriores de la cuenta)." } } }, "warnings": { "type": "array", "description": "Vacío en una aprobación sin incidencias. Cada entrada explica un riesgo detectado; las entradas con `log_type: \"error\"` establecen `status` en `Declined`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "description": "Código de riesgo legible por máquina. Siempre rechazan: `MISSING_ADDRESS_INFORMATION`, `POA_DOCUMENT_EXPIRED`, `INVALID_DOCUMENT_TYPE`, `UNABLE_TO_VALIDATE_DOCUMENT_AGE`, además de `UNABLE_TO_EXTRACT_ISSUE_DATE` y `POA_NAME_NOT_DETECTED` (fijados en rechazo en este endpoint). Controlados por opciones de la solicitud: `NAME_MISMATCH_WITH_PROVIDED` / `ADDRESS_MISMATCH_WITH_PROVIDED` / `POA_COUNTRY_MISMATCH_WITH_PROVIDED` (`poa_address_mismatch_action`), `POOR_DOCUMENT_QUALITY` (este endpoint nunca lo genera) / `DOCUMENT_METADATA_MISMATCH` (`poa_document_issues_action`), `SUSPECTED_DOCUMENT_MANIPULATION` (`poa_document_authenticity_action`), `UNSUPPORTED_DOCUMENT_LANGUAGE` (`poa_unsupported_language_action`), `ISSUER_NOT_IDENTIFIED` (`poa_issuer_not_identified_action`). Informativos en este endpoint: `POA_DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION`, `UNPARSABLE_OR_INVALID_ADDRESS`.", "example": "POA_DOCUMENT_EXPIRED" }, "feature": { "type": "string", "enum": [ "PROOF_OF_ADDRESS" ], "description": "Función que emitió la advertencia. En este endpoint siempre es `PROOF_OF_ADDRESS`." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Contexto adicional para algunos riesgos: p. ej., `POA_DOCUMENT_EXPIRED` incluye `expiration_reason` (`printed_expiration` o `age_window`), `document_type`, `document_subtype` e `issue_date`, además de `expiration_date` en la ruta `printed_expiration` o `max_age_months` en la ruta `age_window`; `SUSPECTED_DOCUMENT_MANIPULATION` incluye `reason` y `detection_method`. `null` para la mayoría de los riesgos." }, "log_type": { "type": "string", "enum": [ "error", "information" ], "description": "Gravedad. Las advertencias `error` llevan `status` a `Declined`; las entradas `information` son orientativas y nunca rechazan por sí solas. (Este endpoint no produce `warning`: sus opciones solo aceptan `DECLINE` o `NO_ACTION`.)" }, "short_description": { "type": "string", "description": "Resumen legible del riesgo en una línea." }, "long_description": { "type": "string", "description": "Explicación legible del riesgo." } } } }, "detected_codes": { "type": "array", "description": "Códigos QR y códigos de barras detectados en todas las páginas procesadas del documento. Vacío cuando no se encuentra ninguno. Un código QR localizado pero que no se puede decodificar tiene `parsed_payload: null`.", "items": { "$ref": "#/components/schemas/DocumentAIDetectedCode" } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste, o `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Devuelve el objeto `metadata` que enviaste, o `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de tiempo ISO 8601 (UTC) del momento en que se generó la respuesta." } } } } } }, "400": { "description": "Error de validación o de procesamiento. Los problemas a nivel de campo devuelven el formato estándar de DRF (un array de mensajes por cada campo afectado). Los problemas con PDF cifrados devuelven `{\"detail\": ...}`. Un documento que el proceso de extracción no puede procesar devuelve `{\"error\": [\"Error extracting POA information\"]}`.", "content": { "application/json": { "examples": { "Missing document": { "summary": "`document` no se incluyó en los datos del formulario", "value": { "document": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Extensión de archivo distinta de tiff/jpg/jpeg/png/pdf/webp", "value": { "document": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, pdf, webp." ] } }, "File too large": { "summary": "El archivo supera el límite de 15 MB", "value": { "document": [ "File size should not exceed 15 MB" ] } }, "Encrypted PDF": { "summary": "PDF subido sin la contraseña requerida", "value": { "detail": "The PDF is encrypted. Please upload a decrypted PDF or a photo instead." } }, "Wrong PDF password": { "summary": "`document_password` no descifra el PDF", "value": { "detail": "The PDF password is incorrect. Please provide the correct password." } }, "Invalid language code": { "summary": "`poa_languages_allowed` contiene un código no admitido", "value": { "poa_languages_allowed": [ "Invalid language code: 'xx'. Must be one of the supported languages: ['ar', 'bn', 'hy', 'bg', 'bs', 'ca', 'cnr', 'sq', 'zh', 'hr', 'cs', 'da', 'nl', 'en', 'et', 'fi', 'fr', 'ka', 'kk', 'de', 'el', 'he', 'hi', 'hu', 'id', 'it', 'ja', 'ko', 'ky', 'lv', 'lt', 'mk', 'mn', 'ms', 'no', 'fa', 'pl', 'pt', 'ro', 'ru', 'sr', 'sk', 'sl', 'so', 'es', 'sv', 'th', 'tr', 'uk', 'uz', 'vi']." ] } }, "Invalid document age value": { "summary": "Valor de `poa_document_age_months` fuera del rango 1–120 / -1", "value": { "poa_document_age_months": [ "Invalid integer value for 'utility_bill': '999'. Must be -1 (unlimited) or a positive integer between 1 and 120." ] } }, "Extraction failure": { "summary": "El pipeline de extracción no pudo procesar el documento", "value": { "error": [ "Error extracting POA information" ] } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key` y también cuando el saldo de la organización que realiza la llamada no la cubre; una clave incorrecta, revocada o expirada devuelve `401`. Si falta la clave, se devuelve `403` con `{\"detail\": ...}`; una clave incorrecta, revocada o expirada devuelve `401`. La falta de créditos devuelve `403` con `{\"error\": ...}` antes de que se procese ningún documento.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de la organización no cubre la llamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/poa/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'document=@./utility-bill.pdf' \\\n -F 'expected_address=Av. Monseñor Tavella 1291, Salta, Argentina' \\\n -F 'expected_country=ARG' \\\n -F 'expected_first_name=Sophia' \\\n -F 'expected_last_name=Martinez' \\\n -F 'poa_languages_allowed=en,es' \\\n -F 'vendor_data=user-123' \\\n --max-time 45" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.proof_of_address.verify(\n document=open(\"document.pdf\", \"rb\"),\n expected_address=\"Av. Monseñor Tavella 1291, Salta, Argentina\",\n expected_country=\"ARG\",\n expected_first_name=\"Sophia\",\n expected_last_name=\"Martinez\",\n poa_languages_allowed=\"en,es\",\n save_api_request=True,\n vendor_data=\"user-123\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.proofOfAddress.verify({\n document: await fileFromPath(\"document.pdf\"),\n expected_address: \"Av. Monseñor Tavella 1291, Salta, Argentina\",\n expected_country: \"ARG\",\n expected_first_name: \"Sophia\",\n expected_last_name: \"Martinez\",\n poa_languages_allowed: \"en,es\",\n save_api_request: true,\n vendor_data: \"user-123\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.ProofOfAddress.Verify(ctx, didit.ProofOfAddressVerifyParams{\n\tDocument: didit.FileFromPath(\"document.pdf\"),\n\tExpectedAddress: didit.String(\"Av. Monseñor Tavella 1291, Salta, Argentina\"),\n\tExpectedCountry: didit.String(\"ARG\"),\n\tExpectedFirstName: didit.String(\"Sophia\"),\n\tExpectedLastName: didit.String(\"Martinez\"),\n\tPOALanguagesAllowed: didit.String(\"en,es\"),\n\tSaveAPIRequest: didit.Bool(true),\n\tVendorData: didit.String(\"user-123\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.ProofOfAddressVerifyParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.proofOfAddress().verify(ProofOfAddressVerifyParams.builder()\n .document(Path.of(\"document.pdf\"))\n .expectedAddress(\"Av. Monseñor Tavella 1291, Salta, Argentina\")\n .expectedCountry(\"ARG\")\n .expectedFirstName(\"Sophia\")\n .expectedLastName(\"Martinez\")\n .poaLanguagesAllowed(\"en,es\")\n .saveApiRequest(true)\n .vendorData(\"user-123\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "proofOfAddress->verify([\n 'document' => File::fromPath('document.pdf'),\n 'expected_address' => 'Av. Monseñor Tavella 1291, Salta, Argentina',\n 'expected_country' => 'ARG',\n 'expected_first_name' => 'Sophia',\n 'expected_last_name' => 'Martinez',\n 'poa_languages_allowed' => 'en,es',\n 'save_api_request' => true,\n 'vendor_data' => 'user-123',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.proof_of_address.verify(\n document: Pathname(\"document.pdf\"),\n expected_address: \"Av. Monseñor Tavella 1291, Salta, Argentina\",\n expected_country: \"ARG\",\n expected_first_name: \"Sophia\",\n expected_last_name: \"Martinez\",\n poa_languages_allowed: \"en,es\",\n save_api_request: true,\n vendor_data: \"user-123\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.ProofOfAddress.VerifyAsync(new ProofOfAddressVerifyParams\n{\n Document = FileUpload.FromPath(\"document.pdf\"),\n ExpectedAddress = \"Av. Monseñor Tavella 1291, Salta, Argentina\",\n ExpectedCountry = \"ARG\",\n ExpectedFirstName = \"Sophia\",\n ExpectedLastName = \"Martinez\",\n PoaLanguagesAllowed = \"en,es\",\n SaveApiRequest = true,\n VendorData = \"user-123\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/document-ai/": { "post": { "summary": "Document AI (extracción de campos personalizados + comprobaciones de manipulación)", "description": "Extrae los campos que **tú** defines de cualquier documento de respaldo (nóminas, pruebas de fondos, cartas de origen del patrimonio, declaraciones fiscales, contratos, facturas) en una sola llamada. Envía el archivo junto con una definición de `fields` (clave, nombre, instrucción de extracción, tipo) y recibe valores tipados (`text`, `number`, `date` como `YYYY-MM-DD`), una puntuación de coincidencia de nombre opcional frente a la persona o empresa esperada, señales de manipulación de PDF/EXIF, un `status` `Approved`/`Declined`/`In Review` y una lista de `warnings` que explica cada problema detectado. Es el equivalente de servidor a servidor del paso de Document AI del flujo de verificación alojado (consulta `/core-technology/document-ai/overview`); usa el modelo de extracción predeterminado de Didit y no permite elegir el proveedor.\n\n**Latencia.** La extracción se basa en un LLM: las llamadas típicas tardan **5–15 segundos** y los PDF de varias páginas, hasta **~30 segundos**. Configura un tiempo de espera del cliente de **al menos 45 segundos** y no reintentes antes de que la llamada termine.\n\n**Formato de la solicitud.** Solo `multipart/form-data`. `fields` es **una única cadena con un array codificado en JSON** (1–30 elementos, 16 KB como máximo); los arrays de formulario con corchetes se rechazan con `400`. Cada elemento es `{key, name, instruction, type, required, is_full_name}`: `key` es la clave JSON que recibes (`^[a-z0-9_]{1,64}$`, única), `instruction` indica al modelo qué debe leer, `type` es `text` (predeterminado) | `number` | `date`, `required` genera `DOCUMENT_AI_MISSING_REQUIRED_FIELDS` cuando no se puede leer el valor, y como máximo un campo puede establecer `is_full_name: true` para marcar el valor que se compara con el nombre esperado.\n\n**Coincidencia de nombre.** Envía `expected_first_name` + `expected_last_name` (persona) **o** `expected_company_name` (+ `expected_company_country` opcional), pero no ambos. El valor del campo `is_full_name` (o, si no hay ninguno marcado, el del primer campo de texto cuya clave parezca un nombre) se compara de forma aproximada; `name_match_score` (0–100) y `name_on_document` se devuelven siempre que existen ambos lados, y una puntuación inferior a `document_ai_name_match_score_threshold` (80 por defecto) añade `DOCUMENT_AI_NAME_MISMATCH`, que se rige por `document_ai_name_mismatch_action`.\n\n**Lógica de decisión.** Cada riesgo se asocia a una acción configurable: `DECLINE` → `status: \"Declined\"`, `REVIEW` → `status: \"In Review\"`, `NO_ACTION` → solo informativo. Los valores predeterminados son los mismos que en el paso del flujo: documento ilegible `REVIEW`, campos obligatorios ausentes `REVIEW`, sospecha de manipulación `DECLINE`, discrepancia de nombre `NO_ACTION`, archivo no admitido `REVIEW`. Un documento que no se puede procesar en absoluto devuelve `400`; un documento legible pero problemático devuelve `200` con `Declined`/`In Review`. Revisa siempre `document_ai.status` y `document_ai.warnings`, no solo el código HTTP.\n\n**Facturación.** Cada respuesta `200` consume un crédito de API de Document AI (**$0.20 por documento** según la tarifa de lista), que se paga con el crédito de tu plan o con tu saldo recargado. Cuando el saldo de la organización no cubre la llamada, el endpoint devuelve `403` antes de cualquier procesamiento. Las claves de API de sandbox devuelven una respuesta simulada determinista y no generan cargos.\n\n**Persistencia.** Con `save_api_request=true` (predeterminado), la llamada se guarda como una sesión de tipo API: se conservan el documento, los valores extraídos, las definiciones de campos y la instantánea de la coincidencia de nombre, la sesión aparece en la Business Console y `request_id` funciona con `GET /v3/session/{sessionId}/decision/`.", "operationId": "post_v3document-ai", "x-didit-sdk": { "resource": "document_ai", "method": "analyze", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "document", "fields" ], "properties": { "document": { "type": "string", "format": "binary", "description": "El documento que se va a leer. Extensiones permitidas: `tiff`, `jpg`, `jpeg`, `png`, `pdf`, `webp`, `zip`. Tamaño máximo de carga: **30 MB** (los archivos más grandes se rechazan con `400`). Se admiten PDF de varias páginas (con una latencia mayor); los PDF cifrados se rechazan con `400`. Las imágenes se comprimen automáticamente antes del procesamiento." }, "fields": { "type": "string", "description": "Una cadena con un array codificado en JSON con **1–30** definiciones de campos (máximo 16 KB). Cada elemento: `key` (obligatorio, `^[a-z0-9_]{1,64}$`, único: la clave que se devuelve en `extracted_data`), `name` (≤100 caracteres, se muestra en los mensajes), `instruction` (≤500 caracteres, lo que el modelo debe leer), `type` (`text` por defecto | `number` | `date`), `required` (booleano, por defecto `false`), `is_full_name` (booleano, por defecto `false`, como máximo uno por solicitud). Los arrays de formulario con corchetes, el JSON no válido, las claves duplicadas o más de un `is_full_name` devuelven `400` antes de cualquier procesamiento o facturación.", "example": "[{\"key\": \"employer_name\", \"name\": \"Employer name\", \"instruction\": \"The employer or company issuing the payslip.\", \"type\": \"text\", \"required\": true, \"is_full_name\": false}, {\"key\": \"employee_name\", \"name\": \"Employee name\", \"instruction\": \"The full name of the employee as printed on the payslip.\", \"type\": \"text\", \"required\": true, \"is_full_name\": true}, {\"key\": \"net_pay\", \"name\": \"Net pay\", \"instruction\": \"The net amount paid to the employee for the period.\", \"type\": \"number\", \"required\": true, \"is_full_name\": false}, {\"key\": \"pay_date\", \"name\": \"Pay date\", \"instruction\": \"The payment date shown on the payslip.\", \"type\": \"date\", \"required\": false, \"is_full_name\": false}]" }, "expected_first_name": { "type": "string", "description": "Nombre que se verifica contra el campo de nombre del documento (coincidencia aproximada, con soporte de transliteración). Úsalo junto con `expected_last_name`; no se puede combinar con `expected_company_name`.", "example": "Sophia" }, "expected_last_name": { "type": "string", "description": "Apellido que se verifica contra el campo de nombre del documento, combinado con `expected_first_name` para `name_match_score`.", "example": "Martinez" }, "expected_company_name": { "type": "string", "description": "Nombre de la empresa que se comparará con el campo de nombre del documento (para documentos de empresa). No se puede combinar con `expected_first_name` / `expected_last_name` (no tiene valor de ejemplo a propósito: el ejemplo de solicitud generado usa los campos de persona; sustitúyelos por este al verificar un documento de empresa)." }, "expected_company_country": { "type": "string", "description": "Código de país ISO 3166-1 alfa-2 opcional (dos letras ASCII, p. ej., `FR`) que ajusta la normalización del nombre de la empresa para `expected_company_name`. Solo se usa con `expected_company_name`." }, "document_ai_name_match_score_threshold": { "type": "integer", "minimum": 0, "maximum": 100, "default": 80, "description": "`name_match_score` mínimo (0–100) para considerar que el nombre coincide. Una puntuación inferior añade `DOCUMENT_AI_NAME_MISMATCH`, que se rige por `document_ai_name_mismatch_action`.", "example": 80 }, "document_ai_unreadable_document_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "REVIEW", "description": "Qué hacer cuando no se pudo leer ningún campo del documento (`DOCUMENT_AI_UNREADABLE_DOCUMENT`)." }, "document_ai_missing_required_fields_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "REVIEW", "description": "Qué hacer cuando no se pudo leer al menos un campo `required` (`DOCUMENT_AI_MISSING_REQUIRED_FIELDS`; `additional_data.missing_fields` los enumera)." }, "document_ai_document_tampering_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "DECLINE", "description": "Qué hacer cuando el análisis forense de PDF/EXIF sospecha una manipulación: modificación posterior a la firma digital, editor de PDF conocido, manipulación con texto superpuesto, reexportación sospechosa o anomalías en la imagen (`DOCUMENT_AI_SUSPECTED_MANIPULATION`)." }, "document_ai_name_mismatch_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "NO_ACTION", "description": "Qué hacer cuando `name_match_score` está por debajo del umbral (`DOCUMENT_AI_NAME_MISMATCH`)." }, "document_ai_unsupported_file_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "REVIEW", "description": "Qué hacer cuando el archivo subido está vacío o no se puede procesar (`DOCUMENT_AI_UNSUPPORTED_FILE`)." }, "save_api_request": { "type": "boolean", "default": true, "description": "Cuando es `true` (valor predeterminado), guarda la llamada como una sesión de tipo API: visible en la Business Console, recuperable mediante `GET /v3/session/{sessionId}/decision/` con el `request_id` devuelto, y con el documento subido, los valores extraídos, las definiciones de campos y la instantánea de la coincidencia de nombre almacenados. Cuando es `false`, no se almacena nada y `request_id` es un UUID temporal que solo sirve para correlacionar la respuesta; la llamada se factura igualmente.", "example": true }, "vendor_data": { "type": "string", "description": "Cadena opaca opcional (tu ID de usuario interno, correo electrónico, UUID…) que se guarda en la sesión persistida y se devuelve en la respuesta. Úsala para relacionar las llamadas a la API con tus propios registros y para filtrar sesiones más adelante.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objeto JSON opcional que se almacena con la sesión (cuando `save_api_request=true`) y se devuelve en la respuesta. En solicitudes multipart, envíalo como un campo de cadena codificado en JSON (p. ej., `metadata={\"flow\":\"onboarding\"}`): se convierte en un objeto.", "example": { "flow": "onboarding" } } } } } } }, "responses": { "200": { "description": "Documento procesado. `document_ai.status` es `Approved`, `Declined` o `In Review`; cada problema detectado se detalla en `document_ai.warnings`. Un documento con problemas también devuelve `200`: revisa el cuerpo, no solo el código HTTP. Cuando `save_api_request=true`, `request_id` es el ID de la sesión guardada.", "content": { "application/json": { "examples": { "Approved": { "summary": "Nómina leída correctamente, nombre coincidente", "value": { "request_id": "9d6a3b1e-2f0c-4a8e-9b7d-1c2e3f4a5b6c", "document_ai": { "status": "Approved", "extracted_data": { "employer_name": "Acme Payments Ltd", "employee_name": "Sophia Martinez", "net_pay": 3120.5, "pay_date": "2026-07-31" }, "detected_codes": [ { "type": "CODE_128", "page_number": 1, "position": [ [ 96, 456 ], [ 96, 616 ], [ 1012, 611 ], [ 1015, 456 ] ], "x": 96, "y": 456, "width": 919, "height": 160, "page_width": 1200, "page_height": 1700, "raw_payload": "SU5WLTIwMjYtMDA0Mg==", "parsed_payload": "INV-2026-0042" } ], "fields": [ { "key": "employer_name", "name": "Employer name", "instruction": "The employer or company issuing the payslip.", "type": "text", "required": true, "is_full_name": false }, { "key": "employee_name", "name": "Employee name", "instruction": "The full name of the employee as printed on the payslip.", "type": "text", "required": true, "is_full_name": true }, { "key": "net_pay", "name": "Net pay", "instruction": "The net amount paid to the employee for the period.", "type": "number", "required": true, "is_full_name": false }, { "key": "pay_date", "name": "Pay date", "instruction": "The payment date shown on the payslip.", "type": "date", "required": false, "is_full_name": false } ], "name_match_score": 100.0, "name_on_document": "Sophia Martinez", "warnings": [] }, "vendor_data": "user-123", "metadata": { "flow": "onboarding" }, "created_at": "2026-08-19T16:40:12.318Z" } }, "In Review — missing required field": { "summary": "No se pudo leer `net_pay`; acción predeterminada: REVIEW", "value": { "request_id": "3f2a9c7b-5d4e-4b1a-8c6f-0e9d8c7b6a5f", "document_ai": { "status": "In Review", "extracted_data": { "employer_name": "Acme Payments Ltd", "employee_name": "Sophia Martinez", "net_pay": null, "pay_date": "2026-07-31" }, "detected_codes": [], "fields": [ { "key": "employer_name", "name": "Employer name", "instruction": "The employer or company issuing the payslip.", "type": "text", "required": true, "is_full_name": false }, { "key": "employee_name", "name": "Employee name", "instruction": "The full name of the employee as printed on the payslip.", "type": "text", "required": true, "is_full_name": true }, { "key": "net_pay", "name": "Net pay", "instruction": "The net amount paid to the employee for the period.", "type": "number", "required": true, "is_full_name": false }, { "key": "pay_date", "name": "Pay date", "instruction": "The payment date shown on the payslip.", "type": "date", "required": false, "is_full_name": false } ], "name_match_score": 100.0, "name_on_document": "Sophia Martinez", "warnings": [ { "risk": "DOCUMENT_AI_MISSING_REQUIRED_FIELDS", "feature": "DOCUMENT_AI", "additional_data": { "missing_fields": [ "Net pay" ] }, "log_type": "warning", "short_description": "Required fields could not be extracted", "long_description": "One or more fields configured as required could not be extracted from the uploaded document." } ] }, "vendor_data": null, "metadata": null, "created_at": "2026-08-19T16:41:05.002Z" } }, "Declined — suspected manipulation": { "summary": "El análisis forense del PDF detectó un editor conocido; acción predeterminada DECLINE", "value": { "request_id": "7c1d2e3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "document_ai": { "status": "Declined", "extracted_data": { "employer_name": "Acme Payments Ltd", "employee_name": "Sophia Martinez", "net_pay": 3120.5, "pay_date": "2026-07-31" }, "detected_codes": [], "fields": [ { "key": "employer_name", "name": "Employer name", "instruction": "The employer or company issuing the payslip.", "type": "text", "required": true, "is_full_name": false }, { "key": "employee_name", "name": "Employee name", "instruction": "The full name of the employee as printed on the payslip.", "type": "text", "required": true, "is_full_name": true }, { "key": "net_pay", "name": "Net pay", "instruction": "The net amount paid to the employee for the period.", "type": "number", "required": true, "is_full_name": false }, { "key": "pay_date", "name": "Pay date", "instruction": "The payment date shown on the payslip.", "type": "date", "required": false, "is_full_name": false } ], "name_match_score": null, "name_on_document": "Sophia Martinez", "warnings": [ { "risk": "DOCUMENT_AI_SUSPECTED_MANIPULATION", "feature": "DOCUMENT_AI", "additional_data": { "detection_method": "known_editor", "processed_by_known_editor": "ilovepdf" }, "log_type": "error", "short_description": "Suspected document manipulation", "long_description": "The system detected signs of potential manipulation or editing in the uploaded document." } ] }, "vendor_data": null, "metadata": null, "created_at": "2026-08-19T16:42:40.771Z" } } }, "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sesión guardada cuando `save_api_request=true` (se puede usar con `GET /v3/session/{sessionId}/decision/`); en caso contrario, un UUID de correlación temporal." }, "document_ai": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "`Approved` cuando ninguna advertencia se resuelve en un rechazo o una revisión; `Declined` cuando al menos un riesgo se asigna a `DECLINE`; en caso contrario, `In Review` cuando al menos uno se asigna a `REVIEW`. La lista `warnings` explica el motivo." }, "extracted_data": { "type": "object", "additionalProperties": true, "description": "Una entrada por cada clave de campo solicitada. Los valores tienen el tipo que indica el `type` del campo: cadenas para `text`, números para `number`, cadenas `YYYY-MM-DD` para `date`, o `null` cuando no se pudo leer el valor.", "example": { "employer_name": "Acme Payments Ltd", "employee_name": "Sophia Martinez", "net_pay": 3120.5, "pay_date": "2026-07-31" } }, "detected_codes": { "type": "array", "description": "Códigos QR y códigos de barras detectados en todas las páginas procesadas. Vacío cuando no se encuentra ninguno. Un código QR localizado pero que no se puede decodificar tiene `parsed_payload: null`.", "items": { "$ref": "#/components/schemas/DocumentAIDetectedCode" } }, "fields": { "type": "array", "description": "Las definiciones de campo normalizadas que se usaron para esta extracción, devueltas tal cual (también se guardan con la sesión cuando `save_api_request=true`).", "items": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "instruction": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "number", "date" ] }, "required": { "type": "boolean" }, "is_full_name": { "type": "boolean" } } } }, "name_match_score": { "type": "number", "nullable": true, "minimum": 0, "maximum": 100, "description": "Similitud difusa (0–100) entre `name_on_document` y el nombre esperado de la persona o empresa. Se devuelve siempre que existan tanto un valor de nombre como un nombre esperado, en coincidencias **y** en discrepancias; `null` en caso contrario.", "example": 96.0 }, "name_on_document": { "type": "string", "nullable": true, "description": "El valor de nombre extraído del documento (el campo `is_full_name`, o el primer campo de texto con aspecto de nombre) que se comparó con el nombre esperado. `null` cuando no había ningún valor de nombre disponible.", "example": "Sophia Martinez" }, "warnings": { "type": "array", "description": "Vacío en una aprobación sin incidencias. Cada entrada explica un riesgo detectado; las entradas con `log_type: \"error\"` establecen `status` en `Declined`, y las entradas con `log_type: \"warning\"` lo establecen en `In Review`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "DOCUMENT_AI_UNREADABLE_DOCUMENT", "DOCUMENT_AI_MISSING_REQUIRED_FIELDS", "DOCUMENT_AI_SUSPECTED_MANIPULATION", "DOCUMENT_AI_NAME_MISMATCH", "DOCUMENT_AI_UNSUPPORTED_FILE" ], "description": "Código de riesgo legible por máquina. Cada uno se controla con la opción de solicitud `document_ai_*_action` correspondiente.", "example": "DOCUMENT_AI_MISSING_REQUIRED_FIELDS" }, "feature": { "type": "string", "enum": [ "DOCUMENT_AI" ], "description": "Función que emitió la advertencia. En este endpoint siempre es `DOCUMENT_AI`." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Contexto adicional del riesgo: `{\"missing_fields\": [\"Net pay\"]}` para campos obligatorios ausentes, `{\"name_on_document\", \"score\", \"threshold\"}` para una discrepancia de nombre, y el hallazgo forense (`detection_method`, datos del productor o editor) para una sospecha de manipulación. `null` cuando no hay nada que añadir.", "example": { "missing_fields": [ "Net pay" ] } }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravedad derivada de la acción configurada: `error` (DECLINE), `warning` (REVIEW), `information` (NO_ACTION)." }, "short_description": { "type": "string", "description": "Descripción legible del riesgo en una línea.", "example": "Required fields could not be extracted" }, "long_description": { "type": "string", "description": "Explicación legible, completada con `additional_data` cuando corresponde." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste, o `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Devuelve el objeto `metadata` que enviaste, o `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Fecha y hora en que se procesó la solicitud (UTC, ISO 8601)." } } } } } }, "400": { "description": "Error de validación o de procesamiento. Los problemas a nivel de campo devuelven el formato estándar de DRF (un array de mensajes por cada campo afectado). Los documentos cifrados o ilegibles y los fallos de extracción devuelven `{\"error\": ...}`.", "content": { "application/json": { "examples": { "Missing document": { "summary": "`document` no se incluyó en los datos del formulario", "value": { "document": [ "No file was submitted." ] } }, "Invalid fields payload": { "summary": "`fields` no es una única cadena de array codificada en JSON", "value": { "fields": [ "fields must be a valid JSON array string." ] } }, "Duplicate field keys": { "summary": "Dos elementos comparten la misma `key`", "value": { "fields": [ "Every fields item must have a unique key." ] } }, "Conflicting expectations": { "summary": "Datos esperados de la persona y de la empresa enviados juntos", "value": { "non_field_errors": [ "Provide either person expected-name fields or expected_company_name, not both." ] } }, "Invalid metadata": { "summary": "`metadata` no es un objeto JSON (o contiene un carácter NUL)", "value": { "metadata": [ "Metadata must be a JSON object." ] } }, "Oversized vendor_data": { "summary": "`vendor_data` supera el límite de 2000 bytes", "value": { "vendor_data": [ "vendor_data is too long (maximum 2000 bytes)." ] } }, "Encrypted PDF": { "summary": "PDF protegido con contraseña", "value": { "error": "The PDF is encrypted. Please upload a decrypted PDF or a photo instead." } }, "Extraction failed": { "summary": "El proceso de extracción no pudo procesar el documento", "value": { "error": [ "Error extracting Document AI information" ] } } }, "schema": { "type": "object", "additionalProperties": true } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key` y también cuando el saldo de la organización que realiza la llamada no la cubre; una clave incorrecta, revocada o expirada devuelve `401`. Si falta la clave, se devuelve `403` con `{\"detail\": ...}`; una clave incorrecta, revocada o expirada devuelve `401`. La falta de créditos (y las organizaciones con facturación por contrato cuya tabla de tarifas no incluye una entrada para la API de Document AI) devuelve `403` con `{\"error\": ...}` antes de que se procese ningún documento.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de la organización no cubre la llamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } }, "Contract rate missing": { "summary": "Organización con facturación por contrato cuya tabla de tarifas no tiene una entrada para la API de Document AI", "value": { "error": "Document AI API is not included in your contract rate card. Contact support@didit.me to enable it." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "error": { "type": "string" } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.document_ai.analyze(\n document=open(\"document.pdf\", \"rb\"),\n fields=\"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.documentAi.analyze({\n document: await fileFromPath(\"document.pdf\"),\n fields: \"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.DocumentAi.Analyze(ctx, didit.DocumentAiAnalyzeParams{\n\tDocument: didit.FileFromPath(\"document.pdf\"),\n\tFields: \"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.DocumentAiAnalyzeParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.documentAi().analyze(DocumentAiAnalyzeParams.builder()\n .document(Path.of(\"document.pdf\"))\n .fields(\"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "documentAi->analyze([\n 'document' => File::fromPath('document.pdf'),\n 'fields' => '[{\"key\": \"employer_name\", \"name\": \"Employer name\", \"instruction\": \"The employer or company issuing the payslip.\", \"type\": \"text\", \"required\": true, \"is_full_name\": false}, {\"key\": \"employee_name\", \"name\": \"Employee name\", \"instruction\": \"The full name of the employee as printed on the payslip.\", \"type\": \"text\", \"required\": true, \"is_full_name\": true}, {\"key\": \"net_pay\", \"name\": \"Net pay\", \"instruction\": \"The net amount paid to the employee for the period.\", \"type\": \"number\", \"required\": true, \"is_full_name\": false}, {\"key\": \"pay_date\", \"name\": \"Pay date\", \"instruction\": \"The payment date shown on the payslip.\", \"type\": \"date\", \"required\": false, \"is_full_name\": false}]',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.document_ai.analyze(\n document: Pathname(\"document.pdf\"),\n fields: \"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.DocumentAi.AnalyzeAsync(new DocumentAiAnalyzeParams\n{\n Document = FileUpload.FromPath(\"document.pdf\"),\n Fields = \"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/aml/": { "post": { "summary": "Análisis AML (independiente)", "operationId": "post_v3aml", "x-didit-sdk": { "resource": "aml", "method": "screen", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Clave opcional para reintentar de forma segura, de hasta 255 caracteres. Si reutilizas la misma clave con el mismo cuerpo de solicitud, se devuelve la respuesta original sin ejecutar ni facturar un segundo análisis. Si reutilizas la clave con un cuerpo distinto, se devuelve `409`.", "schema": { "type": "string", "maxLength": 255 } } ], "description": "Analiza a una persona o empresa frente a bases de datos de PEP, sanciones, advertencias/listas de vigilancia y medios adversos en una sola llamada.\n\n**Modelo de dos puntuaciones.** Cada coincidencia incluye un `match_score` (0–100, confianza en la identidad) y un `risk_score` (0–100, riesgo de la entidad). Las coincidencias cuyo `match_score` es inferior a `aml_match_score_threshold` (por defecto **93**) se etiquetan con `review_status: \"False Positive\"` y no se tienen en cuenta para el riesgo. El `risk_score` más alto entre las coincidencias restantes pasa a ser `aml.score`. El `aml.status` final depende de tus umbrales: `score` > `aml_score_review_threshold` (por defecto **100**) → `Declined`; `score` > `aml_score_approve_threshold` (por defecto **80**) → `In Review`; en caso contrario, `Approved`. Siempre que `score` no sea cero y sea ≥ el umbral de aprobación, se añade una advertencia `POSSIBLE_MATCH_FOUND` (una puntuación de exactamente 0 nunca genera advertencia).\n\n**Pesos de la puntuación de coincidencia.** `aml_name_weight` + `aml_dob_weight` + `aml_country_weight` deben sumar exactamente 100 (por defecto 60/25/15). Los componentes que faltan en la solicitud se excluyen y los pesos restantes se renormalizan. Un `document_number` coincidente actúa como clave maestra y fija `match_score` en 100.\n\n**Latencia.** Los análisis simples suelen completarse en pocos segundos. Con `include_adverse_media=true`, la API espera el enriquecimiento de medios adversos (una pausa inicial de ~5 s más hasta ~25 s de sondeo), así que configura un tiempo de espera del cliente de **al menos 60 segundos**.\n\n**Persistencia.** `save_api_request` es **true** por defecto: el análisis se guarda como una sesión (`request_id` funciona con `GET /v3/session/{sessionId}/decision/`), aparece en la consola, se dispara un webhook `status.updated` y los estados de revisión de las coincidencias pueden actualizarse más adelante. Con `save_api_request=false` no se guarda nada y `request_id` es un id de correlación temporal. `include_ongoing_monitoring=true` vuelve a analizar el perfil de forma continua y requiere `save_api_request=true` (si no, la API devuelve un `400`).\n\n**Idempotencia.** Envía un encabezado `Idempotency-Key` al reintentar tras un tiempo de espera agotado o un error transitorio. La clave se aplica a tu aplicación y al cuerpo exacto de la solicitud. La primera solicitud completada almacena su respuesta, y los reintentos idénticos posteriores devuelven esa misma respuesta sin ejecutar ni facturar otro análisis AML. Si la solicitud original sigue en curso, vuelve a intentarlo más tarde con la misma clave. Si se reutiliza la misma clave con un cuerpo diferente, la API devuelve `409`.\n\n**Facturación.** Se cobra un crédito de API de AML tras el primer análisis correcto. Las respuestas idempotentes repetidas no se vuelven a cobrar. Si el saldo es insuficiente, la API devuelve `403` antes de realizar ningún análisis nuevo.\n\n**Sandbox.** Las claves de aplicaciones de sandbox omiten por completo el análisis y la facturación y devuelven un resultado simulado: `Approved` sin coincidencias, salvo que envíes `sandbox_scenario`. `save_api_request` funciona igual que con las claves de producción, así que puedes recuperar un análisis de sandbox guardado mediante `GET /v3/session/{sessionId}/decision/` y `GET /v3/session/{sessionId}/generate-pdf/`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "full_name" ], "properties": { "full_name": { "type": "string", "minLength": 2, "description": "Nombre completo de la persona o empresa que se va a analizar. Mínimo **2 caracteres**, el mínimo que exige el propio proveedor de análisis. Un nombre más corto o vacío devuelve `400` en este campo antes de que se ejecute ningún análisis, por lo que no se factura nada.", "example": "Antonio Ejemplo Modelo" }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "default": "person", "description": "Tipo de entidad que se va a analizar. El valor predeterminado es `person`." }, "date_of_birth": { "type": "string", "format": "date", "description": "Fecha de nacimiento (personas) o fecha de constitución (empresas), `YYYY-MM-DD`. Mejora la precisión de la coincidencia mediante el peso de la fecha de nacimiento.", "example": "1972-02-29" }, "nationality": { "type": "string", "description": "Código de país ISO 3166-1 **alfa-2** (p. ej. `ES`). Los códigos no válidos devuelven `400`. Mejora la precisión de la coincidencia mediante el peso del país.", "example": "ES" }, "document_number": { "type": "string", "description": "Número del documento de identidad. No tiene ponderación; actúa como clave maestra: una coincidencia exacta eleva a 100 el `match_score` del resultado y una discrepancia clara lo penaliza. Se envía al proveedor de análisis como filtro de búsqueda solo cuando tiene **entre 2 y 50 caracteres**; un valor fuera de ese rango se acepta y se almacena, y el análisis se ejecuta y se factura igualmente, solo que sin acotarlo por número de documento." }, "aml_score_approve_threshold": { "type": "number", "minimum": 0, "maximum": 100, "default": 80, "description": "Umbral de puntuación de riesgo igual o por debajo del cual el resultado es `Approved`. Debe ser ≤ `aml_score_review_threshold` (de lo contrario, `400`)." }, "aml_score_review_threshold": { "type": "number", "minimum": 0, "maximum": 100, "default": 100, "description": "Umbral de puntuación de riesgo por encima del cual el resultado es `Declined`. Las puntuaciones entre los dos umbrales dan como resultado `In Review`." }, "aml_name_weight": { "type": "integer", "minimum": 0, "maximum": 100, "default": 60, "description": "Peso de la similitud del nombre en la puntuación de coincidencia de cada resultado. Los tres pesos deben sumar exactamente 100 (de lo contrario, `400`)." }, "aml_dob_weight": { "type": "integer", "minimum": 0, "maximum": 100, "default": 25, "description": "Peso de la fecha de nacimiento en la puntuación de coincidencia de cada resultado." }, "aml_country_weight": { "type": "integer", "minimum": 0, "maximum": 100, "default": 15, "description": "Peso del país o la nacionalidad en la puntuación de coincidencia de cada resultado." }, "aml_match_score_threshold": { "type": "integer", "minimum": 0, "maximum": 100, "default": 93, "description": "Umbral por coincidencia: las coincidencias con `match_score` inferior a este valor son `False Positive` (se excluyen de la evaluación de riesgo); las que lo igualan o superan son posibles coincidencias `Unreviewed`." }, "include_adverse_media": { "type": "boolean", "default": false, "description": "Busca también cobertura negativa en medios de comunicación. Añade hasta ~30 s de latencia mientras se recopilan los resultados: usa un tiempo de espera del cliente de ≥60 s." }, "include_ongoing_monitoring": { "type": "boolean", "default": false, "description": "Sigue volviendo a analizar este perfil y envía los cambios mediante webhook. Requiere `save_api_request=true` (de lo contrario, `400`)." }, "save_api_request": { "type": "boolean", "default": true, "description": "Guarda el análisis como una sesión (visible en la consola, con endpoint de decisión, webhooks y revisión de coincidencias). Establécelo en `false` para una comprobación sin estado." }, "vendor_data": { "type": "string", "description": "Tu identificador del usuario analizado; se devuelve en la respuesta y se almacena con la sesión." }, "metadata": { "type": "object", "nullable": true, "description": "JSON libre que se guarda con la solicitud y se devuelve en la respuesta." }, "sandbox_scenario": { "type": "string", "description": "Slug de escenario exclusivo de sandbox. Solo se acepta cuando la clave de API pertenece a una aplicación en modo sandbox; se rechaza en aplicaciones en producción. Un análisis independiente no tiene una sesión que preparar, así que el slug va en la propia solicitud de análisis: `decline_aml_hit` devuelve una coincidencia con la misma estructura que en producción y cierra el análisis como `Declined`, `review_aml_possible_match` lo cierra como `In Review`, y un escenario que no prepara ningún resultado AML deja el análisis limpio. Consulta el catálogo de escenarios en GET /v1/sandbox/scenarios/ o [Sandbox y datos de prueba](/es/integration/sandbox-testing).", "example": "decline_aml_hit" } } }, "example": { "full_name": "Antonio Ejemplo Modelo", "entity_type": "person", "date_of_birth": "1972-02-29", "nationality": "ES", "include_adverse_media": false, "vendor_data": "user-1234" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/aml/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -H 'Idempotency-Key: aml-user-1234-2026-08-20' \\\n -d '{\n \"full_name\": \"Antonio Ejemplo Modelo\",\n \"entity_type\": \"person\",\n \"date_of_birth\": \"1972-02-29\",\n \"nationality\": \"ES\",\n \"include_adverse_media\": false,\n \"vendor_data\": \"user-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.aml.screen(\n full_name=\"Antonio Ejemplo Modelo\",\n entity_type=\"person\",\n date_of_birth=\"1972-02-29\",\n nationality=\"ES\",\n include_adverse_media=False,\n vendor_data=\"user-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.aml.screen({\n full_name: \"Antonio Ejemplo Modelo\",\n entity_type: \"person\",\n date_of_birth: \"1972-02-29\",\n nationality: \"ES\",\n include_adverse_media: false,\n vendor_data: \"user-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.AML.Screen(ctx, didit.AMLScreenParams{\n\tFullName: \"Antonio Ejemplo Modelo\",\n\tEntityType: didit.Some(didit.AMLScreenParamsEntityType(\"person\")),\n\tDateOfBirth: didit.String(\"1972-02-29\"),\n\tNationality: didit.String(\"ES\"),\n\tIncludeAdverseMedia: didit.Bool(false),\n\tVendorData: didit.String(\"user-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport me.didit.Didit;\nimport me.didit.types.AmlScreenParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.aml().screen(AmlScreenParams.builder()\n .fullName(\"Antonio Ejemplo Modelo\")\n .entityType(AmlScreenParams.EntityType.of(\"person\"))\n .dateOfBirth(LocalDate.parse(\"1972-02-29\"))\n .nationality(\"ES\")\n .includeAdverseMedia(false)\n .vendorData(\"user-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "aml->screen([\n 'full_name' => 'Antonio Ejemplo Modelo',\n 'entity_type' => 'person',\n 'date_of_birth' => '1972-02-29',\n 'nationality' => 'ES',\n 'include_adverse_media' => false,\n 'vendor_data' => 'user-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.aml.screen(\n full_name: \"Antonio Ejemplo Modelo\",\n entity_type: \"person\",\n date_of_birth: \"1972-02-29\",\n nationality: \"ES\",\n include_adverse_media: false,\n vendor_data: \"user-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Aml.ScreenAsync(new AmlScreenParams\n{\n FullName = \"Antonio Ejemplo Modelo\",\n EntityType = new AmlScreenParamsEntityType(\"person\"),\n DateOfBirth = \"1972-02-29\",\n Nationality = \"ES\",\n IncludeAdverseMedia = false,\n VendorData = \"user-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Análisis completado. `aml.status` refleja tus umbrales. Cada coincidencia igual o superior al umbral mínimo interno de inclusión aparece en `aml.hits` con su `match_score` de identidad, su `risk_score` de entidad y un `score_breakdown` que explica la coincidencia.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sesión guardada cuando `save_api_request=true` (se puede usar con `GET /v3/session/{sessionId}/decision/`); en caso contrario, un UUID de correlación temporal." }, "aml": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "`Declined` cuando `score` > `aml_score_review_threshold`; `In Review` cuando `score` > `aml_score_approve_threshold`; `Approved` en caso contrario (también cuando no hay ninguna puntuación disponible)." }, "total_hits": { "type": "integer", "description": "Número de entradas en `hits`." }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Devuelve el tipo de entidad analizada." }, "hits": { "type": "array", "items": { "type": "object", "description": "Una coincidencia del análisis. `match_score` (0–100) mide la confianza en la identidad: las coincidencias por debajo de `aml_match_score_threshold` se etiquetan con `review_status: \"False Positive\"` y se excluyen de la evaluación de riesgo; las que están en ese umbral o por encima son posibles coincidencias `\"Unreviewed\"`. `risk_score` (0–100) mide el nivel de riesgo de la entidad coincidente y determina el `aml.score` de nivel superior.", "properties": { "id": { "type": "string", "nullable": true, "description": "Identificador estable de Didit para la coincidencia: `hit_` seguido de 24 caracteres hexadecimales. La misma entidad coincidente conserva el mismo `id` cuando el sujeto se vuelve a analizar. Pásalo como `hit_id` a los endpoints de revisión de coincidencias AML." }, "url": { "type": "string", "nullable": true, "description": "URL de origen de la entidad coincidente, cuando está disponible." }, "match": { "type": "boolean", "nullable": true, "description": "Indicador heredado de coincidencia exacta. Es preferible usar `match_score` + `review_status`." }, "score": { "type": "number", "nullable": true, "description": "OBSOLETO. Puntuación de coincidencia ponderada en el rango 0–1. Usa `match_score` en su lugar." }, "match_score": { "type": "number", "nullable": true, "description": "Confianza de identidad (0–100). Se compara con `aml_match_score_threshold` para separar los falsos positivos de las posibles coincidencias." }, "risk_score": { "type": "number", "nullable": true, "description": "Puntuación de riesgo de la entidad (0–100). El `risk_score` más alto entre las coincidencias que no son falsos positivos pasa a ser el `aml.score` de nivel superior." }, "target": { "type": "boolean", "nullable": true }, "caption": { "type": "string", "nullable": true, "description": "Nombre visible de la entidad coincidente." }, "datasets": { "type": "array", "nullable": true, "items": { "type": "string", "enum": [ "PEP", "PEP Level 1", "PEP Level 2", "PEP Level 3", "PEP Level 4", "Sanctions", "Adverse Media", "Warnings and Regulatory Enforcement", "Fitness and Probity", "SIP", "SIE", "Insolvency", "Other Lists" ] }, "description": "Categorías de riesgo en las que figura la entidad: `PEP` (con su nivel, de `PEP Level 1` a `PEP Level 4`), `Sanctions`, `Adverse Media`, `Warnings and Regulatory Enforcement`, `Fitness and Probity`, `SIP`, `SIE` o `Insolvency`. `Other Lists` cuando la fuente de la entidad no indica ninguna de estas categorías." }, "features": { "type": "object", "nullable": true }, "properties": { "type": "object", "nullable": true, "description": "Perfil de la entidad: `name`, `alias`, `notes`, `gender`, `birthDate`, `birthPlace`, `nationality`, `position` y otros arrays biográficos (cada uno puede ser nulo)." }, "rca_name": { "type": "string", "nullable": true, "description": "Nombre del allegado cercano relacionado a través del cual coincidió la entidad, cuando la coincidencia es un RCA." }, "pep_matches": { "type": "array", "description": "Entradas de listas PEP que respaldan esta coincidencia.", "items": { "type": "object", "properties": { "list_name": { "type": "string" }, "publisher": { "type": "string" }, "source_url": { "type": "string" }, "description": { "type": "string" }, "matched_name": { "type": "string" }, "pep_position": { "type": "string" }, "date_of_birth": { "type": "string" }, "place_of_birth": { "type": "string" }, "aliases": { "type": "array", "items": { "type": "string" } }, "education": { "type": "array", "items": { "type": "string" } }, "other_sources": { "type": "array", "items": { "type": "string" } } } } }, "sanction_matches": { "type": "array", "items": { "type": "object" }, "description": "Entradas de listas de sanciones que respaldan esta coincidencia (misma estructura de lista de respaldo que `pep_matches`, más campos específicos de sanciones)." }, "warning_matches": { "type": "array", "items": { "type": "object" }, "description": "Entradas de advertencias o listas de vigilancia que respaldan esta coincidencia." }, "adverse_media_matches": { "type": "array", "description": "Artículos de medios adversos. Solo se rellena cuando `include_adverse_media=true`.", "items": { "type": "object", "properties": { "headline": { "type": "string" }, "summary": { "type": "string" }, "sentiment": { "type": "string" }, "sentiment_score": { "type": "number" }, "source_url": { "type": "string" }, "thumbnail": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "author_name": { "type": "string", "nullable": true }, "publication_date": { "type": "string", "nullable": true }, "adverse_keywords": { "type": "array", "items": { "type": "string" } }, "other_sources": { "type": "array", "items": { "type": "string" } } } } }, "adverse_media_details": { "type": "object", "nullable": true, "description": "Sentimiento agregado de medios adversos para la entidad (`sentiment`, `sentiment_score` y el mapa de frecuencias `adverse_keywords`). Solo se rellena cuando `include_adverse_media=true`." }, "first_seen": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo apareció la entidad por primera vez en los conjuntos de datos." }, "last_seen": { "type": "string", "format": "date-time", "nullable": true, "description": "Actualización más reciente del conjunto de datos que incluyó a la entidad." }, "linked_entities": { "type": "array", "description": "Relaciones conocidas de la entidad coincidente (familia, asociados, empresas).", "items": { "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" } }, "relation": { "type": "array", "items": { "type": "string" } }, "status": { "type": "array", "items": { "type": "string" } }, "details": { "type": "array", "items": { "type": "string" } }, "active": { "type": "array", "items": { "type": "string" } } } } }, "risk_view": { "type": "object", "nullable": true, "description": "Desglose del riesgo por dimensión (`crimes`, `countries`, `categories`, `custom_list`), cada una con `score`, `weightage`, `risk_level` y un mapa `risk_scores`." }, "additional_information": { "type": "object", "nullable": true, "description": "Contexto adicional libre, p. ej., un array `flag_summary` que explica por qué se ha marcado la entidad." }, "review_status": { "type": "string", "nullable": true, "enum": [ "False Positive", "Unreviewed", "Confirmed Match", "Inconclusive" ], "description": "`False Positive`: `match_score` inferior a `aml_match_score_threshold`, excluido de la evaluación de riesgo. `Unreviewed`: posible coincidencia pendiente de revisión. `Confirmed Match` / `Inconclusive`: los establece manualmente un revisor (desde la Business Console) en sesiones guardadas; esa función de revisión no forma parte de esta especificación." }, "score_breakdown": { "type": "object", "nullable": true, "description": "Cómo se calculó `match_score`. El nombre, la fecha de nacimiento y el país aportan cada uno `_score` × `_weight_normalized` puntos; los pesos se vuelven a normalizar cuando falta un componente en los datos analizados. El número de documento no se pondera: actúa como una 'llave maestra': `MATCH` fija la puntuación en 100, `NEUTRAL` la deja sin cambios y `HARD_MISMATCH` aplica una penalización.", "properties": { "name_score": { "type": "integer", "nullable": true, "description": "Similitud de nombre sin procesar (0–100)." }, "name_weight": { "type": "integer", "nullable": true, "description": "Peso configurado del nombre (`aml_name_weight`)." }, "name_weight_normalized": { "type": "number", "nullable": true, "description": "Peso del nombre tras la renormalización (0–100)." }, "name_contribution": { "type": "number", "nullable": true, "description": "Puntos que el nombre aportó a `total_score`." }, "dob_score": { "type": "integer", "nullable": true, "description": "Puntuación de la fecha de nacimiento como porcentaje de su peso (−100 a 100)." }, "dob_weight": { "type": "integer", "nullable": true, "description": "Peso configurado de la fecha de nacimiento (`aml_dob_weight`)." }, "dob_weight_normalized": { "type": "number", "nullable": true, "description": "Peso de la fecha de nacimiento tras la renormalización (0–100)." }, "dob_contribution": { "type": "number", "nullable": true, "description": "Puntos que la fecha de nacimiento aportó a `total_score`." }, "country_score": { "type": "integer", "nullable": true, "description": "Puntuación del país como porcentaje de su peso (de −100 a 100)." }, "country_weight": { "type": "integer", "nullable": true, "description": "Peso configurado del país (`aml_country_weight`)." }, "country_weight_normalized": { "type": "number", "nullable": true, "description": "Peso del país tras la renormalización (0–100)." }, "country_contribution": { "type": "number", "nullable": true, "description": "Puntos que el país aportó a `total_score`." }, "document_number_match_type": { "type": "string", "nullable": true, "enum": [ "MATCH", "NEUTRAL", "HARD_MISMATCH" ], "description": "Resultado de clave dorada (golden key) de la comparación del número de documento." }, "document_number_effect": { "type": "string", "nullable": true, "description": "Descripción legible del efecto del número de documento." }, "total_score": { "type": "integer", "nullable": true, "description": "Puntuación de coincidencia ponderada final (0–100); refleja `match_score`." } } } } } }, "score": { "type": "number", "nullable": true, "description": "Puntuación de riesgo AML global (0–100): el `risk_score` más alto entre las coincidencias que no son falsos positivos. Determina `status` mediante los dos umbrales." }, "screened_data": { "type": "object", "description": "Devuelve lo que se analizó: `full_name`, `date_of_birth`, `nationality`, `document_number` (los campos ausentes son `null`).", "properties": { "full_name": { "type": "string" }, "date_of_birth": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "document_number": { "type": "string", "nullable": true } } }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Función que emitió la advertencia." }, "risk": { "type": "string", "description": "Identificador de riesgo legible por máquina." }, "additional_data": { "type": "object", "nullable": true, "description": "Contexto adicional de la advertencia, cuando está disponible." }, "log_type": { "type": "string", "description": "`warning`, `information` o `error`: cómo afectó el riesgo al resultado." }, "short_description": { "type": "string", "description": "Resumen de una línea legible para personas." }, "long_description": { "type": "string", "description": "Explicación completa y legible para personas." } } }, "description": "Contiene una advertencia `POSSIBLE_MATCH_FOUND` siempre que `score` sea distinto de cero y ≥ `aml_score_approve_threshold` (una puntuación de exactamente 0 nunca genera advertencia); en caso contrario, está vacío." } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste." }, "metadata": { "type": "object", "nullable": true, "description": "Devuelve el `metadata` que enviaste." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "No hits (Approved)": { "summary": "Análisis limpio: cero coincidencias", "value": { "request_id": "d27c5509-7a66-45a9-b05e-d69d9f4c336a", "aml": { "status": "Approved", "total_hits": 0, "entity_type": "person", "hits": [], "score": 0, "screened_data": { "full_name": "Maximilian Mustermann-Doe", "date_of_birth": "1992-03-14", "nationality": "DE", "document_number": null }, "warnings": [] }, "vendor_data": "user-1234", "metadata": { "internal_ref": "abc-123" }, "created_at": "2026-06-11T10:21:07.013938+00:00" } }, "PEP hit (Approved — risk below approve threshold)": { "summary": "Una posible coincidencia PEP; la puntuación de riesgo 73 queda por debajo del umbral de aprobación predeterminado de 80", "value": { "request_id": "0b7e7a3e-65a1-4f3d-9c7a-1de2f9a40111", "aml": { "status": "Approved", "total_hits": 1, "entity_type": "person", "hits": [ { "id": "hit_7c1e9a40b2d35f86e0a4c912", "url": "https://news.example.org/articles/sample", "match": false, "score": 0.93, "match_score": 93.0, "risk_score": 73.0, "target": null, "caption": "Antonio Ejemplo Modelo", "datasets": [ "PEP Level 1", "PEP" ], "features": null, "rca_name": "", "first_seen": "2026-01-07T00:00:00", "last_seen": "2026-01-07T00:00:00", "review_status": "Unreviewed", "properties": { "name": [ "Antonio Ejemplo Modelo", "Antonio Ejemplo" ], "alias": [ "Antonio Ejemplo Modelo", "Ejemplo Modelo, Pedro" ], "notes": [ "Prime Minister of Spain" ], "gender": [ "male" ], "birthDate": [ "1972-02-29" ], "birthPlace": [ "Madrid, Spain" ], "nationality": null, "position": null }, "risk_view": { "crimes": { "score": 0.0, "weightage": 20, "risk_level": "Low", "risk_scores": {} }, "countries": { "score": 9.64, "weightage": 30, "risk_level": "Low", "risk_scores": { "Spain": 25.71 } }, "categories": { "score": 62.5, "weightage": 50, "risk_level": "High", "risk_scores": { "PEP": 100.0, "PEP Level 1": 100.0 } }, "custom_list": {} }, "score_breakdown": { "name_score": 89, "name_weight": 60, "name_weight_normalized": 60.0, "name_contribution": 53.4, "dob_score": 100, "dob_weight": 25, "dob_weight_normalized": 25.0, "dob_contribution": 25.0, "country_score": 100, "country_weight": 15, "country_weight_normalized": 15.0, "country_contribution": 15.0, "document_number_match_type": "NEUTRAL", "document_number_effect": "No document number provided for screening", "total_score": 93 }, "pep_matches": [ { "aliases": [], "education": [], "list_name": "Presidency of the Government of Spain", "publisher": "Presidency of the Government of Spain", "source_url": "https://news.example.org/articles/sample", "description": "The Presidency of the Government is the central institutional body in Spain that supports the Prime Minister and coordinates the general action of the central government.", "matched_name": "Antonio Ejemplo Modelo", "pep_position": "", "date_of_birth": "1972-02-29", "other_sources": [], "place_of_birth": "Madrid, Spain" } ], "sanction_matches": [], "warning_matches": [], "adverse_media_matches": [], "adverse_media_details": null, "linked_entities": [ { "name": [ "Maria Begona Gomez Fernandez" ], "active": [], "status": [], "details": [], "relation": [ "spouse" ] } ], "additional_information": { "flag_summary": [ "Antonio Ejemplo Modelo has been flagged as a Level 1 Politically Exposed Person (PEP) from Spain, serving as the President of the Government of Spain." ] } } ], "score": 73.0, "screened_data": { "full_name": "Pedro Sanchez Perez-Castejon", "date_of_birth": "1972-02-29", "nationality": "ES", "document_number": null }, "warnings": [] }, "vendor_data": null, "metadata": null, "created_at": "2026-06-11T10:23:44.812000+00:00" } } } } } }, "400": { "description": "Error de validación. Los problemas a nivel de campo devuelven el envoltorio estándar de DRF (un array de mensajes por cada campo incorrecto); las reglas entre campos (suma de pesos, orden de umbrales, monitorización sin guardar) devuelven `{\"error\": [...]}`.", "content": { "application/json": { "examples": { "Missing full_name": { "summary": "`full_name` es el único campo obligatorio", "value": { "full_name": [ "This field is required." ] } }, "Short full_name": { "summary": "`full_name` debe tener al menos 2 caracteres", "value": { "full_name": [ "Ensure this field has at least 2 characters." ] } }, "Invalid nationality": { "summary": "`nationality` debe ser ISO 3166-1 alpha-2", "value": { "nationality": [ "Invalid ISO 3166-1 alpha-2 country code." ] } }, "Weights do not sum to 100": { "summary": "`aml_name_weight` + `aml_dob_weight` + `aml_country_weight` ≠ 100", "value": { "error": [ "AML weights must sum to 100. Current sum: 90 (name: 50, dob: 25, country: 15)" ] } }, "Thresholds out of order": { "summary": "Umbral de aprobación superior al umbral de revisión", "value": { "error": [ "Approve threshold (90.0) cannot be greater than review threshold (80.0)" ] } }, "Monitoring without saving": { "summary": "`include_ongoing_monitoring=true` con `save_api_request=false`", "value": { "error": [ "Ongoing monitoring can only be enabled when the API request is saved." ] } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key` y también cuando el saldo de la organización que realiza la llamada no la cubre; una clave incorrecta, revocada o expirada devuelve `401`. Si falta la clave, se devuelve `403` con `{\"detail\": ...}`; una clave incorrecta, revocada o expirada devuelve `401`. La falta de créditos devuelve `403` con `{\"error\": ...}` antes de que se realice cualquier análisis o llamada a un proveedor.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de la organización no cubre la llamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } } } }, "/v3/face-search/": { "post": { "summary": "Búsqueda facial", "description": "Busca una imagen de rostro (1:N) en el índice de búsqueda facial de tu aplicación (rostros registrados a partir de sesiones de verificación, llamadas independientes a la API guardadas, rostros subidos directamente a perfiles de usuario y tus listas de bloqueo y de permitidos) y obtén coincidencias ordenadas por similitud, junto con advertencias de lista de bloqueo y de duplicados.\n\n**Cómo funciona.** Se genera el embedding del rostro más grande detectado en `user_image` y se busca en el índice, limitado a tu aplicación. En `matches` se devuelven hasta **5 coincidencias** por encima del umbral mínimo de similitud. Cada una incluye `similarity_percentage`, la sesión de origen (`session_id`, `session_number`, `status`, `vendor_data`), los `user_details` extraídos durante la verificación de documentos de esa sesión, los indicadores `is_blocklisted` / `is_allowlisted` y un discriminador `source` (`session`, `imported` o `list_entry`).\n\n- `search_type=most_similar` (valor por defecto) ordena todos los rostros registrados por similitud. Úsalo para la deduplicación y la investigación de redes de fraude.\n- `search_type=blocklisted_or_approved` limita los candidatos a rostros de la lista de bloqueo, rostros de la lista de permitidos, rostros de sesiones aprobadas y rostros importados de perfiles de usuario, y coloca primero las entradas de la lista de bloqueo. Úsalo cuando el objetivo principal sea el control contra la lista de bloqueo.\n\n`status` es `Declined` solo cuando se dispara una advertencia `FACE_IN_BLOCKLIST` o `POSSIBLE_FACE_IN_BLOCKLIST`; `DUPLICATED_FACE` / `POSSIBLE_DUPLICATED_FACE` (`information`) y `MULTIPLE_FACES_DETECTED` (`warning`) nunca provocan un rechazo. A diferencia de la prueba de vida pasiva, este endpoint **no** excluye de las coincidencias las sesiones anteriores con el mismo `vendor_data`. También se ejecuta internamente un análisis de prueba de vida pasiva, que se almacena con la sesión persistida, pero su resultado no forma parte de esta respuesta.\n\n**Facturación.** Cada respuesta `200` consume un crédito de la API de Búsqueda facial (se paga con el crédito de tu plan o con tu saldo de recargas). Si el saldo es insuficiente, se devuelve `403` antes de procesar ninguna imagen.\n\n**Persistencia de la sesión y registro del rostro (`save_api_request`, `true` por defecto).** Cuando es `true`, la llamada se guarda como una sesión de tipo API (Business Console, `GET /v3/session/{sessionId}/decision/` mediante el `request_id` devuelto, webhook `status.updated`) y el rostro buscado se registra en tu índice de búsqueda facial. Los rostros registrados mediante llamadas de Búsqueda facial se excluyen de los resultados futuros de Búsqueda facial, por lo que las búsquedas repetidas nunca coinciden entre sí. Cuando es `false`, la llamada es puntual: no se almacena nada, el rostro no se registra y los valores de `match_image_url` son rutas de almacenamiento interno en lugar de URL descargables.\n\n**Sandbox.** Las claves de API de sandbox omiten todo el procesamiento y la facturación: tras validar la solicitud (una entrada mal formada sigue devolviendo `400`), el endpoint devuelve un payload simulado estático `Approved`, no se persiste ninguna sesión y no se consumen créditos.\n\n**Autenticación.** Envía la clave de API de tu aplicación en el encabezado `x-api-key`. Si faltan las credenciales o no son válidas, se devuelve `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`): esta API nunca devuelve `401`.\n\n**Límite de solicitudes.** Presupuesto de escritura compartido de 300 solicitudes/min por clave de API entre todos los endpoints POST/PATCH/DELETE; si se supera, se devuelve `429`.", "operationId": "post_v3face-search", "x-didit-sdk": { "resource": "face_search", "method": "search", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "user_image" ], "properties": { "user_image": { "type": "string", "format": "binary", "description": "Imagen frontal del rostro con la que buscar. Extensiones permitidas: `tiff`, `jpg`, `jpeg`, `png`, `webp`. Tamaño máximo de carga: **5 MB** (los archivos más grandes se rechazan con `400`). Las imágenes se comprimen automáticamente a ~0.5 MB antes del procesamiento, por lo que las resoluciones muy altas no mejoran la precisión. La imagen debe contener al menos un rostro detectable; de lo contrario, el endpoint devuelve `400`. Cuando hay varios rostros, se busca el más grande y se añade una advertencia `MULTIPLE_FACES_DETECTED`." }, "search_type": { "type": "string", "default": "most_similar", "enum": [ "most_similar", "blocklisted_or_approved" ], "description": "Política de búsqueda. `most_similar` (predeterminado) ordena por similitud todos los rostros registrados en tu aplicación. `blocklisted_or_approved` limita los candidatos a rostros en la lista de bloqueo, rostros en la lista de permitidos, rostros de sesiones aprobadas y rostros de perfiles de usuario importados, con las entradas de la lista de bloqueo en primer lugar.", "example": "most_similar" }, "rotate_image": { "type": "boolean", "default": false, "description": "Si es `true`, el servicio prueba rotaciones de 90 grados de la entrada y usa la orientación que ofrece la mejor detección facial. Útil cuando falta la orientación EXIF. Añade latencia.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Si es `true` (valor predeterminado), guarda la llamada como una sesión de tipo API, emite un webhook `status.updated`, genera URL prefirmadas para los valores de `match_image_url` y registra el rostro buscado en tu índice de búsqueda facial (los registros de Búsqueda facial se excluyen de búsquedas futuras). Si es `false`, la búsqueda es puntual: no se almacena ninguna sesión y el rostro no se registra.", "example": true }, "vendor_data": { "type": "string", "description": "Identificador opaco opcional (tu ID de usuario, correo electrónico, UUID…) que se guarda en la sesión persistida y se devuelve. No excluye de los resultados de la búsqueda los rostros del mismo usuario.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objeto JSON opcional que se almacena con la sesión (cuando `save_api_request=true`) y se devuelve. En solicitudes multipart, envíalo como un campo de cadena codificado en JSON: se convierte en un objeto.", "example": { "flow": "dedup_check" } } } }, "example": { "user_image": "(binary JPEG/PNG selfie)", "search_type": "most_similar", "rotate_image": false, "save_api_request": true, "vendor_data": "user-123", "metadata": { "flow": "dedup_check" } } } } }, "responses": { "200": { "description": "Búsqueda facial completada. `face_search.matches` contiene hasta 5 rostros similares ordenados por similitud; un array vacío significa que ningún rostro registrado superó el umbral mínimo de similitud. `status` es `Declined` solo cuando hay coincidencias en la lista de bloqueo: las coincidencias duplicadas por sí solas devuelven `Approved`, así que revisa `matches` y `warnings`, no solo `status`. Cuando `save_api_request=true`, `request_id` es el ID de la sesión guardada. Cada coincidencia incluye `source` (`session`, `imported`, `list_entry` o `retained_template`), `vendor_user_id` y `biometric_template_id`; una coincidencia `retained_template` procede de una plantilla biométrica sin imagen que se conservó después de que se eliminara la sesión de origen, y tiene `null` en los campos de sesión, `match_image_url` y `user_details`.", "content": { "application/json": { "examples": { "Blocklist hit (Declined)": { "summary": "El rostro coincide con un rostro de la lista de bloqueo", "value": { "request_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "face_search": { "status": "Declined", "total_matches": 1, "matches": [ { "session_id": "882c42d5-8a4d-4d20-8080-a22f57822c86", "session_number": 323442, "similarity_percentage": 99.99, "source": "session", "vendor_data": "user-1", "verification_date": "2025-01-01T00:00:00Z", "user_details": { "full_name": "Jane Marie Doe", "document_type": "ID", "document_number": "X1234567" }, "match_image_url": "https:///face/3f6a1c2e/reference.jpg", "status": "Approved", "is_blocklisted": true, "is_allowlisted": false, "api_service": null, "vendor_user_id": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f", "biometric_template_id": null } ], "user_image": { "entities": [ { "bbox": [ 40, 40, 120, 120 ], "confidence": 0.732973 } ], "best_angle": 0 }, "warnings": [ { "risk": "FACE_IN_BLOCKLIST", "feature": "LIVENESS", "additional_data": { "blocklisted_session_id": "882c42d5-8a4d-4d20-8080-a22f57822c86", "blocklisted_session_number": 323442, "api_service": null }, "log_type": "error", "short_description": "Face in blocklist", "long_description": "The system identified a face in the blocklist, which means the face is not allowed to be verified." } ] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T01:04:42.763237+00:00" } }, "Duplicate found (Approved)": { "summary": "El rostro ya apareció en otra sesión aprobada; es informativo y no provoca un rechazo", "value": { "request_id": "5e0c3a1f-7b2d-4c8e-9f10-2a3b4c5d6e7f", "face_search": { "status": "Approved", "total_matches": 1, "matches": [ { "session_id": "1f2e3d4c-5b6a-7980-1122-334455667788", "session_number": 1024, "similarity_percentage": 87.42, "source": "session", "vendor_data": "user-9", "verification_date": "2025-11-20T09:15:00Z", "user_details": null, "match_image_url": "https:///face/9c8b7a6d/reference.jpg", "status": "Approved", "is_blocklisted": false, "is_allowlisted": false, "api_service": "PASSIVE_LIVENESS", "vendor_user_id": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f", "biometric_template_id": null } ], "user_image": { "entities": [ { "bbox": [ 40, 40, 120, 120 ], "confidence": 0.732973 } ], "best_angle": 0 }, "warnings": [ { "risk": "DUPLICATED_FACE", "feature": "LIVENESS", "additional_data": { "duplicated_session_id": "1f2e3d4c-5b6a-7980-1122-334455667788", "duplicated_session_number": 1024, "api_service": "PASSIVE_LIVENESS" }, "log_type": "information", "short_description": "Duplicated face from other approved session", "long_description": "The system identified a duplicated face from another approved session, requiring further investigation." } ] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T01:04:42.763237+00:00" } }, "No matches (Approved)": { "summary": "Ningún rostro registrado superó el umbral mínimo de similitud", "value": { "request_id": "9d8c7b6a-5f4e-3d2c-1b0a-998877665544", "face_search": { "status": "Approved", "total_matches": 0, "matches": [], "user_image": { "entities": [ { "bbox": [ 40, 40, 120, 120 ], "confidence": 0.732973 } ], "best_angle": 0 }, "warnings": [] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T01:04:42.763237+00:00" } } }, "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sesión guardada cuando `save_api_request=true` (se puede usar con `GET /v3/session/{sessionId}/decision/`); en caso contrario, un UUID de correlación temporal." }, "face_search": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Declined` solo cuando se activó una advertencia `FACE_IN_BLOCKLIST` o `POSSIBLE_FACE_IN_BLOCKLIST`. Las coincidencias duplicadas y las advertencias de varios rostros nunca provocan un rechazo." }, "total_matches": { "type": "integer", "description": "Número de entradas en `matches` (0–5).", "example": 1 }, "matches": { "type": "array", "maxItems": 5, "description": "Hasta 5 rostros de tu índice de búsqueda facial que superan el umbral mínimo de similitud, ordenados por similitud (con las entradas de la lista de bloqueo en primer lugar cuando `search_type=blocklisted_or_approved`). Vacío cuando ningún rostro registrado es lo bastante similar.", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Id de la sesión de verificación a la que pertenece el rostro coincidente. `null` cuando `source` es `imported`, `list_entry` o `retained_template`.", "example": "882c42d5-8a4d-4d20-8080-a22f57822c86" }, "session_number": { "type": "integer", "nullable": true, "description": "Número de sesión legible que se muestra en la Business Console. `null` en las coincidencias que no son sesiones.", "example": 323442 }, "similarity_percentage": { "type": "number", "format": "float", "minimum": 0, "maximum": 100, "description": "Similitud entre el rostro enviado y el rostro coincidente (0–100).", "example": 99.99 }, "source": { "type": "string", "enum": [ "session", "imported", "list_entry", "retained_template" ], "description": "Origen del registro del rostro coincidente: `session`: una sesión de verificación o una llamada independiente a la API guardada; `imported`: un rostro subido directamente a un perfil de usuario; `list_entry`: un rostro asociado a una de tus listas; `retained_template`: una plantilla biométrica sin imagen almacenada en un usuario, que aparece en `/v3/biometric-templates/`." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` de la sesión coincidente o del User vinculado, para rostros importados y rostros con plantilla retenida.", "example": "user-1" }, "vendor_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID del usuario vinculado. `null` para las entradas de lista y las coincidencias de sesión sin usuario.", "example": "2f7c1a9e-4b28-4a6d-97f1-83576f80e1b4" }, "biometric_template_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID de la plantilla biométrica conservada. Solo se establece cuando `source` es `retained_template`; `null` en caso contrario.", "example": null }, "verification_date": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que se capturó originalmente el rostro coincidente, o en que se creó una plantilla conservada (`YYYY-MM-DDThh:mm:ssZ`). `null` para coincidencias `list_entry`.", "example": "2025-01-01T00:00:00Z" }, "user_details": { "type": "object", "nullable": true, "description": "Datos de identidad extraídos durante la verificación del documento de la sesión coincidente. `null` cuando la sesión coincidente no tiene datos de documento (p. ej., sesiones solo de prueba de vida) y siempre `null` en las coincidencias `retained_template`. En las coincidencias con `source: imported`, se rellena en cambio a partir del perfil de usuario: `full_name` informado y `document_type`/`document_number` en null.", "properties": { "full_name": { "type": "string", "nullable": true, "example": "Jane Marie Doe" }, "document_type": { "type": "string", "nullable": true, "example": "ID" }, "document_number": { "type": "string", "nullable": true, "example": "X1234567" } } }, "match_image_url": { "type": "string", "nullable": true, "description": "URL de validez limitada (`https:///...`) de la imagen de referencia del rostro coincidente cuando `save_api_request=true`. Con `save_api_request=false`, es una ruta de almacenamiento interna que no se puede descargar directamente. Siempre es `null` en las coincidencias `retained_template`, porque las plantillas retenidas no contienen ninguna imagen.", "example": "https:///face/3f6a1c2e/reference.jpg" }, "status": { "type": "string", "nullable": true, "description": "Estado de la sesión coincidente (`Approved`, `Declined`, `In Review`, …). `null` para coincidencias `imported`/`list_entry`.", "example": "Approved" }, "is_blocklisted": { "type": "boolean", "description": "`true` cuando el rostro coincidente está en tu lista de bloqueo facial. Cualquier coincidencia suficientemente similar en la lista de bloqueo rechaza la búsqueda." }, "is_allowlisted": { "type": "boolean", "description": "`true` cuando el rostro coincidente está en una de tus listas de permitidos. Las coincidencias en listas de permitidos suprimen las advertencias de duplicado." }, "api_service": { "type": "string", "nullable": true, "description": "Se establece cuando el rostro coincidente se registró mediante una llamada a la API independiente (p. ej., `PASSIVE_LIVENESS`); `null` para las sesiones de verificación normales y los rostros importados.", "example": null } } } }, "user_image": { "type": "object", "description": "Resultados de la detección facial de la imagen enviada. Estas entradas solo incluyen `bbox` y `confidence`.", "properties": { "entities": { "type": "array", "description": "Una entrada por rostro detectado. El rostro más grande es el que se busca.", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Cuadro delimitador `[x_min, y_min, x_max, y_max]` en píxeles.", "example": [ 40, 40, 120, 120 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Confianza de la detección facial (0–1).", "example": 0.732973 } } } }, "best_angle": { "type": "integer", "description": "Rotación (en grados) que produjo la mejor detección facial; solo es distinta de cero cuando `rotate_image=true` corrigió la orientación. Nunca es null en este endpoint (toma el valor 0 por defecto cuando el modelo la omite).", "example": 0 } } }, "warnings": { "type": "array", "description": "Señales de riesgo. `FACE_IN_BLOCKLIST` / `POSSIBLE_FACE_IN_BLOCKLIST` (`error`) rechazan la búsqueda; `MULTIPLE_FACES_DETECTED` (`warning`) y `DUPLICATED_FACE` / `POSSIBLE_DUPLICATED_FACE` (`information`) son solo informativas.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "MULTIPLE_FACES_DETECTED", "FACE_IN_BLOCKLIST", "POSSIBLE_FACE_IN_BLOCKLIST", "DUPLICATED_FACE", "POSSIBLE_DUPLICATED_FACE" ], "description": "Código de riesgo legible por máquina." }, "feature": { "type": "string", "enum": [ "LIVENESS" ], "description": "Función que emitió la advertencia. En este endpoint siempre es `LIVENESS`." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "`null` para `MULTIPLE_FACES_DETECTED`. Las coincidencias en la lista de bloqueo incluyen `{blocklisted_session_id, blocklisted_session_number, api_service}`; las coincidencias de duplicados incluyen `{duplicated_session_id, duplicated_session_number, api_service}`, que apunta a la primera sesión coincidente." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravedad. Las advertencias `error` llevan `status` a `Declined`; las entradas `warning` e `information` son informativas y nunca rechazan por sí solas." }, "short_description": { "type": "string", "description": "Resumen legible del riesgo en una línea." }, "long_description": { "type": "string", "description": "Explicación legible del riesgo." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste, o `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Devuelve el objeto `metadata` que enviaste, o `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de tiempo ISO 8601 (UTC) del momento en que se generó la respuesta, p. ej., `2026-06-12T01:04:42.763237+00:00`." } } } } } }, "400": { "description": "Error de validación. Se devuelve cuando falta `user_image`, supera los 5 MB o tiene una extensión no admitida, o cuando **no se detecta ningún rostro** en la imagen enviada. Los errores de campo usan el formato `{field: [messages]}` de DRF; los fallos de detección facial usan `{\"error\": ...}`.", "content": { "application/json": { "examples": { "No face detected": { "summary": "La imagen se decodifica correctamente, pero no contiene ningún rostro detectable", "value": { "error": "No face detected in the image" } }, "Missing image": { "summary": "`user_image` no incluido en los datos del formulario", "value": { "user_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Extensión de archivo distinta de tiff/jpg/jpeg/png/webp", "value": { "user_image": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp." ] } }, "File too large": { "summary": "El archivo supera el límite de 5 MB", "value": { "user_image": [ "File size should not exceed 5 MB" ] } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key` y también cuando el saldo de la organización que realiza la llamada no la cubre; una clave incorrecta, revocada o expirada devuelve `401`. Si falta la clave, se devuelve `403` con `{\"detail\": ...}`; una clave incorrecta, revocada o expirada devuelve `401`. La falta de créditos devuelve `403` con `{\"error\": ...}` antes de que se procese ninguna imagen.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de la organización no cubre la llamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/face-search/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'user_image=@./selfie.jpg' \\\n -F 'search_type=most_similar' \\\n -F 'save_api_request=true' \\\n -F 'vendor_data=user-123'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.face_search.search(\n user_image=open(\"user_image.jpg\", \"rb\"),\n search_type=\"most_similar\",\n rotate_image=False,\n save_api_request=True,\n vendor_data=\"user-123\",\n metadata={\"flow\": \"dedup_check\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.faceSearch.search({\n user_image: await fileFromPath(\"user_image.jpg\"),\n search_type: \"most_similar\",\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"dedup_check\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.FaceSearch.Search(ctx, didit.FaceSearchSearchParams{\n\tUserImage: didit.FileFromPath(\"user_image.jpg\"),\n\tSearchType: didit.Some(didit.FaceSearchSearchParamsSearchType(\"most_similar\")),\n\tRotateImage: didit.Bool(false),\n\tSaveAPIRequest: didit.Bool(true),\n\tVendorData: didit.String(\"user-123\"),\n\tMetadata: didit.Some(map[string]any{\"flow\": \"dedup_check\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.FaceSearchSearchParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.faceSearch().search(FaceSearchSearchParams.builder()\n .userImage(Path.of(\"user_image.jpg\"))\n .searchType(FaceSearchSearchParams.SearchType.of(\"most_similar\"))\n .rotateImage(false)\n .saveApiRequest(true)\n .vendorData(\"user-123\")\n .metadata(Map.of(\"flow\", \"dedup_check\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "faceSearch->search([\n 'user_image' => File::fromPath('user_image.jpg'),\n 'search_type' => 'most_similar',\n 'rotate_image' => false,\n 'save_api_request' => true,\n 'vendor_data' => 'user-123',\n 'metadata' => ['flow' => 'dedup_check'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.face_search.search(\n user_image: Pathname(\"user_image.jpg\"),\n search_type: \"most_similar\",\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"dedup_check\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.FaceSearch.SearchAsync(new FaceSearchSearchParams\n{\n UserImage = FileUpload.FromPath(\"user_image.jpg\"),\n SearchType = new FaceSearchSearchParamsSearchType(\"most_similar\"),\n RotateImage = false,\n SaveApiRequest = true,\n VendorData = \"user-123\",\n Metadata = new Dictionary { [\"flow\"] = \"dedup_check\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/sessions/": { "get": { "summary": "Lista sesiones de verificación (KYC y/o KYB) con filtros y paginación", "description": "Devuelve una lista paginada de las sesiones de verificación de la aplicación identificada por tu clave de API, de la más reciente a la más antigua (`session_number` en orden descendente).\n\n**URL canónica:** la ruta es `/v3/sessions/` (con barra final). Las solicitudes a `/v3/sessions` sin la barra reciben una redirección `301` a la URL con barra, conservando la cadena de consulta; la mayoría de los clientes HTTP la siguen de forma transparente en GET.\n\n**Cuándo usar este endpoint y cuándo los webhooks.** Usa este endpoint para paneles, búsquedas de back-office, conciliación y exportaciones por lotes. No lo consultes periódicamente para seguir el progreso de verificaciones individuales: configura [webhooks](/es/integration/webhooks) en su lugar, que envían eventos `status.updated` en el momento en que una sesión cambia. Para obtener el resultado completo de una sesión, llama a `GET /v3/session/{sessionId}/decision/`.\n\n**Sesiones KYC y KYB.** `session_kind` selecciona qué tipos se listan:\n- `user` (predeterminado): solo sesiones de Verificación de usuarios (KYC). Comportamiento compatible con versiones anteriores.\n- `business`: solo sesiones de Verificación de empresas (KYB). Las filas tienen una estructura distinta y más reducida (consulta el esquema de la respuesta).\n- `all`: ambos tipos en una sola respuesta: la página de KYC y la página de KYB para los mismos `limit`/`offset` se concatenan en `results` (primero las filas KYC), por lo que una página puede contener hasta `2 x limit` filas. `count` es la suma de ambos tipos y `next`/`previous` reflejan la paginación del lado KYC. Para una paginación estricta de datos mixtos, llama a `user` y `business` por separado.\n\nCada fila incluye un discriminador `session_kind` (`\"user\"` o `\"business\"`).\n\n**Paginación.** Paginación estándar por limit/offset: `limit` (50 por defecto) y `offset` (0 por defecto), con `next`/`previous` como URLs de página ya construidas. Para las filas KYC, `count` es exacto. Para las filas KYB, `count` se calcula con un recorrido acotado y tiene un máximo de 100: cuando hay más de 100 coincidencias se queda en 100, así que itera usando `next` (o comprobando si se devolvió una página completa) en lugar de calcular el total de páginas a partir de `count`.\n\n**Semántica de los filtros.** Todos los filtros se combinan con AND y se aplican a las filas KYC. Cuando `session_kind` es `business` o `all`, el lado KYB respeta los parámetros compartidos `vendor_data`, `status`, `workflow_id`, `country` (código de país de la empresa en el registro), `date_from`, `date_to`, `search` (nombre de la empresa, número de registro —escribe los números de registro sin separadores, por ejemplo `DPC001` y no `DPC-001`—, vendor_data, número de sesión o UUID de la sesión), `warning` y `organization_name`; los demás filtros exclusivos de KYC se ignoran para las filas KYB. Los parámetros separados por comas (`status`, `country`, `document_type`, `region`, `workflow_id`, `document_name`, `warning`, `organization_name`, `session_type`) coinciden con cualquiera de los valores indicados (OR dentro del parámetro). `vendor_data` es una coincidencia exacta: usa `search` para coincidencias parciales. Los valores desconocidos en los filtros de lista simplemente no devuelven filas (sin error); los valores con tipo mal formados (`date_from`, `date_to`, `didit_internal_id`, `api_service`, `session_kind`) devuelven `400` con un objeto de error por campo.\n\n**Búsqueda.** `search` se adapta a la entrada: un UUID completo busca por `session_id`; los dígitos (con `+ - . space` opcionales, es decir, signo más, guion, punto o espacio) coinciden con el prefijo del número de sesión, números de documento o personales, el prefijo del número de teléfono o `vendor_data`; los valores que contienen `@` coinciden con prefijos de correo electrónico; cualquier otro texto coincide con nombres (sin distinguir acentos) y con `vendor_data`.\n\nNo se aplica un límite de solicitudes fijo por endpoint, pero consulta la lista con poca frecuencia y usa los webhooks para las actualizaciones en tiempo real.", "operationId": "get_v3_sessions", "x-didit-sdk": { "resource": "sessions", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "session_kind", "in": "query", "required": false, "description": "Qué tipo de sesiones listar: `user` (solo KYC, valor predeterminado), `business` (solo KYB) o `all` (ambas, concatenadas; consulta la descripción para conocer la semántica de la paginación combinada). La coincidencia no distingue mayúsculas de minúsculas (`BUSINESS` funciona); cualquier valor que no sea una variante en mayúsculas o minúsculas de `user`/`business`/`all` devuelve `400`.", "schema": { "type": "string", "enum": [ "user", "business", "all" ], "default": "user" }, "example": "all" }, { "name": "limit", "in": "query", "required": false, "description": "Número máximo de filas por página (por tipo cuando `session_kind=all`). El valor predeterminado es 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 20 }, { "name": "offset", "in": "query", "required": false, "description": "Número de filas que se omiten antes de la primera fila devuelta. El valor predeterminado es 0. Es preferible seguir las URL `next`/`previous` de la respuesta.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 20 }, { "name": "status", "in": "query", "required": false, "description": "Lista separada por comas de los estados de sesión que se incluirán, por ejemplo, `Approved,In Review`. Los valores distinguen mayúsculas de minúsculas; consulta [Estados de verificación](/es/integration/verification-statuses). Los valores desconocidos no coinciden con nada.", "schema": { "type": "string" }, "example": "Approved,In Review" }, { "name": "vendor_data", "in": "query", "required": false, "description": "Filtro de coincidencia exacta sobre el `vendor_data` que enviaste al crear la sesión (tu propio identificador de usuario o empresa). Para coincidencias parciales, usa `search`.", "schema": { "type": "string" }, "example": "your-user-id-123" }, { "name": "search", "in": "query", "required": false, "description": "Una referencia completa tal como se muestra, como `S-0001` (usuario) o `B-0001` (empresa), coincide solo con ese número y tipo de sesión; los ceros iniciales y las mayúsculas o minúsculas no afectan a la coincidencia. Búsqueda inteligente de texto libre. Un UUID completo coincide con `session_id`; una entrada numérica coincide con el prefijo del número de sesión, números de documento o personales, el prefijo de teléfono o `vendor_data`; una entrada que contiene `@` coincide con prefijos de correo electrónico; el resto del texto coincide con nombres (sin distinguir acentos) y `vendor_data`. El texto libre que contiene dígitos también coincide con los campos de búsqueda de números de documento o personales y con los prefijos del número de sesión.", "schema": { "type": "string" }, "example": "jane doe" }, { "name": "workflow_id", "in": "query", "required": false, "description": "UUID de flujos separados por comas (los encontrarás en la página Workflows de la Console). Los UUID mal formados de la lista se ignoran; si ninguno es válido, el resultado queda vacío.", "schema": { "type": "string" }, "example": "9f9b1234-aaaa-bbbb-cccc-1234567890ab" }, { "name": "date_from", "in": "query", "required": false, "description": "Solo sesiones creadas en esta fecha o después (UTC), con formato `YYYY-MM-DD`. Las fechas mal formadas devuelven `400`.", "schema": { "type": "string", "format": "date" }, "example": "2026-06-01" }, { "name": "date_to", "in": "query", "required": false, "description": "Solo sesiones creadas hasta esta fecha (UTC), con formato `YYYY-MM-DD`. En las filas de KYC se incluye el día completo; en las filas de KYB la comparación es `created_at <= date_to` (medianoche), así que usa la fecha del día siguiente para incluir un día completo de sesiones de KYB.", "schema": { "type": "string", "format": "date" }, "example": "2026-06-30" }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "string" }, "description": "IDs de etiquetas separados por comas (`tags` de tu aplicación). Devuelve las sesiones que tengan cualquiera de ellas. Los IDs que no son UUID válidos se ignoran y, si ninguno es válido, la lista queda vacía." }, { "name": "decided_from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Fecha y hora ISO 8601. Devuelve las sesiones cuyo estado cambió por última vez en ese momento o después. Filtra por la hora del último cambio de estado, no por la hora de creación." }, { "name": "decided_to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Fecha y hora ISO 8601. Devuelve las sesiones cuyo estado cambió por última vez antes de ese momento. Combínalo con `decided_from` para obtener un intervalo semiabierto." }, { "name": "country", "in": "query", "required": false, "description": "Filtro de país separado por comas. Para las filas de KYC: códigos ISO 3166-1 alfa-3 del Estado emisor del documento de identidad (por ejemplo, `ESP,USA`), que puede diferir de la nacionalidad. Para las filas de KYB: el código de país de la empresa en el registro.", "schema": { "type": "string" }, "example": "ESP,USA" }, { "name": "document_type", "in": "query", "required": false, "description": "Códigos de tipo de documento de identidad verificados en la sesión, separados por comas (solo filas de KYC): `P` (pasaporte), `ID` (documento de identidad), `DL` (licencia de conducir), `RP` (permiso de residencia), `SSC` (tarjeta de seguridad social), `HIC` (tarjeta de seguro médico), `WP` (permiso de trabajo), `TC` (tarjeta fiscal), `VISA`, `PSC` (tarjeta de servicios públicos), `BC` (certificado de nacimiento), `OTHER`. Ten en cuenta que el campo `document_type` de la respuesta contiene el nombre visible, no el código.", "schema": { "type": "string" }, "example": "P,ID" }, { "name": "document_name", "in": "query", "required": false, "description": "Nombres exactos de documentos; se pueden pasar varios nombres separados por comas, pero el valor solo se divide por comas cuando contiene más de un separador ` - ` (un nombre único con una coma interna se compara completo). Los nombres son los que reconoce la verificación de documentos (anverso o reverso), por ejemplo `Spain - Id Card (2021)`. Solo filas de KYC.", "schema": { "type": "string" }, "example": "Spain - Id Card (2021)" }, { "name": "region", "in": "query", "required": false, "description": "Valores de región o estado del documento separados por comas (para documentos emitidos por región, como las licencias de conducir de EE. UU.). Solo filas de KYC.", "schema": { "type": "string" }, "example": "CA,TX" }, { "name": "didit_internal_id", "in": "query", "required": false, "description": "Filtra por el identificador interno de usuario de Didit (el campo de respuesta `didit_internal_id`) para listar todas las sesiones de un usuario verificado. Debe ser un UUID válido; los valores mal formados devuelven `400`. Solo filas de KYC.", "schema": { "type": "string", "format": "uuid" }, "example": "d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147" }, { "name": "session_type", "in": "query", "required": false, "description": "Canales de creación de sesión separados por comas: `API`, `HOSTED`, `MIGRATED`. El valor especial `ALL` (u omitir el parámetro) desactiva el filtro. Solo filas de KYC.", "schema": { "type": "string" }, "example": "HOSTED" }, { "name": "api_service", "in": "query", "required": false, "description": "Filtrar las sesiones de API independientes por servicio. Los valores no válidos devuelven `400`. Solo filas KYC.", "schema": { "type": "string", "enum": [ "ID_VERIFICATION", "FACE_MATCH", "AGE_ESTIMATION", "FACE_SEARCH", "POA", "AML", "KYB_REGISTRY", "PASSIVE_LIVENESS", "DATABASE_VALIDATION", "PHONE_VERIFICATION", "EMAIL_VERIFICATION" ] }, "example": "AML" }, { "name": "screened_full_name", "in": "query", "required": false, "description": "Búsqueda por nombre, sin distinguir acentos, en los datos analizados por AML y por la validación de base de datos. Si se combina con `api_service=AML` o `api_service=DATABASE_VALIDATION`, la búsqueda se limita a los datos analizados por esa función. Solo filas de KYC.", "schema": { "type": "string" }, "example": "Jane Doe" }, { "name": "warning", "in": "query", "required": false, "description": "Códigos de riesgo de advertencias separados por comas. Devuelve las sesiones que generaron cualquiera de ellos (p. ej., `POSSIBLE_FRAUD`). Los códigos de riesgo de cada función aparecen en la [documentación de advertencias](/es/integration/webhooks). Se aplica a las filas de KYC y, con códigos de advertencia de empresa, a las filas de KYB.", "schema": { "type": "string" }, "example": "POSSIBLE_FRAUD" }, { "name": "status_initialized_as_in_review", "in": "query", "required": false, "description": "Si es `true`, solo las sesiones cuya decisión quedó inicialmente en `In Review` (útil para auditar el volumen de revisión manual). Solo filas de KYC.", "schema": { "type": "boolean" }, "example": true }, { "name": "is_kyc_to_be_reviewed", "in": "query", "required": false, "description": "`true` devuelve las sesiones cuya verificación de documentos está marcada para revisión manual; `false` devuelve las sesiones cuya verificación de documentos explícitamente no está marcada. Omítelo para desactivar el filtro. Solo filas de KYC.", "schema": { "type": "boolean" }, "example": true }, { "name": "euuid", "in": "query", "required": false, "description": "Filtrar por el euuid del usuario final (UUID asignado al usuario que se verifica, usado por los enlaces directos de la Console). Debe ser un UUID válido; los valores mal formados devuelven un error de campo 400. Solo filas KYC.", "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "organization_name", "in": "query", "required": false, "description": "Nombres de organización separados por comas. Orientado a la consola; con una clave de API (ya limitada a una aplicación) solo coincide con el nombre de tu propia organización.", "schema": { "type": "string" }, "example": "Acme Inc" } ], "responses": { "200": { "description": "Lista paginada de sesiones. Los elementos de `results` son filas de KYC, de KYB o de ambos tipos según `session_kind`; distínguelos con el campo `session_kind` de cada fila.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Número de sesiones que coinciden con los filtros: exacto hasta 100 y limitado a 100 por encima de esa cifra, así que no lo uses como total. Usa `next` para saber si hay más páginas. Con `session_kind=all` es la suma de ambos tipos, cada uno limitado a 100.", "example": 2 }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la página siguiente, o `null` en la última página.", "example": "https://verification.didit.me/v3/sessions/?limit=20&offset=20" }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la página anterior, o `null` en la primera página.", "example": null }, "results": { "type": "array", "description": "Filas de sesiones, de la más reciente a la más antigua. Con `session_kind=all`, primero van las filas KYC y después las KYB.", "items": { "oneOf": [ { "$ref": "#/components/schemas/UserSessionListItem" }, { "$ref": "#/components/schemas/BusinessSessionListItem" } ], "discriminator": { "propertyName": "session_kind", "mapping": { "user": "#/components/schemas/UserSessionListItem", "business": "#/components/schemas/BusinessSessionListItem" } } } } } }, "examples": { "KYC sessions (default)": { "summary": "session_kind=user: una sesión completada y otra sin iniciar", "value": { "count": 2, "next": null, "previous": null, "results": [ { "session_id": "5b3720ed-d429-42ef-b67f-37ea805f48ee", "session_kind": "user", "session_number": 720, "session_url": "https://verify.didit.me/session/CuXoBYCYVO5Y", "portrait_image": "https:///portraits/5b3720ed.jpg?X-Amz-Expires=3600&X-Amz-Signature=...", "document_type": "Passport", "full_name": "Jane Marie Doe", "country": "ESP", "status": "Approved", "vendor_data": "your-user-id-123", "didit_internal_id": "d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147", "created_at": "2026-06-09T12:26:54.328364Z", "features": [ { "feature": "ID_VERIFICATION", "status": "Approved" }, { "feature": "LIVENESS", "status": "Approved" }, { "feature": "FACE_MATCH", "status": "Approved" }, { "feature": "AML", "status": "Approved" }, { "feature": "IP_ANALYSIS", "status": "Approved" } ], "phone_number": { "number": "+14155552671", "is_verified": true }, "email_address": { "email": "jane@example.com", "is_verified": true }, "additional_details": { "aml": { "total_hits": 0, "entity_type": "person", "is_adverse_media_fetched": false }, "liveness": { "method": "PASSIVE", "score": 0.98 }, "face_match": { "score": 0.95 } } }, { "session_id": "038ad62f-5ebd-46c2-afe9-4b2956bf687f", "session_kind": "user", "session_number": 719, "session_url": "https://verify.didit.me/session/7RGKiO6ioGH6", "portrait_image": null, "document_type": null, "full_name": null, "country": null, "status": "Not Started", "vendor_data": "your-user-id-124", "didit_internal_id": "eb4e679d-ca4b-461f-9685-687bac29ebdb", "created_at": "2026-06-09T08:02:23.343053Z", "features": [ { "feature": "ID_VERIFICATION", "status": "Not Finished" }, { "feature": "LIVENESS", "status": "Not Finished" }, { "feature": "FACE_MATCH", "status": "Not Finished" }, { "feature": "AML", "status": "Not Finished" }, { "feature": "IP_ANALYSIS", "status": "Not Finished" } ], "phone_number": null, "email_address": null, "additional_details": null } ] } }, "Mixed KYC + KYB (session_kind=all)": { "summary": "session_kind=all: una fila de KYC seguida de una fila de KYB", "value": { "count": 2, "next": null, "previous": null, "results": [ { "session_id": "5b3720ed-d429-42ef-b67f-37ea805f48ee", "session_kind": "user", "session_number": 720, "session_url": "https://verify.didit.me/session/CuXoBYCYVO5Y", "portrait_image": null, "document_type": "Identity Card", "full_name": "Jane Marie Doe", "country": "ESP", "status": "In Review", "vendor_data": "your-user-id-123", "didit_internal_id": "d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147", "created_at": "2026-06-09T12:26:54.328364Z", "features": [ { "feature": "ID_VERIFICATION", "status": "In Review" }, { "feature": "LIVENESS", "status": "Approved" } ], "phone_number": null, "email_address": null, "additional_details": { "liveness": { "method": "PASSIVE", "score": 0.98 } } }, { "session_id": "8a1f63c2-1b9e-4f3a-9c41-2f6a1f0b7d52", "session_kind": "business", "session_number": 42, "status": "Approved", "vendor_data": "your-company-id-77", "created_at": "2026-06-08T09:14:02.118450Z", "workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab", "workflow_type": "kyb", "workflow_label": "Standard KYB", "company_name": "Acme Holdings S.L.", "registration_number": "B12345678", "country": "ES" } ] } } } } } }, "301": { "description": "Redirección a la URL canónica con barra final. Se devuelve cuando la ruta de la solicitud es `/v3/sessions` (sin barra final); el encabezado `Location` apunta a `/v3/sessions/` y conserva la cadena de consulta. Los clientes GET normalmente la siguen de forma automática." }, "400": { "description": "Parámetro de consulta no válido. El cuerpo es un objeto cuyas claves son los parámetros erróneos.", "content": { "application/json": { "examples": { "Invalid session_kind": { "summary": "session_kind no es user/business/all", "value": { "session_kind": "Must be \"user\", \"business\", or \"all\"." } }, "Invalid date": { "summary": "date_from/date_to con formato incorrecto", "value": { "date_from": [ "Enter a valid date." ] } }, "Invalid didit_internal_id": { "summary": "didit_internal_id no es un UUID", "value": { "didit_internal_id": [ "Enter a valid UUID." ] } }, "Invalid api_service": { "summary": "api_service no está entre los valores permitidos", "value": { "api_service": [ "Select a valid choice. FOO is not one of the available choices." ] } } } } } }, "403": { "description": "Falta la clave de API, tiene un formato incorrecto o fue revocada. Si falta la clave, se devuelve `403`; si es incorrecta, fue revocada o expiró, se devuelve `401`.\n\n**Aplicación eliminada:** durante unos minutos después de eliminar una aplicación, una solicitud hecha con una de sus claves de API puede responder `{\"detail\": \"This application was deleted.\", \"code\": \"application_deleted\"}`. No vuelvas a intentarlo: la aplicación y sus claves de API ya no existen. Pasados esos minutos, la clave se rechaza como cualquier otra clave no válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You do not have permission to perform this action." }, "code": { "type": "string", "description": "Motivo legible por máquina, presente solo en algunos fallos. `application_deleted`: la clave de API pertenece a una aplicación que se eliminó.", "example": "application_deleted" } }, "required": [ "detail" ] }, "examples": { "Forbidden": { "summary": "x-api-key ausente o no válido", "value": { "detail": "You do not have permission to perform this action." } }, "ApplicationDeleted": { "summary": "Clave de API de una aplicación eliminada", "value": { "detail": "This application was deleted.", "code": "application_deleted" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -s 'https://verification.didit.me/v3/sessions/?status=Approved,In%20Review&date_from=2026-06-01&limit=20' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.sessions.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.sessions.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.ListAutoPaging(ctx, didit.SessionsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.sessions().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "sessions->list() as $item) {\n print_r($item);\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Sessions.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/session/{sessionId}/share/": { "post": { "summary": "Genera un token para compartir una sesión de verificación finalizada", "description": "Genera un JWT de corta duración que permite a una aplicación específica de Didit importar esta sesión finalizada. Úsalo junto con `POST /v3/session/import-shared/`.", "operationId": "post_v3_session_share", "x-didit-sdk": { "resource": "sessions", "method": "share", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "responses": { "200": { "description": "Token para compartir generado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "share_token": { "type": "string", "description": "JWT firmado con HS256. Pásalo tal cual como `share_token` a [`POST /v3/session/import-shared/`](/sessions-api/import-shared-session) en la aplicación de destino.", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." }, "for_application_id": { "type": "string", "format": "uuid", "description": "Devuelve el UUID de la aplicación de destino a la que está vinculado el token.", "example": "a5f3bca2-46e2-411e-90ef-a580900a57ee" }, "session_kind": { "type": "string", "enum": [ "user", "business" ], "description": "Si la sesión de origen es una sesión de Verificación de usuarios (KYC) o de Verificación de empresas (KYB)." } } }, "examples": { "User session": { "summary": "Compartir una sesión KYC", "value": { "share_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXNzaW9uX2lkIjoiMjBiYjNjM2ItNjE0Ni00MzlmLTg0YTQtYmQzMGQwMGFjNmEyIiwiZnJvbV9hcHBsaWNhdGlvbl9pZCI6ImRiZDIwZTM0LTQyZTktNGYyYy1iYTkxLWNmMDc2MjAxNmY2NCIsImZvcl9hcHBsaWNhdGlvbl9pZCI6ImE1ZjNiY2EyLTQ2ZTItNDExZS05MGVmLWE1ODA5MDBhNTdlZSIsImlhdCI6MTc1MzYzMDY2NiwiZXhwIjoxNzUzNjM0MjY2fQ.JJ9pNE_hqZsOtbR0XYZIWw4JzidjdEl279iUrsIkhGE", "for_application_id": "a5f3bca2-46e2-411e-90ef-a580900a57ee", "session_kind": "user" } }, "Business session": { "summary": "Compartir una sesión KYB", "value": { "share_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "for_application_id": "a5f3bca2-46e2-411e-90ef-a580900a57ee", "session_kind": "business" } } } } } }, "401": { "description": "Credenciales ausentes o no válidas. A diferencia de la mayoría de los endpoints v3, este endpoint se autentica mediante el decorador de permisos y devuelve `401` cuando no se presenta un token o una clave válidos.", "content": { "application/json": { "examples": { "Unauthorized": { "summary": "No autorizado", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "404": { "description": "No existe ninguna sesión con el `session_id` indicado en tu aplicación.", "content": { "application/json": { "examples": { "Not Found": { "summary": "Sesión no encontrada", "value": { "detail": "Not found." } } } } } }, "400": { "description": "Error de validación. Los errores de campo se agrupan por nombre de campo; el error de no finalizado llega bajo una clave `detail` (como array).", "content": { "application/json": { "examples": { "Wrong status": { "summary": "La sesión de origen no ha finalizado", "value": { "detail": [ "Only finished sessions (\"Approved\", \"Declined\", \"In Review\") can be shared." ] } }, "Target missing": { "summary": "La aplicación de destino no existe", "value": { "for_application_id": [ "Target application does not exist." ] } }, "Self-share": { "summary": "El destino es la aplicación que realiza la llamada", "value": { "for_application_id": [ "Cannot share a session with the same application." ] } }, "TTL bounds": { "summary": "ttl_in_seconds fuera de los límites", "value": { "ttl_in_seconds": [ "Ensure this value is greater than or equal to 60." ] } } } } } }, "403": { "description": "Las credenciales son válidas, pero no tienen el permiso `write:sessions` para esta aplicación.", "content": { "application/json": { "examples": { "No Permission": { "value": { "detail": "You do not have permission to perform this action." }, "summary": "Sin permiso" } } } } } }, "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sesión de verificación de origen para la que se emite un token.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "for_application_id" ], "properties": { "for_application_id": { "type": "string", "format": "uuid", "description": "UUID de la aplicación de Didit que canjeará el token. Debe existir, no debe estar eliminada y debe ser distinta de la aplicación que hace la llamada. Encuéntralo en la Business Console, en **Settings → Application**.", "example": "a5f3bca2-46e2-411e-90ef-a580900a57ee" }, "ttl_in_seconds": { "type": "integer", "description": "Duración del token, en segundos. Mínimo `60`, máximo `86400` (24 h). Valor predeterminado: `3600` (1 h).", "minimum": 60, "maximum": 86400, "default": 3600, "example": 3600 } } }, "example": { "for_application_id": "a5f3bca2-46e2-411e-90ef-a580900a57ee", "ttl_in_seconds": 7200 } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/share/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"for_application_id\": \"a5f3bca2-46e2-411e-90ef-a580900a57ee\",\n \"ttl_in_seconds\": 7200\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.share(\n \"11111111-2222-3333-4444-555555555555\",\n for_application_id=\"a5f3bca2-46e2-411e-90ef-a580900a57ee\",\n ttl_in_seconds=7200,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.share(\"11111111-2222-3333-4444-555555555555\", {\n for_application_id: \"a5f3bca2-46e2-411e-90ef-a580900a57ee\",\n ttl_in_seconds: 7200,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Share(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsShareParams{\n\tForApplicationID: \"a5f3bca2-46e2-411e-90ef-a580900a57ee\",\n\tTTLInSeconds: didit.Int(7200),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsShareParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().share(\"11111111-2222-3333-4444-555555555555\", SessionsShareParams.builder()\n .forApplicationId(\"a5f3bca2-46e2-411e-90ef-a580900a57ee\")\n .ttlInSeconds(7200L)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->share('11111111-2222-3333-4444-555555555555', [\n 'for_application_id' => 'a5f3bca2-46e2-411e-90ef-a580900a57ee',\n 'ttl_in_seconds' => 7200,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.share(\n \"11111111-2222-3333-4444-555555555555\",\n for_application_id: \"a5f3bca2-46e2-411e-90ef-a580900a57ee\",\n ttl_in_seconds: 7200\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ShareAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsShareParams\n{\n ForApplicationId = \"a5f3bca2-46e2-411e-90ef-a580900a57ee\",\n TtlInSeconds = 7200,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/import-shared/": { "post": { "summary": "Canjea un token compartido para clonar una sesión de verificación en tu aplicación", "description": "Canjea un token compartido para clonar una sesión de KYC o KYB en la aplicación que realiza la llamada, con un `session_id` nuevo. No es idempotente: un token se canjea una sola vez por receptor.", "operationId": "post_v3_session_import_shared", "x-didit-sdk": { "resource": "sessions", "method": "import_shared", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "responses": { "201": { "description": "Sesión clonada. El cuerpo es el payload de decisión V3 para ambos tipos, que se distinguen por `session_kind`: `\"user\"` (KYC), con bloques de funciones en forma de lista como `id_verifications`, `liveness_checks` y `aml_screenings`; `\"business\"` (KYB), con bloques como `registry_checks` y `key_people_checks`. Ambos incluyen `shared_from_session`, que es el `session_id` de la sesión original en la aplicación de origen. Con `trust_review: false`, el `status` de la sesión clonada se fuerza a `In Review`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionDecision" }, "examples": { "User session imported": { "summary": "Sesión de KYC clonada (truncada; en realidad incluye el payload completo de la decisión de V3)", "value": { "session_id": "11111111-2222-3333-4444-555555555555", "session_kind": "user", "shared_from_session": "99999999-8888-7777-6666-555555555555", "session_number": 43762, "session_url": null, "status": "In Review", "workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab", "vendor_data": "user-1", "created_at": "2026-05-17T08:42:11Z", "expires_at": "2026-05-24T08:42:11Z" } }, "Business session imported": { "summary": "Sesión de KYB clonada (truncada; en realidad incluye el payload completo de la decisión de KYB de V3)", "value": { "session_id": "22222222-3333-4444-5555-666666666666", "session_kind": "business", "shared_from_session": "88888888-7777-6666-5555-444444444444", "session_number": 982, "session_url": null, "status": "Approved", "workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab", "vendor_data": "company-1" } } } } } }, "400": { "description": "Error de validación (token no válido, expirado, con un destino incorrecto o que hace referencia a una sesión que ya no existe).", "content": { "application/json": { "examples": { "Invalid Share Token": { "summary": "JWT no válido", "value": { "share_token": [ "Invalid share token." ] } }, "Expired Share Token": { "summary": "Token con `exp` superado", "value": { "share_token": [ "Share token has expired." ] } }, "Wrong audience": { "summary": "Token no vinculado a esta aplicación", "value": { "share_token": [ "This token is not valid for this application." ] } }, "Original missing": { "summary": "La sesión de origen se eliminó", "value": { "share_token": [ "Original session does not exist." ] } } } } } }, "403": { "description": "Falta la clave de API (una clave incorrecta, revocada o expirada recibe `401`), o esta sesión de origen ya se importó en la aplicación que hace la llamada (un solo canje por receptor).", "content": { "application/json": { "examples": { "Forbidden": { "summary": "Prohibido", "value": { "detail": "You do not have permission to perform this action." } }, "Already imported": { "summary": "El origen ya se importó una vez", "value": { "detail": "This session has already been shared with your application." } } } } } }, "404": { "description": "`workflow_id` no pertenece a la aplicación que hace la llamada.", "content": { "application/json": { "examples": { "Workflow not found": { "summary": "Flujo desconocido", "value": { "detail": "Workflow does not exist for this application." } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "share_token", "trust_review", "workflow_id" ], "properties": { "share_token": { "type": "string", "description": "Token JWT para compartir emitido por [`POST /v3/session/{sessionId}/share/`](/sessions-api/share-session).", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." }, "trust_review": { "type": "boolean", "description": "Si es `true`, la sesión clonada conserva el `status` final de la sesión de origen. Si es `false`, se fuerza a `In Review`.", "example": false }, "workflow_id": { "type": "string", "format": "uuid", "description": "UUID de un flujo de la aplicación que hace la llamada. Los ID de otras aplicaciones se rechazan con `404`.", "example": "9f9b1234-aaaa-bbbb-cccc-1234567890ab" }, "vendor_data": { "type": "string", "nullable": true, "description": "Valor opcional que sustituye el `vendor_data` de la sesión clonada.", "example": "user-1" } } }, "example": { "share_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "trust_review": false, "workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab", "vendor_data": "user-1" } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/session/import-shared/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"share_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"trust_review\": false,\n \"workflow_id\": \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n \"vendor_data\": \"user-1\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.import_shared(\n share_token=\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n trust_review=False,\n workflow_id=\"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n vendor_data=\"user-1\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.importShared({\n share_token: \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n trust_review: false,\n workflow_id: \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n vendor_data: \"user-1\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ImportShared(ctx, didit.SessionsImportSharedParams{\n\tShareToken: \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n\tTrustReview: false,\n\tWorkflowID: \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n\tVendorData: didit.String(\"user-1\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsImportSharedParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().importShared(SessionsImportSharedParams.builder()\n .shareToken(\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\")\n .trustReview(false)\n .workflowId(\"9f9b1234-aaaa-bbbb-cccc-1234567890ab\")\n .vendorData(\"user-1\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->importShared([\n 'share_token' => 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',\n 'trust_review' => false,\n 'workflow_id' => '9f9b1234-aaaa-bbbb-cccc-1234567890ab',\n 'vendor_data' => 'user-1',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.import_shared(\n share_token: \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n trust_review: false,\n workflow_id: \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n vendor_data: \"user-1\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ImportSharedAsync(new SessionsImportSharedParams\n{\n ShareToken = \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n TrustReview = false,\n WorkflowId = \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n VendorData = \"user-1\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/kyb/search/": { "post": { "summary": "Búsqueda de empresas en el registro KYB (independiente)", "operationId": "post_v3_kyb_search", "x-didit-sdk": { "resource": "kyb", "method": "search", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [], "description": "Busca empresas candidatas en los registros oficiales de empresas por nombre y/o número de registro. Este es el paso 1 del flujo de registro en dos pasos: **search** devuelve candidatos ligeros y, después, `POST /v3/kyb/select/` obtiene el perfil completo de un candidato.\n\n**Facturación de la búsqueda.** Las búsquedas correctas que usan una fuente de datos de empresas de pago cuestan USD 0.50 por solicitud, sin importar el número de candidatos. No se cobran los resultados vacíos, los fallos ni los resultados que solo provienen de otras fuentes. El precio aplicable se reserva antes de buscar; si el saldo es insuficiente, se devuelve 403 con el código `insufficient_credits`. Se aplican las tarifas contractuales cuando se hayan acordado, y si la tarifa de búsqueda del contrato no está configurada, se devuelve 403. Las búsquedas en sandbox son gratuitas. Repetir una búsqueda correcta puede generar otro cargo; la entrega del callback no añade ningún cargo. La obtención del perfil se factura por separado. Esta tarifa de búsqueda también se aplica a v2. Los candidatos siempre se devuelven con `fetch_status: \"pending\"`: los datos completos de la empresa solo se obtienen (y se facturan) al seleccionar.\n\n**`kyb_response_id` es efímero.** Es un identificador por búsqueda, no un id estable de la empresa. Selecciona poco después de buscar y vuelve a buscar para obtener un identificador nuevo en lugar de almacenarlo.\n\n**`tier` elige la cadena de proveedores.** `tier` indica el nivel de registro en el que se ejecuta la búsqueda: `basic` (el valor predeterminado, la cadena Lite), `shareholders` o `ubo`. La búsqueda usa la cadena de proveedores que atiende ese nivel, y no siempre es la misma cadena que consulta la búsqueda Lite, por lo que una búsqueda Lite vacía no demuestra que el registro no contenga la empresa: vuelve a buscar en el nivel que necesites. En un país que no ofrece el nivel que indicas, se busca en el nivel más alto que ofrezca hasta ese. Obtén el candidato desde el endpoint que vende ese nivel: `POST /v3/kyb/select/` (Lite), `POST /v3/kyb/shareholders/` o `POST /v3/kyb/ubo/`.\n\n**Autenticación.** `POST /v3/kyb/search/` (y `/v2/`) recibe la clave de API de tu aplicación en el encabezado `x-api-key`. El `POST /v1/kyb/search/` alojado es la ruta autenticada por sesión a la que llama un flujo de verificación alojado: responde `403` a una clave de API y no acepta `tier`; la configuración de registro KYB del flujo elige la cadena.\n\n**Dos modos.**\n- *Síncrono (predeterminado):* la API consulta el registro hasta que la búsqueda se resuelve y devuelve la lista final de candidatos (`search_resolved: true`).\n- *Asíncrono:* pasa `webhook_url` y la API responde de inmediato (normalmente con `search_status: \"pending\"` y una lista de candidatos vacía) y luego envía por POST un callback `kyb.registry_search.resolved` a tu URL cuando el registro termina. El cuerpo del callback es `{\"event_id\", \"event_type\": \"kyb.registry_search.resolved\", \"request_id\", \"vendor_data\", \"metadata\", \"search_status\", \"search_resolved\", \"kyb_registry\", \"timestamp\", \"created_at\"}` (ten en cuenta que `timestamp` y `created_at` en el callback son enteros de tiempo epoch, a diferencia del `created_at` en formato ISO de este endpoint) y se envía **sin firmar** (encabezado `X-Didit-Unsigned-Callback: true`, sin `X-Signature`).\n\n**Códigos de país.** ISO 3166-1 alfa-2 (`GB`, `DE`), además de códigos de subdivisión `XX-YY` donde los registros son regionales, por ejemplo, `US-CA` para California.\n\n**Sandbox.** Las claves de aplicaciones de sandbox devuelven un único candidato estático sin contactar con ningún registro.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "country_code" ], "properties": { "country_code": { "type": "string", "maxLength": 10, "description": "Código ISO 3166-1 alfa-2 del país en cuyo registro de empresas se busca. Por ejemplo, `GB`. Cuando los registros de empresas funcionan a nivel de estado o provincia, añade el código de subdivisión ISO 3166-2 con el formato `XX-YY`: `US-CA` busca en el registro de California. Las búsquedas en Estados Unidos siempre requieren la subdivisión: un `US` sin subdivisión se rechaza. No distingue mayúsculas y minúsculas; se normaliza a mayúsculas.", "example": "GB" }, "name": { "type": "string", "maxLength": 255, "description": "Nombre de la empresa que se va a buscar. Se requiere `name` o `registration_number`.", "example": "Tesco" }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro que se buscará en el registro. Se requiere `name` o `registration_number`." }, "tier": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "default": "basic", "description": "Nivel de registro cuya cadena de proveedores usa esta búsqueda. `basic` (predeterminado) busca en la cadena Lite del país; `shareholders` y `ubo` buscan en la cadena de propiedad de ese nivel, que puede ser una fuente distinta, por lo que una búsqueda Lite vacía no demuestra que la empresa no figure en el registro. En un país que no ofrece el nivel indicado, la búsqueda se hace en el nivel más alto que ofrezca hasta ese. Obtén el candidato desde el endpoint que vende el nivel en el que buscaste: `POST /v3/kyb/select/` (Lite), `POST /v3/kyb/shareholders/` o `POST /v3/kyb/ubo/`.", "example": "basic" }, "search_type": { "type": "string", "enum": [ "contains" ], "default": "contains", "description": "Estrategia de coincidencia de nombres que aplica la búsqueda en el registro. `contains` es el único valor aceptado: ninguna fuente de registro detrás de la búsqueda ofrece un modo por prefijo o aproximado, por lo que `start_with` y `fuzzy` se rechazan con `400` (`not a valid choice`)." }, "vendor_data": { "type": "string", "description": "Tu identificador de esta consulta; se devuelve en la respuesta y se incluye en el callback del webhook." }, "metadata": { "type": "object", "nullable": true, "description": "JSON libre; se devuelve en la respuesta y se incluye en el callback del webhook." }, "webhook_url": { "type": "string", "format": "uri", "maxLength": 500, "description": "Cambia la búsqueda al modo asíncrono: la API responde de inmediato y envía mediante POST un callback `kyb.registry_search.resolved` sin firmar a esta URL cuando la lista de candidatos está lista." } } }, "example": { "country_code": "GB", "name": "Tesco", "search_type": "contains", "vendor_data": "company-1234" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/kyb/search/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"country_code\": \"GB\",\n \"name\": \"Tesco\",\n \"search_type\": \"contains\",\n \"vendor_data\": \"company-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.kyb.search(\n country_code=\"GB\",\n name=\"Tesco\",\n search_type=\"contains\",\n vendor_data=\"company-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.kyb.search({\n country_code: \"GB\",\n name: \"Tesco\",\n search_type: \"contains\",\n vendor_data: \"company-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.KYB.Search(ctx, didit.KYBSearchParams{\n\tCountryCode: \"GB\",\n\tName: didit.String(\"Tesco\"),\n\tSearchType: didit.Some(didit.KYBSearchParamsSearchType(\"contains\")),\n\tVendorData: didit.String(\"company-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.KybSearchParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.kyb().search(KybSearchParams.builder()\n .countryCode(\"GB\")\n .name(\"Tesco\")\n .searchType(KybSearchParams.SearchType.of(\"contains\"))\n .vendorData(\"company-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "kyb->search([\n 'country_code' => 'GB',\n 'name' => 'Tesco',\n 'search_type' => 'contains',\n 'vendor_data' => 'company-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.kyb.search(\n country_code: \"GB\",\n name: \"Tesco\",\n search_type: \"contains\",\n vendor_data: \"company-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Kyb.SearchAsync(new KybSearchParams\n{\n CountryCode = \"GB\",\n Name = \"Tesco\",\n SearchType = new KybSearchParamsSearchType(\"contains\"),\n VendorData = \"company-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Búsqueda aceptada. El modo síncrono devuelve la lista de candidatos resuelta; el modo webhook responde de inmediato (a menudo con `search_status: \"pending\"`) y entrega la lista final mediante el callback `kyb.registry_search.resolved`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Con `webhook_url`: el id persistido de la solicitud de búsqueda, que se devuelve como `request_id` en el callback `kyb.registry_search.resolved`. Sin `webhook_url`: un UUID de correlación transitorio (la búsqueda no se almacena)." }, "kyb_registry": { "$ref": "#/components/schemas/KYBRegistrySearchResults" }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste." }, "metadata": { "type": "object", "nullable": true, "description": "Devuelve el `metadata` que enviaste." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved search": { "summary": "Modo síncrono: lista final de candidatos", "value": { "request_id": "0c7e9a40-3a13-4f7e-8a44-9d2e2f1c5b6a", "kyb_registry": { "companies": [ { "kyb_response_id": "69aeeb95febb0f1704042259", "name": "Tesco PLC", "registration_number": "00445790", "status": "active", "type": "Public Limited Company", "risk_level": null, "fetch_status": "pending" }, { "kyb_response_id": "69aeeb95febb0f170404225a", "name": "E-TESCO LTD", "registration_number": "15168476", "status": "active", "type": "Private Limited Company", "risk_level": null, "fetch_status": "pending" } ], "pagination": { "total": 2, "page": 1, "per_page": 25 }, "search_status": "resolved", "search_resolved": true }, "vendor_data": "company-1234", "metadata": null, "created_at": "2026-06-11T10:40:00.000000+00:00" } }, "Pending search (webhook mode)": { "summary": "Se proporcionó `webhook_url`: los candidatos llegan mediante el callback kyb.registry_search.resolved", "value": { "request_id": "5f2d8c1b-7e4a-4b9c-9f0d-3a6e8c2b1d4f", "kyb_registry": { "companies": [], "pagination": { "total": 0, "page": 1, "per_page": 25 }, "search_status": "pending", "search_resolved": false }, "vendor_data": "company-1234", "metadata": { "source": "onboarding" }, "created_at": "2026-06-11T10:41:00.000000+00:00" } } } } } }, "400": { "description": "Error de validación. Los problemas a nivel de campo usan el envoltorio estándar de DRF; la regla de nombre/número de registro informa en `non_field_errors`. Un país que los registros no cubren responde `400` con `code: kyb_registry_country_unsupported`.", "content": { "application/json": { "examples": { "Missing search criteria": { "summary": "No se proporcionó ni `name` ni `registration_number`", "value": { "non_field_errors": [ "Either 'name' or 'registration_number' is required." ] } }, "Invalid country_code": { "summary": "Debe ser `XX` (alpha-2) o una subdivisión `XX-YY`", "value": { "country_code": [ "country_code must be a 2-letter ISO code." ] } }, "Invalid search_type": { "summary": "Solo se acepta `contains`", "value": { "search_type": [ "\"start_with\" is not a valid choice." ] } }, "Invalid webhook_url": { "summary": "`webhook_url` debe ser una URL válida", "value": { "webhook_url": [ "Enter a valid URL." ] } }, "Country not covered": { "summary": "Ningún registro de empresas cubre el país", "value": { "detail": "Company registry search is not available for this country. Enter the company details manually to continue.", "code": "kyb_registry_country_unsupported" } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key`; una clave incorrecta, revocada o expirada devuelve `401`. Si falta la clave, se devuelve `403` con `{\"detail\": ...}`; una clave incorrecta, revocada o expirada devuelve `401`. También se devuelve antes de la búsqueda cuando no se puede cubrir la tarifa de búsqueda aplicable (`code: \"insufficient_credits\"`) o cuando falta una tarifa de búsqueda en el contrato.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Límite de solicitudes superado o cupo de búsquedas agotado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API, con los encabezados `X-RateLimit-*` y `Retry-After`. Por separado, las búsquedas de pago en registros están limitadas a 600 por aplicación por hora: a partir de ese número, la respuesta es `429` con `code: kyb_registry_search_limit_reached`, y las búsquedas atendidas solo por fuentes gratuitas siguen funcionando. Espera y vuelve a buscar más tarde.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } }, "Search allowance spent": { "summary": "Más de 600 búsquedas de pago en la última hora", "value": { "detail": "The maximum number of company registry searches for this session has been reached. Enter the company details manually to continue.", "code": "kyb_registry_search_limit_reached" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string" } } } } } }, "502": { "description": "El proveedor de registros KYB no está disponible temporalmente: el registro de origen devolvió una respuesta 5xx, agotó el tiempo de espera o falló la conexión. La búsqueda no se factura. Vuelve a intentarlo más tarde o, en el flujo de verificación alojado de Didit, al usuario se le ofrece automáticamente introducir la empresa manualmente en lugar de un error que solo permite reintentar.", "content": { "application/json": { "examples": { "Registry provider outage": { "summary": "El proveedor del registro no respondió a la búsqueda", "value": { "detail": "The KYB registry provider is temporarily unavailable. Please try again shortly.", "code": "kyb_registry_provider_unavailable" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string" } } } } } } } } }, "/v3/kyb/select/": { "post": { "summary": "Selección de empresa en el registro KYB: nivel Lite (independiente)", "operationId": "post_v3_kyb_select", "x-didit-sdk": { "resource": "kyb", "method": "select", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [], "description": "Obtén el perfil de registro **Lite** de un candidato devuelto por `POST /v3/kyb/search/`: datos de la empresa, domicilio social, identificadores, estado, actividad y directivos, además del payload sin procesar del registro. Los accionistas y los beneficiarios finales últimos se venden mediante `POST /v3/kyb/shareholders/` y `POST /v3/kyb/ubo/`.\n\n**Emparejamiento con la búsqueda.** Pasa el `kyb_response_id` del candidato exactamente como lo devolvió una búsqueda de la misma aplicación. El identificador es efímero y está vinculado a esa búsqueda: selecciónalo sin demora y, en lugar de almacenarlo, vuelve a buscar para obtener uno nuevo.\n\n**Facturación.** Cada selección se factura al precio Lite del país (cualquier tarifa de búsqueda es aparte); consulta [Precios del registro KYB](/es/getting-started/kyb-registry-pricing). El saldo se comprueba antes de cualquier llamada al registro (`403` si no es suficiente) y el cargo se registra en la sesión de empresa creada.\n\n**La persistencia es obligatoria.** Cada selección crea una sesión de empresa (su id es el `request_id`) para poder hacer seguimiento de la facturación y la recuperación; aparece en la consola. `save_api_request` se acepta por simetría, pero debe ser `true` (el valor predeterminado): enviar `false` devuelve `400`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KYBRegistryCandidateRequest" }, "example": { "kyb_response_id": "69aeeb95febb0f1704042259", "vendor_data": "company-1234" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/kyb/select/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"kyb_response_id\": \"69aeeb95febb0f1704042259\",\n \"vendor_data\": \"company-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.kyb.select(\n kyb_response_id=\"69aeeb95febb0f1704042259\",\n vendor_data=\"company-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.kyb.select({\n kyb_response_id: \"69aeeb95febb0f1704042259\",\n vendor_data: \"company-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.KYB.Select(ctx, didit.KYBRegistryCandidateRequest{\n\tKYBResponseID: \"69aeeb95febb0f1704042259\",\n\tVendorData: didit.String(\"company-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.KYBRegistryCandidateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.kyb().select(KYBRegistryCandidateRequest.builder()\n .kybResponseId(\"69aeeb95febb0f1704042259\")\n .vendorData(\"company-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "kyb->select([\n 'kyb_response_id' => '69aeeb95febb0f1704042259',\n 'vendor_data' => 'company-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.kyb.select(\n kyb_response_id: \"69aeeb95febb0f1704042259\",\n vendor_data: \"company-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Kyb.SelectAsync(new KYBRegistryCandidateRequest\n{\n KybResponseId = \"69aeeb95febb0f1704042259\",\n VendorData = \"company-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Empresa obtenida y facturada. `kyb_registry` contiene el perfil completo; revisa `data_resolved`: cuando es `false`, el registro de empresas aún estaba procesando la solicitud y el registro guardado se completa automáticamente en cuanto se resuelve.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sesión de empresa creada para esta consulta. El registro almacenado (visible en la consola) se sigue actualizando si el registro de empresas responde después de la respuesta." }, "registry_tier_requested": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "El nivel que vende este endpoint: `basic` (Lite) para países seleccionados, `shareholders`, `ubo`." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "El nivel realmente entregado y facturado. Es inferior al solicitado cuando los registros del país no contienen datos de propiedad o cuando el registro no tiene ningún registro de propiedad para esta empresa." }, "kyb_registry": { "type": "object", "description": "Perfil completo de la empresa en el registro.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID de Didit de este registro de empresa." }, "node_id": { "type": "string", "example": "feature_kyb_registry" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review" ], "description": "Evaluación de Didit de la comprobación en el registro (p. ej., `In Review` cuando la empresa no está activa en el registro o no se pudieron derivar los datos de propiedad)." }, "registry_status": { "type": "string", "nullable": true, "enum": [ "active", "dissolved", "deregistered", "see full details", "authorised", "appointed representative", "unauthorised", "inactive", "no longer authorised", "closed", "struck off" ], "description": "Estado normalizado de la empresa según lo informa el registro." }, "data_resolved": { "type": "boolean", "description": "`true` una vez que el registro de empresas devolvió el perfil completo. `false` cuando el registro de empresas seguía procesando tras el sondeo: los datos almacenados se completan automáticamente cuando el registro de empresas lo resuelve." }, "company_name": { "type": "string", "example": "Tesco PLC" }, "registration_number": { "type": "string", "nullable": true, "example": "00445790" }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2.", "example": "GB" }, "region": { "type": "string", "nullable": true, "description": "Código de subdivisión cuando el registro es regional (p. ej., `CA` para `US-CA`); vacío en caso contrario." }, "company_type": { "type": "string", "nullable": true, "example": "Public Limited Company" }, "incorporation_date": { "type": "string", "format": "date", "nullable": true, "example": "1947-11-27" }, "registered_address": { "type": "string", "nullable": true, "example": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA" }, "tax_number": { "type": "string", "nullable": true, "example": "GB412 8925 93" }, "risk_level": { "type": "string", "nullable": true, "description": "Nivel de riesgo según el registro, cuando está disponible." }, "verification_status": { "type": "string", "nullable": true, "description": "Estado de verificación en el registro, cuando está disponible." }, "is_from_registry": { "type": "boolean", "description": "Siempre `true` en este endpoint: el perfil se obtuvo de un registro oficial." }, "fetch_status": { "type": "string", "enum": [ "pending", "resolved" ], "description": "Ciclo de vida de la consulta al registro. Se refleja en `data_resolved`." }, "alternative_names": { "type": "string", "nullable": true, "description": "Nombres alternativos, comerciales, anteriores o en el idioma original de la empresa, como texto, cuando se informan." }, "nature_of_business": { "type": "string", "nullable": true, "description": "Descripción de la actividad o código de clasificación, cuando se informa." }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Importe decimal como cadena, cuando se informa." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Código ISO 4217, cuando se informa." }, "website": { "type": "string", "nullable": true, "example": "https://www.tesco.com/" }, "email": { "type": "string", "nullable": true, "example": "customer.service@tesco.co.uk" }, "phone": { "type": "string", "nullable": true, "example": "03301231688" }, "legal_entity_identifier": { "type": "string", "nullable": true, "description": "LEI, cuando se informa." }, "location_of_registration": { "type": "string", "nullable": true, "description": "Registro o jurisdicción en la que está inscrita la empresa, cuando se indica." }, "vat_number": { "type": "string", "nullable": true, "description": "Número de IVA de la UE, cuando se recopila durante el paso de registro alojado o se edita después. En el momento de la selección normalmente todavía no está definido: la validación del IVA y de la identificación fiscal se ejecuta cuando el usuario final envía el paso de registro en el flujo alojado." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Resultado de validar el número de IVA o, si no lo hay, el `tax_number`, al enviar al registro. `valid` / `invalid`: lo decide el registro oficial del país (VIES de la UE, Noruega, Suiza, Brasil, Colombia, Costa Rica, Ecuador, Paraguay; Polonia también mediante su registro nacional de IVA). `format_valid` / `invalid_format`: lo deciden las reglas de formato y dígito de control del país cuando no se puede consultar ningún registro. `could_not_validate`: el registro no estaba disponible. `not_applicable`: no hay número, el país no tiene registro ni reglas, o es una sesión de sandbox." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "El número que se comprobó, tal como lo conoce la fuente (por ejemplo, el número de IVA derivado de un SIREN francés o de un RSIN neerlandés). `null` cuando no se realizó ninguna comprobación." }, "vat_validation_source": { "type": "string", "nullable": true, "enum": [ "eu_vies", "pl_vat_white_list", "no_brreg", "ch_uid_register", "br_receita_federal", "co_rues", "cr_hacienda", "ec_sri", "py_dnit", "format_rules", null ], "description": "La fuente que determinó `vat_validation_status`: un registro oficial o `format_rules`. `null` cuando no se ejecutó ninguna comprobación." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Nombre registrado en la fuente que validó el número, cuando la fuente lo revela. Solo se informa cuando el estado es `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Dirección registrada en la fuente que validó el número, cuando esta la facilita. Solo se establece cuando el estado es `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de tiempo de la comprobación. `null` cuando no se ejecutó ninguna comprobación." }, "financial_summary": { "type": "object", "nullable": true, "description": "Detalles de acciones y capital según el registro (moneda, total de acciones, clases de acciones), cuando están disponibles." }, "officers": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "example": "MELISSA BETHELL" }, "designation": { "type": "string", "nullable": true, "description": "Designación del registro sin procesar (p. ej., `Director`, `Secretary`)." }, "role": { "type": "string", "description": "Rol normalizado derivado del cargo. Conjunto completo del modelo de 17 valores; el análisis del registro en este endpoint suele devolver director, non_executive_director, secretary, chairman o company_officer.", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "company_officer", "settlor", "protector", "investor", "other" ] }, "nationality": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "description": "`false` cuando el registro marca el nombramiento como dimitido." }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending" ], "description": "Estado de una sesión KYC asociada, cuando se inició una para este directivo. `null` en caso contrario." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "URL de verificación de la sesión de KYC asociada, si existe." }, "first_name": { "type": "string", "nullable": true, "description": "Nombre de pila cuando el registro lo indica explícitamente; no se deduce del nombre completo." }, "last_name": { "type": "string", "nullable": true, "description": "Apellido, cuando el registro lo indica explícitamente." }, "address": { "type": "string", "nullable": true, "description": "Dirección del directivo según el registro." }, "appointment_date": { "type": "string", "nullable": true, "description": "Fecha en que se nombró al cargo.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Fecha en que terminó el nombramiento, cuando se informa.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Fecha de nacimiento completa según el registro. Es null cuando solo se conoce el año o el mes de nacimiento.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Año de nacimiento según el registro, incluso cuando la fecha completa no está disponible." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Mes de nacimiento según el registro. Null cuando solo se conoce el año." } } }, "description": "Directores, secretarios y otros administradores extraídos del registro." }, "beneficial_owners": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Si el propietario es una persona física o una persona jurídica." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles normalizados (por ejemplo, `ubo`, `shareholder`)." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Límite inferior de la franja de propiedad informada por el registro (por ejemplo, `25%`)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Límite superior del rango de propiedad informado por el registro." }, "is_active": { "type": "boolean" }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending" ] }, "kyc_session_url": { "type": "string", "nullable": true }, "effective_ownership_percent": { "type": "number", "nullable": true, "description": "Porcentaje de propiedad analizado (límite máximo, con el límite mínimo como alternativa)." }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "country_of_birth": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "designation": { "type": "string", "nullable": true }, "voting_min_shares": { "type": "string", "nullable": true }, "voting_max_shares": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "nullable": true, "description": "Fecha de nacimiento completa, cuando se informa.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Fecha de nombramiento, cuando se informa.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } }, "description": "Beneficiarios finales / personas con control significativo extraídos del registro. Puede estar vacío cuando el registro no expone la propiedad." }, "addresses": { "type": "array", "nullable": true, "description": "Todas las direcciones que indica el registro, con una única forma canónica. Es null si no indica ninguna.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "Las actividades en las que el registro clasifica a la empresa, con una única forma canónica. Es null cuando no indica ninguna.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Fechas de presentación ante el registro, cuando están disponibles. Las declaraciones anuales y las juntas generales usan last_annual_return_date y last_agm_date; son distintas de las cuentas financieras." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "description": "Siempre `null` en este endpoint (lo usa el flujo de KYB alojado cuando los usuarios finales editan los datos del registro)." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Siempre `null` en este endpoint." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Se establece cuando un revisor de la consola edita el registro más adelante." }, "is_editable": { "type": "boolean", "description": "Si los datos procedentes del registro aún se pueden editar en el flujo alojado o en la consola." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "Igual que `registry_tier_delivered` del nivel superior." }, "registry_ownership_status": { "type": "string", "nullable": true, "enum": [ "not_requested", "delivered", "not_held", "unavailable" ], "description": "`delivered` cuando se recibieron los datos de propiedad, `not_held` cuando el registro de propiedad respondió y no incluye esta empresa (consulta `registry_data.ownership_error`), `unavailable` cuando se solicitó un nivel con propiedad pero el registro no tenía datos de esta empresa o no se pudo consultar (consulta `registry_data.ownership_error`), `not_requested` en el nivel Lite." }, "ownership": { "$ref": "#/components/schemas/KYBRegistryOwnership" }, "registry_tier": { "type": "string", "nullable": true, "description": "El nivel de registro que solicitó el flujo: `basic`, `shareholders` o `ubo`. También en `ownership.tier_requested`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "El monitor de registro más reciente de la empresa, o `null` si no existe ninguno.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "unavailable_reason": { "type": "string", "nullable": true }, "enrolled_at": { "type": "string", "format": "date-time", "nullable": true }, "cancelled_at": { "type": "string", "format": "date-time", "nullable": true }, "last_bill_date": { "type": "string", "format": "date", "nullable": true }, "next_bill_date": { "type": "string", "format": "date", "nullable": true }, "last_event_at": { "type": "string", "format": "date-time", "nullable": true }, "events_count": { "type": "integer" }, "watched_fields": { "description": "Los campos de la empresa que vigila el monitor." } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste." }, "metadata": { "type": "object", "nullable": true, "description": "Devuelve el `metadata` que enviaste." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved company": { "summary": "Perfil completo del registro (lista de cargos truncada por brevedad)", "value": { "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e", "kyb_registry": { "uuid": "f1e2d3c4-b5a6-4789-9c0d-1e2f3a4b5c6d", "node_id": "feature_kyb_registry", "status": "In Review", "registry_status": "active", "data_resolved": true, "company_name": "Tesco PLC", "registration_number": "00445790", "country_code": "GB", "region": "", "company_type": "Public Limited Company", "incorporation_date": "1947-11-27", "registered_address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA", "tax_number": "GB412 8925 93", "risk_level": "low risk", "verification_status": "verified", "is_from_registry": true, "fetch_status": "resolved", "alternative_names": "TESCO STORES (HOLDINGS) PUBLIC LIMITED COMPANY", "nature_of_business": null, "registered_capital": null, "registered_capital_amount": null, "registered_capital_currency": null, "website": "https://www.tesco.com/", "email": "customer.service@tesco.co.uk", "phone": "03301231688", "legal_entity_identifier": null, "location_of_registration": null, "financial_summary": { "currency": "Pound (£)", "total_number_of_shares": "8174378721", "meta_detail": { "Class_Of_Share": "Ordinary" } }, "officers": [ { "uuid": "a1b2c3d4-e5f6-4789-9a0b-1c2d3e4f5a6b", "name": "CHRISTOPHER JON TAYLOR", "designation": "Secretary", "role": "secretary", "nationality": null, "is_active": true, "kyc_status": null, "kyc_session_url": null }, { "uuid": "b2c3d4e5-f6a7-4890-8b1c-2d3e4f5a6b7c", "name": "MELISSA BETHELL", "designation": "Director", "role": "director", "nationality": "British", "is_active": true, "kyc_status": null, "kyc_session_url": null } ], "beneficial_owners": [], "addresses": [ { "address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA", "type": "legal_entity_registry_address", "description": "registered office address" } ], "industries": null, "accounts": { "last_account": "26 February 2025", "next_account": "26 February 2026", "due_by_date": "26 August 2026" }, "registry_data": {}, "user_provided_data": null, "confirmed_by_user_at": null, "last_console_edit_at": null, "is_editable": true }, "vendor_data": "company-1234", "metadata": null, "created_at": "2026-06-11T10:45:00.000000+00:00" } }, "Pending (registry still resolving)": { "summary": "La selección siguió pendiente tras el sondeo: campos incompletos, se completa automáticamente en el servidor", "value": { "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e", "kyb_registry": { "uuid": "7c0a4f7e-2b1d-4f6a-9c3e-8d5b2a1f0e9d", "node_id": "feature_kyb_registry", "status": "Not Finished", "registry_status": null, "data_resolved": false, "company_name": "Tesco PLC", "registration_number": "00445790", "country_code": "GB", "region": null, "company_type": null, "incorporation_date": null, "registered_address": null, "tax_number": null, "risk_level": null, "verification_status": null, "is_from_registry": true, "fetch_status": "pending", "alternative_names": null, "nature_of_business": null, "registered_capital": null, "registered_capital_amount": null, "registered_capital_currency": null, "website": null, "email": null, "phone": null, "legal_entity_identifier": null, "location_of_registration": null, "financial_summary": {}, "officers": [], "beneficial_owners": [], "addresses": null, "industries": null, "accounts": null, "registry_data": {}, "user_provided_data": null, "confirmed_by_user_at": null, "last_console_edit_at": null, "is_editable": true }, "vendor_data": "company-1234", "metadata": null, "created_at": "2026-06-11T10:45:00.000000+00:00" } } } } } }, "400": { "description": "Error de validación. Los problemas a nivel de campo usan el envoltorio estándar de DRF. Un país que los registros no cubren responde `400` con `code: kyb_registry_country_unsupported`.", "content": { "application/json": { "examples": { "Missing kyb_response_id": { "summary": "`kyb_response_id` es obligatorio", "value": { "kyb_response_id": [ "This field is required." ] } }, "save_api_request=false rejected": { "summary": "Las selecciones siempre se guardan", "value": { "save_api_request": [ "KYB registry select must be saved so billing and retrieval can be tracked." ] } }, "Country not covered": { "summary": "Ningún registro de empresas cubre el país", "value": { "detail": "Company registry search is not available for this country. Enter the company details manually to continue.", "code": "kyb_registry_country_unsupported" } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key` y también cuando el saldo de la organización que realiza la llamada no la cubre; una clave incorrecta, revocada o expirada devuelve `401`. Si falta la clave, se devuelve `403` con `{\"detail\": ...}`; una clave incorrecta, revocada o expirada devuelve `401`. La falta de créditos devuelve `403` con `{\"error\": ...}` antes de que se realice cualquier análisis o llamada a un proveedor.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de la organización no cubre la llamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } } } }, "/v3/passive-liveness/": { "post": { "summary": "Prueba de vida pasiva", "description": "Detecta ataques de presentación (fotos impresas, reproducciones en pantalla, máscaras, deepfakes) a partir de una sola imagen facial. No requiere vídeo, movimiento ni interacción del usuario.\n\n**Cómo funciona.** Un modelo biométrico analiza la imagen: evalúa el rostro más grande detectado y calcula una puntuación de prueba de vida (`score`, 0–100). `status` es `Declined` cuando se activa cualquier advertencia con severidad `error`:\n- `NO_FACE_DETECTED`: el modelo de prueba de vida no encontró ningún rostro,\n- `LOW_LIVENESS_SCORE`: puntuación igual o inferior a `face_liveness_score_decline_threshold` (por defecto `30`),\n- `LIVENESS_FACE_ATTACK`: el modelo detectó un ataque de presentación,\n- `FACE_IN_BLOCKLIST` / `POSSIBLE_FACE_IN_BLOCKLIST`: el rostro coincide con una entrada de tu lista de bloqueo de rostros.\n\n`MULTIPLE_FACES_DETECTED` es una señal de severidad `warning` (no rechaza), y `DUPLICATED_FACE` / `POSSIBLE_DUPLICATED_FACE` son señales de severidad `information` que indican que el mismo rostro ya apareció en otra sesión aprobada (nunca rechazan). `face_quality` y `face_luminance` (0–100, pueden ser null) describen la calidad de la captura.\n\n**Lista de bloqueo y detección de duplicados.** Se ejecuta en **cada** llamada, con o sin `save_api_request`, comparando el rostro detectado con el índice de búsqueda facial de tu aplicación. Los rostros previos con el mismo `vendor_data` se excluyen de toda la búsqueda en el índice. Por eso, volver a ejecutar la prueba de vida para el mismo usuario no activa `DUPLICATED_FACE`, y un rostro de la lista de bloqueo que provenga de una sesión con el mismo `vendor_data` del llamante tampoco se marca (la comprobación `FACE_IN_BLOCKLIST` se omite para los rostros con el mismo `vendor_data`).\n\n**Facturación.** Cada respuesta `200` consume un crédito de la API de prueba de vida pasiva (se paga con el crédito de tu plan o con tu saldo de recarga). Si el saldo es insuficiente, se devuelve `403` antes de procesar ninguna imagen.\n\n**Persistencia de la sesión e inscripción del rostro (`save_api_request`, por defecto `true`).** Cuando es `true`, la llamada se guarda como una sesión de tipo API (Business Console, `GET /v3/session/{sessionId}/decision/` mediante el `request_id` devuelto, webhook `status.updated`), se almacenan la imagen de referencia y el recorte del rostro, y el rostro detectado se **inscribe en tu índice de búsqueda facial** para que las llamadas posteriores a Búsqueda facial y las comprobaciones de duplicados puedan encontrarlo. Cuando es `false`, la llamada es puntual: no se almacena nada y el rostro no se inscribe (la comprobación de lista de bloqueo y de duplicados se sigue ejecutando).\n\n**Sandbox.** Con las claves de API de sandbox no hay procesamiento ni facturación: tras validar la solicitud (una entrada mal formada sigue devolviendo `400`), el endpoint devuelve un payload simulado estático `Approved`, no se guarda ninguna sesión y no se consumen créditos.\n\n**Autenticación.** Envía la clave de API de tu aplicación en el encabezado `x-api-key`. Si las credenciales faltan o no son válidas, se devuelve `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`): esta API nunca devuelve `401`.\n\n**Límite de solicitudes.** Hay un presupuesto de escritura compartido de 300 solicitudes/min por clave de API para todos los endpoints POST/PATCH/DELETE; si lo superas, se devuelve `429`.", "operationId": "post_v3passive-liveness", "x-didit-sdk": { "resource": "passive_liveness", "method": "check", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "user_image" ], "properties": { "user_image": { "type": "string", "format": "binary", "description": "Imagen frontal del rostro (p. ej., una selfie). Extensiones permitidas: `tiff`, `jpg`, `jpeg`, `png`, `webp`. Tamaño máximo de carga: **5 MB** (los archivos más grandes se rechazan con `400`). Las imágenes se comprimen automáticamente a ~0.5 MB antes del procesamiento, por lo que las resoluciones muy altas no mejoran la precisión. La imagen debe contener una sola persona: cuando hay varios rostros, se evalúa el más grande y se añade una advertencia `MULTIPLE_FACES_DETECTED`." }, "face_liveness_score_decline_threshold": { "type": "number", "format": "float", "default": 30, "minimum": 0, "maximum": 100, "description": "Umbral de puntuación de la prueba de vida (0–100). Una puntuación calculada **igual o inferior** a este valor emite una advertencia `LOW_LIVENESS_SCORE` y establece `status` en `Declined`. El valor predeterminado es `30`; súbelo para una postura antisuplantación más estricta. Los valores fuera de 0–100 devuelven `400`.", "example": 30 }, "rotate_image": { "type": "boolean", "default": false, "description": "Si es `true`, el servicio prueba rotaciones de 90 grados de la entrada y usa la orientación que ofrece la mejor detección facial. Útil cuando falta la orientación EXIF. Añade latencia.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Si es `true` (valor predeterminado), guarda la llamada como una sesión de tipo API, almacena las imágenes faciales, emite un webhook `status.updated` y registra el rostro detectado en tu índice de búsqueda facial. Si es `false`, la llamada es puntual: no se almacena nada y el rostro no se registra. Las comprobaciones de lista de bloqueo y de duplicados se ejecutan en ambos casos.", "example": true }, "vendor_data": { "type": "string", "description": "Identificador opaco opcional (tu ID de usuario, correo electrónico, UUID…) que se guarda en la sesión persistida y se devuelve. También se usa para excluir de la comprobación de rostro duplicado las sesiones anteriores con el mismo `vendor_data`, de modo que reverificar al mismo usuario no genere `DUPLICATED_FACE`.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objeto JSON opcional que se almacena con la sesión (cuando `save_api_request=true`) y se devuelve. En solicitudes multipart, envíalo como un campo de cadena codificado en JSON: se convierte en un objeto.", "example": { "flow": "withdrawal" } } } }, "example": { "user_image": "(binary JPEG/PNG selfie)", "face_liveness_score_decline_threshold": 30, "rotate_image": false, "save_api_request": true, "vendor_data": "user-123", "metadata": { "flow": "withdrawal" } } } } }, "responses": { "200": { "description": "Prueba de vida pasiva completada. `liveness.score` es la confianza del modelo, de 0 a 100, de que la imagen muestra a una persona real; `status` es `Approved` salvo que se haya activado una advertencia de severidad `error`. Un rostro suplantado o incluido en la lista de bloqueo sigue devolviendo `200`: revisa `liveness.status` y `liveness.warnings`, no solo el código HTTP. Cuando `save_api_request=true`, `request_id` es el ID de la sesión guardada.", "content": { "application/json": { "examples": { "Approved": { "summary": "Rostro real — sin advertencias", "value": { "request_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "liveness": { "status": "Approved", "method": "PASSIVE", "score": 95.0, "user_image": { "entities": [ { "bbox": [ 661, 728, 1688, 2188 ], "confidence": 0.732973, "age": 26.91, "gender": "male", "race": null } ], "best_angle": 0 }, "warnings": [], "face_quality": 84.21, "face_luminance": 50.33 }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T01:04:42.763237+00:00" } }, "Declined - presentation attack": { "summary": "El modelo detectó una suplantación (impresión, reproducción, máscara…)", "value": { "request_id": "f1c8c9b2-d3e4-4f5a-9b8c-7d6e5f4a3b2c", "liveness": { "status": "Declined", "method": "PASSIVE", "score": 12.5, "user_image": { "entities": [ { "bbox": [ 100, 120, 420, 540 ], "confidence": 0.81, "age": 30.1, "gender": "female", "race": null } ], "best_angle": 0 }, "warnings": [ { "risk": "LOW_LIVENESS_SCORE", "feature": "LIVENESS", "additional_data": null, "log_type": "error", "short_description": "Low liveness score", "long_description": "The liveness check resulted in a low score, indicating potential use of non-live facial representations or poor-quality biometric data." }, { "risk": "LIVENESS_FACE_ATTACK", "feature": "LIVENESS", "additional_data": null, "log_type": "error", "short_description": "Liveness Face Attack", "long_description": "The system detected a potential attempt to bypass the liveness check." } ], "face_quality": 72.4, "face_luminance": 48.2 }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T01:04:42.763237+00:00" } }, "Declined - face on blocklist": { "summary": "Rostro real, pero coincide con una entrada de la lista de bloqueo", "value": { "request_id": "0b54a1de-22aa-4e0f-9c84-5a2b1f3c4d5e", "liveness": { "status": "Declined", "method": "PASSIVE", "score": 93.75, "user_image": { "entities": [ { "bbox": [ 40, 40, 100, 100 ], "confidence": 0.722082, "age": 27.0, "gender": "male", "race": null } ], "best_angle": 0 }, "warnings": [ { "risk": "FACE_IN_BLOCKLIST", "feature": "LIVENESS", "additional_data": { "blocklisted_session_id": "882c42d5-8a4d-4d20-8080-a22f57822c86", "blocklisted_session_number": 3242, "api_service": null }, "log_type": "error", "short_description": "Face in blocklist", "long_description": "The system identified a face in the blocklist, which means the face is not allowed to be verified." } ], "face_quality": null, "face_luminance": null }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T01:04:42.763237+00:00" } } }, "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sesión guardada cuando `save_api_request=true` (se puede usar con `GET /v3/session/{sessionId}/decision/`); en caso contrario, un UUID de correlación temporal." }, "liveness": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Declined` cuando se activó al menos una advertencia de gravedad `error` (ningún rostro, puntuación baja, ataque de presentación o coincidencia en la lista de bloqueo); `Approved` en caso contrario. Las entradas `warning`/`information` (varios rostros, duplicados) nunca provocan un rechazo por sí solas." }, "method": { "type": "string", "enum": [ "PASSIVE" ], "description": "Siempre `PASSIVE` para este endpoint." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Confianza de la prueba de vida (0–100, dos decimales) de que la imagen muestra a una persona real y no una suplantación. `null` cuando el modelo no devolvió ninguna confianza.", "example": 95.0 }, "user_image": { "type": "object", "description": "Resultados de la detección facial de la imagen enviada.", "properties": { "entities": { "type": "array", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Cuadro delimitador del rostro detectado, en coordenadas de píxeles `[x_min, y_min, x_max, y_max]` de la imagen procesada.", "example": [ 661, 728, 1688, 2188 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Confianza de la detección facial (0–1).", "example": 0.732973 }, "age": { "type": "number", "format": "float", "description": "Edad del rostro detectado estimada por el modelo, en años. Solo es informativa: no afecta a la decisión de prueba de vida.", "example": 26.91 }, "gender": { "type": "string", "description": "Género del rostro detectado predicho por el modelo (`male` o `female`). Solo es informativo.", "example": "male" }, "race": { "type": "string", "nullable": true, "description": "Campo reservado: siempre es `null` en las respuestas de este endpoint.", "example": null } } }, "description": "Una entrada por rostro detectado. El rostro más grande es el que se evalúa." }, "best_angle": { "type": "integer", "nullable": true, "description": "Rotación (en grados) que produjo la mejor detección facial; solo es distinta de cero cuando `rotate_image=true` corrigió la orientación.", "example": 0 } } }, "warnings": { "type": "array", "description": "Señales de riesgo. Gravedad `error` (rechazan): `NO_FACE_DETECTED`, `LOW_LIVENESS_SCORE` (puntuación igual o inferior al umbral), `LIVENESS_FACE_ATTACK`, `FACE_IN_BLOCKLIST`, `POSSIBLE_FACE_IN_BLOCKLIST`. Gravedad `warning` (revisión, sin rechazo): `MULTIPLE_FACES_DETECTED`. Gravedad `information` (sin rechazo): `DUPLICATED_FACE`, `POSSIBLE_DUPLICATED_FACE`: el mismo rostro ya apareció en otra sesión aprobada.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "NO_FACE_DETECTED", "LOW_LIVENESS_SCORE", "LIVENESS_FACE_ATTACK", "MULTIPLE_FACES_DETECTED", "FACE_IN_BLOCKLIST", "POSSIBLE_FACE_IN_BLOCKLIST", "DUPLICATED_FACE", "POSSIBLE_DUPLICATED_FACE" ], "description": "Código de riesgo legible por máquina." }, "feature": { "type": "string", "enum": [ "LIVENESS" ], "description": "Función que emitió la advertencia. En este endpoint siempre es `LIVENESS`." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "`null` para la mayoría de las advertencias. Las coincidencias con la lista de bloqueo incluyen `{blocklisted_session_id, blocklisted_session_number, api_service}`; las coincidencias de duplicados incluyen `{duplicated_session_id, duplicated_session_number, api_service}`, que apuntan a la sesión coincidente." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravedad. Las advertencias `error` llevan `status` a `Declined`; las entradas `warning` e `information` son informativas y nunca rechazan por sí solas." }, "short_description": { "type": "string", "description": "Resumen legible del riesgo en una línea." }, "long_description": { "type": "string", "description": "Explicación legible del riesgo." } } } }, "face_quality": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Puntuación de la calidad de captura del rostro detectado, normalizada de 0 a 100. `null` cuando el modelo no pudo producir un valor fiable.", "example": 84.21 }, "face_luminance": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Brillo del rostro detectado, normalizado de 0 a 100. `null` cuando no está disponible.", "example": 50.33 } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste, o `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Devuelve el objeto `metadata` que enviaste, o `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de tiempo ISO 8601 (UTC) del momento en que se generó la respuesta, p. ej., `2026-06-12T01:04:42.763237+00:00`." } } } } } }, "400": { "description": "Error de validación. Se devuelve cuando falta `user_image`, supera los 5 MB, tiene una extensión no admitida o no se puede decodificar la imagen en el servidor, o cuando una opción está fuera de rango. Los errores de campo usan el formato `{field: [messages]}` de DRF; los fallos de decodificación de imagen usan `{\"error\": ...}`.", "content": { "application/json": { "examples": { "Missing image": { "summary": "`user_image` no incluido en los datos del formulario", "value": { "user_image": [ "No file was submitted." ] } }, "Invalid image format": { "summary": "Extensión permitida, pero el contenido de la imagen no se puede decodificar", "value": { "error": "Invalid user image format.", "code": "invalid_image" } }, "Unsupported file extension": { "summary": "Extensión de archivo distinta de tiff/jpg/jpeg/png/webp", "value": { "user_image": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp." ] } }, "File too large": { "summary": "El archivo supera el límite de 5 MB", "value": { "user_image": [ "File size should not exceed 5 MB" ] } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key` y también cuando el saldo de la organización que realiza la llamada no la cubre; una clave incorrecta, revocada o expirada devuelve `401`. Si falta la clave, se devuelve `403` con `{\"detail\": ...}`; una clave incorrecta, revocada o expirada devuelve `401`. La falta de créditos devuelve `403` con `{\"error\": ...}` antes de que se procese ninguna imagen.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de la organización no cubre la llamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/passive-liveness/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'user_image=@./selfie.jpg' \\\n -F 'face_liveness_score_decline_threshold=30' \\\n -F 'save_api_request=true' \\\n -F 'vendor_data=user-123'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.passive_liveness.check(\n user_image=open(\"user_image.jpg\", \"rb\"),\n face_liveness_score_decline_threshold=30.0,\n rotate_image=False,\n save_api_request=True,\n vendor_data=\"user-123\",\n metadata={\"flow\": \"withdrawal\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.passiveLiveness.check({\n user_image: await fileFromPath(\"user_image.jpg\"),\n face_liveness_score_decline_threshold: 30.0,\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"withdrawal\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.PassiveLiveness.Check(ctx, didit.PassiveLivenessCheckParams{\n\tUserImage: didit.FileFromPath(\"user_image.jpg\"),\n\tFaceLivenessScoreDeclineThreshold: didit.Float(30.0),\n\tRotateImage: didit.Bool(false),\n\tSaveAPIRequest: didit.Bool(true),\n\tVendorData: didit.String(\"user-123\"),\n\tMetadata: didit.Some(map[string]any{\"flow\": \"withdrawal\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.PassiveLivenessCheckParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.passiveLiveness().check(PassiveLivenessCheckParams.builder()\n .userImage(Path.of(\"user_image.jpg\"))\n .faceLivenessScoreDeclineThreshold(30.0)\n .rotateImage(false)\n .saveApiRequest(true)\n .vendorData(\"user-123\")\n .metadata(Map.of(\"flow\", \"withdrawal\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "passiveLiveness->check([\n 'user_image' => File::fromPath('user_image.jpg'),\n 'face_liveness_score_decline_threshold' => 30.0,\n 'rotate_image' => false,\n 'save_api_request' => true,\n 'vendor_data' => 'user-123',\n 'metadata' => ['flow' => 'withdrawal'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.passive_liveness.check(\n user_image: Pathname(\"user_image.jpg\"),\n face_liveness_score_decline_threshold: 30.0,\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"withdrawal\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.PassiveLiveness.CheckAsync(new PassiveLivenessCheckParams\n{\n UserImage = FileUpload.FromPath(\"user_image.jpg\"),\n FaceLivenessScoreDeclineThreshold = 30.0,\n RotateImage = false,\n SaveApiRequest = true,\n VendorData = \"user-123\",\n Metadata = new Dictionary { [\"flow\"] = \"withdrawal\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/database-validation/": { "post": { "summary": "Validación de base de datos (independiente)", "operationId": "post_v3database-validation", "x-didit-sdk": { "resource": "database_validation", "method": "validate", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [], "description": "Valida los datos de identidad de una persona contra fuentes oficiales gubernamentales y registrales: CPF en Brasil, RENAPER en Argentina, registros de DNI en España y Perú, INE en México y más de 100+ servicios adicionales en más de 60+ países.\n\n**Selección de servicios.** Cada país ofrece uno o más servicios del catálogo, identificados por un `service_id` (por ejemplo, `bra_cpf`, `arg_renaper`, `pan_cedula_sib`). Fija los servicios que quieres con el array `services`. Si lo omites, se ejecuta exactamente **un** servicio predeterminado (el servicio activo con más trayectoria para el país). Enviar `services` también cambia la respuesta al formato extendido con `services_used` y `match_score`. Consulta los servicios, sus campos obligatorios y sus precios mediante `GET /v1/organization/database-validation-countries/` (un endpoint de catálogo no documentado en esta especificación) o en el editor de flujos de la Business Console. Algunos servicios están marcados con `requires_consent=true` en el catálogo y exigen `consent=true`. Otros requieren un onboarding para tu organización antes de poder llamarlos.\n\n**Campos de entrada.** `identification_number` es un campo universal que se asigna automáticamente al campo específico del país que corresponda (consulta su descripción). Las reglas de formato de cada país se aplican antes de llamar a cualquier proveedor (por ejemplo, el CPF de BRA debe tener exactamente 11 dígitos), y los errores de formato nunca se facturan. Los servicios biométricos necesitan subir una `selfie` (solo multipart). RENAPER de Argentina además requiere `gender`.\n\n**Resultados.** Cada servicio devuelve un mapa `validation` campo por campo, además de un `outcome_code` independiente del proveedor (`MATCH`, `PARTIAL_MATCH`, `NO_MATCH`, `DOCUMENT_NOT_FOUND`, `INVALID_DOCUMENT_FORMAT`, `INVALID_INPUT`, `MINOR_BLOCKED`, `DECEASED`, `BIOMETRIC_NO_MATCH`, `BIOMETRIC_IMAGE_UNUSABLE`, `INCONCLUSIVE`, `DOCUMENT_SUPERSEDED`, `REGISTRY_UNAVAILABLE`, `REGISTRY_ERROR`). Ten en cuenta las diferencias: `NO_MATCH` es una no coincidencia definitiva; `INCONCLUSIVE` significa que el registro no pudo confirmar en ningún sentido (revisar, no rechazar), y `BIOMETRIC_IMAGE_UNUSABLE` es un problema técnico de la selfie (repetirla), a diferencia del definitivo `BIOMETRIC_NO_MATCH`. El `match_type` global agrega los resultados de todos los servicios (cualquier coincidencia total → `full_match`; si no, cualquier coincidencia parcial → `partial_match`; si no, `no_match`), y `no_match_action`/`partial_match_action` lo traducen al `status` final. `validation_type` se deriva: `two_by_two` cuando dos o más servicios distintos produjeron una coincidencia total (en el número de identificación, en el nombre completo y la fecha de nacimiento juntos, o en la dirección sin contradicciones); en caso contrario, `one_by_one`.\n\n**Persistencia.** `save_api_request` es **true** de forma predeterminada: el resultado se almacena como una sesión (`request_id` funciona con `GET /v3/session/{sessionId}/decision/`), aparece en la consola y dispara un webhook `status.updated`. También controla el formato de `validations`: objetos por servicio cuando se guarda, y un mapa combinado `{field: match}` cuando no.\n\n**Facturación.** Por servicio: cada servicio que devuelve un resultado facturable se cobra a su propio precio de catálogo. Los servicios fallidos u omitidos no se facturan, y las solicitudes rechazadas con `400` no cuestan nada. La comprobación previa del saldo cubre la suma de los precios de los servicios seleccionados (`403` si no alcanza).\n\n**Errores.** Cuando ningún servicio seleccionado devuelve un resultado utilizable, la API devuelve `400` con `validation_errors` si todos los intentos sin respuesta rechazaron explícitamente la entrada (`provider_rejected_input`, `retryable: false`). Corrige la entrada antes de volver a intentarlo. En caso contrario, devuelve `502` con `validation_errors` (`empty_provider_response`, `retryable: true`), lo que incluye casos mixtos de entrada rechazada e intentos alternativos no disponibles; no se factura nada (aun así, se registra una sesión con el estado `Not Finished` cuando `save_api_request=true`). Cuando solo fallan algunos servicios, la respuesta `200` incluye sus errores en `database_validation.errors`.\n\n**Sandbox.** Las claves de aplicaciones de sandbox omiten las llamadas a los registros y la facturación, y devuelven una respuesta estática `full_match`. El payload de sandbox siempre incluye `services_used` y `match_score: 100`, independientemente de cómo se haya enviado `services`, así que no valides con respuestas de sandbox la activación condicional del formato extendido ni la fracción 0.0–1.0 de `match_score` del entorno de producción.\n\nEnvía la solicitud como `application/json`, o como `multipart/form-data` cuando subas una `selfie`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "issuing_state" ], "properties": { "issuing_state": { "type": "string", "description": "Código de país ISO 3166-1 **alfa-3** del registro contra el que se valida (p. ej. `BRA`, `ESP`, `COL`). Determina qué servicios están disponibles. Los códigos no admitidos devuelven `400` con la lista completa de opciones válidas.", "example": "BRA" }, "services": { "type": "array", "items": { "type": "string" }, "description": "`service_id` del catálogo que se ejecutarán para este país (p. ej., `[\"bra_cpf\"]`). También acepta una sola cadena o una cadena separada por comas o codificada en JSON. **Si se omite o está vacío, se ejecuta exactamente un servicio predeterminado**: el servicio activo más consolidado del país; los servicios más recientes, biométricos y de pago por uso deben indicarse explícitamente. Enviar `services` cambia la respuesta al formato extendido (añade `services_used` y `match_score`). Cada id debe existir y estar activo para el `issuing_state`; los servicios que requieren onboarding devuelven `400` hasta que se activen para tu organización. Consulta los servicios disponibles por país mediante `GET /v1/organization/database-validation-countries/` (un endpoint de catálogo no documentado en esta especificación) o el editor de flujos de la Business Console.", "example": [ "bra_cpf" ] }, "validation_type": { "type": "string", "deprecated": true, "description": "OBSOLETO. Se acepta por compatibilidad con versiones anteriores, pero se ignora: el `validation_type` de la respuesta ahora se deriva de cuántos servicios obtuvieron una coincidencia total. Usa `services` para fijar servicios concretos." }, "consent": { "type": "boolean", "default": false, "description": "Establécelo en `true` cuando el usuario final haya dado su consentimiento explícito para los servicios de validación seleccionados. Obligatorio para los servicios marcados con `requires_consent=true` en el catálogo: sin él, esos servicios devuelven `400` con `services_requiring_consent`." }, "identification_number": { "type": "string", "description": "Número de identificación universal: se asigna automáticamente al campo específico del país correcto, por lo que puedes usarlo en lugar de `personal_number`/`tax_number`/`document_number`: ARG→document_number (DNI), BOL→document_number (CI), BRA→tax_number (CPF, 11 dígitos), CHL→personal_number (RUT), COL→personal_number (Cédula), CRI→personal_number (Cédula), DOM→personal_number (Cédula, 11 dígitos), ECU→personal_number (Cédula, 10 dígitos), ESP→personal_number (DNI/NIE), GTM→document_number (DPI), HND→document_number (DNI), MEX→personal_number (CURP, 18 caracteres), PAN→personal_number (Cédula), PER→personal_number (DNI, 8 dígitos), PRY→document_number (CI), SLV→document_number (DUI), URY→personal_number (CI), VEN→document_number (Cédula). Nunca sobrescribe un campo específico del país proporcionado explícitamente." }, "first_name": { "type": "string", "description": "El nombre de pila de la persona. Obligatorio en algunos servicios o países.", "example": "John" }, "last_name": { "type": "string", "description": "El apellido de la persona. Obligatorio en algunos servicios o países.", "example": "Doe" }, "middle_name": { "type": "string", "description": "Segundo nombre, utilizado por algunos servicios nacionales (AUS, NZL, …)." }, "full_name": { "type": "string", "description": "Nombre completo: algunos servicios lo aceptan en lugar del nombre y el apellido (p. ej., los servicios de CHN, que comparan el nombre en escritura nativa)." }, "date_of_birth": { "type": "string", "format": "date", "description": "Fecha de nacimiento, `YYYY-MM-DD`. Muchos servicios la exigen.", "example": "1980-01-01" }, "personal_number": { "type": "string", "description": "Identificador personal único emitido por el gobierno. Lo usan: CHL (RUT), COL (Cédula), CRI, DOM, ECU, ESP (DNI/NIE), MEX (CURP), PAN (Cédula), PER (DNI), URY. Considera usar `identification_number` en su lugar." }, "tax_number": { "type": "string", "description": "Número de identificación fiscal. Lo usa: BRA (CPF, 11 dígitos). Considera usar `identification_number` en su lugar." }, "document_number": { "type": "string", "description": "Número de documento. Lo usan: ARG (DNI), BOL (CI), GTM (DPI), HND (DNI), PRY (CI), SLV (DUI), VEN (Cédula). Considera usar `identification_number` en su lugar." }, "document_type": { "type": "string", "enum": [ "P", "DL", "ID", "RP", "SSC", "HIC", "WP", "TC", "VISA", "PSC", "BC", "OTHER" ], "description": "Tipo de documento que se valida: `P` pasaporte, `DL` licencia de conducir, `ID` documento nacional de identidad, `RP` permiso de residencia (además de `SSC`, `HIC`, `WP`, `TC`, `VISA`, `PSC`, `BC`, `OTHER`). Lo exigen algunos servicios (p. ej., ESP)." }, "expiration_date": { "type": "string", "format": "date", "description": "Fecha de caducidad del documento, `YYYY-MM-DD`. Obligatoria para la validación de ESP (España).", "example": "2030-01-15" }, "date_of_issue": { "type": "string", "format": "date", "description": "Fecha de expedición del documento, `YYYY-MM-DD` (fecha de expedición). Obligatoria para la validación de la cédula de COL (Colombia).", "example": "2015-06-20" }, "nationality": { "type": "string", "description": "Nacionalidad en formato ISO 3166-1 alfa-3. Algunos servicios la exigen." }, "gender": { "type": "string", "enum": [ "M", "F", "X" ], "description": "Género: `M`, `F` o `X` (otro/desconocido). Obligatorio para la validación RENAPER de Argentina (`arg_renaper`)." }, "address": { "description": "Dirección de residencia. Es preferible el objeto estructurado `{\"street_1\":\"123 Main St\",\"street_2\":\"Apt 4B\",\"city\":\"Springfield\",\"region\":\"IL\",\"postal_code\":\"62701\",\"country\":\"US\"}`; se sigue aceptando una cadena completa en una sola línea. Obligatoria para los servicios de verificación de dirección; cuando un servicio define requisitos de dirección, las partes que falten devuelven `400` con `address_fields_required_by`.", "oneOf": [ { "type": "object", "properties": { "street_1": { "type": "string" }, "street_2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" } } }, { "type": "string", "description": "Dirección completa en una sola línea (formato heredado)." } ] }, "address_element_1": { "type": "string", "description": "Dirección de la calle, incluidos el número y el tipo de vía. Si se omite, se deriva de `address`." }, "address_element_2": { "type": "string", "description": "Apartamento, unidad, edificio, planta o línea adicional de la dirección. Envíalo solo cuando lo tengas de forma explícita." }, "address_element_3": { "type": "string", "description": "Ciudad, barrio, distrito, localidad o vecindario. Si se omite, se obtiene de `address`." }, "address_element_4": { "type": "string", "description": "Estado, provincia, región o localidad. Si se omite, se deriva de `address`." }, "address_element_5": { "type": "string", "description": "Código postal. Se acepta `postal_code` como alias." }, "postal_code": { "type": "string", "description": "Código postal para servicios basados en la dirección (alias de `address_element_5`)." }, "driver_license_number": { "type": "string", "description": "Número de licencia de conducir para los servicios gubernamentales de verificación de documentos (AUS, NZL, IND)." }, "driver_license_card_number": { "type": "string", "description": "Número de la tarjeta física de la licencia de conducir, cuando se exige por separado del número de licencia (AUS)." }, "driver_license_state": { "type": "string", "description": "Estado o territorio de expedición de la licencia de conducir (AUS)." }, "driver_license_version": { "type": "string", "description": "Código de versión de la licencia de conducir (NZL)." }, "passport_number": { "type": "string", "description": "Número de pasaporte para los servicios gubernamentales de verificación de pasaportes (AUS, NZL, IND, CHN)." }, "passport_expiration_date": { "type": "string", "format": "date", "description": "Fecha de caducidad del pasaporte, `YYYY-MM-DD`, para los servicios de verificación de pasaportes." }, "passport_file_number": { "type": "string", "description": "Número de expediente del pasaporte (IND)." }, "passport_issue_country": { "type": "string", "description": "País emisor del pasaporte (ISO 3166-1 alpha-3) para los servicios de verificación de pasaportes." }, "medicare_card_number": { "type": "string", "description": "Número de tarjeta Medicare (AUS)." }, "immi_card_number": { "type": "string", "description": "Número de la ImmiCard australiana." }, "immi_card_expiry_date": { "type": "string", "format": "date", "description": "Fecha de caducidad de la ImmiCard australiana." }, "citizenship_certificate_number": { "type": "string", "description": "Número del certificado de ciudadanía (AUS)." }, "birth_registration_number": { "type": "string", "description": "Número de registro del certificado de nacimiento (AUS)." }, "birth_registration_date": { "type": "string", "format": "date", "description": "Fecha de registro del certificado de nacimiento (AUS)." }, "birth_registration_state": { "type": "string", "description": "Estado de registro del certificado de nacimiento (AUS)." }, "marriage_certificate_number": { "type": "string", "description": "Número del certificado de matrimonio (AUS)." }, "change_of_name_certificate_number": { "type": "string", "description": "Número de certificado de cambio de nombre (AUS)." }, "first_partner_name": { "type": "string", "description": "Nombre de la pareja en un certificado de matrimonio (AUS)." }, "last_partner_name": { "type": "string", "description": "Apellido de la pareja en un certificado de matrimonio (AUS)." }, "voter_id": { "type": "string", "description": "Número de registro electoral (IND EPIC, IRL)." }, "epic_card": { "type": "string", "description": "Número de la tarjeta electoral EPIC de India." }, "pan": { "type": "string", "description": "PAN (Permanent Account Number) de India." }, "national_id": { "type": "string", "description": "Número de documento nacional de identidad (CHN, MYS, KEN, KHM, NGA, ZAF, …)." }, "cic": { "type": "string", "description": "Código de Identificación de Credencial (CIC) del INE/IFE de México, de 9 dígitos. Lo utiliza el servicio de vigencia de la credencial del INE de México (`mex_ine_vigencia`)." }, "identificador_ciudadano": { "type": "string", "description": "Identificador del Ciudadano del INE de México (9 dígitos). Se usa con `cic` para los modelos modernos del INE (E/F/G/H) en `mex_ine_vigencia`." }, "ocr": { "type": "string", "description": "Número OCR del INE de México (13 dígitos, en el reverso de la credencial). Se usa con `cic` para el Modelo D en `mex_ine_vigencia`." }, "voter_number": { "type": "string", "description": "Clave de Elector del INE de México (18 caracteres). Se usa con `emission_number` para los modelos antiguos del IFE (A/B/C) en `mex_ine_vigencia`." }, "emission_number": { "type": "string", "description": "Número de Emisión del INE de México. Se usa con `voter_number` para los modelos antiguos del IFE (A/B/C) en `mex_ine_vigencia`." }, "bvn": { "type": "string", "description": "Número de Verificación Bancaria (BVN) de Nigeria." }, "bank_card_number": { "type": "string", "description": "Número de tarjeta bancaria (verificación de tarjeta bancaria de CHN)." }, "company_registration_number": { "type": "string", "description": "Número de registro de la empresa tal como lo emite el registro mercantil: el CNPJ en Brasil (p. ej., `11222333000181`) y el número de registro en Sudáfrica (p. ej., `1936/007721/06`). Lo requieren los servicios de registro de empresas y de directores de empresas (`bra_company_registry`, `bra_company_directors`, `zaf_company_registry`, `zaf_company_directors`)." }, "company_name": { "type": "string", "description": "Razón social registrada, cotejada con la inscripción en el registro. Opcional para `zaf_company_registry`." }, "initials": { "type": "string", "description": "Las iniciales de la persona tal como aparecen impresas en el documento. Obligatorio para `zaf_drivers_license`; se acepta para `zaf_bank_account_holder`." }, "licence_number": { "type": "string", "description": "Número de licencia de conducir tal como figura impreso en la tarjeta, para `zaf_drivers_license`. Si se omite, se usa `document_number`." }, "refugee_file_number": { "type": "string", "description": "Número de expediente de refugiado emitido por el Department of Home Affairs de Sudáfrica. Obligatorio para `zaf_refugee`." }, "bank_name": { "type": "string", "description": "Nombre del banco donde está la cuenta. Obligatorio para `zaf_bank_account_holder`." }, "bank_account_number": { "type": "string", "description": "Número de cuenta bancaria. Obligatorio para `zaf_bank_account_holder`; aceptado por `zaf_fraud_prevention`." }, "account_type": { "type": "string", "description": "Tipo de cuenta bancaria para `zaf_bank_account_holder`: `current`, `savings`, `transmission`, `subscriptionShare` o `notKnown`, sin distinguir entre mayúsculas y minúsculas. Cualquier otro valor devuelve `400`. Omítelo cuando no conozcas el tipo: en ese caso, la comprobación cruzada del tipo de cuenta se indica como no confirmada." }, "phone_number": { "type": "string", "description": "Número de móvil de contacto, para los servicios que verifican la posibilidad de contacto (`zaf_bank_account_holder`, `zaf_fraud_prevention`, `zaf_refugee`)." }, "right_thumb": { "type": "string", "description": "Huella dactilar del pulgar derecho codificada en base64 para `zaf_dha_fingerprint_match`, junto con `left_thumb` o por sí sola." }, "left_thumb": { "type": "string", "description": "Huella dactilar del pulgar izquierdo codificada en base64 para `zaf_dha_fingerprint_match`, junto con `right_thumb` o por sí sola." }, "score_level": { "type": "integer", "description": "Nivel mínimo de puntuación biométrica para `zaf_criminal_face_screening`. El valor predeterminado es `3`." }, "max_matches": { "type": "integer", "description": "Número máximo de coincidencias candidatas que devuelve `zaf_criminal_face_screening`. El valor predeterminado es `1`." }, "vehicle_register_number": { "type": "string", "description": "Número de registro del vehículo. Obligatorio, junto con `vehicle_licence_plate` y `vin`, para `zaf_vehicle_ownership`." }, "vehicle_licence_plate": { "type": "string", "description": "Número de matrícula (placa) del vehículo. Obligatorio, junto con `vehicle_register_number` y `vin`, para `zaf_vehicle_ownership`." }, "vin": { "type": "string", "description": "Número de identificación del vehículo (VIN o número de chasis). Obligatorio, junto con `vehicle_register_number` y `vehicle_licence_plate`, para `zaf_vehicle_ownership`." }, "ssn": { "type": "string", "description": "Número de la Seguridad Social (EE. UU.)." }, "phone": { "type": "string", "description": "Número de teléfono para los servicios de verificación de teléfono." }, "landline": { "type": "string", "description": "Número de teléfono fijo para los servicios de verificación de teléfono." }, "email": { "type": "string", "format": "email", "description": "Dirección de correo electrónico para los servicios de verificación de identidad." }, "country_of_residence": { "type": "string", "description": "País de residencia en formato ISO 3166-1 alfa-2. Lo usan los servicios globales de enriquecimiento de identidad (p. ej. `glb_identity_enrichment`) para acotar la consulta.", "example": "US" }, "partial_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "NO_ACTION", "description": "Qué efecto tiene un `partial_match` en `database_validation.status`. Por defecto, `NO_ACTION` (el estado sigue siendo `Approved`, con una advertencia)." }, "no_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Qué efecto tiene un `no_match` en `database_validation.status`. Por defecto, `DECLINE`." }, "save_api_request": { "type": "boolean", "default": true, "description": "Guarda la validación como una sesión (visible en la consola, en el endpoint de decisión y en el webhook `status.updated`). También cambia la forma de `validations` en la respuesta: objetos por servicio cuando es `true` (valor predeterminado) y un mapa de campos combinado cuando es `false`." }, "vendor_data": { "type": "string", "description": "Tu identificador del usuario validado; se devuelve en la respuesta y se almacena con la sesión." }, "metadata": { "type": "object", "nullable": true, "description": "JSON libre que se guarda con la solicitud y se devuelve en la respuesta." } } }, "example": { "issuing_state": "BRA", "services": [ "bra_cpf" ], "identification_number": "12345678900", "first_name": "John", "last_name": "Doe", "date_of_birth": "1980-01-01", "vendor_data": "user-1234" } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "issuing_state" ], "properties": { "issuing_state": { "type": "string", "description": "Código de país ISO 3166-1 **alfa-3** del registro contra el que se valida (p. ej. `BRA`, `ESP`, `COL`). Determina qué servicios están disponibles. Los códigos no admitidos devuelven `400` con la lista completa de opciones válidas.", "example": "BRA" }, "services": { "type": "array", "items": { "type": "string" }, "description": "`service_id` del catálogo que se ejecutarán para este país (p. ej., `[\"bra_cpf\"]`). También acepta una sola cadena o una cadena separada por comas o codificada en JSON. **Si se omite o está vacío, se ejecuta exactamente un servicio predeterminado**: el servicio activo más consolidado del país; los servicios más recientes, biométricos y de pago por uso deben indicarse explícitamente. Enviar `services` cambia la respuesta al formato extendido (añade `services_used` y `match_score`). Cada id debe existir y estar activo para el `issuing_state`; los servicios que requieren onboarding devuelven `400` hasta que se activen para tu organización. Consulta los servicios disponibles por país mediante `GET /v1/organization/database-validation-countries/` (un endpoint de catálogo no documentado en esta especificación) o el editor de flujos de la Business Console.", "example": [ "bra_cpf" ] }, "validation_type": { "type": "string", "deprecated": true, "description": "OBSOLETO. Se acepta por compatibilidad con versiones anteriores, pero se ignora: el `validation_type` de la respuesta ahora se deriva de cuántos servicios obtuvieron una coincidencia total. Usa `services` para fijar servicios concretos." }, "consent": { "type": "boolean", "default": false, "description": "Establécelo en `true` cuando el usuario final haya dado su consentimiento explícito para los servicios de validación seleccionados. Obligatorio para los servicios marcados con `requires_consent=true` en el catálogo: sin él, esos servicios devuelven `400` con `services_requiring_consent`." }, "identification_number": { "type": "string", "description": "Número de identificación universal: se asigna automáticamente al campo específico del país correcto, por lo que puedes usarlo en lugar de `personal_number`/`tax_number`/`document_number`: ARG→document_number (DNI), BOL→document_number (CI), BRA→tax_number (CPF, 11 dígitos), CHL→personal_number (RUT), COL→personal_number (Cédula), CRI→personal_number (Cédula), DOM→personal_number (Cédula, 11 dígitos), ECU→personal_number (Cédula, 10 dígitos), ESP→personal_number (DNI/NIE), GTM→document_number (DPI), HND→document_number (DNI), MEX→personal_number (CURP, 18 caracteres), PAN→personal_number (Cédula), PER→personal_number (DNI, 8 dígitos), PRY→document_number (CI), SLV→document_number (DUI), URY→personal_number (CI), VEN→document_number (Cédula). Nunca sobrescribe un campo específico del país proporcionado explícitamente." }, "first_name": { "type": "string", "description": "El nombre de pila de la persona. Obligatorio en algunos servicios o países.", "example": "John" }, "last_name": { "type": "string", "description": "El apellido de la persona. Obligatorio en algunos servicios o países.", "example": "Doe" }, "middle_name": { "type": "string", "description": "Segundo nombre, utilizado por algunos servicios nacionales (AUS, NZL, …)." }, "full_name": { "type": "string", "description": "Nombre completo: algunos servicios lo aceptan en lugar del nombre y el apellido (p. ej., los servicios de CHN, que comparan el nombre en escritura nativa)." }, "date_of_birth": { "type": "string", "format": "date", "description": "Fecha de nacimiento, `YYYY-MM-DD`. Muchos servicios la exigen.", "example": "1980-01-01" }, "personal_number": { "type": "string", "description": "Identificador personal único emitido por el gobierno. Lo usan: CHL (RUT), COL (Cédula), CRI, DOM, ECU, ESP (DNI/NIE), MEX (CURP), PAN (Cédula), PER (DNI), URY. Considera usar `identification_number` en su lugar." }, "tax_number": { "type": "string", "description": "Número de identificación fiscal. Lo usa: BRA (CPF, 11 dígitos). Considera usar `identification_number` en su lugar." }, "document_number": { "type": "string", "description": "Número de documento. Lo usan: ARG (DNI), BOL (CI), GTM (DPI), HND (DNI), PRY (CI), SLV (DUI), VEN (Cédula). Considera usar `identification_number` en su lugar." }, "document_type": { "type": "string", "enum": [ "P", "DL", "ID", "RP", "SSC", "HIC", "WP", "TC", "VISA", "PSC", "BC", "OTHER" ], "description": "Tipo de documento que se valida: `P` pasaporte, `DL` licencia de conducir, `ID` documento nacional de identidad, `RP` permiso de residencia (además de `SSC`, `HIC`, `WP`, `TC`, `VISA`, `PSC`, `BC`, `OTHER`). Lo exigen algunos servicios (p. ej., ESP)." }, "expiration_date": { "type": "string", "format": "date", "description": "Fecha de caducidad del documento, `YYYY-MM-DD`. Obligatoria para la validación de ESP (España).", "example": "2030-01-15" }, "date_of_issue": { "type": "string", "format": "date", "description": "Fecha de expedición del documento, `YYYY-MM-DD` (fecha de expedición). Obligatoria para la validación de la cédula de COL (Colombia).", "example": "2015-06-20" }, "nationality": { "type": "string", "description": "Nacionalidad en formato ISO 3166-1 alfa-3. Algunos servicios la exigen." }, "gender": { "type": "string", "enum": [ "M", "F", "X" ], "description": "Género: `M`, `F` o `X` (otro/desconocido). Obligatorio para la validación RENAPER de Argentina (`arg_renaper`)." }, "address": { "description": "Dirección de residencia. Es preferible el objeto estructurado `{\"street_1\":\"123 Main St\",\"street_2\":\"Apt 4B\",\"city\":\"Springfield\",\"region\":\"IL\",\"postal_code\":\"62701\",\"country\":\"US\"}`; se sigue aceptando una cadena completa en una sola línea. Obligatoria para los servicios de verificación de dirección; cuando un servicio define requisitos de dirección, las partes que falten devuelven `400` con `address_fields_required_by`.", "oneOf": [ { "type": "object", "properties": { "street_1": { "type": "string" }, "street_2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" } } }, { "type": "string", "description": "Dirección completa en una sola línea (formato heredado)." } ] }, "address_element_1": { "type": "string", "description": "Dirección de la calle, incluidos el número y el tipo de vía. Si se omite, se deriva de `address`." }, "address_element_2": { "type": "string", "description": "Apartamento, unidad, edificio, planta o línea adicional de la dirección. Envíalo solo cuando lo tengas de forma explícita." }, "address_element_3": { "type": "string", "description": "Ciudad, barrio, distrito, localidad o vecindario. Si se omite, se obtiene de `address`." }, "address_element_4": { "type": "string", "description": "Estado, provincia, región o localidad. Si se omite, se deriva de `address`." }, "address_element_5": { "type": "string", "description": "Código postal. Se acepta `postal_code` como alias." }, "postal_code": { "type": "string", "description": "Código postal para servicios basados en la dirección (alias de `address_element_5`)." }, "driver_license_number": { "type": "string", "description": "Número de licencia de conducir para los servicios gubernamentales de verificación de documentos (AUS, NZL, IND)." }, "driver_license_card_number": { "type": "string", "description": "Número de la tarjeta física de la licencia de conducir, cuando se exige por separado del número de licencia (AUS)." }, "driver_license_state": { "type": "string", "description": "Estado o territorio de expedición de la licencia de conducir (AUS)." }, "driver_license_version": { "type": "string", "description": "Código de versión de la licencia de conducir (NZL)." }, "passport_number": { "type": "string", "description": "Número de pasaporte para los servicios gubernamentales de verificación de pasaportes (AUS, NZL, IND, CHN)." }, "passport_expiration_date": { "type": "string", "format": "date", "description": "Fecha de caducidad del pasaporte, `YYYY-MM-DD`, para los servicios de verificación de pasaportes." }, "passport_file_number": { "type": "string", "description": "Número de expediente del pasaporte (IND)." }, "passport_issue_country": { "type": "string", "description": "País emisor del pasaporte (ISO 3166-1 alpha-3) para los servicios de verificación de pasaportes." }, "medicare_card_number": { "type": "string", "description": "Número de tarjeta Medicare (AUS)." }, "immi_card_number": { "type": "string", "description": "Número de la ImmiCard australiana." }, "immi_card_expiry_date": { "type": "string", "format": "date", "description": "Fecha de caducidad de la ImmiCard australiana." }, "citizenship_certificate_number": { "type": "string", "description": "Número del certificado de ciudadanía (AUS)." }, "birth_registration_number": { "type": "string", "description": "Número de registro del certificado de nacimiento (AUS)." }, "birth_registration_date": { "type": "string", "format": "date", "description": "Fecha de registro del certificado de nacimiento (AUS)." }, "birth_registration_state": { "type": "string", "description": "Estado de registro del certificado de nacimiento (AUS)." }, "marriage_certificate_number": { "type": "string", "description": "Número del certificado de matrimonio (AUS)." }, "change_of_name_certificate_number": { "type": "string", "description": "Número de certificado de cambio de nombre (AUS)." }, "first_partner_name": { "type": "string", "description": "Nombre de la pareja en un certificado de matrimonio (AUS)." }, "last_partner_name": { "type": "string", "description": "Apellido de la pareja en un certificado de matrimonio (AUS)." }, "voter_id": { "type": "string", "description": "Número de registro electoral (IND EPIC, IRL)." }, "epic_card": { "type": "string", "description": "Número de la tarjeta electoral EPIC de India." }, "pan": { "type": "string", "description": "PAN (Permanent Account Number) de India." }, "national_id": { "type": "string", "description": "Número de documento nacional de identidad (CHN, MYS, KEN, KHM, NGA, ZAF, …)." }, "cic": { "type": "string", "description": "Código de Identificación de Credencial (CIC) del INE/IFE de México, de 9 dígitos. Lo utiliza el servicio de vigencia de la credencial del INE de México (`mex_ine_vigencia`)." }, "identificador_ciudadano": { "type": "string", "description": "Identificador del Ciudadano del INE de México (9 dígitos). Se usa con `cic` para los modelos modernos del INE (E/F/G/H) en `mex_ine_vigencia`." }, "ocr": { "type": "string", "description": "Número OCR del INE de México (13 dígitos, en el reverso de la credencial). Se usa con `cic` para el Modelo D en `mex_ine_vigencia`." }, "voter_number": { "type": "string", "description": "Clave de Elector del INE de México (18 caracteres). Se usa con `emission_number` para los modelos antiguos del IFE (A/B/C) en `mex_ine_vigencia`." }, "emission_number": { "type": "string", "description": "Número de Emisión del INE de México. Se usa con `voter_number` para los modelos antiguos del IFE (A/B/C) en `mex_ine_vigencia`." }, "bvn": { "type": "string", "description": "Número de Verificación Bancaria (BVN) de Nigeria." }, "bank_card_number": { "type": "string", "description": "Número de tarjeta bancaria (verificación de tarjeta bancaria de CHN)." }, "company_registration_number": { "type": "string", "description": "Número de registro de la empresa tal como lo emite el registro mercantil: el CNPJ en Brasil (p. ej., `11222333000181`) y el número de registro en Sudáfrica (p. ej., `1936/007721/06`). Lo requieren los servicios de registro de empresas y de directores de empresas (`bra_company_registry`, `bra_company_directors`, `zaf_company_registry`, `zaf_company_directors`)." }, "company_name": { "type": "string", "description": "Razón social registrada, cotejada con la inscripción en el registro. Opcional para `zaf_company_registry`." }, "initials": { "type": "string", "description": "Las iniciales de la persona tal como aparecen impresas en el documento. Obligatorio para `zaf_drivers_license`; se acepta para `zaf_bank_account_holder`." }, "licence_number": { "type": "string", "description": "Número de licencia de conducir tal como figura impreso en la tarjeta, para `zaf_drivers_license`. Si se omite, se usa `document_number`." }, "refugee_file_number": { "type": "string", "description": "Número de expediente de refugiado emitido por el Department of Home Affairs de Sudáfrica. Obligatorio para `zaf_refugee`." }, "bank_name": { "type": "string", "description": "Nombre del banco donde está la cuenta. Obligatorio para `zaf_bank_account_holder`." }, "bank_account_number": { "type": "string", "description": "Número de cuenta bancaria. Obligatorio para `zaf_bank_account_holder`; aceptado por `zaf_fraud_prevention`." }, "account_type": { "type": "string", "description": "Tipo de cuenta bancaria para `zaf_bank_account_holder`: `current`, `savings`, `transmission`, `subscriptionShare` o `notKnown`, sin distinguir entre mayúsculas y minúsculas. Cualquier otro valor devuelve `400`. Omítelo cuando no conozcas el tipo: en ese caso, la comprobación cruzada del tipo de cuenta se indica como no confirmada." }, "phone_number": { "type": "string", "description": "Número de móvil de contacto, para los servicios que verifican la posibilidad de contacto (`zaf_bank_account_holder`, `zaf_fraud_prevention`, `zaf_refugee`)." }, "right_thumb": { "type": "string", "description": "Huella dactilar del pulgar derecho codificada en base64 para `zaf_dha_fingerprint_match`, junto con `left_thumb` o por sí sola." }, "left_thumb": { "type": "string", "description": "Huella dactilar del pulgar izquierdo codificada en base64 para `zaf_dha_fingerprint_match`, junto con `right_thumb` o por sí sola." }, "score_level": { "type": "integer", "description": "Nivel mínimo de puntuación biométrica para `zaf_criminal_face_screening`. El valor predeterminado es `3`." }, "max_matches": { "type": "integer", "description": "Número máximo de coincidencias candidatas que devuelve `zaf_criminal_face_screening`. El valor predeterminado es `1`." }, "vehicle_register_number": { "type": "string", "description": "Número de registro del vehículo. Obligatorio, junto con `vehicle_licence_plate` y `vin`, para `zaf_vehicle_ownership`." }, "vehicle_licence_plate": { "type": "string", "description": "Número de matrícula (placa) del vehículo. Obligatorio, junto con `vehicle_register_number` y `vin`, para `zaf_vehicle_ownership`." }, "vin": { "type": "string", "description": "Número de identificación del vehículo (VIN o número de chasis). Obligatorio, junto con `vehicle_register_number` y `vehicle_licence_plate`, para `zaf_vehicle_ownership`." }, "ssn": { "type": "string", "description": "Número de la Seguridad Social (EE. UU.)." }, "phone": { "type": "string", "description": "Número de teléfono para los servicios de verificación de teléfono." }, "landline": { "type": "string", "description": "Número de teléfono fijo para los servicios de verificación de teléfono." }, "email": { "type": "string", "format": "email", "description": "Dirección de correo electrónico para los servicios de verificación de identidad." }, "country_of_residence": { "type": "string", "description": "País de residencia en formato ISO 3166-1 alfa-2. Lo usan los servicios globales de enriquecimiento de identidad (p. ej. `glb_identity_enrichment`) para acotar la consulta.", "example": "US" }, "partial_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "NO_ACTION", "description": "Qué efecto tiene un `partial_match` en `database_validation.status`. Por defecto, `NO_ACTION` (el estado sigue siendo `Approved`, con una advertencia)." }, "no_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Qué efecto tiene un `no_match` en `database_validation.status`. Por defecto, `DECLINE`." }, "save_api_request": { "type": "boolean", "default": true, "description": "Guarda la validación como una sesión (visible en la consola, en el endpoint de decisión y en el webhook `status.updated`). También cambia la forma de `validations` en la respuesta: objetos por servicio cuando es `true` (valor predeterminado) y un mapa de campos combinado cuando es `false`." }, "vendor_data": { "type": "string", "description": "Tu identificador del usuario validado; se devuelve en la respuesta y se almacena con la sesión." }, "metadata": { "type": "object", "nullable": true, "description": "JSON libre que se guarda con la solicitud y se devuelve en la respuesta." }, "selfie": { "type": "string", "format": "binary", "description": "Imagen de selfie (`jpg`, `jpeg`, `png`, `webp`; máximo 2 MB: las imágenes se comprimen a ~1.5 MB antes de enviarse al registro) para servicios de validación biométrica, por ejemplo RENAPER de Argentina (`arg_renaper`) y SIB de Panamá (`pan_cedula_sib`, `pan_cedula_sib_plus`). Es obligatoria siempre que un servicio seleccionado la incluya como campo obligatorio. Solo disponible mediante `multipart/form-data`." } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/database-validation/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"issuing_state\": \"BRA\",\n \"services\": [\"bra_cpf\"],\n \"identification_number\": \"12345678900\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1980-01-01\",\n \"vendor_data\": \"user-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.database_validation.validate(\n issuing_state=\"BRA\",\n services=[\"bra_cpf\"],\n identification_number=\"12345678900\",\n first_name=\"John\",\n last_name=\"Doe\",\n date_of_birth=\"1980-01-01\",\n vendor_data=\"user-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.databaseValidation.validate({\n issuing_state: \"BRA\",\n services: [\"bra_cpf\"],\n identification_number: \"12345678900\",\n first_name: \"John\",\n last_name: \"Doe\",\n date_of_birth: \"1980-01-01\",\n vendor_data: \"user-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.DatabaseValidation.Validate(ctx, didit.DatabaseValidationValidateParams{\n\tIssuingState: \"BRA\",\n\tServices: didit.Some([]string{\"bra_cpf\"}),\n\tIdentificationNumber: didit.String(\"12345678900\"),\n\tFirstName: didit.String(\"John\"),\n\tLastName: didit.String(\"Doe\"),\n\tDateOfBirth: didit.String(\"1980-01-01\"),\n\tVendorData: didit.String(\"user-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.DatabaseValidationValidateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.databaseValidation().validate(DatabaseValidationValidateParams.builder()\n .issuingState(\"BRA\")\n .services(List.of(\"bra_cpf\"))\n .identificationNumber(\"12345678900\")\n .firstName(\"John\")\n .lastName(\"Doe\")\n .dateOfBirth(LocalDate.parse(\"1980-01-01\"))\n .vendorData(\"user-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "databaseValidation->validate([\n 'issuing_state' => 'BRA',\n 'services' => ['bra_cpf'],\n 'identification_number' => '12345678900',\n 'first_name' => 'John',\n 'last_name' => 'Doe',\n 'date_of_birth' => '1980-01-01',\n 'vendor_data' => 'user-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.database_validation.validate(\n issuing_state: \"BRA\",\n services: [\"bra_cpf\"],\n identification_number: \"12345678900\",\n first_name: \"John\",\n last_name: \"Doe\",\n date_of_birth: \"1980-01-01\",\n vendor_data: \"user-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.DatabaseValidation.ValidateAsync(new DatabaseValidationValidateParams\n{\n IssuingState = \"BRA\",\n Services = new string[] { \"bra_cpf\" },\n IdentificationNumber = \"12345678900\",\n FirstName = \"John\",\n LastName = \"Doe\",\n DateOfBirth = \"1980-01-01\",\n VendorData = \"user-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Validación completada: al menos uno de los servicios seleccionados devolvió un resultado utilizable. Consulta `database_validation.match_type` para ver el resultado agregado, `validations` para ver las comparaciones de campos por servicio y los `outcome_code`, y `errors` (cuando está presente) para ver los servicios que fallaron.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sesión guardada cuando `save_api_request=true` (se puede usar con `GET /v3/session/{sessionId}/decision/`); en caso contrario, un UUID de correlación temporal." }, "database_validation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "`Declined` cuando el `match_type` global activa una acción `DECLINE` (`no_match_action` es `DECLINE` de forma predeterminada y `partial_match_action`, `NO_ACTION`); `In Review` cuando ningún servicio produjo una comparación utilizable, por ejemplo cuando el único servicio seleccionado devolvió `REGISTRY_UNAVAILABLE` o `INCONCLUSIVE`; `Approved` en caso contrario. Una solicitud que seleccionó varios servicios puede quedar en `Approved` por la coincidencia de un servicio aunque otro no estuviera disponible, así que revisa también `errors` y los `outcome_code` de cada servicio." }, "issuing_state": { "type": "string", "description": "Devuelve el país ISO 3166-1 alfa-3 con el que se validó.", "example": "BRA" }, "validation_type": { "type": "string", "enum": [ "one_by_one", "two_by_two" ], "description": "Se deriva de los resultados: `two_by_two` cuando ≥2 servicios distintos produjeron una coincidencia completa (en el número de identificación, en el nombre completo y la fecha de nacimiento juntos, o en la dirección sin contradicciones); `one_by_one` en caso contrario. (El campo de la solicitud con el mismo nombre está obsoleto y se ignora)." }, "screened_data": { "type": "object", "description": "Devuelve los campos de entrada que se enviaron a los servicios seleccionados (las fechas se normalizan a `YYYY-MM-DD`; una `selfie`, si se envía, se devuelve como URL prefirmada; se añade `consent_obtained: true` cuando se dio el consentimiento)." }, "match_type": { "type": "string", "nullable": true, "enum": [ "full_match", "partial_match", "no_match" ], "description": "Resultado global agregado entre los servicios con comparaciones a nivel de campo: si alguno es `full_match` → `full_match`; si no, si alguno es `partial_match` → `partial_match`; si no, `no_match`. Los servicios que solo devuelven un resultado, como el análisis biométrico de antecedentes penales, pueden devolver `null`; consulta cada elemento de `validations` para ver su `outcome_code`." }, "validations": { "description": "La estructura depende de `save_api_request`. **`true` (predeterminado):** un array de objetos por servicio (`service_id`, `service_name`, `validation`, `outcome_code`, `outcome_detail`, `source_data`). **`false`:** un único objeto plano que combina los resultados por campo de todos los servicios (`{\"full_name\": \"full_match\", ...}`).", "oneOf": [ { "type": "array", "items": { "type": "object", "description": "Resultado de validación por servicio (se devuelve cuando `save_api_request=true`, el valor predeterminado).", "properties": { "service_id": { "type": "string", "description": "Id de catálogo del servicio que produjo este resultado (p. ej., `bra_cpf`).", "example": "bra_cpf" }, "service_name": { "type": "string", "description": "Nombre legible del servicio en el catálogo.", "example": "Brazil - CPF status check" }, "validation": { "type": "object", "description": "Comparación campo a campo entre tus datos de entrada y el registro que consta en el registro oficial. Las claves son nombres de campo canónicos (`full_name`, `date_of_birth`, `identification_number`, `address`, …); los valores son `full_match`, `partial_match` o `no_match`.", "additionalProperties": { "type": "string", "enum": [ "full_match", "partial_match", "no_match" ] } }, "outcome_code": { "type": "string", "enum": [ "MATCH", "PARTIAL_MATCH", "NO_MATCH", "DOCUMENT_NOT_FOUND", "INVALID_DOCUMENT_FORMAT", "INVALID_INPUT", "MINOR_BLOCKED", "DECEASED", "BIOMETRIC_NO_MATCH", "BIOMETRIC_IMAGE_UNUSABLE", "INCONCLUSIVE", "DOCUMENT_SUPERSEDED", "REGISTRY_UNAVAILABLE", "REGISTRY_ERROR" ], "description": "Resultado de la consulta al registro, independiente del proveedor. `MATCH`/`PARTIAL_MATCH`/`NO_MATCH` describen la comparación; `DOCUMENT_NOT_FOUND` significa que el identificador no está en el registro; `INCONCLUSIVE` significa que el registro no pudo confirmar en ningún sentido (se envía a revisión; NO es una no coincidencia); `BIOMETRIC_NO_MATCH` es una discrepancia facial definitiva, mientras que `BIOMETRIC_IMAGE_UNUSABLE` es un problema técnico de la imagen (vuelve a tomar la selfie); `DECEASED`/`MINOR_BLOCKED` son resultados derivados de la política del registro; `DOCUMENT_SUPERSEDED` significa que la identidad coincidió, pero la edición del documento presentado no es la que consta en el registro (se ha emitido una edición más reciente); `INVALID_DOCUMENT_FORMAT`/`INVALID_INPUT` significan que el propio registro rechazó los datos que se le enviaron; `REGISTRY_UNAVAILABLE`/`REGISTRY_ERROR` indican fallos en el servicio de origen." }, "outcome_detail": { "type": "string", "nullable": true, "description": "Detalle sin procesar del estado del servicio de origen que respalda el código de resultado (p. ej., un código de estado HTTP o del registro)." }, "source_data": { "type": "object", "nullable": true, "description": "Vista depurada y normalizada del registro, con nombres de campo canónicos (`identification_number`, `first_name`, `last_name`, `date_of_birth`, además de indicadores específicos del registro). Los campos de imagen, cuando existen, se devuelven como URL prefirmadas." } } } }, { "type": "object", "additionalProperties": { "type": "string", "enum": [ "full_match", "partial_match", "no_match" ] }, "description": "Resultados combinados a nivel de campo (formato sin estado de `save_api_request=false`)." } ] }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Función que emitió la advertencia." }, "risk": { "type": "string", "description": "Identificador de riesgo legible por máquina." }, "additional_data": { "type": "object", "nullable": true, "description": "Contexto adicional de la advertencia, cuando está disponible." }, "log_type": { "type": "string", "description": "`warning`, `information` o `error`: cómo afectó el riesgo al resultado." }, "short_description": { "type": "string", "description": "Resumen de una línea legible para personas." }, "long_description": { "type": "string", "description": "Explicación completa y legible para personas." } } }, "description": "`DATABASE_VALIDATION_NO_MATCH` o `DATABASE_VALIDATION_PARTIAL_MATCH` cuando corresponda; vacío cuando la coincidencia es total." }, "errors": { "type": "array", "description": "Presente solo cuando algunos (pero no todos) de los servicios seleccionados fallaron. Cada entrada incluye `service_id`, `code`, `message` y `retryable`. Un servicio indicado aquí no aparece en `validations` ni en `services_used`, y no se factura. Este array es el único lugar donde aparece, así que revísalo incluso cuando `status` sea `Approved`.", "items": { "type": "object", "properties": { "service_id": { "type": "string" }, "code": { "type": "string", "example": "empty_provider_response" }, "message": { "type": "string" }, "retryable": { "type": "boolean", "description": "`true` cuando el servicio no produjo respuesta y reintentarlo más tarde puede funcionar; `false` cuando la fuente rechazó los datos que se le enviaron y primero hay que corregir la entrada.", "example": true } } } }, "services_used": { "type": "array", "items": { "type": "string" }, "description": "Ids de catálogo de los servicios que devolvieron un resultado facturable. **Solo está presente cuando la solicitud envió `services` explícitamente.**" }, "match_score": { "type": "number", "description": "Fracción (0.0–1.0) de los servicios consultados que produjeron una coincidencia completa (en el número de identificación, en el nombre completo y la fecha de nacimiento juntos, o en la dirección sin contradicciones). **Solo está presente cuando la solicitud envió `services` de forma explícita.**" } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste." }, "metadata": { "type": "object", "nullable": true, "description": "Devuelve el `metadata` que enviaste." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Full match (Approved)": { "summary": "save_api_request=true predeterminado: objetos `validations` por servicio", "value": { "request_id": "7f9a1c0e-1f2b-4f6e-9d3a-2b1c0e7f9a1c", "database_validation": { "status": "Approved", "issuing_state": "BRA", "validation_type": "one_by_one", "screened_data": { "tax_number": "12345678900", "first_name": "John", "last_name": "Doe", "date_of_birth": "1980-01-01" }, "match_type": "full_match", "validations": [ { "validation": { "full_name": "full_match", "date_of_birth": "full_match", "identification_number": "full_match" }, "outcome_code": "MATCH", "outcome_detail": "200", "service_id": "bra_cpf", "service_name": "Brazil - CPF status check", "source_data": { "identification_number": "12345678900", "first_name": "JOHN", "last_name": "DOE", "date_of_birth": "1980-01-01", "lgpd_minor": false, "minor_under_16": false, "minor_under_18": false } } ], "warnings": [] }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-11T10:30:00.000000+00:00" } }, "Explicit services (extended shape)": { "summary": "La solicitud envió `services`: la respuesta añade `services_used` y `match_score`", "value": { "request_id": "b3e7c1a2-9d4f-4f0b-8a6c-5e2d1f0a9b3e", "database_validation": { "status": "Approved", "issuing_state": "BRA", "validation_type": "one_by_one", "screened_data": { "tax_number": "12345678900", "first_name": "John", "last_name": "Doe", "date_of_birth": "1980-01-01" }, "match_type": "full_match", "validations": [ { "validation": { "full_name": "full_match", "date_of_birth": "full_match", "identification_number": "full_match" }, "outcome_code": "MATCH", "outcome_detail": "200", "service_id": "bra_cpf", "service_name": "Brazil - CPF status check", "source_data": { "identification_number": "12345678900", "first_name": "JOHN", "last_name": "DOE", "date_of_birth": "1980-01-01", "lgpd_minor": false, "minor_under_16": false, "minor_under_18": false } } ], "warnings": [], "services_used": [ "bra_cpf" ], "match_score": 1.0 }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-11T10:30:00.000000+00:00" } }, "No match (Declined)": { "summary": "El registro no coincide: valor predeterminado `no_match_action=DECLINE`", "value": { "request_id": "0a1b2c3d-4e5f-6789-abcd-ef0123456789", "database_validation": { "status": "Declined", "issuing_state": "BRA", "validation_type": "one_by_one", "screened_data": { "tax_number": "12345678900", "first_name": "John", "last_name": "Doe", "date_of_birth": "1980-01-01" }, "match_type": "no_match", "validations": [ { "validation": { "full_name": "no_match", "date_of_birth": "no_match", "identification_number": "no_match" }, "outcome_code": "NO_MATCH", "outcome_detail": "200", "service_id": "bra_cpf", "service_name": "Brazil - CPF status check", "source_data": { "identification_number": "00987654321", "first_name": "TOTALLY", "last_name": "DIFFERENT NAME", "date_of_birth": "1999-01-01", "lgpd_minor": false, "minor_under_16": false, "minor_under_18": false } } ], "warnings": [ { "feature": "DATABASE_VALIDATION", "risk": "DATABASE_VALIDATION_NO_MATCH", "additional_data": null, "log_type": "error", "short_description": "Database validation no match", "long_description": "The system identified a no match in the database validation, requiring further investigation." } ] }, "vendor_data": null, "metadata": null, "created_at": "2026-06-11T10:31:00.000000+00:00" } }, "Stateless (save_api_request=false)": { "summary": "`validations` se condensa en un mapa de campos combinado; no se almacena nada", "value": { "request_id": "c4d5e6f7-8901-2345-6789-abcdef012345", "database_validation": { "status": "Approved", "issuing_state": "BRA", "validation_type": "one_by_one", "screened_data": { "tax_number": "12345678900", "first_name": "John", "last_name": "Doe", "date_of_birth": "1980-01-01" }, "match_type": "full_match", "validations": { "full_name": "full_match", "date_of_birth": "full_match", "identification_number": "full_match" }, "warnings": [] }, "vendor_data": null, "metadata": null, "created_at": "2026-06-11T10:32:00.000000+00:00" } } } } } }, "400": { "description": "Error de validación: no se factura nada. Los errores de campo de la comprobación previa se producen antes de cualquier llamada externa. Si todos los intentos sin respuesta rechazan explícitamente la entrada, la respuesta incluye en su lugar `validation_errors` con `code: provider_rejected_input` y `retryable: false`; corrige la entrada antes de reintentar. Los problemas a nivel de campo usan el formato estándar de DRF; los problemas del catálogo devuelven un array `services` (además de `requires_onboarding` o `services_requiring_consent` cuando corresponde); los errores por campos que faltan incluyen `fields_required_by`, que asocia cada campo que falta con los servicios que lo exigen; los servicios que necesitan al menos un identificador adicional (por ejemplo, `usa_states_credit_bureau`, que no puede verificar solo un nombre) devuelven `any_field_required_by`, que asocia cada servicio con los campos de los que al menos uno debe estar presente; los problemas de formato que se comprueban por servicio devuelven `invalid_fields_by_service`.", "content": { "application/json": { "examples": { "Invalid issuing_state": { "summary": "País no admitido: el mensaje enumera todos los códigos alfa-3 válidos", "value": { "error": [ "Invalid issuing state. Valid options are: ARE, ARG, AUS, AUT, BEL, BGD, BOL, BRA, CAN, CHE, CHL, CHN, CIV, COL, CRI, CZE, DEU, DNK, DOM, ECU, ESP, FIN, FRA, GBR, GHA, GLB, GRC, GTM, HKG, HND, IDN, IND, IRL, ITA, KEN, KHM, MAR, MEX, MYS, NGA, NLD, NOR, NZL, OMN, PAN, PER, PHL, POL, PRT, PRY, QAT, SGP, SLV, SVK, SWE, THA, UGA, URY, USA, VEN, ZAF, ZMB, ZWE" ] } }, "Missing required fields": { "summary": "Unión de los campos obligatorios de los servicios seleccionados, con la indicación de campos universales", "value": { "error": [ "Missing required fields: tax_number (or use 'identification_number' which maps to 'tax_number' for BRA)" ], "fields_required_by": { "tax_number": [ "bra_cpf" ] } } }, "Unknown service id": { "summary": "`services` contiene un id que no está en el catálogo", "value": { "services": [ "Unknown service_id(s): ['bogus_service']" ] } }, "Service not live for country": { "summary": "`services` nombra un servicio de otro país (o una entrada provisional)", "value": { "services": [ "Services not currently live for PER: ['bra_cpf']. Available services: ['per_dni', 'per_residential', 'per_tax_registration']" ] } }, "Service requires onboarding": { "summary": "El servicio existe, pero aún no está activado para tu organización", "value": { "services": [ "Services require onboarding before they can be enabled for AUS: ['aus_australia_driver_licence']. Contact Didit support to activate them." ], "requires_onboarding": [ "aus_australia_driver_licence" ] } }, "Consent missing": { "summary": "Un servicio seleccionado está marcado con requires_consent=true y `consent` no era `true`", "value": { "consent": [ "Explicit end-user consent is required for these database validation services: ['chn_national_id']. Send `consent=true`." ], "services_requiring_consent": [ "chn_national_id" ] } }, "Country format rule violation": { "summary": "El identificador no cumple la regla de formato del país (longitud/dígitos/regex)", "value": { "tax_number": [ "Invalid tax number for BRA: Brazilian CPF (exactly 11 digits). Must be exactly 11 characters long (got 10)." ] } }, "Service-specific format violation": { "summary": "Un campo no cumple los requisitos de formato propios del servicio seleccionado", "value": { "error": [ "One or more fields do not match the format required by the selected service." ], "invalid_fields_by_service": { "chn_national_id": [ "national_id_format" ] } } }, "Input refused by every attempt": { "summary": "Corrige los datos de entrada antes de reintentar", "value": { "error": "The source refused to run this query with the supplied input.", "validation_errors": [ { "service_id": "bra_cpf", "code": "provider_rejected_input", "message": "The source refused to run this query with the supplied input.", "retryable": false } ] } } }, "schema": { "type": "object", "additionalProperties": true, "properties": { "error": { "description": "Explicación a nivel de solicitud o errores de campo de la comprobación previa.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "validation_errors": { "type": "array", "description": "Presente cuando todos los intentos sin respuesta rechazaron la entrada tras la comprobación previa.", "items": { "type": "object", "properties": { "service_id": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean", "description": "Indica si reintentar más tarde puede resolver este fallo del servicio. False significa que primero debes corregir los datos proporcionados." } } } } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key` y también cuando el saldo de la organización que realiza la llamada no la cubre; una clave incorrecta, revocada o expirada devuelve `401`. Si falta la clave, se devuelve `403` con `{\"detail\": ...}`; una clave incorrecta, revocada o expirada devuelve `401`. La falta de créditos devuelve `403` con `{\"error\": ...}` antes de que se realice cualquier análisis o llamada a un proveedor.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de la organización no cubre la llamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "502": { "description": "Ningún servicio seleccionado devolvió un resultado utilizable. Revisa cada entrada de validation_errors antes de reintentar; un HTTP 502 por sí solo no indica que el fallo sea transitorio. Una entrada empty_provider_response con retryable: true indica resultados no disponibles o sin explicación, incluido el caso de un proveedor principal que rechaza la solicitud seguido de un proveedor de respaldo no disponible. Las entradas heredadas provider_invalid_input y provider_validation_error, en cambio, requieren corregir los datos de entrada y pueden omitir retryable. No se factura nada. Cuando save_api_request=true, el intento fallido se registra como una sesión con estado Not Finished. Los fallos parciales devuelven 200 con database_validation.errors.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "validation_errors": { "type": "array", "items": { "type": "object", "properties": { "service_id": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean", "description": "Indica si reintentar más tarde puede resolver este fallo del servicio. False significa que primero debes corregir los datos proporcionados." } } } } } }, "examples": { "Provider returned no result": { "summary": "Fallaron todos los servicios seleccionados", "value": { "error": "Database validation could not be performed. The external validation service did not return a result. Please try again later.", "validation_errors": [ { "service_id": "bra_cpf", "code": "empty_provider_response", "message": "The provider did not return a database validation result.", "retryable": true } ] } } } } } } } } }, "/v3/phone/send/": { "post": { "summary": "Enviar código por teléfono", "description": "Envía un código de un solo uso (OTP) a un número de teléfono por WhatsApp, SMS u otro canal compatible y, después, verifícalo con [`POST /v3/phone/check/`](/es/standalone-apis/phone-check).\n\n**Cómo se relacionan el envío y la comprobación.** El estado de la verificación se identifica por tu aplicación y el `phone_number` en formato E.164: la llamada de comprobación no recibe `request_id`. Cada nuevo envío crea una verificación pendiente que dura **5 minutos**: llama a la comprobación con el mismo número y el código que recibió el usuario antes de que se cierre ese plazo. Si vuelves a llamar al envío para el mismo número mientras hay una verificación pendiente, se reenvía un código para esa misma verificación (`status: \"Retry\"`, mismo `request_id`). Solo se asocia un reintento de esta forma (dos envíos en total); un envío adicional inicia una verificación nueva con un `request_id` nuevo. El plazo de 5 minutos se cuenta desde el primer envío y los reintentos no lo amplían.\n\n**Canales de entrega.** `options.preferred_channel` selecciona el canal (`whatsapp` por defecto; también se admiten `sms`, `telegram`, `voice`, `rcs`, `viber` y `zalo`). Cuando el canal preferido no está disponible para el país o el número de destino, la entrega recurre automáticamente a SMS: el envío sigue devolviendo `Success` y el canal realmente utilizado aparece en la respuesta de la comprobación (`phone.verification_method` y los eventos de `lifecycle`).\n\n**Marca.** Los códigos por SMS llevan el nombre de remitente SMS de tu aplicación, configurado en la Business Console, sin coste adicional. Pasa `options.sms_sender_name` para firmar un código con otro nombre, u `options.use_white_label_customization: true` para usar tu nombre público de marca blanca cuando no haya ningún nombre de remitente configurado. Los códigos por WhatsApp usan un mensaje fijo; conecta tu propio número de WhatsApp Business en la Business Console para enviarlos con el nombre y el número de tu empresa, y solo se factura la tarifa de Didit.\n\n**Estados del envío.** `Success`: OTP enviado para una verificación nueva; `Retry`: OTP reenviado para la verificación pendiente; `Blocked`: la capa antifraude se negó a enviarlo (consulta `reason`, por ejemplo `repeated_attempts`, `suspicious`, `spam`). Un envío `Blocked` finaliza de inmediato la verificación como `Declined` con una advertencia de riesgo alto, por lo que una comprobación posterior devuelve `Expired or Not Found`.\n\n**Facturación.** El precio depende del país de destino y del canal que realmente entrega el mensaje; consulta [Precios de la verificación de teléfono](/es/getting-started/phone-verification-pricing). Solo los envíos `Blocked` son siempre gratuitos: cualquier otro intento de envío no facturado se cobra al finalizar o expirar la verificación, aunque nunca se haya confirmado la entrega o el proveedor de entrega haya informado de que el mensaje no se pudo entregar. Las comprobaciones son siempre gratuitas. Como medida contra el abuso, la verificación de teléfono está desactivada hasta la primera recarga de tu organización (`403`).\n\n**Persistencia de la sesión.** Cada verificación nueva se guarda como una sesión de tipo API: `request_id` es un id de sesión real que puedes pasar a `GET /v3/session/{sessionId}/decision/`, la verificación aparece en la Business Console y se disparan webhooks `status.updated` a medida que avanza.\n\n**Sandbox.** Las claves de API de sandbox omiten la entrega y la facturación: tras validar la solicitud (una entrada mal formada sigue devolviendo `400`), el endpoint devuelve un payload estático `Success` con un `request_id` aleatorio; no se envía ningún mensaje y no se guarda nada. Usa el código `123456` en la comprobación de sandbox.\n\n**Autenticación.** Envía la clave de API de tu aplicación en el encabezado `x-api-key`. Si faltan las credenciales o no son válidas, se devuelve `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`): esta API nunca devuelve `401`.\n\n**Límites de solicitudes.** Presupuesto de escritura compartido de 300 solicitudes/min por clave de API entre todos los endpoints POST/PATCH/DELETE, más un límite contra el abuso de 4 intentos de envío por número de teléfono y hora; si se supera cualquiera de los dos, se devuelve `429`.", "operationId": "post_v3phone_send", "x-didit-sdk": { "resource": "phone", "method": "send_code", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/phone/send/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"phone_number\": \"+14155552671\",\n \"options\": {\n \"code_size\": 6,\n \"preferred_channel\": \"whatsapp\",\n \"locale\": \"en-US\"\n },\n \"vendor_data\": \"user-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.phone.send_code(\n phone_number=\"+14155552671\",\n options={\n \"locale\": \"en-US\",\n \"preferred_channel\": \"whatsapp\",\n },\n vendor_data=\"user-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.phone.sendCode({\n phone_number: \"+14155552671\",\n options: {\n locale: \"en-US\",\n preferred_channel: \"whatsapp\",\n },\n vendor_data: \"user-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Phone.SendCode(ctx, didit.PhoneSendCodeParams{\n\tPhoneNumber: \"+14155552671\",\n\tOptions: didit.Some(didit.PhoneSendCodeParamsOptions{\n\t\tLocale: didit.String(\"en-US\"),\n\t\tPreferredChannel: didit.Some(didit.PhoneSendCodeParamsOptionsPreferredChannel(\"whatsapp\")),\n\t}),\n\tVendorData: didit.String(\"user-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.PhoneSendCodeParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.phone().sendCode(PhoneSendCodeParams.builder()\n .phoneNumber(\"+14155552671\")\n .options(PhoneSendCodeParams.Options.builder()\n .locale(\"en-US\")\n .preferredChannel(PhoneSendCodeParams.Options.PreferredChannel.of(\"whatsapp\"))\n .build())\n .vendorData(\"user-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "phone->sendCode([\n 'phone_number' => '+14155552671',\n 'options' => [\n 'locale' => 'en-US',\n 'preferred_channel' => 'whatsapp',\n ],\n 'vendor_data' => 'user-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.phone.send_code(\n phone_number: \"+14155552671\",\n options: {\n locale: \"en-US\",\n preferred_channel: \"whatsapp\",\n },\n vendor_data: \"user-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Phone.SendCodeAsync(new PhoneSendCodeParams\n{\n PhoneNumber = \"+14155552671\",\n Options = new PhoneSendCodeParamsOptions\n {\n Locale = \"en-US\",\n PreferredChannel = new PhoneSendCodeParamsOptionsPreferredChannel(\"whatsapp\"),\n },\n VendorData = \"user-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone_number": { "type": "string", "maxLength": 20, "description": "Número de teléfono del destinatario en formato E.164: `+` inicial y código de país (p. ej., `+14155552671`). Los números se validan y se normalizan a E.164; los números que no se pueden analizar o que no son válidos devuelven `400` con un error en el campo `phone_number`.", "example": "+14155552671" }, "options": { "type": "object", "description": "Opciones de entrega del OTP. Todos los campos son opcionales.", "properties": { "code_size": { "type": "integer", "minimum": 4, "maximum": 8, "default": 6, "description": "Número de dígitos del OTP." }, "locale": { "type": "string", "maxLength": 5, "pattern": "^[a-z]{2,3}(-[A-Z]{2,3})?$", "description": "Configuración regional BCP-47 que se usa para localizar el mensaje de verificación (p. ej., `en-US`, `fr`, `es`). Los formatos no válidos devuelven `400`.", "example": "en-US" }, "preferred_channel": { "type": "string", "enum": [ "whatsapp", "sms", "telegram", "voice", "rcs", "viber", "zalo" ], "default": "whatsapp", "description": "Canal de entrega preferido. Si el canal no está disponible para el país o el número de destino, el mensaje recurre automáticamente a SMS y el envío sigue informando `Success`." }, "use_white_label_customization": { "type": "boolean", "default": false, "description": "Si es `true`, el envío es de marca blanca: si tu aplicación no tiene nombre de remitente de SMS, el SMS menciona en su lugar tu nombre público de marca blanca (\"123456 es tu código de verificación para Acme Bank\"). Tu nombre de remitente de SMS, si está configurado, se usa con o sin este indicador. Se aplica a los mensajes SMS, incluido un SMS de respaldo desde otro canal; los códigos de WhatsApp se envían con un mensaje fijo y no llevan marca. El valor predeterminado es `false`." }, "sms_sender_name": { "type": "string", "nullable": true, "maxLength": 30, "example": "Acme Bank", "description": "El nombre que lleva el SMS de este código (\"123456 is your verification code for Acme Bank\"), en lugar del nombre de remitente de SMS de tu aplicación. Gratis. De 1 a 30 caracteres: solo letras, dígitos, espacios y ' & - !, no solo dígitos, con un único espacio entre palabras; cualquier otro valor devuelve `400` y no se envía ningún código. Si se omite o es `null` o está vacío, se usa el nombre de remitente de SMS de tu aplicación. Cada aplicación puede empezar a usar hasta dos nombres nuevos por día (UTC); a partir de ese límite, el código se envía con el nombre de tu aplicación. Se aplica a los mensajes SMS, incluido un SMS de respaldo desde otro canal; los códigos por WhatsApp no llevan marca.", "pattern": "^$|^(?![\\d ]+$)[\\p{L}\\p{N}'&!-]+( [\\p{L}\\p{N}'&!-]+)*$" } } }, "signals": { "type": "object", "description": "Señales opcionales de dispositivo y red sobre el usuario final, que se envían a la capa antifraude para mejorar la detección de tráfico abusivo o automatizado. Todos los campos son opcionales.", "properties": { "ip": { "type": "string", "description": "Dirección IP del dispositivo del usuario final. IPv4 o IPv6.", "example": "192.0.2.1" }, "device_id": { "type": "string", "maxLength": 255, "description": "Identificador único del dispositivo del usuario final. Android: `ANDROID_ID`; iOS: `identifierForVendor`.", "example": "8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2" }, "device_platform": { "type": "string", "enum": [ "android", "ios", "ipados", "tvos", "web" ], "description": "Plataforma del dispositivo del usuario final." }, "device_model": { "type": "string", "maxLength": 255, "description": "Modelo del dispositivo del usuario final.", "example": "iPhone17,2" }, "os_version": { "type": "string", "maxLength": 64, "description": "Versión del sistema operativo del dispositivo del usuario final.", "example": "18.0.1" }, "app_version": { "type": "string", "maxLength": 64, "description": "Versión de tu aplicación.", "example": "1.2.34" }, "user_agent": { "type": "string", "maxLength": 512, "description": "User agent del navegador o la aplicación del usuario final.", "example": "Mozilla/5.0 (iPhone; CPU iPhone OS 14_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Mobile/15E148 Safari/604.1" } } }, "vendor_data": { "type": "string", "description": "Identificador opcional controlado por quien llama (tu id interno de usuario, un correo electrónico, un UUID, etc.) que se guarda en la sesión y se devuelve en la respuesta del envío, en la respuesta de la comprobación correspondiente, en los webhooks y en la Business Console. Úsalo para relacionar el `request_id` de Didit con tu registro de usuario." }, "metadata": { "type": "object", "nullable": true, "description": "Objeto JSON opcional de formato libre que se guarda en la sesión y se devuelve en la respuesta del envío, en la respuesta de la comprobación correspondiente, en los webhooks y en la Business Console." } }, "required": [ "phone_number" ] }, "examples": { "WhatsApp (default)": { "summary": "OTP de 6 dígitos por WhatsApp, con paso automático a SMS como alternativa", "value": { "phone_number": "+14155552671", "options": { "preferred_channel": "whatsapp", "locale": "en-US" }, "vendor_data": "user-1234" } }, "SMS with custom code length": { "summary": "Forzar la entrega por SMS con un código de 4 dígitos", "value": { "phone_number": "+34699999999", "options": { "preferred_channel": "sms", "code_size": 4, "locale": "es" } } }, "With fraud signals": { "summary": "Envía señales del dispositivo para reforzar el análisis antifraude", "value": { "phone_number": "+14155552671", "signals": { "ip": "192.0.2.1", "device_id": "8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2", "device_platform": "ios", "device_model": "iPhone17,2", "os_version": "18.0.1", "app_version": "1.2.34" }, "vendor_data": "user-1234" } } } } } }, "responses": { "200": { "description": "Envío confirmado. Revisa `status`: `Success` y `Retry` significan que hay un código en camino; `Blocked` significa que la capa antifraude lo rechazó y la verificación ya se ha finalizado como `Declined`. `request_id` es el id de sesión persistido (el mismo id en un `Retry`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneVerificationSendResponse" }, "examples": { "Success": { "summary": "OTP enviado para una nueva verificación", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Success", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Retry": { "summary": "Segundo envío al mismo número dentro de la ventana de 5 minutos: mismo request_id", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Retry", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Blocked": { "summary": "Rechazo antifraude: la verificación se finaliza como Declined y no se factura nada", "value": { "request_id": "0d8af1f4-0c43-46d7-b75c-6e4e22c0a7b3", "status": "Blocked", "reason": "repeated_attempts", "vendor_data": "user-1234", "metadata": null } } } } } }, "400": { "description": "Error de validación. Una entrada mal formada devuelve el envoltorio de errores de campo de DRF (un array de mensajes por cada campo incorrecto, anidado bajo `options` para los errores de opciones). Un número que se analiza correctamente pero se rechaza en el momento del envío (inalcanzable, o un tipo de línea no apto, como un código corto) devuelve en su lugar un envoltorio `{\"detail\": ...}`.", "content": { "application/json": { "examples": { "Invalid phone number (field error)": { "summary": "El número no es un E.164 válido", "value": { "phone_number": [ "Invalid phone number provided." ] } }, "Missing phone number": { "summary": "`phone_number` no está incluido en el cuerpo", "value": { "phone_number": [ "This field is required." ] } }, "Invalid options": { "summary": "`code_size` fuera de rango, `locale` mal formado, `preferred_channel` desconocido", "value": { "options": { "code_size": [ "Ensure this value is less than or equal to 8." ], "locale": [ "Ensure this field has no more than 5 characters." ], "preferred_channel": [ "\"carrier_pigeon\" is not a valid choice." ] } } }, "Number rejected at send time": { "summary": "Formato E.164 válido, pero el número no puede recibir un OTP", "value": { "detail": "Invalid phone number provided." } }, "Ineligible line type": { "summary": "El tipo de línea no puede recibir un OTP (p. ej., un código corto)", "value": { "detail": "Invalid phone line type provided." } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key` (`{\"detail\": ...}`); una clave incorrecta, revocada o expirada devuelve `401`. También se devuelve antes de cualquier envío cuando la organización nunca ha recargado saldo (medida antiabuso) o cuando su saldo no cubre el precio de envío al destino (`{\"error\": ...}`).", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } }, "Top-up required": { "summary": "La verificación de teléfono permanece desactivada hasta la primera recarga de la organización", "value": { "detail": "To protect against abuse, phone verification is disabled until your first top-up." } }, "Not enough credits": { "summary": "El saldo de la organización no cubre el precio del envío", "value": { "error": "You don't have enough credits to perform this request." } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. Además, se aplica previamente un tope antiabuso de 4 intentos de verificación por número de teléfono por hora. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`. Nota: los encabezados `X-RateLimit-*`/`Retry-After` acompañan solo al 429 del límite de escritura de 300 por minuto; el 429 del tope por número no incluye encabezados de límite de solicitudes.", "content": { "application/json": { "examples": { "Per-number cap": { "summary": "Más de 4 intentos de verificación para el mismo número en la última hora", "value": { "detail": "Maximum verification attempts reached for this phone number. Only 4 authentication attempts are allowed per hour. Try again later or use a different number." } }, "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "502": { "description": "El proveedor de verificación de teléfono no está disponible temporalmente: una respuesta 5xx, un tiempo de espera agotado o un fallo de conexión que persistió tras los reintentos integrados. Puedes reintentar sin riesgo; no se factura nada ni se consume ningún intento.", "content": { "application/json": { "examples": { "Provider outage": { "summary": "El proveedor no respondió a la solicitud de envío", "value": { "detail": "Phone verification is temporarily unavailable. Please try again shortly.", "code": "phone_provider_unavailable" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string" } } } } } }, "500": { "description": "Error inesperado al crear la verificación que no corresponde a una caída conocida del proveedor. Se puede reintentar sin riesgo.", "content": { "application/json": { "examples": { "Provider error": { "summary": "No se pudo iniciar la entrega del OTP", "value": { "detail": "Error creating phone verification" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/phone/check/": { "post": { "summary": "Comprobar código de teléfono", "description": "Verifica el OTP enviado por [`POST /v3/phone/send/`](/es/standalone-apis/phone-send) y obtén el resultado final de la verificación junto con inteligencia telefónica: nombre del operador y tipo de línea, indicadores de número virtual (VoIP) y desechable, y uso duplicado del número en tus sesiones.\n\n**Cómo localiza la comprobación la verificación.** La coincidencia se hace por tu aplicación más el `phone_number` en formato E.164. `request_id` no es un dato de entrada. Se comprueba la verificación pendiente más reciente creada en los últimos **5 minutos**. Si no hay ninguna (nunca se envió, ya se finalizó o tiene más de 5 minutos), el endpoint devuelve `200` con `status: \"Expired or Not Found\"`.\n\n**Límite de intentos.** Cada verificación permite **3 intentos de código**. Los dos primeros códigos incorrectos devuelven `status: \"Failed\"` con los intentos restantes y `phone: null`. El tercer código incorrecto finaliza la verificación como `Declined` con una advertencia `VERIFICATION_CODE_ATTEMPTS_EXCEEDED` y devuelve el informe completo del teléfono.\n\n**Resultados.** `Approved`: código correcto y ningún riesgo que provoque el rechazo. `Declined`: estado definitivo. El código era correcto pero coincidió un riesgo que provoca el rechazo (una acción `DECLINE` de las que se describen más abajo, o un número en la lista de bloqueo o de alto riesgo), o se agotaron los intentos. `Failed`: código incorrecto, con intentos restantes. `Expired or Not Found`: no hay nada que comprobar. Con `Approved`/`Declined`, el `request_id` es igual al `request_id` del envío (el ID de la sesión) y `phone` contiene el informe completo (`carrier`, `is_virtual`, `is_disposable`, `warnings`, `lifecycle`, `matches`). Con `Failed` y `Expired or Not Found`, el `request_id` es un UUID aleatorio de un solo uso.\n\n**Acciones de riesgo.** `duplicated_phone_number_action`, `disposable_number_action` y `voip_number_action` deciden qué ocurre cuando se detecta el riesgo correspondiente con un código correcto. `DECLINE` cambia el estado final a `Declined`. `NO_ACTION` (valor predeterminado) registra el riesgo en `phone.warnings` sin afectar al estado.\n\n**Facturación.** Las comprobaciones son gratuitas. La entrega se factura en el envío (consulta [Precios de Verificación de teléfono](/es/getting-started/phone-verification-pricing)).\n\n**Persistencia de la sesión.** Una comprobación finalizada actualiza la sesión creada por el envío (visible en la Business Console y consultable mediante `GET /v3/session/{sessionId}/decision/`) y dispara un webhook `status.updated`.\n\n**Sandbox.** Las claves de API de sandbox omiten todo el procesamiento: cualquier código con formato válido (de 4 a 8 dígitos, `123456` incluido) devuelve un payload estático `Approved` con un objeto `phone` plano y simplificado (`status`, `phone_number`, `country_code`, `carrier_name`, `line_type`, `flags`). Una entrada con formato incorrecto sigue devolviendo `400`. No se guarda nada.\n\n**Autenticación.** Envía la clave de API de tu aplicación en el encabezado `x-api-key`. Si faltan las credenciales o no son válidas, se devuelve `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`). Esta API nunca devuelve `401`.\n\n**Límites de solicitudes.** Límite de escritura compartido de 300 solicitudes por minuto por clave de API, más el límite antiabuso del proveedor de 4 intentos por número y hora. Si se supera cualquiera de los dos, se devuelve `429`.\n\n**Huella social.** Establece `enable_social` en `true` para añadir un bloque `phone_social`: las plataformas en línea en las que está registrado este número, con recuentos por categoría y los datos de perfil disponibles. `profiles_registered: 0` significa que se comprobaron las plataformas y el número no se encontró en ninguna. Es una respuesta válida y facturable. El bloque no aparece cuando no se solicitó el complemento o no se pudo completar la comprobación, y en ese caso no se factura. La facturación añade una unidad `phone_social` por solicitud, además del precio propio de este endpoint.", "operationId": "post_v3phone_check", "x-didit-sdk": { "resource": "phone", "method": "check_code", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/phone/check/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"phone_number\": \"+14155552671\",\n \"code\": \"123456\",\n \"voip_number_action\": \"DECLINE\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.phone.check_code(\n phone_number=\"+14155552671\",\n code=\"123456\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.phone.checkCode({\n phone_number: \"+14155552671\",\n code: \"123456\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Phone.CheckCode(ctx, didit.PhoneCheckCodeParams{\n\tPhoneNumber: \"+14155552671\",\n\tCode: \"123456\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.PhoneCheckCodeParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.phone().checkCode(PhoneCheckCodeParams.builder()\n .phoneNumber(\"+14155552671\")\n .code(\"123456\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "phone->checkCode([\n 'phone_number' => '+14155552671',\n 'code' => '123456',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.phone.check_code(\n phone_number: \"+14155552671\",\n code: \"123456\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Phone.CheckCodeAsync(new PhoneCheckCodeParams\n{\n PhoneNumber = \"+14155552671\",\n Code = \"123456\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone_number": { "type": "string", "maxLength": 20, "description": "El mismo número de teléfono usado en la llamada correspondiente a [`POST /v3/phone/send/`](/es/standalone-apis/phone-send), en formato E.164. Es lo que vincula la comprobación con el envío.", "example": "+14155552671" }, "code": { "type": "string", "minLength": 4, "maxLength": 8, "pattern": "^[0-9]{4,8}$", "description": "El OTP que recibió el usuario final. Debe tener entre 4 y 8 dígitos numéricos; cualquier otro valor devuelve `400` sin consumir un intento. Un código con formato correcto pero erróneo devuelve `200` con `status: \"Failed\"` y consume uno de los 3 intentos.", "example": "123456" }, "duplicated_phone_number_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Qué hacer cuando otro usuario de tu aplicación (con un `vendor_data` distinto) ya usó el mismo número. `DECLINE` cambia el `status` final a `Declined`; `NO_ACTION` registra el riesgo en `phone.warnings` y rellena `phone.matches`." }, "disposable_number_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Qué hacer cuando la consulta al operador marca el número como línea temporal o desechable (`phone.is_disposable`). `DECLINE` cambia el `status` final a `Declined`; `NO_ACTION` registra el riesgo en `phone.warnings`." }, "voip_number_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Qué hacer cuando la consulta al operador indica un tipo de línea virtual: `voip`, `isp` o `vpn` (`phone.is_virtual`). `DECLINE` cambia el `status` final a `Declined`; `NO_ACTION` registra el riesgo en `phone.warnings`." }, "enable_enrichment": { "type": "boolean", "default": false, "description": "Si es `true`, también ejecuta inteligencia de teléfono sobre el número: una puntuación de riesgo, el tipo de línea, si se portó recientemente y un índice de confianza. Se factura como una unidad `phone_intelligence_api` por solicitud ($0.05 a precio de lista), además del precio propio de este endpoint. La solicitud devuelve `403` cuando tu saldo no alcanza para cubrirlo.", "example": false }, "phone_intelligence_score_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acción cuando la puntuación de riesgo de inteligencia del teléfono supera el umbral. `DECLINE` cambia el `status` final a `Declined`; `NO_ACTION` registra la señal sin rechazar. Solo tiene efecto cuando `enable_enrichment` es `true`." }, "phone_type_risk_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acción cuando el número es de un tipo de línea de alto riesgo. `DECLINE` cambia el `status` final a `Declined`; `NO_ACTION` registra la señal sin rechazar. Solo tiene efecto cuando `enable_enrichment` es `true`." }, "recent_port_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acción cuando el número se portó recientemente a otro operador. `DECLINE` cambia el `status` final a `Declined`; `NO_ACTION` registra la señal sin rechazar. Solo tiene efecto cuando `enable_enrichment` es `true`." }, "low_phone_trust_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acción cuando el índice de confianza de inteligencia del teléfono es igual o inferior al umbral. `DECLINE` cambia el `status` final a `Declined`; `NO_ACTION` registra la señal sin rechazar. Solo tiene efecto cuando `enable_enrichment` es `true`." }, "enable_social": { "type": "boolean", "default": false, "description": "Si es true, también se consulta la huella social del número: las plataformas de mensajería, redes sociales, comercio electrónico y profesionales en las que está registrado. Se factura como una unidad `phone_social` por solicitud, además del precio propio de este endpoint.", "example": true }, "phone_no_social_presence_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acción cuando la comprobación de huella social no encuentra el número registrado en ninguna de las plataformas que cubre. En este endpoint solo se aceptan NO_ACTION y DECLINE; REVIEW está disponible en la clave de configuración del flujo con el mismo nombre." } }, "required": [ "phone_number", "code" ] }, "examples": { "Default": { "summary": "Registrar los riesgos, pero nunca rechazar automáticamente", "value": { "phone_number": "+14155552671", "code": "123456" } }, "Strict risk policy": { "summary": "Rechazar automáticamente las líneas VoIP y desechables", "value": { "phone_number": "+14155552671", "code": "123456", "voip_number_action": "DECLINE", "disposable_number_action": "DECLINE" } } } } } }, "responses": { "200": { "description": "Comprobación completada: los códigos incorrectos y las verificaciones inexistentes también devuelven `200`; revisa `status`, no el código HTTP. `phone` solo se rellena en resultados finalizados (`Approved`/`Declined`), es `null` en `Failed` y no aparece en `Expired or Not Found`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneVerificationCheckResponse" }, "examples": { "Approved": { "summary": "Código correcto: informe completo del teléfono con operador, ciclo de vida y coincidencias", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Approved", "message": "The verification code is correct.", "phone": { "status": "Approved", "phone_number_prefix": "+1", "phone_number": "4155552671", "full_number": "+14155552671", "country_code": "US", "country_name": "United States", "carrier": { "name": "AT&T", "type": "mobile" }, "is_disposable": false, "is_virtual": false, "verification_method": "whatsapp", "verification_attempts": 1, "verified_at": "2026-06-12T01:24:47.311323Z", "warnings": [], "lifecycle": [ { "type": "PHONE_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null, "channel": "whatsapp", "actual_channel": "whatsapp" }, "fee": 0.0509 }, { "type": "PHONE_DELIVERY_DELIVERED", "timestamp": "2026-06-12T01:23:43.118220+00:00", "details": { "channel": "whatsapp", "status": "delivered" }, "fee": 0 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "PHONE_VERIFICATION_APPROVED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": null, "fee": 0 } ], "matches": [] }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Failed (attempts remaining)": { "summary": "Código incorrecto: el usuario puede reintentar; aquí request_id es un UUID de un solo uso", "value": { "request_id": "11111111-2222-3333-4444-555555555555", "status": "Failed", "message": "The verification code is incorrect. Attempts remaining: 2", "phone": null, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:21.512340+00:00" } }, "Declined (max attempts)": { "summary": "Tercer código incorrecto: verificación finalizada como Declined", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Declined", "message": "The verification code is incorrect. Maximum attempts reached.", "phone": { "status": "Declined", "phone_number_prefix": "+1", "phone_number": "4155552671", "full_number": "+14155552671", "country_code": "US", "country_name": "United States", "carrier": { "name": "AT&T", "type": "mobile" }, "is_disposable": false, "is_virtual": false, "verification_method": "whatsapp", "verification_attempts": 1, "verified_at": null, "warnings": [ { "feature": "PHONE", "risk": "VERIFICATION_CODE_ATTEMPTS_EXCEEDED", "additional_data": null, "log_type": "error", "short_description": "Verification code attempts exceeded", "long_description": "The system detected that the phone number has exceeded the maximum number of verification code attempts." } ], "lifecycle": [ { "type": "PHONE_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null, "channel": "whatsapp", "actual_channel": "whatsapp" }, "fee": 0.0509 }, { "type": "INVALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:01.118220+00:00", "details": { "code_tried": "111111", "status": "Failed" }, "fee": 0 }, { "type": "INVALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:21.512340+00:00", "details": { "code_tried": "222222", "status": "Failed" }, "fee": 0 }, { "type": "INVALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "333333", "status": "Failed" }, "fee": 0 }, { "type": "PHONE_VERIFICATION_DECLINED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": { "reason": "VERIFICATION_CODE_ATTEMPTS_EXCEEDED" }, "fee": 0 } ], "matches": [] }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Declined (risk policy)": { "summary": "Código correcto, pero la línea es VoIP y voip_number_action=DECLINE", "value": { "request_id": "7f1c9d2e-44a1-4b6e-9a3e-5b8e6f1c2d3a", "status": "Declined", "message": "The verification code is correct.", "phone": { "status": "Declined", "phone_number_prefix": "+1", "phone_number": "5005550006", "full_number": "+15005550006", "country_code": "US", "country_name": "United States", "carrier": { "name": "CLEC LLC", "type": "voip" }, "is_disposable": false, "is_virtual": true, "verification_method": "sms", "verification_attempts": 1, "verified_at": "2026-06-12T01:24:47.311323Z", "warnings": [ { "feature": "PHONE", "risk": "VOIP_NUMBER_DETECTED", "additional_data": null, "log_type": "error", "short_description": "VoIP number detected", "long_description": "The system detected that the phone number is a VoIP number, which is not allowed." } ], "lifecycle": [ { "type": "PHONE_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null, "channel": "whatsapp", "actual_channel": "sms" }, "fee": 0.0509 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "PHONE_VERIFICATION_DECLINED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": { "reason": "VOIP_NUMBER_DETECTED" }, "fee": 0 } ], "matches": [] }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Expired or Not Found": { "summary": "No hay ninguna verificación pendiente para este número en los últimos 5 minutos", "value": { "request_id": "69cc35c6-280a-47a6-ab8c-4f32abc02ed0", "status": "Expired or Not Found", "message": "No pending phone verification found in the last 5 minutes.", "vendor_data": null, "metadata": null, "created_at": "2026-06-12T01:24:47.311323+00:00" } } } } } }, "400": { "description": "Error de validación: formato de errores de campo de DRF, con un array de mensajes por cada campo incorrecto.", "content": { "application/json": { "examples": { "Invalid code format": { "summary": "`code` no tiene entre 4 y 8 dígitos numéricos", "value": { "code": [ "Invalid code format. Enter 4 to 8 numeric digits." ] } }, "Invalid phone number": { "summary": "`phone_number` no es un número E.164 válido", "value": { "phone_number": [ "Invalid phone number provided." ] } }, "Invalid action": { "summary": "Las acciones de riesgo solo aceptan NO_ACTION o DECLINE", "value": { "voip_number_action": [ "\"REVIEW\" is not a valid choice." ] } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key`; una clave incorrecta, revocada o expirada devuelve `401`. Las comprobaciones son gratuitas, por lo que aquí no se verifica el crédito.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. Además, se aplica previamente un tope antiabuso de 4 intentos de verificación por número de teléfono por hora. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`. Nota: los encabezados `X-RateLimit-*`/`Retry-After` acompañan solo al 429 del límite de escritura de 300 por minuto; el 429 del tope por número no incluye encabezados de límite de solicitudes.", "content": { "application/json": { "examples": { "Per-number cap": { "summary": "Más de 4 intentos de verificación para el mismo número en la última hora", "value": { "detail": "Maximum verification attempts reached for this phone number. Only 4 authentication attempts are allowed per hour. Try again later or use a different number." } }, "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "502": { "description": "El proveedor de verificación de teléfono no está disponible temporalmente: una respuesta 5xx, un tiempo de espera agotado o un fallo de conexión que persistió tras los reintentos integrados. Puedes reintentar sin riesgo; no se consume el cupo de intentos.", "content": { "application/json": { "examples": { "Provider outage": { "summary": "El proveedor no respondió a la solicitud de comprobación", "value": { "detail": "Phone verification is temporarily unavailable. Please try again shortly.", "code": "phone_provider_unavailable" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string" } } } } } }, "500": { "description": "Error inesperado al verificar el código en el proveedor que no corresponde a una caída conocida del proveedor. Se puede reintentar sin riesgo; el cupo de intentos solo lo consumen las comprobaciones completadas.", "content": { "application/json": { "examples": { "Provider error": { "summary": "No se pudo completar la verificación del código", "value": { "detail": "Error checking phone verification" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/bank/account-check/": { "post": { "summary": "Comprobar una cuenta bancaria", "description": "**Aún no está disponible en producción.** La Verificación bancaria está desactivada en producción, así que, hasta que se active, este endpoint responde `404` con `bank_verification_not_available`. No construyas nada sobre él todavía. El resto de esta descripción explica lo que hace el endpoint cuando esté disponible.\n\nComprueba que una cuenta bancaria pertenece a la persona o empresa que indicas antes de enviarle dinero. Sin sesión y sin inicio de sesión: envía el nombre y la cuenta, y lee el resultado. Es la [comprobación de cuenta](/es/core-technology/bank-verification/account-check) del paso de Verificación bancaria, ejecutada desde tu backend.\n\n**Qué envías.** El `country` de la cuenta (ISO 3166-1 alfa-3), la `account` tal como se escribe en ese país y el nombre del `holder`: `full_name` para una persona o `business_name` para una empresa. Un nombre de empresa comprueba una cuenta de empresa.\n\n**Qué recibes.** `result` es `match`, `close_match`, `no_match` o `cannot_verify`. En un `close_match`, `holder_name` es el nombre con el que el banco tiene registrada la cuenta, cuando el banco lo devuelve. `account` se devuelve enmascarada, mostrando solo sus últimos 4 caracteres.\n\n**Facturación.** Cada comprobación que el banco responde se factura una vez al precio de Comprobación de cuenta del país de la cuenta, sea cual sea el resultado: un `no_match`, una cuenta que no existe y un `cannot_verify` también se facturan. Una solicitud respondida con un error nunca se factura.\n\n**Cada solicitud es una comprobación nueva.** No hay clave de idempotencia ni endpoint para volver a leer una comprobación, así que una solicitud que se reintenta se ejecuta, y se factura, de nuevo. Guarda la respuesta.\n\n**Sandbox.** Donde la Verificación bancaria está disponible, una clave de sandbox no llama a ningún banco y no genera ningún cargo. Los últimos 4 caracteres del IBAN, o si no del número de cuenta, determinan la respuesta: `0001` da un `close_match` con `holder_name`, `0002` un `close_match` sin él, `0003` y `0006` un `no_match`, `0004` `cannot_verify`, `0005` un `503` y `0009` un `400`. Cualquier otra terminación da un `match`.\n\n**Claves de API.** Una clave de API con alcance limitado necesita acceso de escritura a las sesiones.", "operationId": "post_v3_bank_account_check", "tags": [ "Standalone APIs" ], "x-didit-sdk": { "resource": "bank", "method": "account_check", "auth": "api_key", "server": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckRequest" }, "examples": { "Person, United Kingdom": { "summary": "Un sort code y un número de cuenta, verificados con el nombre de una persona", "value": { "country": "GBR", "account": { "sort_code": "20-45-67", "account_number": "31926819" }, "holder": { "full_name": "Maria Oliveira" }, "vendor_data": "payout_20481" } }, "Company, IBAN": { "summary": "Un IBAN, verificado con el nombre de una empresa", "value": { "country": "DEU", "account": { "iban": "DE89 3704 0044 0532 0130 00" }, "holder": { "business_name": "Northwind Trading GmbH" } } } } } } }, "responses": { "200": { "description": "El banco respondió. La comprobación se factura, sea cual sea el resultado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckResponse" }, "examples": { "Close match": { "summary": "El banco tiene la cuenta a un nombre similar", "value": { "request_id": "c2f4a9e0-7b1d-4c3a-9e55-1d0a6b8f2a47", "result": "close_match", "holder_name": "MARIA R OLIVEIRA", "account": "****6819", "vendor_data": "payout_20481", "created_at": "2026-10-21T14:32:08Z" } }, "Match": { "summary": "El banco tiene la cuenta al nombre enviado", "value": { "request_id": "5b0e2d7c-41a8-4f6e-9c3b-8e7d1a2f6c90", "result": "match", "holder_name": null, "account": "****3000", "vendor_data": null, "created_at": "2026-10-21T14:35:41Z" } } } } } }, "400": { "description": "Rechazado tal como se envió y no se factura. `field` indica el campo del cuerpo que hay que corregir y `reason` explica el motivo, con los mismos motivos que muestra el formulario de cuenta alojado. Solo se informa del primer campo rechazado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Missing field": { "summary": "La verificación de este país requiere un sort code", "value": { "detail": "The sort code is not valid (required).", "code": "invalid_account_input", "field": "account.sort_code", "reason": "required" } }, "Invalid IBAN": { "summary": "El IBAN no tiene la longitud correcta para su país", "value": { "detail": "The iban is not valid (length).", "code": "invalid_account_input", "field": "account.iban", "reason": "length" } }, "Refused by the bank": { "summary": "El banco rechazó la cuenta tal como se envió", "value": { "detail": "The account was refused as typed (rejected).", "code": "invalid_account_input", "field": "account.account_number", "reason": "rejected" } }, "No name": { "summary": "`holder` no tiene ni `full_name` ni `business_name`", "value": { "detail": "Send full_name for a person or business_name for a company.", "code": "invalid_account_input", "field": "holder", "reason": "required" } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Expired key": { "summary": "La fecha de caducidad de la clave ya pasó", "value": { "detail": "This API key has expired." } } } } } }, "402": { "description": "La comprobación no se puede pagar, así que no se ejecutó. Recarga tu saldo y vuelve a enviarla.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Out of credit": { "summary": "Tu saldo no alcanza para cubrir una comprobación", "value": { "detail": "You don't have enough credits to perform this request. Please top up at https://business.didit.me", "code": "insufficient_credits" } }, "Not in your contract": { "summary": "Tu contrato no tiene precio para la API de comprobación de cuentas", "value": { "detail": "Your contract does not price the Account check API. Contact your account manager.", "code": "contract_rate_missing" } } } } } }, "403": { "description": "Falta el encabezado `x-api-key` o el bearer token, o no es válido; la solicitud llegó desde una dirección que no está en la lista de IP de la clave, o una clave con alcance limitado no tiene acceso de escritura a las sesiones.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Missing or invalid credentials": { "summary": "No hay una clave de API o un token válidos", "value": { "detail": "You do not have permission to perform this action." } }, "No sessions write": { "summary": "Una clave con permisos limitados sin acceso de escritura a las sesiones", "value": { "detail": "This API key has no write access to sessions." } } } } } }, "404": { "description": "Todavía ninguna comprobación de cuenta cubre esta cuenta, por lo que no se ha comprobado ni facturado nada. `country_not_covered`: ninguna cubre su país, o su tipo de cuenta (persona o empresa) en ese país. `bank_not_covered`: ninguna cubre su banco. `bank_verification_not_available`: Bank Verification aún no está habilitada en producción, y esa es la respuesta para todas las solicitudes allí hasta que se active.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Country not covered": { "summary": "Ninguna comprobación de cuenta cubre el país", "value": { "detail": "No account check serves this country yet.", "code": "country_not_covered" } }, "Bank not covered": { "summary": "Ninguna comprobación de cuenta cubre el banco de la cuenta", "value": { "detail": "No account check serves this account's bank yet.", "code": "bank_not_covered" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" }, "503": { "description": "El banco no pudo responder. No se comprobó ni se facturó nada; vuelve a enviar la comprobación más tarde.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Unavailable": { "summary": "El banco no respondió", "value": { "detail": "The account check is temporarily unavailable and this request was not charged. Please try again.", "code": "account_check_unavailable" } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/bank/account-check/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"country\": \"GBR\",\n \"account\": {\"sort_code\": \"20-45-67\", \"account_number\": \"31926819\"},\n \"holder\": {\"full_name\": \"Maria Oliveira\"},\n \"vendor_data\": \"payout_20481\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.bank.account_check(\n country=\"GBR\",\n account={\n \"account_number\": \"31926819\",\n \"sort_code\": \"20-45-67\",\n },\n holder={\n \"full_name\": \"Maria Oliveira\",\n },\n vendor_data=\"payout_20481\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.bank.accountCheck({\n country: \"GBR\",\n account: {\n account_number: \"31926819\",\n sort_code: \"20-45-67\",\n },\n holder: {\n full_name: \"Maria Oliveira\",\n },\n vendor_data: \"payout_20481\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.AccountCheck(ctx, didit.BankAccountCheckRequest{\n\tCountry: \"GBR\",\n\tAccount: didit.BankAccountCheckRequestAccount{\n\t\tAccountNumber: didit.String(\"31926819\"),\n\t\tSortCode: didit.String(\"20-45-67\"),\n\t},\n\tHolder: didit.BankAccountCheckHolder{\n\t\tFullName: didit.String(\"Maria Oliveira\"),\n\t},\n\tVendorData: didit.String(\"payout_20481\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BankAccountCheckHolder;\nimport me.didit.types.BankAccountCheckPersonHolder;\nimport me.didit.types.BankAccountCheckRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.bank().accountCheck(BankAccountCheckRequest.builder()\n .country(\"GBR\")\n .account(BankAccountCheckRequest.Account.builder()\n .accountNumber(\"31926819\")\n .sortCode(\"20-45-67\")\n .build())\n .holder(BankAccountCheckHolder.ofBankAccountCheckPersonHolder(BankAccountCheckPersonHolder.builder()\n .fullName(\"Maria Oliveira\")\n .build()))\n .vendorData(\"payout_20481\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "bank->accountCheck([\n 'country' => 'GBR',\n 'account' => [\n 'account_number' => '31926819',\n 'sort_code' => '20-45-67',\n ],\n 'holder' => [\n 'full_name' => 'Maria Oliveira',\n ],\n 'vendor_data' => 'payout_20481',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.bank.account_check(\n country: \"GBR\",\n account: {\n account_number: \"31926819\",\n sort_code: \"20-45-67\",\n },\n holder: {\n full_name: \"Maria Oliveira\",\n },\n vendor_data: \"payout_20481\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Bank.AccountCheckAsync(new BankAccountCheckRequest\n{\n Country = \"GBR\",\n Account = new()\n {\n AccountNumber = \"31926819\",\n SortCode = \"20-45-67\",\n },\n Holder = new()\n {\n FullName = \"Maria Oliveira\",\n },\n VendorData = \"payout_20481\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/email/send/": { "post": { "summary": "Enviar código por correo electrónico", "description": "Envía un código de un solo uso (OTP) a una dirección de correo electrónico y luego verifícalo con [`POST /v3/email/check/`](/es/standalone-apis/email-check).\n\n**Cómo se relacionan el envío y la comprobación.** El estado de la verificación se identifica por tu aplicación y la dirección `email`: la llamada de comprobación no recibe `request_id`. Cada nuevo envío crea una verificación pendiente que dura **5 minutos**: llama a la comprobación con la misma dirección y el código que recibió el usuario antes de que se cierre ese plazo. Si vuelves a llamar al envío para la misma dirección mientras hay una verificación pendiente, se genera un código nuevo para esa misma verificación (`status: \"Retry\"`, mismo `request_id`) y el código anterior deja de funcionar. Así se asocia como máximo un reintento (dos envíos en total); un envío adicional inicia una verificación nueva con un nuevo `request_id`. El plazo de 5 minutos se cuenta desde el primer envío y los reintentos no lo amplían.\n\n**Comprobación previa de entregabilidad.** Antes de enviar nada, la dirección pasa por una validación de sintaxis y de DNS/MX. Las direcciones que no pueden recibir correo devuelven `200` con `status: \"Undeliverable\"` y `reason: \"email_can_not_be_delivered\"`: no se envía ningún correo, no se factura nada y la verificación se finaliza de inmediato como `Declined` (una comprobación posterior devuelve `Expired or Not Found`). Un fallo de envío posterior se notifica de la misma forma.\n\n**Formato del código y marca.** Los códigos tienen de 4 a 8 caracteres (`options.code_size`, 6 por defecto) y son numéricos por defecto; establece `options.alphanumeric_code: true` para usar letras mayúsculas y dígitos (la comparación en la comprobación no distingue mayúsculas de minúsculas). La plantilla del correo se localiza mediante `options.locale` (54 idiomas compatibles) y puede usar la personalización de marca blanca de tu aplicación mediante `options.use_white_label_customization`.\n\n**Facturación.** Un crédito de la API de Verificación de correo electrónico por cada envío correcto (`status: \"Success\"`), que se cobra en el momento del envío. Los envíos `Retry` y `Undeliverable` son gratuitos, y las comprobaciones también.\n\n**Persistencia de la sesión.** Cada nueva verificación se guarda como una sesión de tipo API: `request_id` es un id de sesión real que puedes pasar a `GET /v3/session/{sessionId}/decision/`, la verificación aparece en la Business Console y se disparan webhooks `status.updated` a medida que avanza.\n\n**Sandbox.** Las claves de API de sandbox omiten la entrega y la facturación: tras validar la solicitud (una entrada mal formada sigue devolviendo `400`), el endpoint devuelve un payload estático `Success` con un `request_id` aleatorio; no se envía ningún correo y no se guarda nada. Usa el código `123456` en la comprobación de sandbox.\n\n**Autenticación.** Envía la clave de API de tu aplicación en el encabezado `x-api-key`. Si faltan las credenciales o no son válidas, se devuelve `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`): esta API nunca devuelve `401`.\n\n**Límite de solicitudes.** Presupuesto de escritura compartido de 300 solicitudes por minuto por clave de API entre todos los endpoints POST/PATCH/DELETE; si se supera, se devuelve `429`.", "operationId": "post_v3email_send", "x-didit-sdk": { "resource": "email", "method": "send_code", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/email/send/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"email\": \"alice@example.com\",\n \"options\": { \"code_size\": 6, \"locale\": \"en\" },\n \"vendor_data\": \"user-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.email.send_code(\n email=\"alice@example.com\",\n options={\n \"locale\": \"en\",\n },\n vendor_data=\"user-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.email.sendCode({\n email: \"alice@example.com\",\n options: {\n locale: \"en\",\n },\n vendor_data: \"user-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Email.SendCode(ctx, didit.EmailSendCodeParams{\n\tEmail: \"alice@example.com\",\n\tOptions: didit.Some(didit.EmailSendCodeParamsOptions{\n\t\tLocale: didit.Some(didit.EmailSendCodeParamsOptionsLocale(\"en\")),\n\t}),\n\tVendorData: didit.String(\"user-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.EmailSendCodeParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.email().sendCode(EmailSendCodeParams.builder()\n .email(\"alice@example.com\")\n .options(EmailSendCodeParams.Options.builder()\n .locale(EmailSendCodeParams.Options.Locale.of(\"en\"))\n .build())\n .vendorData(\"user-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "email->sendCode([\n 'email' => 'alice@example.com',\n 'options' => [\n 'locale' => 'en',\n ],\n 'vendor_data' => 'user-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.email.send_code(\n email: \"alice@example.com\",\n options: {\n locale: \"en\",\n },\n vendor_data: \"user-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Email.SendCodeAsync(new EmailSendCodeParams\n{\n Email = \"alice@example.com\",\n Options = new EmailSendCodeParamsOptions\n {\n Locale = new EmailSendCodeParamsOptionsLocale(\"en\"),\n },\n VendorData = \"user-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "Dirección de correo electrónico del destinatario. Las direcciones mal formadas devuelven `400`; las direcciones sintácticamente válidas que no pueden recibir correo (validación DNS/MX fallida) devuelven `200` con `status: \"Undeliverable\"`.", "example": "alice@example.com" }, "options": { "type": "object", "description": "Opciones de formato, localización y marca del OTP. Todos los campos son opcionales.", "properties": { "code_size": { "type": "integer", "minimum": 4, "maximum": 8, "default": 6, "description": "Número de caracteres del OTP (dígitos de forma predeterminada; letras mayúsculas y dígitos cuando `alphanumeric_code` es `true`)." }, "alphanumeric_code": { "type": "boolean", "default": false, "description": "Si es `true`, el OTP se compone de letras mayúsculas `A–Z` y dígitos `0–9` en lugar de solo dígitos. La comparación de `/v3/email/check/` no distingue entre mayúsculas y minúsculas." }, "locale": { "type": "string", "maxLength": 5, "enum": [ "en", "ar", "bn", "bg", "bs", "ca", "cs", "da", "de", "el", "es", "et", "fa", "fi", "fr", "he", "hi", "hr", "hu", "hy", "id", "it", "ja", "ka", "kk", "ko", "ky", "lt", "lv", "cnr", "mk", "mn", "ms", "nl", "no", "pl", "pt-BR", "pt", "ro", "ru", "sk", "sl", "so", "sq", "sr", "sv", "th", "tr", "uk", "uz", "vi", "zh-CN", "zh-TW", "zh" ], "description": "Idioma de la plantilla de correo electrónico del OTP. El valor predeterminado es `en`. Los valores no admitidos devuelven `400` con la lista de todas las configuraciones regionales admitidas.", "example": "en" }, "use_white_label_customization": { "type": "boolean", "default": false, "description": "Si es `true`, el correo electrónico del OTP usa la personalización de marca blanca de tu aplicación (logotipo, colores, marca del remitente) en lugar de la plantilla predeterminada de Didit." } } }, "signals": { "type": "object", "description": "Señales opcionales de dispositivo y red sobre el usuario final, que se envían a la capa antifraude para mejorar la detección de tráfico abusivo o automatizado. Todos los campos son opcionales.", "properties": { "ip": { "type": "string", "description": "Dirección IP del dispositivo del usuario final. IPv4 o IPv6.", "example": "192.0.2.1" }, "device_id": { "type": "string", "maxLength": 255, "description": "Identificador único del dispositivo del usuario final. Android: `ANDROID_ID`; iOS: `identifierForVendor`.", "example": "8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2" }, "device_platform": { "type": "string", "enum": [ "android", "ios", "ipados", "tvos", "web" ], "description": "Plataforma del dispositivo del usuario final." }, "device_model": { "type": "string", "maxLength": 255, "description": "Modelo del dispositivo del usuario final.", "example": "iPhone17,2" }, "os_version": { "type": "string", "maxLength": 64, "description": "Versión del sistema operativo del dispositivo del usuario final.", "example": "18.0.1" }, "app_version": { "type": "string", "maxLength": 64, "description": "Versión de tu aplicación.", "example": "1.2.34" }, "user_agent": { "type": "string", "maxLength": 512, "description": "User agent del navegador o la aplicación del usuario final.", "example": "Mozilla/5.0 (iPhone; CPU iPhone OS 14_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Mobile/15E148 Safari/604.1" } } }, "vendor_data": { "type": "string", "description": "Identificador opcional controlado por quien llama (tu id interno de usuario, un correo electrónico, un UUID, etc.) que se guarda en la sesión y se devuelve en la respuesta del envío, en la respuesta de la comprobación correspondiente, en los webhooks y en la Business Console. Úsalo para relacionar el `request_id` de Didit con tu registro de usuario." }, "metadata": { "type": "object", "nullable": true, "description": "Objeto JSON opcional de formato libre que se guarda en la sesión y se devuelve en la respuesta del envío, en la respuesta de la comprobación correspondiente, en los webhooks y en la Business Console." } }, "required": [ "email" ] }, "examples": { "Numeric 6-digit code": { "summary": "Predeterminado: código numérico de 6 dígitos en inglés", "value": { "email": "alice@example.com", "options": { "locale": "en" }, "vendor_data": "user-1234" } }, "Alphanumeric 8-character code": { "summary": "Letras mayúsculas + dígitos, plantilla española", "value": { "email": "bob@example.com", "options": { "code_size": 8, "alphanumeric_code": true, "locale": "es" } } }, "White-label branding": { "summary": "Envía el correo de OTP con la personalización de marca blanca de tu aplicación", "value": { "email": "carol@example.com", "options": { "locale": "en", "use_white_label_customization": true }, "vendor_data": "user-5678" } } } } } }, "responses": { "200": { "description": "Envío confirmado. Revisa `status`: `Success` y `Retry` significan que hay un código en camino; `Undeliverable` significa que la dirección no puede recibir correo y la verificación ya se ha finalizado como `Declined`. `request_id` es el id de sesión persistido (el mismo id en un `Retry`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailVerificationSendResponse" }, "examples": { "Success": { "summary": "OTP enviado por correo electrónico para una nueva verificación (facturado)", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Success", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Retry": { "summary": "Segundo envío dentro de la ventana de 5 minutos: código nuevo, mismo request_id, gratis", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Retry", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Undeliverable": { "summary": "La dirección no superó la validación DNS/MX: la verificación finalizó como Rechazada y no se facturó nada", "value": { "request_id": "cb1a5011-344d-444d-bdce-218904745d7f", "status": "Undeliverable", "reason": "email_can_not_be_delivered", "vendor_data": "user-1234", "metadata": null } } } } } }, "400": { "description": "Error de validación: formato de errores de campo de DRF, con un array de mensajes por cada campo incorrecto, anidado bajo `options` para los errores de opciones.", "content": { "application/json": { "examples": { "Invalid email": { "summary": "Dirección de correo electrónico con formato incorrecto", "value": { "email": [ "Enter a valid email address." ] } }, "Unsupported locale": { "summary": "`options.locale` fuera del conjunto admitido", "value": { "options": { "locale": [ "Invalid locale. Supported locales are en, ar, bn, bg, bs, ca, cs, da, de, el, es, et, fa, fi, fr, he, hi, hr, hu, hy, id, it, ja, ka, kk, ko, ky, lt, lv, cnr, mk, mn, ms, nl, no, pl, pt-BR, pt, ro, ru, sk, sl, so, sq, sr, sv, th, tr, uk, uz, vi, zh-CN, zh-TW, zh." ] } } }, "Code size out of range": { "summary": "`options.code_size` fuera del rango 4–8", "value": { "options": { "code_size": [ "Ensure this value is less than or equal to 8." ] } } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key` (`{\"detail\": ...}`); una clave incorrecta, revocada o expirada devuelve `401`. También se devuelve antes de cualquier envío cuando el saldo de la organización no cubre un crédito de la API de Verificación de correo electrónico (`{\"error\": ...}`).", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de la organización no cubre el precio del envío", "value": { "error": "You don't have enough credits to perform this request." } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "503": { "description": "No se pudo contactar con el proveedor de correo electrónico (por una interrupción o un tiempo de espera agotado), por lo que no se envió ningún código y no se facturó nada ni se contó como intento de envío. Repite la misma solicitud.", "content": { "application/json": { "examples": { "Email delivery unavailable": { "summary": "El proveedor de correo electrónico falló tras un reintento automático", "value": { "detail": "Email delivery is temporarily unavailable. Please try again." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/email/check/": { "post": { "summary": "Comprobar código de correo electrónico", "description": "Verifica el OTP enviado por [`POST /v3/email/send/`](/es/standalone-apis/email-send) y obtén el resultado final de la verificación junto con información sobre el correo electrónico: entregabilidad, exposición a filtraciones (`is_breached` y la lista `breaches` procedente de una base de datos de inteligencia sobre filtraciones), detección de proveedores desechables y uso duplicado de la dirección en tus sesiones.\n\n**Cómo localiza la comprobación la verificación.** La coincidencia se hace por tu aplicación más la dirección `email`; `request_id` no es un dato de entrada. Se comprueba la verificación pendiente más reciente creada en los últimos **5 minutos**. Si no hay ninguna (nunca se envió, ya se finalizó, no se pudo entregar en el momento del envío o tiene más de 5 minutos), el endpoint devuelve `200` con `status: \"Expired or Not Found\"`.\n\n**Límite de intentos.** Cada verificación admite **3 intentos de código**. Los dos primeros códigos incorrectos devuelven `status: \"Failed\"` con los intentos restantes y `email: null`; el tercer código incorrecto finaliza la verificación como `Declined` con una advertencia `EMAIL_CODE_ATTEMPTS_EXCEEDED` y devuelve el informe completo del correo electrónico. Los códigos se comparan sin distinguir mayúsculas de minúsculas (relevante para los envíos `alphanumeric_code`); solo es válido el código enviado más recientemente.\n\n**Resultados.** `Approved`: código correcto y ningún riesgo que provoque el rechazo. `Declined`: estado terminal; el código era correcto pero coincidió un riesgo que provoca el rechazo (una acción `DECLINE` de las indicadas más abajo, una dirección en la lista de bloqueo o una dirección que resultó no entregable al finalizar), o se agotó el límite de intentos. `Failed`: código incorrecto, quedan intentos. `Expired or Not Found`: no hay nada que comprobar. En `Approved`/`Declined`, el `request_id` es igual al `request_id` del envío (el ID de la sesión) y `email` contiene el informe completo (`is_breached`, `breaches`, `is_disposable`, `is_undeliverable`, `warnings`, `lifecycle`, `matches`); en `Failed` y `Expired or Not Found`, el `request_id` es un UUID aleatorio de un solo uso.\n\n**Acciones de riesgo.** `duplicated_email_action`, `breached_email_action` y `disposable_email_action` deciden qué ocurre cuando se detecta el riesgo correspondiente con un código correcto: `DECLINE` cambia el estado final a `Declined`; `NO_ACTION` (valor predeterminado) registra el riesgo en `email.warnings` sin afectar al estado.\n\n**Facturación.** Las comprobaciones son gratuitas: el crédito se consume con el envío correcto.\n\n**Persistencia de la sesión.** Una comprobación finalizada actualiza la sesión creada por el envío (visible en la Business Console y consultable mediante `GET /v3/session/{sessionId}/decision/`) y dispara un webhook `status.updated`.\n\n**Sandbox.** Las claves de API de sandbox omiten todo el procesamiento: cualquier código con formato válido (incluido `123456`) devuelve un payload estático `Approved` con un objeto `email` simplificado (`status`, `email`, `is_breached`, `is_disposable`, `is_undeliverable`); una entrada con formato incorrecto sigue devolviendo `400`. No se guarda nada.\n\n**Autenticación.** Envía la clave de API de tu aplicación en el encabezado `x-api-key`. Si las credenciales faltan o no son válidas, se devuelve `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); esta API nunca devuelve `401`.\n\n**Límite de solicitudes.** Presupuesto de escritura compartido de 300 solicitudes/min por clave de API entre todos los endpoints POST/PATCH/DELETE; si lo superas, se devuelve `429`.\n\n**Huella social.** Establece `enable_social` en `true` para añadir un bloque `email_social`: las plataformas en línea en las que está registrada esta dirección, con recuentos por categoría y los detalles de perfil disponibles. `profiles_registered: 0` significa que se comprobaron las plataformas y la dirección no se encontró en ninguna de ellas, lo que es una respuesta válida y facturable. El bloque no aparece cuando no se solicitó el complemento o no se pudo completar la comprobación, y en ese caso no se factura. La facturación añade una unidad `email_social` por solicitud, además del precio propio de este endpoint.", "operationId": "post_v3email_check", "x-didit-sdk": { "resource": "email", "method": "check_code", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/email/check/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"email\": \"alice@example.com\",\n \"code\": \"123456\",\n \"disposable_email_action\": \"DECLINE\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.email.check_code(\n email=\"alice@example.com\",\n code=\"123456\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.email.checkCode({\n email: \"alice@example.com\",\n code: \"123456\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Email.CheckCode(ctx, didit.EmailCheckCodeParams{\n\tEmail: \"alice@example.com\",\n\tCode: \"123456\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.EmailCheckCodeParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.email().checkCode(EmailCheckCodeParams.builder()\n .email(\"alice@example.com\")\n .code(\"123456\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "email->checkCode([\n 'email' => 'alice@example.com',\n 'code' => '123456',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.email.check_code(\n email: \"alice@example.com\",\n code: \"123456\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Email.CheckCodeAsync(new EmailCheckCodeParams\n{\n Email = \"alice@example.com\",\n Code = \"123456\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "La misma dirección de correo electrónico usada en la llamada correspondiente a [`POST /v3/email/send/`](/es/standalone-apis/email-send). Es lo que vincula la comprobación con el envío.", "example": "alice@example.com" }, "code": { "type": "string", "maxLength": 10, "description": "El OTP que recibió el usuario final: entre 4 y 8 dígitos, o entre 4 y 8 letras o dígitos cuando se usó `alphanumeric_code: true` en el envío. La comparación no distingue entre mayúsculas y minúsculas.", "example": "123456" }, "duplicated_email_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Qué hacer cuando otro usuario de tu aplicación (con un `vendor_data` distinto) ya usó y tiene aprobada la misma dirección (solo cuentan las verificaciones aprobadas previamente). `DECLINE` cambia el `status` final a `Declined`; `NO_ACTION` registra el riesgo en `email.warnings` y rellena `email.matches`." }, "breached_email_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Qué hacer cuando la dirección aparece en filtraciones de datos conocidas (`email.is_breached`). `DECLINE` cambia el `status` final a `Declined`; `NO_ACTION` registra el riesgo en `email.warnings`." }, "disposable_email_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Qué hacer cuando el dominio pertenece a un proveedor de correo desechable o temporal (`email.is_disposable`). `DECLINE` cambia el `status` final a `Declined`; `NO_ACTION` registra el riesgo en `email.warnings`." }, "enable_enrichment": { "type": "boolean", "default": false, "description": "Si es `true`, también ejecuta inteligencia de correo electrónico sobre la dirección: una puntuación de riesgo y su historial de filtraciones. Se factura como una unidad `email_intelligence_api` por solicitud ($0.05 a precio de lista), además del precio propio de este endpoint. La solicitud devuelve `403` cuando tu saldo no alcanza para cubrirlo.", "example": false }, "email_intelligence_score_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acción cuando la puntuación de riesgo de inteligencia del correo electrónico supera el umbral. `DECLINE` cambia el `status` final a `Declined`; `NO_ACTION` registra la señal sin rechazar. Solo tiene efecto cuando `enable_enrichment` es `true`." }, "recent_email_breach_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acción cuando la dirección aparece en una filtración de datos conocida reciente. `DECLINE` cambia el `status` final a `Declined`; `NO_ACTION` registra la señal sin rechazar. Solo tiene efecto cuando `enable_enrichment` es `true`." }, "frequent_email_breach_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acción cuando la dirección aparece en muchas filtraciones de datos conocidas. `DECLINE` cambia el `status` final a `Declined`; `NO_ACTION` registra la señal sin rechazar. Solo tiene efecto cuando `enable_enrichment` es `true`." }, "enable_social": { "type": "boolean", "default": false, "description": "Si es true, también se consulta la huella social de la dirección: las plataformas de correo electrónico, redes sociales, profesionales, comercio electrónico y entretenimiento en las que está registrada. Se factura como una unidad `email_social` por solicitud, además del precio propio de este endpoint.", "example": true }, "email_no_social_presence_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acción cuando la comprobación de huella social no encuentra la dirección registrada en ninguna de las plataformas que cubre. En este endpoint solo se aceptan NO_ACTION y DECLINE; REVIEW está disponible en la clave de configuración del flujo con el mismo nombre." } }, "required": [ "email", "code" ] }, "examples": { "Default": { "summary": "Registrar los riesgos, pero nunca rechazar automáticamente", "value": { "email": "alice@example.com", "code": "123456" } }, "Strict risk policy": { "summary": "Rechazar automáticamente los buzones desechables y los expuestos en filtraciones de datos", "value": { "email": "alice@example.com", "code": "123456", "disposable_email_action": "DECLINE", "breached_email_action": "DECLINE" } } } } } }, "responses": { "200": { "description": "Comprobación completada: los códigos incorrectos y las verificaciones inexistentes también devuelven `200`; revisa `status`, no el código HTTP. `email` solo se rellena en resultados finalizados (`Approved`/`Declined`), es `null` en `Failed` y no aparece en `Expired or Not Found`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailVerificationCheckResponse" }, "examples": { "Approved": { "summary": "Código correcto: dirección limpia, informe completo del correo electrónico", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Approved", "message": "The verification code is correct.", "email": { "status": "Approved", "email": "alice@example.com", "is_breached": false, "breaches": [], "is_disposable": false, "is_undeliverable": false, "verification_attempts": 1, "verified_at": "2026-06-12T01:24:47.311323Z", "warnings": [], "lifecycle": [ { "type": "EMAIL_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null }, "fee": 0.02 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "EMAIL_VERIFICATION_APPROVED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": null, "fee": 0 } ], "matches": [] }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Approved with breach exposure": { "summary": "Código correcto; la exposición en filtraciones se registra como advertencia (breached_email_action=NO_ACTION)", "value": { "request_id": "3a1f2b6c-9d4e-4f7a-8b2c-1e5d6f7a8b9c", "status": "Approved", "message": "The verification code is correct.", "email": { "status": "Approved", "email": "bob@example.com", "is_breached": true, "breaches": [ { "name": "ExampleApp", "domain": "exampleapp.com", "breach_date": "2019-03-21", "breach_emails_count": 763117, "description": "In March 2019, the social platform ExampleApp suffered a data breach that exposed email addresses and passwords.", "logo_path": "https:///logos/ExampleApp.png", "data_classes": [ "email_addresses", "passwords" ], "is_verified": true } ], "is_disposable": false, "is_undeliverable": false, "verification_attempts": 1, "verified_at": "2026-06-12T01:24:47.311323Z", "warnings": [ { "feature": "EMAIL", "risk": "BREACHED_EMAIL_DETECTED", "additional_data": null, "log_type": "information", "short_description": "Breached email detected", "long_description": "This email address was found in one or more known data breaches." } ], "lifecycle": [ { "type": "EMAIL_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null }, "fee": 0.02 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "835126", "status": "Approved" }, "fee": 0 }, { "type": "EMAIL_VERIFICATION_APPROVED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": null, "fee": 0 } ], "matches": [] }, "vendor_data": "user-5678", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Failed (attempts remaining)": { "summary": "Código incorrecto: el usuario puede reintentar; aquí request_id es un UUID de un solo uso", "value": { "request_id": "11111111-2222-3333-4444-555555555555", "status": "Failed", "message": "The verification code is incorrect. Attempts remaining: 2", "email": null, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:21.512340+00:00" } }, "Declined (risk policy)": { "summary": "Código correcto, pero la dirección es desechable y disposable_email_action=DECLINE", "value": { "request_id": "8c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "status": "Declined", "message": "The verification code is correct.", "email": { "status": "Declined", "email": "tempuser42@mailinator.com", "is_breached": false, "breaches": [], "is_disposable": true, "is_undeliverable": false, "verification_attempts": 1, "verified_at": "2026-06-12T01:24:47.311323Z", "warnings": [ { "feature": "EMAIL", "risk": "DISPOSABLE_EMAIL_DETECTED", "additional_data": null, "log_type": "error", "short_description": "Disposable email detected", "long_description": "The system detected that the email is disposable, which is not allowed." } ], "lifecycle": [ { "type": "EMAIL_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null }, "fee": 0.02 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "EMAIL_VERIFICATION_DECLINED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": { "reason": "DISPOSABLE_EMAIL_DETECTED" }, "fee": 0 } ], "matches": [] }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Expired or Not Found": { "summary": "No hay ninguna verificación pendiente para esta dirección en los últimos 5 minutos", "value": { "request_id": "88808a77-06e9-4cb0-85f5-9c052ddfd987", "status": "Expired or Not Found", "message": "No pending email verification found in the last 5 minutes.", "vendor_data": null, "metadata": null, "created_at": "2026-06-12T01:24:59.887904+00:00" } } } } } }, "400": { "description": "Error de validación: formato de errores de campo de DRF, con un array de mensajes por cada campo incorrecto.", "content": { "application/json": { "examples": { "Invalid email": { "summary": "Dirección de correo electrónico con formato incorrecto", "value": { "email": [ "Enter a valid email address." ] } }, "Missing code": { "summary": "`code` no se incluye en el cuerpo", "value": { "code": [ "This field is required." ] } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key`; una clave incorrecta, revocada o expirada devuelve `401`. Las comprobaciones son gratuitas, por lo que aquí no se verifica el crédito.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/workflows/": { "get": { "summary": "Listar flujos", "description": "Lista tus flujos, de más reciente a más antiguo, en un sobre de paginación limit/offset (`{count, next, previous, results}`, tamaño de página predeterminado 50). Cada fila es una versión; `workflow_id` es el ID de grupo estable y las nuevas sesiones usan la última versión `published`.", "operationId": "list_workflows", "x-didit-sdk": { "resource": "workflows", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Workflows" ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50 }, "description": "Tamaño de página (número de flujos por página)." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Número de filas que se omiten antes del primer flujo devuelto." } ], "responses": { "200": { "description": "Una página de flujos de verificación (workflows) ordenados por `created_at` en orden descendente, dentro del sobre de paginación. Cada elemento de `results` es un `WorkflowListItem`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número total de versiones del flujo de la aplicación." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la página siguiente, o `null` en la última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la página anterior, o `null` en la primera página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowListItem" } } } }, "examples": { "Two workflows": { "summary": "Un flujo de verificación (workflow) de KYC predeterminado y un borrador de flujo de KYC + AML", "value": { "count": 2, "next": null, "previous": null, "results": [ { "uuid": "a1b2c3d4-5678-90ab-cdef-111111111111", "workflow_id": "a1b2c3d4-5678-90ab-cdef-111111111111", "workflow_label": "Standard KYC", "workflow_type": "kyc", "is_default": true, "is_archived": false, "is_white_label_enabled": false, "total_price": 0.15, "min_price": 0.15, "max_price": 0.15, "features": "OCR + LIVENESS + FACE_MATCH", "is_simple_workflow": true, "is_editable": false, "workflow_url": "https://verify.didit.me/u/_yljPOx8RWG3UAz5ZRQGVQ", "max_retry_attempts": 3, "retry_window_days": 7, "session_expiration_time": 604800, "version": 2, "status": "published", "has_draft": false, "created_by": { "name": "Alex Mateo", "email": "alex@example.com", "type": "user" }, "updated_at": "2026-04-12T10:30:00Z" }, { "uuid": "b2c3d4e5-6789-01bc-defa-222222222222", "workflow_id": "b2c3d4e5-6789-01bc-defa-222222222222", "workflow_label": "Full Verification + AML", "workflow_type": "kyc", "is_default": false, "is_archived": false, "is_white_label_enabled": false, "total_price": 0.25, "min_price": 0.25, "max_price": 0.25, "features": "OCR + LIVENESS + FACE_MATCH + AML", "is_simple_workflow": true, "is_editable": true, "workflow_url": "https://verify.didit.me/u/Aq3kPOx8RWG3UAz5ZRQGVQ", "max_retry_attempts": 3, "retry_window_days": 7, "session_expiration_time": 604800, "version": 1, "status": "draft", "has_draft": true, "created_by": null, "updated_at": "2026-04-15T18:05:21Z" } ] } } } } } }, "403": { "description": "Falta la clave de API, tiene un formato incorrecto, ha expirado o pertenece a otra aplicación. Cuerpo: `{\"detail\": \"You do not have permission to perform this action.\"}`. Renueva el token mediante la [Auth API](/es/auth-api/get-credentials) y vuelve a intentarlo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Límite de solicitudes superado. Reintenta con retroceso exponencial y respeta cualquier encabezado `Retry-After`." }, "500": { "description": "Error inesperado del servidor al generar la lista. La solicitud se puede reintentar sin riesgo." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X GET 'https://verification.didit.me/v3/workflows/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.workflows.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.workflows.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Workflows.ListAutoPaging(ctx, didit.WorkflowsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.workflows().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "workflows->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.workflows.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Workflows.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "summary": "Crear flujo", "description": "Crea un flujo simple. Envía `features` en el orden de ejecución (se aplican reglas de orden); por defecto es `published` v1. El cuerpo acepta SOLO los campos indicados en `SimpleWorkflowRequest`: cualquier otra clave (incluida `workflow_type`) se rechaza con un 400. No es idempotente: cada llamada crea un flujo nuevo. Máximo 50 flujos por aplicación.", "operationId": "create_workflow", "x-didit-sdk": { "resource": "workflows", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Workflows" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleWorkflowRequest" }, "examples": { "Simple KYC": { "summary": "Flujo lineal de verificación de identidad, prueba de vida y coincidencia facial", "value": { "workflow_label": "Standard KYC", "features": [ { "feature": "OCR", "config": { "duplicated_user_action": "review" } }, { "feature": "LIVENESS", "config": { "face_liveness_method": "passive" } }, { "feature": "FACE_MATCH", "config": { "face_match_score_decline_threshold": 40, "face_match_score_review_threshold": 60 } } ] } }, "KYC + AML": { "summary": "Ejecutar el análisis AML después de la verificación de identidad", "value": { "workflow_label": "KYC with AML", "features": [ { "feature": "OCR" }, { "feature": "AML", "config": { "aml_score_review_threshold": 70, "aml_score_approve_threshold": 30 } } ] } }, "Questionnaire workflow": { "summary": "Ejecutar un cuestionario creado con POST /v3/questionnaires/", "value": { "workflow_label": "Source of Funds", "features": [ { "feature": "QUESTIONNAIRE", "config": { "questionnaire_uuid": "11111111-2222-3333-4444-555555555555", "review_questionnaire_manually": true } } ] } } } } } }, "responses": { "201": { "description": "Flujo creado. El cuerpo de la respuesta es la configuración COMPLETA del flujo: la misma serialización sin procesar de `VerificationSettings` que devuelve `GET /v3/workflows/{settings_uuid}/` (~190 campos: cada interruptor de función, umbral, acción y el `workflow_graph` generado), no el elemento compacto de la lista. Guarda el `uuid` (también expuesto como `workflow_id`) para poder referenciarlo en llamadas posteriores de creación de sesiones. Nota: `features` es una cadena unida con `\" + \"` y los precios son números JSON.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDetail" }, "examples": { "Created (abbreviated)": { "summary": "Campos clave del objeto de configuración completo", "value": { "uuid": "c3d4e5f6-7890-12cd-ef34-333333333333", "workflow_id": "c3d4e5f6-7890-12cd-ef34-333333333333", "workflow_label": "Standard KYC", "workflow_type": null, "is_default": false, "is_archived": false, "total_price": 0.15, "min_price": 0.15, "max_price": 0.15, "features": "OCR + LIVENESS + FACE_MATCH", "is_simple_workflow": false, "is_editable": false, "workflow_url": "https://verify.didit.me/u/w9TkPOx8RWG3UAz5ZRQGVQ", "workflow_graph": { "start_node": "ocr", "nodes": "... one node per feature plus a final status node ..." }, "max_retry_attempts": 3, "retry_window_days": 7, "session_expiration_time": 604800, "version": 1, "status": "published", "published_at": "2026-05-17T10:30:00Z", "created_at": "2026-05-17T10:30:00Z", "updated_at": "2026-05-17T10:30:00Z" } } } } } }, "400": { "description": "Error de validación. Causas comunes: una clave de nivel superior fuera de la lista de claves aceptadas (p. ej., `workflow_type`), un valor de `feature` desconocido, una función colocada antes de su dependencia (p. ej., `FACE_MATCH` antes de `OCR`), una función pasiva (`AML`, `IP_ANALYSIS`, `DATABASE_VALIDATION`, `KYB_KEY_PEOPLE`) usada como primer paso, una función `QUESTIONNAIRE` cuyo `config.questionnaire_uuid` no existe para esta aplicación, una función `SIGNATURE` que pasaría a producción sin ningún documento que firmar, una función `SIGNATURE` con `signature_level: \"aes\"` cuando Advanced (AES) no está disponible (`aes_not_available`, consulta `signature_availability` en el flujo) o un umbral fuera de rango. El cuerpo es un objeto de error de validación de DRF: las claves son nombres de campo y los valores son arrays de mensajes legibles.", "content": { "application/json": { "examples": { "Advanced (AES) not available": { "value": { "features": { "signature_level": [ "Node 'signature': Advanced (AES) is not available yet (aes_not_available)." ] } } }, "Signature step with no document": { "value": { "features": { "non_field_errors": [ "Node 'signature': Add a document to sign, or let each session bring its own." ] } } }, "Missing feature": { "value": { "features": [ "At least one feature is required." ] } }, "Unknown top-level field": { "value": { "workflow_type": [ "The v3 workflow API only accepts `workflow_label`, `is_default`, `status`, `features`, `is_white_label_enabled`, `is_desktop_allowed`, `max_retry_attempts`, `retry_window_days`, `session_expiration_time`, `face_liveness_max_attempts`, `face_match_max_attempts`." ] } }, "Unknown feature": { "value": { "features": [ "Invalid feature 'FOO'. Allowed values: AGE_ESTIMATION, AML, DATABASE_VALIDATION, EMAIL_VERIFICATION, FACE_MATCH, IP_ANALYSIS, KYB_DOCUMENTS, KYB_KEY_PEOPLE, KYB_REGISTRY, LIVENESS, NFC, OCR, PHONE_VERIFICATION, PROOF_OF_ADDRESS, QUESTIONNAIRE." ] } }, "Ordering": { "value": { "features": [ "Feature 'FACE_MATCH' must appear after one of: OCR." ] } }, "Questionnaire not found": { "value": { "features": "Questionnaire '11111111-2222-3333-4444-555555555555' was not found for this application. Create the questionnaire first, then use its questionnaire_id." } } } } } }, "403": { "description": "Falta la clave de API, tiene un formato incorrecto, ha expirado o está limitada a otra aplicación. Renuévala mediante la [Auth API](/es/auth-api/get-credentials) y vuelve a intentarlo.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "415": { "description": "Tipo de contenido no admitido. Define `Content-Type: application/json` y envía un cuerpo JSON." }, "429": { "description": "Límite de solicitudes superado. Reintenta con retroceso exponencial." }, "500": { "description": "Error inesperado del servidor al crear el flujo. Se puede reintentar sin riesgo." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/workflows/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"workflow_label\": \"Standard KYC\",\n \"features\": [\n {\"feature\": \"OCR\"},\n {\"feature\": \"LIVENESS\", \"config\": {\"face_liveness_method\": \"passive\"}},\n {\"feature\": \"FACE_MATCH\", \"config\": {\"face_match_score_decline_threshold\": 40, \"face_match_score_review_threshold\": 60}}\n ]\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.workflows.create(\n workflow_label=\"Standard KYC\",\n features=[{\n \"feature\": \"OCR\",\n \"config\": {\"duplicated_user_action\": \"review\"},\n }, {\n \"feature\": \"LIVENESS\",\n \"config\": {\"face_liveness_method\": \"passive\"},\n }, {\n \"feature\": \"FACE_MATCH\",\n \"config\": {\"face_match_score_decline_threshold\": 40, \"face_match_score_review_threshold\": 60},\n }],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.workflows.create({\n workflow_label: \"Standard KYC\",\n features: [{\n feature: \"OCR\",\n config: { duplicated_user_action: \"review\" },\n }, {\n feature: \"LIVENESS\",\n config: { face_liveness_method: \"passive\" },\n }, {\n feature: \"FACE_MATCH\",\n config: { face_match_score_decline_threshold: 40, face_match_score_review_threshold: 60 },\n }],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Workflows.Create(ctx, didit.SimpleWorkflowRequest{\n\tWorkflowLabel: didit.String(\"Standard KYC\"),\n\tFeatures: []didit.SimpleWorkflowFeature{{\n\t\tFeature: \"OCR\",\n\t\tConfig: didit.Some(map[string]any{\"duplicated_user_action\": \"review\"}),\n\t}, {\n\t\tFeature: \"LIVENESS\",\n\t\tConfig: didit.Some(map[string]any{\"face_liveness_method\": \"passive\"}),\n\t}, {\n\t\tFeature: \"FACE_MATCH\",\n\t\tConfig: didit.Some(map[string]any{\"face_match_score_decline_threshold\": 40, \"face_match_score_review_threshold\": 60}),\n\t}},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SimpleWorkflowFeature;\nimport me.didit.types.SimpleWorkflowRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.workflows().create(SimpleWorkflowRequest.builder()\n .workflowLabel(\"Standard KYC\")\n .features(List.of(\n SimpleWorkflowFeature.builder()\n .feature(SimpleWorkflowFeature.Feature.of(\"OCR\"))\n .config(Map.of(\"duplicated_user_action\", \"review\"))\n .build(),\n SimpleWorkflowFeature.builder()\n .feature(SimpleWorkflowFeature.Feature.of(\"LIVENESS\"))\n .config(Map.of(\"face_liveness_method\", \"passive\"))\n .build(),\n SimpleWorkflowFeature.builder()\n .feature(SimpleWorkflowFeature.Feature.of(\"FACE_MATCH\"))\n .config(Map.of(\"face_match_score_decline_threshold\", 40, \"face_match_score_review_threshold\", 60))\n .build()))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "workflows->create([\n 'workflow_label' => 'Standard KYC',\n 'features' => [[\n 'feature' => 'OCR',\n 'config' => ['duplicated_user_action' => 'review'],\n ], [\n 'feature' => 'LIVENESS',\n 'config' => ['face_liveness_method' => 'passive'],\n ], [\n 'feature' => 'FACE_MATCH',\n 'config' => ['face_match_score_decline_threshold' => 40, 'face_match_score_review_threshold' => 60],\n ]],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.workflows.create(\n workflow_label: \"Standard KYC\",\n features: [{\n feature: \"OCR\",\n config: { duplicated_user_action: \"review\" },\n }, {\n feature: \"LIVENESS\",\n config: { face_liveness_method: \"passive\" },\n }, {\n feature: \"FACE_MATCH\",\n config: { face_match_score_decline_threshold: 40, face_match_score_review_threshold: 60 },\n }]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Workflows.CreateAsync(new SimpleWorkflowRequest\n{\n WorkflowLabel = \"Standard KYC\",\n Features = new SimpleWorkflowFeature[]\n {\n new()\n {\n Feature = \"OCR\",\n Config = new Dictionary { [\"duplicated_user_action\"] = \"review\" },\n },\n new()\n {\n Feature = \"LIVENESS\",\n Config = new Dictionary { [\"face_liveness_method\"] = \"passive\" },\n },\n new()\n {\n Feature = \"FACE_MATCH\",\n Config = new Dictionary { [\"face_match_score_decline_threshold\"] = 40, [\"face_match_score_review_threshold\"] = 60 },\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/workflows/{settings_uuid}/": { "get": { "summary": "Obtener flujo de verificación", "description": "Obtiene la configuración completa de una versión de flujo por `settings_uuid`: activación de funciones, umbrales, documentos permitidos, grafo, política de reintentos, callbacks y precios.", "operationId": "get_workflow", "x-didit-sdk": { "resource": "workflows", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Workflows" ], "parameters": [ { "name": "settings_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID por versión del flujo (el valor `uuid` que devuelve el endpoint de listado). Cada versión de un flujo tiene su propio `settings_uuid`." } ], "responses": { "200": { "description": "Configuración completa del flujo. La estructura es la serialización sin procesar de `VerificationSettings` (~190 campos: cada activación de función, umbral, acción de advertencia, configuración de documentos permitidos, el `workflow_graph`, la política de reintentos, los callbacks y los precios). El ejemplo siguiente está abreviado. Notas: `features` es una cadena unida con `\" + \"` (p. ej., `\"OCR + LIVENESS\"`), los precios son números JSON e `is_editable` es `true` solo para las versiones `draft`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDetail" }, "examples": { "KYC workflow with face match (abbreviated)": { "value": { "uuid": "a1b2c3d4-5678-90ab-cdef-111111111111", "workflow_id": "a1b2c3d4-5678-90ab-cdef-111111111111", "workflow_label": "Standard KYC", "workflow_type": "kyc", "is_default": true, "is_archived": false, "is_liveness_enabled": true, "face_liveness_method": "passive", "face_liveness_score_decline_threshold": 50, "face_liveness_score_review_threshold": 70, "is_face_match_enabled": true, "face_match_score_decline_threshold": 40, "face_match_score_review_threshold": 60, "is_aml_enabled": false, "is_phone_verification_enabled": false, "is_email_verification_enabled": false, "is_database_validation_enabled": false, "is_ip_analysis_enabled": false, "is_nfc_enabled": false, "duplicated_user_action": "no_action", "documents_allowed": { "ESP": { "P": { "sides": 1, "enabled": 1, "subtypes": [ "EPASSPORT", "PASSPORT_GENERIC" ], "preferred_characters": "latin", "expiration_check_mode": "strict" } } }, "max_retry_attempts": 3, "retry_window_days": 7, "session_expiration_time": 604800, "version": 2, "status": "published", "published_at": "2026-04-12T10:30:00Z", "is_simple_workflow": false, "is_editable": false, "workflow_url": "https://verify.didit.me/u/_yljPOx8RWG3UAz5ZRQGVQ", "total_price": 0.15, "min_price": 0.15, "max_price": 0.15, "features": "OCR + LIVENESS + FACE_MATCH", "created_at": "2025-01-15T10:30:00Z", "updated_at": "2026-04-12T10:30:00Z" } } } } } }, "403": { "description": "La clave de API falta, tiene un formato incorrecto, ha expirado o está asociada a otra aplicación.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ningún flujo con este `settings_uuid` para la aplicación autenticada. O el UUID es incorrecto o pertenece a otra aplicación: Didit no distingue deliberadamente entre ambos casos para no revelar la existencia de registros de otras aplicaciones.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Límite de solicitudes superado. Reintenta con retroceso exponencial." }, "500": { "description": "Error inesperado del servidor. Se puede reintentar sin riesgo." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X GET 'https://verification.didit.me/v3/workflows/a1b2c3d4-5678-90ab-cdef-111111111111/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.workflows.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.workflows.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Workflows.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.workflows().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "workflows->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.workflows.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Workflows.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "patch": { "summary": "Actualizar flujo", "description": "Actualiza un flujo de verificación (workflow). El versionado depende del campo `status` que envíes y del estado actual de la versión: (1) sin `status` en una versión **publicada** → la versión publicada se actualiza en el mismo lugar (mismo `uuid`, misma `version`); (2) sin `status` en un **borrador** → el borrador se actualiza y se publica de inmediato; (3) `status: \"published\"` en una versión **publicada** → se crea y se devuelve una NUEVA versión publicada bajo el mismo `workflow_id` (nuevo `uuid`, `version` + 1), y se elimina cualquier borrador existente del grupo; (4) `status: \"draft\"` mantiene un borrador como borrador (guardado automático), pero se rechaza con 400 en una versión publicada (`\"Cannot revert a published version to draft.\"`). El cuerpo acepta la misma lista estricta de campos permitidos que la creación: las claves desconocidas se rechazan con 400.", "operationId": "update_workflow", "x-didit-sdk": { "resource": "workflows", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Workflows" ], "parameters": [ { "name": "settings_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID por versión del flujo que se va a actualizar." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleWorkflowUpdateRequest" }, "examples": { "Replace features": { "summary": "Envía el orden completo deseado de las funciones", "value": { "features": [ { "feature": "OCR" }, { "feature": "AML" } ] } }, "Rename": { "summary": "Cambiar el nombre de un flujo de verificación (workflow)", "value": { "workflow_label": "Premium KYC" } }, "Set as default": { "summary": "Establecer este flujo como el predeterminado de la aplicación", "value": { "is_default": true } }, "Update config": { "summary": "Cambiar la configuración de funciones", "value": { "features": [ { "feature": "OCR" }, { "feature": "LIVENESS", "config": { "face_liveness_method": "passive" } } ] } }, "Publish a draft": { "summary": "Promover un borrador a publicado", "value": { "status": "published" } } } } } }, "responses": { "200": { "description": "Flujo actualizado. El cuerpo es la configuración COMPLETA de la versión resultante (con la misma forma `VerificationSettings` sin procesar que `GET /v3/workflows/{settings_uuid}/`). Cuando la actualización crea una versión nueva (al enviar `status: \"published\"` sobre una fila publicada), los valores de `uuid` y `version` devueltos son distintos de los que modificaste: usa el `uuid` devuelto en las llamadas posteriores.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDetail" } } } }, "400": { "description": "Error de validación: una clave de primer nivel fuera de la lista de claves aceptadas, una función desconocida, un orden no válido, un umbral fuera de rango, una referencia a un cuestionario inexistente, una función `SIGNATURE` que se publicaría sin ningún documento que firmar, una nueva función `SIGNATURE` con `signature_level: \"aes\"` cuando la firma avanzada (AES) no está disponible (`aes_not_available`, consulta `signature_availability` en el flujo; un paso que ya almacena `aes` lo conserva), o `status: \"draft\"` enviado para una versión publicada (`\"Cannot revert a published version to draft.\"`). El cuerpo de la respuesta es un error de validación de DRF indexado por nombre de campo." }, "403": { "description": "Falta la clave de API o no es válida.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ningún flujo con este `settings_uuid` para la aplicación autenticada." }, "415": { "description": "Tipo de contenido no admitido. Define `Content-Type: application/json`." }, "429": { "description": "Límite de solicitudes superado. Reintenta con retroceso exponencial." }, "500": { "description": "Error inesperado del servidor. Se puede reintentar sin riesgo." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X PATCH 'https://verification.didit.me/v3/workflows/a1b2c3d4-5678-90ab-cdef-111111111111/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"workflow_label\": \"Premium KYC\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.workflows.update(\n \"11111111-2222-3333-4444-555555555555\",\n features=[{\n \"feature\": \"OCR\",\n }, {\n \"feature\": \"AML\",\n }],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.workflows.update(\"11111111-2222-3333-4444-555555555555\", {\n features: [{\n feature: \"OCR\",\n }, {\n feature: \"AML\",\n }],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Workflows.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SimpleWorkflowUpdateRequest{\n\tFeatures: didit.Some([]didit.SimpleWorkflowFeature{{\n\t\tFeature: \"OCR\",\n\t}, {\n\t\tFeature: \"AML\",\n\t}}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.SimpleWorkflowFeature;\nimport me.didit.types.SimpleWorkflowUpdateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.workflows().update(\"11111111-2222-3333-4444-555555555555\", SimpleWorkflowUpdateRequest.builder()\n .features(List.of(\n SimpleWorkflowFeature.builder()\n .feature(SimpleWorkflowFeature.Feature.of(\"OCR\"))\n .build(),\n SimpleWorkflowFeature.builder()\n .feature(SimpleWorkflowFeature.Feature.of(\"AML\"))\n .build()))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "workflows->update('11111111-2222-3333-4444-555555555555', [\n 'features' => [[\n 'feature' => 'OCR',\n ], [\n 'feature' => 'AML',\n ]],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.workflows.update(\n \"11111111-2222-3333-4444-555555555555\",\n features: [{\n feature: \"OCR\",\n }, {\n feature: \"AML\",\n }]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Workflows.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new SimpleWorkflowUpdateRequest\n{\n Features = new SimpleWorkflowFeature[]\n {\n new()\n {\n Feature = \"OCR\",\n },\n new()\n {\n Feature = \"AML\",\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "summary": "Eliminar flujo", "description": "Elimina de forma permanente una versión de un flujo (no se puede deshacer). Las sesiones existentes conservan sus resultados de verificación, pero se borra su referencia al flujo; las demás versiones del mismo grupo `workflow_id` no se eliminan.", "operationId": "delete_workflow", "x-didit-sdk": { "resource": "workflows", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Workflows" ], "parameters": [ { "name": "settings_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID por versión del flujo que se va a eliminar." } ], "responses": { "204": { "description": "Flujo eliminado. El cuerpo de la respuesta está vacío." }, "403": { "description": "Falta la clave de API o no es válida.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ningún flujo con este `settings_uuid` para la aplicación autenticada.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Límite de solicitudes superado. Reintenta con retroceso exponencial." }, "500": { "description": "Error inesperado del servidor. Se puede reintentar sin riesgo." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X DELETE 'https://verification.didit.me/v3/workflows/a1b2c3d4-5678-90ab-cdef-111111111111/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.workflows.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.workflows.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Workflows.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.workflows().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "workflows->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.workflows.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Workflows.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ] } }, "/v3/questionnaires/": { "get": { "summary": "Listar cuestionarios", "description": "Lista tus cuestionarios, de más reciente a más antiguo, en un sobre de paginación limit/offset (`{count, next, previous, results}`, tamaño de página predeterminado 50). Cada fila es una versión; `questionnaire_group_id` es el ID de grupo estable que se resuelve a la última versión `published`.", "operationId": "list_questionnaires", "x-didit-sdk": { "resource": "questionnaires", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Questionnaires" ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50 }, "description": "Tamaño de página (número de cuestionarios por página)." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Número de filas que se omiten antes del primer cuestionario devuelto." } ], "responses": { "200": { "description": "Una página de cuestionarios ordenados por `created_at` en orden descendente, dentro del sobre de paginación. Cada elemento de `results` es un `QuestionnaireListItem`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número total de versiones del cuestionario de la aplicación." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la página siguiente, o `null` en la última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la página anterior, o `null` en la primera página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/QuestionnaireListItem" } } } }, "examples": { "One questionnaire": { "summary": "Un cuestionario bilingüe sencillo", "value": { "count": 1, "next": null, "previous": null, "results": [ { "uuid": "11111111-2222-3333-4444-555555555555", "title": "KYC Questionnaire", "description": "Additional verification questions", "languages": [ "en", "es" ], "default_language": "en", "is_active": true, "is_simple_questionnaire": true, "created_at": "2026-04-23T09:55:00Z", "updated_at": "2026-04-23T10:00:00Z", "question_types": [ "SHORT_TEXT", "MULTIPLE_CHOICE", "FILE_UPLOAD" ], "workflow_names": [], "questionnaire_group_id": "11111111-2222-3333-4444-555555555555", "version": 1, "status": "published", "published_at": "2026-04-23T10:00:00Z", "is_editable": false } ] } } } } } }, "403": { "description": "Clave de API ausente, con formato incorrecto, expirada o asociada a otra aplicación.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Límite de solicitudes superado. Reintenta con retroceso exponencial." }, "500": { "description": "Error inesperado del servidor al generar la lista. Se puede reintentar sin riesgo." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X GET 'https://verification.didit.me/v3/questionnaires/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.questionnaires.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.questionnaires.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Questionnaires.ListAutoPaging(ctx, didit.QuestionnairesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.questionnaires().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "questionnaires->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.questionnaires.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Questionnaires.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "summary": "Crear cuestionario", "description": "Crea un cuestionario lineal simple. Envía `form_elements` en el orden de visualización; las ramificaciones y los grupos repetibles requieren la Console. Por defecto es `published` v1.", "operationId": "create_questionnaire", "x-didit-sdk": { "resource": "questionnaires", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Questionnaires" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleQuestionnaireRequest" }, "examples": { "Simple": { "summary": "Cuestionario básico", "value": { "title": "Customer Onboarding", "description": "Additional information needed for verification", "default_language": "en", "languages": [ "en" ], "is_active": true, "form_elements": [ { "id": "occupation", "element_type": "short_text", "label": { "en": "What is your occupation?" }, "is_required": true, "placeholder": { "en": "Software engineer" } }, { "id": "source_of_funds", "element_type": "multiple_choice", "label": { "en": "Source of funds" }, "is_required": true, "options": [ { "value": "employment", "label": { "en": "Employment" } }, { "value": "business", "label": { "en": "Business" } }, { "value": "investments", "label": { "en": "Investments" } }, { "value": "other", "label": { "en": "Other" } } ] } ] } } } } } }, "responses": { "201": { "description": "Cuestionario creado. La respuesta incluye el `questionnaire_id`: guárdalo para hacer referencia a este cuestionario desde los flujos o en futuras llamadas de actualización o eliminación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionnaireDetail" }, "examples": { "Created": { "value": { "questionnaire_id": "11111111-2222-3333-4444-555555555555", "title": "Customer Onboarding", "description": "Additional information needed for verification", "languages": [ "en" ], "default_language": "en", "is_active": true, "is_simple_questionnaire": true, "graph": { "start_node": "occupation", "nodes": { "occupation": { "element_type": "SHORT_TEXT", "is_required": true, "title": { "en": "What is your occupation?" }, "next": "source_of_funds" }, "source_of_funds": { "element_type": "MULTIPLE_CHOICE", "is_required": true, "title": { "en": "Source of funds" }, "choices": [ { "value": "employment", "label": { "en": "Employment" } }, { "value": "business", "label": { "en": "Business" } } ], "next": null } } }, "sections": [], "questionnaire_group_id": "11111111-2222-3333-4444-555555555555", "version": 1, "status": "published", "published_at": "2026-04-23T10:00:00Z", "is_editable": false } } } } } }, "400": { "description": "Error de validación. Causas comunes: un `element_type` desconocido, un campo traducible al que le falta la traducción para uno de los idiomas de `languages`, `languages` sin `en`, un `default_language` que no está en `languages`, una opción sin `label`, una pregunta que tiene `branches`/`required_if`/`repeatable_config` (no admitidos por este endpoint), o enviar un `graph` sin procesar en lugar de `form_elements`. El cuerpo es un error de validación de DRF agrupado por nombre de campo.", "content": { "application/json": { "examples": { "Graph not accepted": { "value": { "graph": "The v3 questionnaire API only accepts simple `form_elements`, not `graph`." } }, "Missing label": { "value": { "form_elements": [ { "label": [ "This field is required." ] } ] } } } } } }, "403": { "description": "Clave de API ausente, con formato incorrecto, expirada o asociada a otra aplicación.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "415": { "description": "Tipo de contenido no admitido. Define `Content-Type: application/json` y envía un cuerpo JSON." }, "429": { "description": "Límite de solicitudes superado. Reintenta con retroceso exponencial." }, "500": { "description": "Error inesperado del servidor al crear el cuestionario. Se puede reintentar sin riesgo." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/questionnaires/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"title\": \"Customer Onboarding\",\n \"default_language\": \"en\",\n \"languages\": [\"en\"],\n \"form_elements\": [\n {\n \"id\": \"occupation\",\n \"element_type\": \"short_text\",\n \"label\": {\"en\": \"What is your occupation?\"},\n \"is_required\": true\n }\n ]\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.questionnaires.create(\n title=\"Customer Onboarding\",\n description=\"Additional information needed for verification\",\n languages=[\"en\"],\n default_language=\"en\",\n is_active=True,\n form_elements=[{\n \"id\": \"occupation\",\n \"element_type\": \"short_text\",\n \"label\": {\"en\": \"What is your occupation?\"},\n \"placeholder\": {\"en\": \"Software engineer\"},\n \"is_required\": True,\n }, {\n \"id\": \"source_of_funds\",\n \"element_type\": \"multiple_choice\",\n \"label\": {\"en\": \"Source of funds\"},\n \"is_required\": True,\n \"options\": [{\n \"value\": \"employment\",\n \"label\": {\"en\": \"Employment\"},\n }, {\n \"value\": \"business\",\n \"label\": {\"en\": \"Business\"},\n }, {\n \"value\": \"investments\",\n \"label\": {\"en\": \"Investments\"},\n }, {\n \"value\": \"other\",\n \"label\": {\"en\": \"Other\"},\n }],\n }],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.questionnaires.create({\n title: \"Customer Onboarding\",\n description: \"Additional information needed for verification\",\n languages: [\"en\"],\n default_language: \"en\",\n is_active: true,\n form_elements: [{\n id: \"occupation\",\n element_type: \"short_text\",\n label: { en: \"What is your occupation?\" },\n placeholder: { en: \"Software engineer\" },\n is_required: true,\n }, {\n id: \"source_of_funds\",\n element_type: \"multiple_choice\",\n label: { en: \"Source of funds\" },\n is_required: true,\n options: [{\n value: \"employment\",\n label: { en: \"Employment\" },\n }, {\n value: \"business\",\n label: { en: \"Business\" },\n }, {\n value: \"investments\",\n label: { en: \"Investments\" },\n }, {\n value: \"other\",\n label: { en: \"Other\" },\n }],\n }],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Questionnaires.Create(ctx, didit.SimpleQuestionnaireRequest{\n\tTitle: \"Customer Onboarding\",\n\tDescription: didit.String(\"Additional information needed for verification\"),\n\tLanguages: []string{\"en\"},\n\tDefaultLanguage: didit.String(\"en\"),\n\tIsActive: didit.Bool(true),\n\tFormElements: []didit.SimpleQuestionnaireElement{{\n\t\tID: didit.String(\"occupation\"),\n\t\tElementType: \"short_text\",\n\t\tLabel: map[string]string{\"en\": \"What is your occupation?\"},\n\t\tPlaceholder: didit.Some(map[string]string{\"en\": \"Software engineer\"}),\n\t\tIsRequired: didit.Bool(true),\n\t}, {\n\t\tID: didit.String(\"source_of_funds\"),\n\t\tElementType: \"multiple_choice\",\n\t\tLabel: map[string]string{\"en\": \"Source of funds\"},\n\t\tIsRequired: didit.Bool(true),\n\t\tOptions: didit.Some([]didit.SimpleQuestionnaireElementOptions{{\n\t\t\tValue: didit.String(\"employment\"),\n\t\t\tLabel: map[string]string{\"en\": \"Employment\"},\n\t\t}, {\n\t\t\tValue: didit.String(\"business\"),\n\t\t\tLabel: map[string]string{\"en\": \"Business\"},\n\t\t}, {\n\t\t\tValue: didit.String(\"investments\"),\n\t\t\tLabel: map[string]string{\"en\": \"Investments\"},\n\t\t}, {\n\t\t\tValue: didit.String(\"other\"),\n\t\t\tLabel: map[string]string{\"en\": \"Other\"},\n\t\t}}),\n\t}},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SimpleQuestionnaireElement;\nimport me.didit.types.SimpleQuestionnaireRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.questionnaires().create(SimpleQuestionnaireRequest.builder()\n .title(\"Customer Onboarding\")\n .description(\"Additional information needed for verification\")\n .languages(List.of(\"en\"))\n .defaultLanguage(\"en\")\n .isActive(true)\n .formElements(List.of(\n SimpleQuestionnaireElement.builder()\n .id(\"occupation\")\n .elementType(SimpleQuestionnaireElement.ElementType.of(\"short_text\"))\n .label(Map.of(\"en\", \"What is your occupation?\"))\n .placeholder(Map.of(\"en\", \"Software engineer\"))\n .isRequired(true)\n .build(),\n SimpleQuestionnaireElement.builder()\n .id(\"source_of_funds\")\n .elementType(SimpleQuestionnaireElement.ElementType.of(\"multiple_choice\"))\n .label(Map.of(\"en\", \"Source of funds\"))\n .isRequired(true)\n .options(List.of(\n SimpleQuestionnaireElement.Options.builder()\n .value(\"employment\")\n .label(Map.of(\"en\", \"Employment\"))\n .build(),\n SimpleQuestionnaireElement.Options.builder()\n .value(\"business\")\n .label(Map.of(\"en\", \"Business\"))\n .build(),\n SimpleQuestionnaireElement.Options.builder()\n .value(\"investments\")\n .label(Map.of(\"en\", \"Investments\"))\n .build(),\n SimpleQuestionnaireElement.Options.builder()\n .value(\"other\")\n .label(Map.of(\"en\", \"Other\"))\n .build()))\n .build()))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "questionnaires->create([\n 'title' => 'Customer Onboarding',\n 'description' => 'Additional information needed for verification',\n 'languages' => ['en'],\n 'default_language' => 'en',\n 'is_active' => true,\n 'form_elements' => [[\n 'id' => 'occupation',\n 'element_type' => 'short_text',\n 'label' => ['en' => 'What is your occupation?'],\n 'placeholder' => ['en' => 'Software engineer'],\n 'is_required' => true,\n ], [\n 'id' => 'source_of_funds',\n 'element_type' => 'multiple_choice',\n 'label' => ['en' => 'Source of funds'],\n 'is_required' => true,\n 'options' => [[\n 'value' => 'employment',\n 'label' => ['en' => 'Employment'],\n ], [\n 'value' => 'business',\n 'label' => ['en' => 'Business'],\n ], [\n 'value' => 'investments',\n 'label' => ['en' => 'Investments'],\n ], [\n 'value' => 'other',\n 'label' => ['en' => 'Other'],\n ]],\n ]],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.questionnaires.create(\n title: \"Customer Onboarding\",\n description: \"Additional information needed for verification\",\n languages: [\"en\"],\n default_language: \"en\",\n is_active: true,\n form_elements: [{\n id: \"occupation\",\n element_type: \"short_text\",\n label: { en: \"What is your occupation?\" },\n placeholder: { en: \"Software engineer\" },\n is_required: true,\n }, {\n id: \"source_of_funds\",\n element_type: \"multiple_choice\",\n label: { en: \"Source of funds\" },\n is_required: true,\n options: [{\n value: \"employment\",\n label: { en: \"Employment\" },\n }, {\n value: \"business\",\n label: { en: \"Business\" },\n }, {\n value: \"investments\",\n label: { en: \"Investments\" },\n }, {\n value: \"other\",\n label: { en: \"Other\" },\n }],\n }]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Questionnaires.CreateAsync(new SimpleQuestionnaireRequest\n{\n Title = \"Customer Onboarding\",\n Description = \"Additional information needed for verification\",\n Languages = new string[] { \"en\" },\n DefaultLanguage = \"en\",\n IsActive = true,\n FormElements = new SimpleQuestionnaireElement[]\n {\n new()\n {\n Id = \"occupation\",\n ElementType = \"short_text\",\n Label = new Dictionary { [\"en\"] = \"What is your occupation?\" },\n Placeholder = new Dictionary { [\"en\"] = \"Software engineer\" },\n IsRequired = true,\n },\n new()\n {\n Id = \"source_of_funds\",\n ElementType = \"multiple_choice\",\n Label = new Dictionary { [\"en\"] = \"Source of funds\" },\n IsRequired = true,\n Options = new SimpleQuestionnaireElementOptions[]\n {\n new()\n {\n Value = \"employment\",\n Label = new Dictionary { [\"en\"] = \"Employment\" },\n },\n new()\n {\n Value = \"business\",\n Label = new Dictionary { [\"en\"] = \"Business\" },\n },\n new()\n {\n Value = \"investments\",\n Label = new Dictionary { [\"en\"] = \"Investments\" },\n },\n new()\n {\n Value = \"other\",\n Label = new Dictionary { [\"en\"] = \"Other\" },\n },\n },\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/questionnaires/{questionnaire_uuid}/": { "get": { "summary": "Obtener un cuestionario", "description": "Obtiene el detalle completo del cuestionario de una versión por `questionnaire_uuid`: título, `languages`, `graph` canónico, `sections` derivadas y metadatos de la versión.", "operationId": "get_questionnaire", "x-didit-sdk": { "resource": "questionnaires", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Questionnaires" ], "parameters": [ { "name": "questionnaire_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID por versión del cuestionario (el valor `uuid` que devuelve el endpoint de listado y que también se devuelve como `questionnaire_id` en los endpoints de detalle)." } ], "responses": { "200": { "description": "Detalle completo del cuestionario, que incluye el `graph` canónico, la vista derivada `sections`, los metadatos de versión e `is_editable`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionnaireDetail" }, "examples": { "Published questionnaire": { "value": { "questionnaire_id": "11111111-2222-3333-4444-555555555555", "title": "Customer Onboarding", "description": "Additional information needed for verification", "languages": [ "en" ], "default_language": "en", "is_active": true, "is_simple_questionnaire": true, "graph": { "start_node": "occupation", "nodes": { "occupation": { "element_type": "SHORT_TEXT", "is_required": true, "title": { "en": "What is your occupation?" }, "next": "source_of_funds" }, "source_of_funds": { "element_type": "MULTIPLE_CHOICE", "is_required": true, "title": { "en": "Source of funds" }, "choices": [ { "value": "employment", "label": { "en": "Employment" } }, { "value": "business", "label": { "en": "Business" } } ], "next": null } } }, "sections": [ { "title": {}, "description": {}, "items": [ { "uuid": "11111111-2222-3333-4444-666666666666", "value": "occupation", "element_type": "SHORT_TEXT", "is_required": true, "title": { "en": "What is your occupation?" } } ] } ], "questionnaire_group_id": "11111111-2222-3333-4444-555555555555", "version": 1, "status": "published", "published_at": "2026-04-23T10:00:00Z", "is_editable": false } } } } } }, "403": { "description": "Clave de API ausente, con formato incorrecto, expirada o asociada a otra aplicación.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ningún cuestionario con este `questionnaire_uuid` para la aplicación autenticada. O el UUID es incorrecto o pertenece a otra aplicación: la API no distingue deliberadamente entre ambos casos.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Límite de solicitudes superado. Reintenta con retroceso exponencial." }, "500": { "description": "Error inesperado del servidor. Se puede reintentar sin riesgo." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X GET 'https://verification.didit.me/v3/questionnaires/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.questionnaires.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.questionnaires.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Questionnaires.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.questionnaires().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "questionnaires->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.questionnaires.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Questionnaires.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "patch": { "summary": "Actualizar cuestionario", "description": "Actualiza un cuestionario. El versionado depende del campo `status` que envíes y del estado actual de la versión: (1) sin `status` en una versión **publicada** → la versión publicada se actualiza en el mismo lugar (mismo `questionnaire_id`, misma `version`); (2) sin `status` en un **borrador** → el borrador se actualiza y se publica de inmediato; (3) `status: \"published\"` en una versión **publicada** → se crea y se devuelve una NUEVA versión publicada bajo el mismo `questionnaire_group_id` (nuevo `questionnaire_id`, `version` + 1), y se elimina cualquier borrador existente del grupo; (4) `status: \"draft\"` mantiene un borrador como borrador (guardado automático), pero se rechaza con 400 en una versión publicada (`\"Cannot revert a published version to draft.\"`).", "operationId": "update_questionnaire", "x-didit-sdk": { "resource": "questionnaires", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Questionnaires" ], "parameters": [ { "name": "questionnaire_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID por versión del cuestionario que se va a actualizar." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleQuestionnaireUpdateRequest" }, "examples": { "Rename": { "summary": "Cambiar el nombre de un cuestionario", "value": { "title": "Updated Customer Onboarding" } }, "Replace questions": { "summary": "Reemplazar la lista lineal completa de preguntas", "value": { "form_elements": [ { "id": "occupation", "element_type": "short_text", "label": { "en": "What is your occupation?" }, "is_required": true }, { "id": "source_of_funds", "element_type": "multiple_choice", "label": { "en": "Source of funds" }, "options": [ { "value": "employment", "label": { "en": "Employment" } }, { "value": "business", "label": { "en": "Business" } } ] } ] } } } } } }, "responses": { "200": { "description": "Cuestionario actualizado. El cuerpo es el estado más reciente de la versión resultante: la versión actualizada en el mismo lugar, o la nueva versión publicada creada cuando enviaste `status: \"published\"` sobre una fila publicada (en ese caso, `questionnaire_id` y `version` difieren de los que modificaste). El `questionnaire_id` de la respuesta es el UUID de cada versión; usa `questionnaire_group_id` si necesitas el identificador estable del grupo.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionnaireDetail" } } } }, "400": { "description": "Error de validación: `element_type` desconocido, falta una traducción, campos de ramificación o condicionales no compatibles, falta `en` en `languages`, `default_language` no está en `languages`, una opción sin etiqueta, el envío de un `graph` sin procesar o `status: \"draft\"` en una versión publicada (`\"Cannot revert a published version to draft.\"`). El cuerpo de la respuesta es un error de validación de DRF indexado por nombre de campo." }, "403": { "description": "Falta la clave de API o no es válida.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ningún cuestionario con este `questionnaire_uuid` para la aplicación autenticada." }, "415": { "description": "Tipo de contenido no admitido. Define `Content-Type: application/json`." }, "429": { "description": "Límite de solicitudes superado. Reintenta con retroceso exponencial." }, "500": { "description": "Error inesperado del servidor. Se puede reintentar sin riesgo." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X PATCH 'https://verification.didit.me/v3/questionnaires/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"title\": \"Updated Customer Onboarding\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.questionnaires.update(\n \"11111111-2222-3333-4444-555555555555\",\n title=\"Updated Customer Onboarding\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.questionnaires.update(\"11111111-2222-3333-4444-555555555555\", {\n title: \"Updated Customer Onboarding\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Questionnaires.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SimpleQuestionnaireUpdateRequest{\n\tTitle: didit.String(\"Updated Customer Onboarding\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SimpleQuestionnaireUpdateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.questionnaires().update(\"11111111-2222-3333-4444-555555555555\", SimpleQuestionnaireUpdateRequest.builder()\n .title(\"Updated Customer Onboarding\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "questionnaires->update('11111111-2222-3333-4444-555555555555', [\n 'title' => 'Updated Customer Onboarding',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.questionnaires.update(\n \"11111111-2222-3333-4444-555555555555\",\n title: \"Updated Customer Onboarding\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Questionnaires.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new SimpleQuestionnaireUpdateRequest\n{\n Title = \"Updated Customer Onboarding\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "summary": "Eliminar cuestionario", "description": "Elimina de forma permanente una versión del cuestionario (no se puede deshacer). Las respuestas almacenadas del cuestionario vinculadas a esta versión se eliminan con ella, y las sesiones que la referencian pierden el vínculo; las demás versiones del mismo grupo no se eliminan. Los flujos que la referenciaban siguen funcionando, pero el paso del cuestionario ya no puede cargarla.", "operationId": "delete_questionnaire", "x-didit-sdk": { "resource": "questionnaires", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Questionnaires" ], "parameters": [ { "name": "questionnaire_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID por versión del cuestionario que se va a eliminar." } ], "responses": { "204": { "description": "Cuestionario eliminado. El cuerpo de la respuesta está vacío." }, "403": { "description": "Falta la clave de API o no es válida.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ningún cuestionario con este `questionnaire_uuid` para la aplicación autenticada.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Límite de solicitudes superado. Reintenta con retroceso exponencial." }, "500": { "description": "Error inesperado del servidor. Se puede reintentar sin riesgo." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X DELETE 'https://verification.didit.me/v3/questionnaires/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.questionnaires.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.questionnaires.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Questionnaires.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.questionnaires().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "questionnaires->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.questionnaires.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Questionnaires.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ] } }, "/v3/users/": { "get": { "summary": "Listar usuarios", "description": "Lista los [usuarios](/entities/users) que Didit agrupa a partir de las sesiones KYC que comparten el mismo `vendor_data` (cadena de texto libre, NO un UUID), además de los usuarios creados mediante la API. Paginado y ordenado por `last_session_at` en orden descendente. Este endpoint no admite parámetros de filtrado ni de búsqueda: obtén las páginas y filtra en el cliente.", "operationId": "list_users", "x-didit-sdk": { "resource": "users", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Users" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "description": "Tamaño de página. Si se omite, el valor predeterminado es 50. No hay un máximo obligatorio, pero mantén las páginas pequeñas para reducir la latencia." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Desplazamiento, empezando en cero, del primer registro que se devuelve. Es preferible seguir la URL `next` de la página anterior en lugar de calcularlo a mano." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/users/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.users.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.users.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Users.ListAutoPaging(ctx, didit.UsersListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.users().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "users->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.users.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Users.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Lista paginada de usuarios con su estado de verificación, número de sesiones y desglose por función.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de filas coincidentes: exacto hasta 100, limitado a 100 a partir de ahí por rendimiento. No lo uses para detectar la última página; comprueba en su lugar que `next` sea `null`." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta de la página siguiente, o `null` en la última página." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta de la página anterior, o `null` en la primera página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/UserListItem" } } } }, "examples": { "Example": { "value": { "count": 2, "next": null, "previous": null, "results": [ { "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418", "vendor_data": "user-abc-123", "display_name": null, "full_name": "John Michael Doe", "date_of_birth": "1990-05-15", "effective_name": "John Michael Doe", "status": "ACTIVE", "portrait_image_url": "https:///...", "session_count": 3, "approved_count": 2, "declined_count": 0, "in_review_count": 1, "issuing_states": [ "USA" ], "approved_emails": [ "john@example.com" ], "approved_phones": [ "+14155551234" ], "features": { "ID_VERIFICATION": "Approved", "LIVENESS": "Approved", "FACE_MATCH": "Approved", "AML": "Approved" }, "features_list": [ { "feature": "ID_VERIFICATION", "status": "Approved" }, { "feature": "LIVENESS", "status": "Approved" }, { "feature": "FACE_MATCH", "status": "Approved" }, { "feature": "AML", "status": "Approved" } ], "last_session_at": "2025-06-15T10:30:00Z", "last_activity_at": "2025-06-15T10:30:00Z", "first_session_at": "2025-06-01T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "name": "VIP", "color": "#2567FF" } ], "created_at": "2025-06-01T08:00:00Z" }, { "didit_internal_id": "6ed99d53-e8f5-4cf8-9ac1-4a506cb40f6b", "vendor_data": null, "display_name": "Jane S.", "full_name": "Jane Elizabeth Smith", "date_of_birth": "1985-11-22", "effective_name": "Jane S.", "status": "FLAGGED", "portrait_image_url": null, "session_count": 1, "approved_count": 0, "declined_count": 0, "in_review_count": 1, "issuing_states": [], "approved_emails": [], "approved_phones": [], "features": { "ID_VERIFICATION": "In Review" }, "features_list": [ { "feature": "ID_VERIFICATION", "status": "In Review" } ], "last_session_at": "2025-06-20T14:00:00Z", "last_activity_at": "2025-06-20T14:05:00Z", "first_session_at": "2025-06-20T14:00:00Z", "tags": [], "created_at": "2025-06-20T14:00:00Z" } ] } } } } } }, "401": { "description": "No se proporcionaron credenciales. El middleware de autenticación rechaza las solicitudes a rutas `/v3/users/*` sin un encabezado `x-api-key` (o un token `Authorization: Bearer`) antes de que lleguen a la API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "La clave no puede listar usuarios de esta aplicación. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Límite de solicitudes superado; espera y reintenta cuando haya pasado el intervalo indicado en `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/users/{vendor_data}/": { "get": { "summary": "Obtener usuario", "description": "Obtiene un [usuario](/entities/users) por `vendor_data` (coincidencia exacta). Respecto a la vista de lista, añade `metadata`, `comments` y `updated_at`, y cambia `tags` al formato detallado de vínculos de etiquetas.", "operationId": "get_user", "x-didit-sdk": { "resource": "users", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Users" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tu identificador único del usuario: una cadena de texto libre (NO un UUID). Es el mismo valor que enviaste como `vendor_data` al crear la sesión que dio de alta a este usuario por primera vez, y se compara exactamente tal como se envía.", "example": "user-abc-123" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/users/user-abc-123/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.users.retrieve(\n \"user-abc-123\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.users.retrieve(\"user-abc-123\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Retrieve(ctx, \"user-abc-123\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.users().retrieve(\"user-abc-123\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->retrieve('user-abc-123');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.users.retrieve(\"user-abc-123\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Users.RetrieveAsync(\"user-abc-123\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Detalle completo del usuario, que incluye metadatos, registro de comentarios/actividad y datos agregados de sesiones.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailItem" }, "examples": { "Active user": { "value": { "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418", "vendor_data": "user-abc-123", "display_name": null, "full_name": "John Michael Doe", "date_of_birth": "1990-05-15", "effective_name": "John Michael Doe", "status": "ACTIVE", "metadata": { "tier": "premium", "source": "website" }, "portrait_image_url": "https:///...", "session_count": 3, "approved_count": 2, "declined_count": 0, "in_review_count": 1, "issuing_states": [ "USA" ], "approved_emails": [ "john@example.com" ], "approved_phones": [ "+14155551234" ], "features": { "ID_VERIFICATION": "Approved", "LIVENESS": "Approved", "FACE_MATCH": "Approved", "AML": "Approved" }, "features_list": [ { "feature": "ID_VERIFICATION", "status": "Approved" }, { "feature": "LIVENESS", "status": "Approved" }, { "feature": "FACE_MATCH", "status": "Approved" }, { "feature": "AML", "status": "Approved" } ], "last_session_at": "2025-06-15T10:30:00Z", "last_activity_at": "2025-06-15T10:30:00Z", "first_session_at": "2025-06-01T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "tag": { "uuid": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b", "name": "VIP", "color": "#2567FF", "description": null, "source": "custom", "created_at": "2025-05-01T09:00:00Z", "updated_at": "2025-05-01T09:00:00Z" }, "added_by_email": "analyst@acme.com", "added_by_name": "Jane Analyst", "created_at": "2025-06-02T11:00:00Z" } ], "comments": [ { "uuid": "c1111111-2222-4333-8444-555555555555", "comment_type": "STATUS_CHANGED", "comment": null, "actor_email": "analyst@acme.com", "actor_name": "Jane Analyst", "previous_status": "FLAGGED", "new_status": "ACTIVE", "previous_value": null, "new_value": null, "changed_fields": [], "metadata": null, "mentioned_emails": [], "created_at": "2025-06-01T10:30:00Z" } ], "created_at": "2025-06-01T08:00:00Z", "updated_at": "2025-06-15T10:30:00Z" } } } } } }, "401": { "description": "No se proporcionaron credenciales. El middleware de autenticación rechaza las solicitudes a rutas `/v3/users/*` sin un encabezado `x-api-key` (o un token `Authorization: Bearer`) antes de que lleguen a la API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Clave de API no válida o revocada, o la clave no puede leer los usuarios de esta aplicación. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ningún usuario con el `vendor_data` proporcionado para esta aplicación.", "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": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualizar usuario", "description": "Actualización parcial de un usuario: `display_name`, `full_name`, `date_of_birth`, `status`, `metadata`, `approved_emails`/`approved_phones`/`issuing_states`. `metadata` se reemplaza por completo. Cambiar `status` aquí funciona igual que [Actualizar el estado del usuario](#patch-/v3/users/-vendor_data-/update-status/): registra una actividad `STATUS_CHANGED` con el `reason` opcional, y `BLOCKED` añade el `vendor_data` a la lista de bloqueo del sistema (salir de `BLOCKED` elimina esa entrada). Los cambios en `display_name`, `full_name`, `date_of_birth` o `metadata` se registran como una actividad `PROFILE_UPDATED`.", "operationId": "update_user", "x-didit-sdk": { "resource": "users", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Users" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tu identificador único del usuario (cadena de texto libre, NO un UUID).", "example": "user-abc-123" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"display_name\": \"Jane S.\", \"status\": \"FLAGGED\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.users.update(\n \"user-abc-123\",\n display_name=\"Jane S.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.users.update(\"user-abc-123\", {\n display_name: \"Jane S.\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Update(ctx, \"user-abc-123\", didit.UsersUpdateParams{\n\tDisplayName: didit.String(\"Jane S.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.UsersUpdateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.users().update(\"user-abc-123\", UsersUpdateParams.builder()\n .displayName(\"Jane S.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->update('user-abc-123', [\n 'display_name' => 'Jane S.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.users.update(\n \"user-abc-123\",\n display_name: \"Jane S.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Users.UpdateAsync(\"user-abc-123\", new UsersUpdateParams\n{\n DisplayName = \"Jane S.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Usuario actualizado. Se devuelve el registro completo y actualizado del usuario (con la misma estructura que Get User).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailItem" }, "examples": { "Updated": { "value": { "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418", "vendor_data": "user-abc-123", "display_name": "Jane S.", "full_name": "Jane Elizabeth Smith", "date_of_birth": "1985-11-22", "effective_name": "Jane S.", "status": "FLAGGED", "metadata": { "tier": "premium" }, "portrait_image_url": "https:///...", "session_count": 3, "approved_count": 2, "declined_count": 0, "in_review_count": 1, "issuing_states": [ "USA" ], "approved_emails": [ "john@example.com" ], "approved_phones": [ "+14155551234" ], "features": { "ID_VERIFICATION": "Approved", "LIVENESS": "Approved", "FACE_MATCH": "Approved", "AML": "Approved" }, "features_list": [ { "feature": "ID_VERIFICATION", "status": "Approved" }, { "feature": "LIVENESS", "status": "Approved" }, { "feature": "FACE_MATCH", "status": "Approved" }, { "feature": "AML", "status": "Approved" } ], "last_session_at": "2025-06-15T10:30:00Z", "last_activity_at": "2025-06-15T10:30:00Z", "first_session_at": "2025-06-01T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "tag": { "uuid": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b", "name": "VIP", "color": "#2567FF", "description": null, "source": "custom", "created_at": "2025-05-01T09:00:00Z", "updated_at": "2025-05-01T09:00:00Z" }, "added_by_email": "analyst@acme.com", "added_by_name": "Jane Analyst", "created_at": "2025-06-02T11:00:00Z" } ], "comments": [], "created_at": "2025-06-01T08:00:00Z", "updated_at": "2025-06-15T10:30:00Z" } } } } } }, "400": { "description": "Cuerpo no válido: normalmente un `status` desconocido o una `date_of_birth` que no está en formato `YYYY-MM-DD`.", "content": { "application/json": { "examples": { "Bad status": { "value": { "status": [ "\"INVALID\" is not a valid choice." ] } }, "Bad date_of_birth": { "value": { "date_of_birth": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } }, "Reason too long": { "value": { "reason": [ "Ensure this field has no more than 1000 characters." ] } } } } } }, "401": { "description": "No se proporcionaron credenciales. El middleware de autenticación rechaza las solicitudes a rutas `/v3/users/*` sin un encabezado `x-api-key` (o un token `Authorization: Bearer`) antes de que lleguen a la API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "La clave no puede actualizar usuarios de esta aplicación. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ningún usuario con el `vendor_data` proporcionado para esta aplicación.", "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": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "full_name": { "type": "string", "nullable": true, "maxLength": 512, "description": "Nombre completo del usuario" }, "display_name": { "type": "string", "nullable": true, "description": "Nombre visible personalizado para este usuario" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Fecha de nacimiento en formato YYYY-MM-DD" }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Estado del ciclo de vida del usuario. Cada cambio se registra como una actividad `STATUS_CHANGED`, y `BLOCKED` añade el `vendor_data` a la lista de bloqueo del sistema (salir de `BLOCKED` elimina esa entrada)." }, "metadata": { "type": "object", "nullable": true, "description": "Objeto JSON arbitrario que adjuntas al usuario. **Reemplaza por completo** los metadatos existentes al actualizar: combínalos en el cliente si solo quieres añadir claves." }, "approved_emails": { "type": "array", "items": { "type": "string" }, "description": "Direcciones de correo electrónico verificadas de este usuario, p. ej., `[\"john@example.com\"]`. Reemplaza por completo la lista almacenada." }, "approved_phones": { "type": "array", "items": { "type": "string" }, "description": "Números de teléfono verificados de este usuario. Reemplaza por completo la lista almacenada." }, "issuing_states": { "type": "array", "items": { "type": "string" }, "description": "Países emisores (ISO 3166-1 alfa-3), p. ej., `[\"USA\"]`. Reemplaza por completo la lista almacenada." }, "reason": { "type": "string", "nullable": true, "maxLength": 1000, "description": "Por qué cambió el estado. Se registra en la entrada de cambio de estado de la actividad del usuario (`comments[].comment` y **Activity** en Business Console), solo cuando el estado cambia realmente. Los webhooks no lo incluyen." } } }, "examples": { "Rename": { "summary": "Establecer nombre visible", "value": { "display_name": "Jane S." } }, "Override status": { "summary": "Marcar al usuario para revisión", "value": { "status": "FLAGGED" } }, "Add metadata": { "summary": "Reemplazar el JSON de metadatos", "value": { "metadata": { "tier": "premium", "risk_level": "low" } } }, "Fix extracted DOB": { "summary": "Corregir campos de perfil extraídos", "value": { "full_name": "Jane Elizabeth Smith", "date_of_birth": "1985-11-22" } }, "Flag with reason": { "summary": "Marcar al usuario y registrar el motivo", "value": { "status": "FLAGGED", "reason": "Address does not match the billing country" } } } } } } } }, "/v3/users/{vendor_data}/generate-pdf/": { "get": { "summary": "Descargar el informe PDF con el historial completo del usuario", "description": "Genera y descarga un único PDF listo para cumplimiento con el historial completo de verificaciones del usuario identificado por `vendor_data`. Es el mismo documento que genera la consola desde **User detail → Actions → Download PDF**, así que las exportaciones periódicas de cumplimiento ya no requieren que una persona haga clic en la consola.\n\n**Qué contiene el informe.** Una portada con el resumen del perfil (nombre, fecha de nacimiento, estados emisores, correos electrónicos y teléfonos aprobados), el último estado de cada función, los contadores de sesiones y un índice de las sesiones incluidas, seguida del informe estándar de cada sesión incluida, en orden cronológico (de la más antigua a la más reciente). El informe de cada sesión es el mismo documento que devuelve `GET /v3/session/{sessionId}/generate-pdf/` para esa sesión.\n\n**Sesiones incluidas.** Solo se incluyen las sesiones de Verificación de usuarios (KYC) en estado `Approved`, `Declined`, `In Review` o `Kyc Expired`; las sesiones en cualquier otro estado se omiten. Si el usuario no tiene ninguna sesión en uno de esos estados, el endpoint devuelve `403` (consulta más abajo).\n\n**Límite.** El informe incluye como máximo las **20 sesiones más recientes** que se pueden incluir. Si un usuario tiene más, se incluyen las 20 más recientes y la portada indica cuántas sesiones anteriores quedaron fuera. Usa `GET /v3/sessions/?vendor_data=…` para obtener la lista completa en JSON.\n\n**Marca.** Si tu aplicación tiene personalización de marca blanca, la portada y cada informe de sesión se generan con tu logotipo y la URL de tu política de privacidad; de lo contrario, llevan la marca de Didit. Los informes se generan en inglés: no hay ningún parámetro de idioma.\n\n**Sin caché.** Cada llamada vuelve a generar el PDF a partir de los datos actuales, por lo que un informe generado después de una revisión manual refleja la decisión del revisor. Dos llamadas para el mismo usuario pueden producir archivos distintos a nivel de bytes: archiva el archivo descargado si necesitas una copia inmutable.\n\n**Latencia.** La generación es síncrona y descarga todas las imágenes almacenadas de cada sesión incluida, así que un usuario con muchas sesiones con gran cantidad de contenido multimedia puede tardar decenas de segundos. Usa un tiempo de espera de lectura generoso en el cliente (se recomiendan 120 s) y escribe el cuerpo en disco mediante streaming. La generación se detiene al alcanzar un límite de tiempo en el servidor, en lugar de continuar hasta que tu cliente se rinda: si se alcanza ese límite, la respuesta sigue siendo un PDF válido con las sesiones más recientes y la portada indica cuántas se omitieron.\n\n**Alcance.** El usuario se busca dentro de la aplicación propietaria de la clave de API. Una clave nunca puede exportar un usuario de otra aplicación: para ella, ese usuario no existe y el endpoint devuelve `404`.\n\n**Barra final.** La ruta canónica termina con una barra final (`…/generate-pdf/`). Una solicitud sin ella se atiende directamente con la misma respuesta: no hay redirección `301`, así que ningún cliente tiene que seguir redirecciones y `curl` no necesita `-L`. Usa la URL con barra, como en los ejemplos.", "operationId": "get_user_generate_pdf", "x-didit-sdk": { "resource": "users", "method": "generate_pdf", "auth": "api_key", "server": true }, "tags": [ "Users" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tu identificador único del usuario: una cadena de texto libre (NO un UUID). Es el mismo valor que enviaste como `vendor_data` al crear las sesiones del usuario, y se compara exactamente tal como se envía. Codifícalo para URL; un valor que contenga `/` no se puede usar con esta ruta.", "example": "user-abc-123" } ], "responses": { "200": { "description": "El documento PDF generado, devuelto directamente como binario `application/pdf`: no hay envoltorio JSON ni redirección a una URL de descarga. El cuerpo empieza con los bytes mágicos `%PDF`. Guárdalo en un archivo `.pdf` o transmítelo directamente a quien hizo la llamada.", "headers": { "Content-Disposition": { "description": "`attachment; filename=user_{didit_internal_id}.pdf`: el archivo lleva el nombre del identificador estable de Didit del usuario (`didit_internal_id` en `GET /v3/users/{vendor_data}/`), no el de `vendor_data`.", "schema": { "type": "string", "example": "attachment; filename=user_f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418.pdf" } }, "Content-Length": { "description": "Tamaño total del PDF en bytes; el cuerpo no se envía en fragmentos.", "schema": { "type": "integer", "example": 148213 } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "No se proporcionaron credenciales. El middleware de autenticación rechaza las solicitudes a rutas `/v3/users/*` sin un encabezado `x-api-key` (o un token `Authorization: Bearer`) antes de que lleguen a la API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Error de autorización o de elegibilidad. Distingue ambos casos por la cadena `detail`:\n\n- `\"You do not have permission to perform this action.\"`: la clave de API no es válida o se revocó, o la solicitud incluye un token de usuario de la Console en lugar de una clave de API de la aplicación.\n- `\"This user has no sessions in review, declined, approved or kyc expired to report.\"`: el usuario existe en tu aplicación, pero ninguna de sus sesiones está todavía en un estado que permita generar el informe (por ejemplo, todas las sesiones siguen en `In Progress`, o el usuario se creó mediante `POST /v3/users/create/` y nunca se ha verificado). Espera un webhook `status.updated` antes de solicitar el informe.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "This user has no sessions in review, declined, approved or kyc expired to report." } } }, "examples": { "Invalid credentials": { "summary": "Clave de API revocada o no válida, o un token de usuario de la Console", "value": { "detail": "You do not have permission to perform this action." } }, "No reportable sessions": { "summary": "El usuario existe, pero no tiene ninguna sesión Aprobada / Rechazada / En revisión / KYC expirado", "value": { "detail": "This user has no sessions in review, declined, approved or kyc expired to report." } } } } } }, "404": { "description": "No existe ningún usuario con el `vendor_data` proporcionado en la aplicación asociada a la clave de API. Los usuarios de otras aplicaciones no son visibles para esta clave y devuelven el mismo `404`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "User not found." } } }, "examples": { "Unknown user": { "summary": "vendor_data no coincide con ningún usuario de esta aplicación", "value": { "detail": "User not found." } } } } } }, "429": { "description": "Límite de solicitudes superado. La generación de PDF tiene un límite propio de **50 solicitudes por minuto por credencial** (clave de API, token Bearer o IP de origen cuando no hay autenticación), compartido entre este endpoint y `GET /v3/session/{sessionId}/generate-pdf/`, además del límite global de 600 GET por minuto. Espera los segundos indicados en `Retry-After` (también reflejados en los encabezados `X-RateLimit-*`) y luego reintenta. Los informes no se almacenan en caché en el servidor, así que descarga cada informe una sola vez y guarda el archivo en lugar de volver a solicitarlo.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar la solicitud.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Número máximo de generaciones de PDF permitidas en la ventana actual (50).", "schema": { "type": "integer", "example": 50 } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Marca de tiempo Unix (segundos) en que se restablece la ventana actual.", "schema": { "type": "integer", "example": 1750000000 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Explicación legible de la superación del límite de solicitudes.", "example": "Session PDF generation rate limit exceeded. You can make up to 50 requests per minute." } } }, "examples": { "Throttled": { "summary": "Más de 50 generaciones de PDF en un minuto con la misma credencial", "value": { "detail": "Session PDF generation rate limit exceeded. You can make up to 50 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --fail \\\n 'https://verification.didit.me/v3/users/user-abc-123/generate-pdf/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n --output user-history.pdf" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.users.generate_pdf(\n \"user-abc-123\",\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.users.generatePdf(\"user-abc-123\");\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Users.GeneratePDF(ctx, \"user-abc-123\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.users().generatePdf(\"user-abc-123\")\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "users->generatePdf('user-abc-123');\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.users.generate_pdf(\"user-abc-123\")\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Users.GeneratePdfAsync(\"user-abc-123\");\nawait content.SaveToAsync(\"download.pdf\");" } ] } }, "/v3/users/delete/": { "post": { "summary": "Eliminar usuarios en lote", "description": "**Elimina de forma permanente** usuarios: los registros de usuario se eliminan de forma permanente. Para bloqueos habituales, es preferible [Actualizar el estado del usuario](#patch-/v3/users/-vendor_data-/update-status/) con `BLOCKED`. Selecciona usuarios con `vendor_data_list`, con `didit_internal_id_list` o con ambos a la vez; o envía `delete_all: true`. Este endpoint nunca acota `delete_all` con filtros. Los filtros de People de la consola se rechazan con un `400` (consulta la respuesta `400`), de modo que una intención acotada no se convierte en un borrado total. Hay dos excepciones: `filter_has_approved_sessions` y `filter_has_declined_sessions` no se rechazan ni se aplican, así que con `delete_all: true` igualmente eliminan a todos los usuarios; no los envíes.\n\n**Plantillas biométricas:** salvo que establezcas `retain_face_embeddings` en `true`, cada plantilla biométrica sin imagen conservada para estos usuarios tras la eliminación de la sesión (consulta `/v3/biometric-templates/`) se purga antes de eliminar al usuario, de modo que la persona deja de coincidir en la detección de duplicados y en la Búsqueda facial. Con `retain_face_embeddings: true` y `face_retention_days`, eliges conservar una plantilla biométrica sin imagen por persona durante ese número de días, y no se conserva nada más sobre la persona. Si una plantilla no se puede purgar porque un almacén biométrico no está disponible, la llamada devuelve `503`, no se elimina ningún usuario de la solicitud y, al repetir la solicitud, se completa el proceso.\n\n**Informes regulatorios presentados:** si los datos seleccionados están en un informe regulatorio finalizado, se rechaza toda la solicitud con `409` y no se elimina nada. El cuerpo usa `code: in_filed_report` e identifica cada informe con `uuid`, `report_number`, `report_type` y `case_uuid`. Elimina los informes y repite la solicitud.", "operationId": "batch_delete_users", "x-didit-sdk": { "resource": "users", "method": "batch_delete", "auth": "api_key", "server": true }, "tags": [ "Users" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Proporciona `vendor_data_list`, `didit_internal_id_list` o `delete_all: true`. Las dos listas se pueden combinar y se aplican con OR. Cuando `delete_all` es `true`, tiene precedencia y se ignoran ambas listas.", "properties": { "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Tus propios identificadores que se van a eliminar, comparados exactamente como se enviaron." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs internos de usuario de Didit que se van a eliminar: el `didit_internal_id` que devuelven los endpoints de creación y obtención." }, "delete_all": { "type": "boolean", "default": false, "description": "Si es `true`, elimina todos los usuarios de la aplicación." }, "retain_face_embeddings": { "type": "boolean", "default": false, "description": "Tu decisión explícita de conservar una plantilla biométrica sin imágenes de cada persona eliminada para la detección de duplicados, durante `face_retention_days`. Todo lo demás sobre la persona se elimina. Omítelo, o envía `false`, para eliminar las plantillas junto con los usuarios. Cuando es `true`, `face_retention_days` es obligatorio." }, "face_retention_days": { "type": "integer", "minimum": 1, "maximum": 3650, "description": "Número de días que se conserva la plantilla biométrica sin imágenes cuando `retain_face_embeddings` es `true`. Es obligatorio junto con él, y sin él se rechaza con un `400` en `face_retention_days`.", "example": 365 } } }, "examples": { "Specific users": { "summary": "Eliminar usuarios por vendor_data", "value": { "vendor_data_list": [ "user-123", "user-456" ] } }, "By Didit internal ID": { "summary": "Eliminar usuarios por didit_internal_id", "value": { "didit_internal_id_list": [ "3f1c0d3e-8f0a-4c2e-9a3d-9b1f5f4a2c11" ] } }, "All users": { "summary": "Borrar todos los usuarios de esta aplicación", "value": { "delete_all": true } }, "Keep face templates": { "summary": "Eliminar usuarios y conservar plantillas faciales anónimas durante 365 días", "value": { "vendor_data_list": [ "user-123" ], "retain_face_embeddings": true, "face_retention_days": 365 } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/users/delete/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"vendor_data_list\": [\"user-123\", \"user-456\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.users.batch_delete(\n vendor_data_list=[\"user-123\", \"user-456\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.users.batchDelete({\n vendor_data_list: [\"user-123\", \"user-456\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.BatchDelete(ctx, didit.UsersBatchDeleteParams{\n\tVendorDataList: didit.Some([]string{\"user-123\", \"user-456\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.UsersBatchDeleteParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.users().batchDelete(UsersBatchDeleteParams.builder()\n .vendorDataList(List.of(\"user-123\", \"user-456\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->batchDelete([\n 'vendor_data_list' => ['user-123', 'user-456'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.users.batch_delete(vendor_data_list: [\"user-123\", \"user-456\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Users.BatchDeleteAsync(new UsersBatchDeleteParams\n{\n VendorDataList = new string[] { \"user-123\", \"user-456\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Usuarios eliminados. Devuelve el número de usuarios realmente eliminados.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "integer", "description": "Número de usuarios eliminados (excluye los valores de vendor_data que no coincidieron con nada)." } } }, "examples": { "Deleted some": { "value": { "deleted": 2 } }, "Nothing matched": { "value": { "deleted": 0 } } } } } }, "400": { "description": "Error de validación; no se elimina nada. Los errores se agrupan por nombre de campo. Sin selector (ninguna de las listas y `delete_all` distinto de `true`), el cuerpo es `{\"vendor_data_list\": [\"This field is required unless delete_all is true.\"]}`; una lista vacía se rechaza bajo su propia clave con `\"This list may not be empty.\"`. Un filtro exclusivo de la Console (`filter_search`, `filter_status`, `filter_country`, `filter_date_from`, `filter_date_to`, `filter_tag`, `filter_latest_verification_status`, `filter_risk`, `filter_has_sessions`, `filter_has_open_alerts`, `filter_aml_monitoring`, `filter_can_sign_in`, `filter_auth_status`, `filter_auth_method` o `filter_auth_mfa_enabled`) se rechaza siempre que tenga un valor, incluso `false`, con un objeto cuyas claves son cada uno de esos campos. Cualquier otra clave `filter_*` desconocida se rechaza con `\"Unknown filter.\"`.", "content": { "application/json": { "examples": { "Missing selector": { "summary": "No se proporcionó ni list ni delete_all", "value": { "vendor_data_list": [ "This field is required unless delete_all is true." ] } }, "Console-only filter": { "value": { "filter_has_sessions": "This filter is Console-only and is not supported by this endpoint." } } } } } }, "401": { "description": "No se proporcionaron credenciales. El middleware de autenticación rechaza las solicitudes a rutas `/v3/users/*` sin un encabezado `x-api-key` (o un token `Authorization: Bearer`) antes de que lleguen a la API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Clave de API no válida o revocada, o la clave no puede eliminar usuarios de esta aplicación. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Límite de solicitudes superado; espera y reintenta cuando haya pasado el intervalo indicado en `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } }, "503": { "description": "Un almacén biométrico no estaba disponible al conservar o purgar una plantilla biométrica. No se elimina nada; repite la misma solicitud. Los reintentos son idempotentes y convergen en una única plantilla.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Retryable": { "value": { "detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable." } } } } } }, "409": { "description": "La selección incluye una persona que figura en un informe regulatorio finalizado. No se elimina nada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/sessions/delete/": { "post": { "summary": "Eliminar en bloque sesiones de KYC por session_number", "description": "Elimina en bloque sesiones de Verificación de usuarios (KYC) por su `session_number` numérico, o todas las sesiones KYC de tu aplicación con `delete_all: true`.\n\n`session_number` es el contador incremental y fácil de leer que se muestra en la lista de sesiones de la consola y que los endpoints de creación de sesión y de decisión devuelven como `session_number`; **no** es el UUID `session_id`. Para eliminar una sesión por su UUID, o para eliminar una sesión de Verificación de empresas (KYB), que este endpoint nunca toca, usa `DELETE /v3/session/{sessionId}/delete/` en su lugar.\n\n**Hasta 20 sesiones se eliminan dentro de la solicitud; si son más, se procesan como un trabajo.** Lo que decide es el número de sesiones que coinciden, tanto si se seleccionan con `session_numbers` como con `delete_all`:\n- Hasta 20 sesiones coincidentes: se eliminan antes de la respuesta, que es `200` con una entrada por sesión en `results[]`.\n- Más de 20: la respuesta es `202` con un trabajo de eliminación, y las sesiones se eliminan en segundo plano. Consulta `GET /v3/sessions/delete/{job_id}/` hasta que `status` sea `COMPLETED` o `FAILED`. Un trabajo informa de recuentos por resultado, nunca de qué sesiones eliminó. Un trabajo con `delete_all` elimina solo las sesiones creadas antes de la solicitud; las sesiones iniciadas mientras se ejecuta no se eliminan.\n\nCada sesión eliminada recibe exactamente el mismo tratamiento que con el endpoint de eliminación de una sola sesión: se eliminan la sesión, todos los intentos de verificación que contiene, su decisión y los datos extraídos, sus registros de funciones relacionados (verificación de identidad, rostro, prueba de vida, coincidencia facial, etc.) y todos sus archivos almacenados; desaparece de todos los endpoints de lectura y las URL de medios emitidas anteriormente dejan de resolverse. Las entregas de webhook que sigan en cola para una sesión eliminada, y sus reintentos, se descartan; los webhooks ya entregados no se ven afectados. Las entradas de la lista de bloqueo **no** se eliminan, los créditos ya consumidos **no** se reembolsan y las entidades User principales **no** se eliminan (usa `POST /v3/users/delete/` para ello); no se emite ningún webhook por la eliminación. La eliminación es permanente e irreversible.\n\n**Semántica de la selección:**\n- Con `delete_all: true` puedes acotar la selección con los filtros de `GET /v3/sessions/`, cada uno con el prefijo `filter_` (por ejemplo, `filter_status`, `filter_workflow_id`, `filter_date_from`). Los filtros que admiten varios valores en List Sessions (`status`, `workflow_id`, `country`, `region`, `document_type`, `document_name`, `session_type`, `warning`, `organization_name`) aceptan una cadena separada por comas o un array; los demás admiten un solo valor. Un valor vacío se ignora. Los filtros solo se aplican junto con `delete_all`, y un trabajo de eliminación aplica los mismos filtros.\n- Una clave `filter_*` desconocida, o un valor de filtro que no se puede interpretar, rechaza toda la solicitud con `400` antes de eliminar nada, de modo que un filtro mal escrito nunca amplía la eliminación a todas las sesiones.\n- Las entradas de `session_numbers` que no coinciden con una sesión KYC activa de tu aplicación (números desconocidos, sesiones ya eliminadas o sesiones de otra aplicación) se **omiten sin avisar**: no aparecen en `results` y no se cuentan en el `total` de un trabajo.\n- Los errores de validación (una entrada no numérica, una lista vacía, no indicar ni `session_numbers` ni `delete_all`, o una retención de plantilla que la aplicación no puede cumplir) rechazan **toda la solicitud** con `400` y no eliminan nada.\n- Las sesiones se eliminan por grupos. Si un grupo no se puede eliminar (por ejemplo, porque un servicio de almacenamiento no está disponible), todas las sesiones de ese grupo se notifican como `face_retention_outcome: failed_retryable` y se conservan; los demás grupos no se ven afectados. Repite la solicitud para esas sesiones. Un trabajo reintenta ese grupo por sí mismo.\n- No hay un límite documentado para la longitud de la lista; el límite práctico es el límite de solicitudes de escritura compartido (ver más abajo).\n\n**Datos biométricos faciales:** los campos opcionales `retain_face_embeddings`, `face_retention_days`, `face_retention_deadline`, `deletion_instruction` e `instruction_id` tienen el mismo significado que en `DELETE /v3/session/{sessionId}/delete/` y se aplican a todas las sesiones coincidentes. Cada resultado indica su propio `face_retention_outcome`.\n\n**Respuesta:** `200 OK` con `results[]` para hasta 20 sesiones coincidentes, o `202 Accepted` con un trabajo de eliminación si son más. Todos los resultados confirman la eliminación excepto `face_retention_outcome: failed_retryable`, que indica una sesión que NO se eliminó y que debe reintentarse. Las versiones anteriores de este endpoint devolvían `204 No Content`; actualiza los clientes que comprueban `204`.\n\n**Idempotencia:** repetir la misma solicitud no elimina nada más: los números que ya no coinciden con una sesión se omiten.\n\n**`delete_all: true` (destructivo):** elimina **todas** las sesiones KYC restantes de la aplicación; `session_numbers` se ignora si se indica. No hay paso de confirmación ni forma de deshacerlo.\n\n**Autenticación:** clave de API en el encabezado `x-api-key`. Si las credenciales faltan o no son válidas, se devuelve `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); esta API nunca devuelve `401`.\n\n**Límite de solicitudes:** presupuesto de escritura compartido de 300 solicitudes/min por clave de API entre todos los endpoints POST/PATCH/DELETE; si se supera, se devuelve `429`.\n\nEste endpoint solo acepta claves de API. Los tokens Bearer de usuarios de Business Console se rechazan con `403` (a diferencia de la eliminación de una sola sesión, que acepta ambos).\n\n**Informes regulatorios presentados:** si los datos seleccionados están en un informe regulatorio finalizado, toda la solicitud se rechaza con `409` y no se elimina nada. El cuerpo usa `code: in_filed_report` e identifica cada informe con `uuid`, `report_number`, `report_type` y `case_uuid`. Elimina los informes y repite la solicitud.", "operationId": "batch_delete_sessions", "x-didit-sdk": { "resource": "sessions", "method": "batch_delete", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "session_numbers": { "type": "array", "description": "Valores numéricos de `session_number` de las sesiones de KYC que se van a eliminar, como cadenas que solo contienen dígitos (también se aceptan números JSON, que se convierten). Es obligatorio salvo que `delete_all` sea `true`; una lista vacía devuelve `400`. Cualquier entrada que no sea solo dígitos rechaza toda la solicitud con `400` (salvo que `delete_all` sea `true`, en cuyo caso se omite la validación y las entradas se ignoran). Los números que no correspondan a una sesión activa de tu aplicación se omiten sin aviso.", "items": { "type": "string", "pattern": "^[0-9]+$", "example": "1001" }, "minItems": 1, "example": [ "1001", "1002", "1003" ] }, "delete_all": { "type": "boolean", "description": "Si es `true`, se eliminan todas las sesiones de KYC restantes de la aplicación que hace la llamada y se ignora `session_numbers`, salvo que acotes la selección con claves `filter_*`. Si coinciden más de 20 sesiones, se ejecuta un trabajo de eliminación (`202`) que solo abarca las sesiones creadas antes de la solicitud. El valor predeterminado es `false`. Es irreversible; no hay paso de confirmación.", "default": false, "example": false }, "retain_face_embeddings": { "type": "boolean", "nullable": true, "description": "Anula la `face_retention_policy` de la aplicación para esta eliminación. `true` conserva una plantilla biométrica facial sin imágenes vinculada al usuario de la sesión después de eliminar la sesión; `false` elimina el embedding facial junto con la sesión; omítelo o usa `null` para seguir la política de la aplicación. Se ignora en las sesiones KYB y en las sesiones sin embedding facial.", "example": true }, "face_retention_days": { "type": "integer", "minimum": 1, "maximum": 3650, "description": "Duración de retención finita, en días, de una plantilla conservada. Es obligatoria cuando se conserva una plantilla, salvo que la aplicación ya defina `face_retention_days`. El `expires_at` de la plantilla es el más temprano entre esta duración, el periodo general de retención de datos de la aplicación y `face_retention_deadline`.", "example": 365 }, "face_retention_deadline": { "type": "string", "format": "date-time", "description": "Caducidad estricta opcional para una plantilla retenida. Debe ser una fecha futura.", "example": "2027-08-28T00:00:00Z" }, "deletion_instruction": { "type": "string", "enum": [ "operational_session_delete", "privacy_erasure" ], "default": "operational_session_delete", "description": "El tipo de instrucción que das. `operational_session_delete` elimina la sesión y conserva una plantilla solo cuando la política o `retain_face_embeddings` lo indican. `privacy_erasure` purga todas las plantillas biométricas conservadas vinculadas al usuario de la sesión antes de eliminar la sesión, la política de la aplicación no puede anularla y no se puede combinar con `retain_face_embeddings: true` (`400`).", "example": "operational_session_delete" }, "instruction_id": { "type": "string", "maxLength": 255, "description": "Tu referencia permanente para esta instrucción de eliminación (por ejemplo, el ID de un ticket de supresión). Se registra en el registro de auditoría y en cualquier plantilla conservada. Didit la genera si se omite.", "example": "dsar-2026-0142" }, "filter_status": { "description": "Restringe un `delete_all` a las sesiones que coinciden con el filtro `status` de [Listar sesiones](/es/sessions-api/list-sessions), con los mismos valores. Una cadena separada por comas o un array. Se ignora sin `delete_all`. Un valor vacío se ignora y no restringe la selección.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_vendor_data": { "description": "Restringe un `delete_all` a las sesiones que coinciden con el filtro `vendor_data` de [Listar sesiones](/es/sessions-api/list-sessions), con el mismo valor. Un solo valor, no una lista: un array se une en un único texto separado por comas, por lo que varios valores no se tratan como alternativas. Se ignora sin `delete_all`. Un valor vacío se ignora y no restringe la selección.", "type": "string" }, "filter_search": { "description": "Restringe un `delete_all` a las sesiones que coinciden con el filtro `search` de [Listar sesiones](/es/sessions-api/list-sessions), con el mismo valor. Un solo valor, no una lista: un array se une en un único texto separado por comas, por lo que varios valores no se tratan como alternativas. Se ignora sin `delete_all`. Un valor vacío se ignora y no restringe la selección.", "type": "string" }, "filter_workflow_id": { "description": "Restringe un `delete_all` a las sesiones que coinciden con el filtro `workflow_id` de [Listar sesiones](/es/sessions-api/list-sessions), con los mismos valores. Una cadena separada por comas o un array. Se ignora sin `delete_all`. Un valor vacío se ignora y no restringe la selección.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_date_from": { "description": "Limita un `delete_all` a las sesiones que coinciden con el filtro `date_from` de [List Sessions](/es/sessions-api/list-sessions), con el mismo valor. Un solo valor, no una lista: un array se une en un único valor separado por comas, por lo que varios valores se rechazan con `400`. Se ignora sin `delete_all`. Un valor vacío se ignora y no limita la selección.", "type": "string", "format": "date" }, "filter_date_to": { "description": "Limita un `delete_all` a las sesiones que coinciden con el filtro `date_to` de [List Sessions](/es/sessions-api/list-sessions), con el mismo valor. Un solo valor, no una lista: un array se une en un único valor separado por comas, por lo que varios valores se rechazan con `400`. Se ignora sin `delete_all`. Un valor vacío se ignora y no limita la selección.", "type": "string", "format": "date" }, "filter_country": { "description": "Limita un `delete_all` a las sesiones que coinciden con el filtro `country` de [List Sessions](/es/sessions-api/list-sessions), con los mismos valores. Una cadena separada por comas o un array. Se ignora sin `delete_all`. Un valor vacío se ignora y no limita la selección.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_document_type": { "description": "Limita un `delete_all` a las sesiones que coinciden con el filtro `document_type` de [List Sessions](/es/sessions-api/list-sessions), con los mismos valores. Una cadena separada por comas o un array. Se ignora sin `delete_all`. Un valor vacío se ignora y no limita la selección.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_document_name": { "description": "Limita un `delete_all` a las sesiones que coinciden con el filtro `document_name` de [List Sessions](/es/sessions-api/list-sessions), con los mismos valores. Una cadena separada por comas o un array. Se ignora sin `delete_all`. Un valor vacío se ignora y no limita la selección.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_region": { "description": "Restringe un `delete_all` a las sesiones que coinciden con el filtro `region` de [Listar sesiones](/es/sessions-api/list-sessions), con los mismos valores. Una cadena separada por comas o un array. Se ignora sin `delete_all`. Un valor vacío se ignora y no restringe la selección.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_didit_internal_id": { "description": "Limita un `delete_all` a las sesiones que coinciden con el filtro `didit_internal_id` de [List Sessions](/es/sessions-api/list-sessions), con el mismo valor. Un solo valor, no una lista: un array se une en un único valor separado por comas, por lo que varios valores se rechazan con `400`. Se ignora sin `delete_all`. Un valor vacío se ignora y no limita la selección.", "type": "string", "format": "uuid" }, "filter_session_type": { "description": "Restringe un `delete_all` a las sesiones que coinciden con el filtro `session_type` de [Listar sesiones](/es/sessions-api/list-sessions), con los mismos valores. Una cadena separada por comas o un array. Se ignora sin `delete_all`. Un valor vacío se ignora y no restringe la selección.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_api_service": { "description": "Limita un `delete_all` a las sesiones que coinciden con el filtro `api_service` de [List Sessions](/es/sessions-api/list-sessions), con el mismo valor. Un solo valor, no una lista: un array se une en un único valor separado por comas, por lo que varios valores se rechazan con `400`. Se ignora sin `delete_all`. Un valor vacío se ignora y no limita la selección.", "type": "string" }, "filter_screened_full_name": { "description": "Restringe un `delete_all` a las sesiones que coinciden con el filtro `screened_full_name` de [Listar sesiones](/es/sessions-api/list-sessions), con el mismo valor. Un solo valor, no una lista: un array se une en un único texto separado por comas, por lo que varios valores no se tratan como alternativas. Se ignora sin `delete_all`. Un valor vacío se ignora y no restringe la selección.", "type": "string" }, "filter_warning": { "description": "Restringe un `delete_all` a las sesiones que coinciden con el filtro `warning` de [Listar sesiones](/es/sessions-api/list-sessions), con los mismos valores. Una cadena separada por comas o un array. Se ignora sin `delete_all`. Un valor vacío se ignora y no restringe la selección.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_status_initialized_as_in_review": { "description": "Restringe un `delete_all` a las sesiones que coinciden con el filtro `status_initialized_as_in_review` de [Listar sesiones](/es/sessions-api/list-sessions), con los mismos valores. Se ignora sin `delete_all`. Un valor vacío se ignora y no restringe la selección.", "type": "boolean" }, "filter_is_kyc_to_be_reviewed": { "description": "Limita un `delete_all` a las sesiones que coinciden con el filtro `is_kyc_to_be_reviewed` de [List Sessions](/es/sessions-api/list-sessions), con los mismos valores. Se ignora sin `delete_all`. Un valor vacío se ignora y no limita la selección.", "type": "boolean" }, "filter_euuid": { "description": "Limita un `delete_all` a las sesiones que coinciden con el filtro `euuid` de [List Sessions](/es/sessions-api/list-sessions), con el mismo valor. Un solo valor, no una lista: un array se une en un único valor separado por comas, por lo que varios valores se rechazan con `400`. Se ignora sin `delete_all`. Un valor vacío se ignora y no limita la selección.", "type": "string", "format": "uuid" }, "filter_organization_name": { "description": "Restringe un `delete_all` a las sesiones que coinciden con el filtro `organization_name` de [Listar sesiones](/es/sessions-api/list-sessions), con los mismos valores. Una cadena separada por comas o un array. Con una clave de API solo puede coincidir con el nombre de tu propia organización, así que selecciona todas tus sesiones o ninguna. Se ignora sin `delete_all`. Un valor vacío se ignora y no restringe la selección.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "examples": { "Specific sessions": { "summary": "Eliminar sesiones concretas por número", "value": { "session_numbers": [ "1001", "1002", "1003" ] } }, "All sessions": { "summary": "Eliminar todas las sesiones KYC de la aplicación", "value": { "delete_all": true } }, "Delete and retain templates": { "summary": "Eliminar sesiones pero conservar las plantillas biométricas sin imágenes durante 365 días", "value": { "session_numbers": [ "1001", "1002" ], "retain_face_embeddings": true, "face_retention_days": 365, "instruction_id": "post-approval-cleanup-2026-08" } }, "Privacy erasure": { "summary": "Eliminar sesiones y purgar todas las plantillas conservadas de sus usuarios", "value": { "session_numbers": [ "1001" ], "deletion_instruction": "privacy_erasure", "instruction_id": "dsar-2026-0142" } }, "Filtered delete_all": { "summary": "Eliminar todas las sesiones rechazadas de un flujo creadas en septiembre de 2026", "value": { "delete_all": true, "filter_status": [ "Declined" ], "filter_workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "filter_date_from": "2026-09-01", "filter_date_to": "2026-09-30" } } } } } }, "responses": { "200": { "description": "Hasta 20 sesiones coincidieron y se procesaron en la solicitud. Hay un resultado por cada sesión coincidente; los números que no coincidieron con nada (desconocidos o ya eliminados) se omiten y no aparecen. Un resultado confirma la eliminación, excepto cuando `face_retention_outcome` es `failed_retryable`: esa sesión NO se eliminó y debe reintentarse.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "La sesión eliminada." }, "session_number": { "type": "integer", "nullable": true, "description": "El número de la sesión eliminada." }, "face_retention_outcome": { "type": "string", "enum": [ "retained_with_user", "deleted", "none", "ineligible_no_vendor_user", "failed_retryable" ], "description": "Qué ocurrió con los datos biométricos faciales de la sesión. `deleted`: el embedding facial se eliminó junto con la sesión (valor predeterminado). `retained_with_user`: la sesión se elimina y se conserva una plantilla biométrica sin imágenes vinculada al User; consulta `biometric_template_uuid`. `none`: la sesión no tenía embedding facial (por ejemplo, una sesión KYC solo de documento sin selfie de prueba de vida; este endpoint nunca selecciona sesiones KYB). `ineligible_no_vendor_user`: se solicitó la retención, pero la sesión no tiene ningún User vinculado, por lo que el embedding se eliminó junto con la sesión. `failed_retryable` (solo en el endpoint por lotes): no se pudo eliminar el grupo con el que se iba a eliminar esta sesión (un servicio de almacenamiento, un almacén biométrico o un proveedor de monitorización no estaba disponible); esta sesión sigue existiendo, repite la solicitud para ella." }, "biometric_template_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "ID de la plantilla biométrica conservada cuando `face_retention_outcome` es `retained_with_user`; `null` en caso contrario. Gestiónala a través de `/v3/biometric-templates/{template_uuid}/`." }, "biometric_template_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que se elimina la plantilla biométrica conservada, cuando `face_retention_outcome` es `retained_with_user`; `null` cuando no se conserva ninguna plantilla." }, "deleted_child_verifications": { "type": "integer", "description": "Siempre `0` en este endpoint, que solo elimina sesiones KYC. Al eliminar una sesión de Verificación de empresas (KYB) con `DELETE /v3/session/{sessionId}/delete/`, se informan las verificaciones que creó y que se eliminaron con ella." } } } } } }, "examples": { "Mixed outcomes": { "value": { "results": [ { "session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02", "session_number": 1001, "face_retention_outcome": "deleted", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 }, { "session_id": "b8e1d2c3-4f5a-4b6c-8d7e-9f0a1b2c3d4e", "session_number": 1002, "face_retention_outcome": "retained_with_user", "biometric_template_uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "biometric_template_expires_at": "2027-10-09T10:15:00Z", "deleted_child_verifications": 0 }, { "session_id": "7a1e9c2d-5f4b-4c3a-8e2d-1b0a9f8e7d6c", "session_number": 1003, "face_retention_outcome": "ineligible_no_vendor_user", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 }, { "session_id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f", "session_number": 1004, "face_retention_outcome": "failed_retryable", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 } ] } } } } } }, "202": { "description": "Coincidieron más de 20 sesiones. Se eliminan en segundo plano; consulta `GET /v3/sessions/delete/{job_id}/` hasta que `status` sea `COMPLETED` o `FAILED`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionDeletionJob" }, "examples": { "Job accepted": { "value": { "job_id": "5b8f2c1e-7d3a-4f6b-9e2c-1a0d8f7e6c5b", "status": "PENDING", "total": 250, "processed": 0, "outcomes": { "deleted": 0, "none": 0, "retained_with_user": 0, "ineligible_no_vendor_user": 0, "failed_retryable": 0, "already_deleted": 0 }, "deleted_child_verifications": 0, "error": null, "created_at": "2026-10-09T10:15:00Z", "completed_at": null } } } } } }, "400": { "description": "Error de validación: no se eliminó nada. Los valores de error son arrays de cadenas de mensaje indexados por nombre de campo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_numbers": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": { "description": "Otras claves: una clave `filter_*` que no es un filtro de List Sessions (`\"Unknown filter.\"`), o una clave `filter_*` cuyo valor no se puede leer (indexada por esa clave `filter_*`, con un array de mensajes)." } }, "examples": { "Missing selector": { "summary": "No se proporcionó ni session_numbers ni delete_all", "value": { "session_numbers": [ "This field is required unless delete_all is true." ] } }, "Empty list": { "summary": "session_numbers es un array vacío", "value": { "session_numbers": [ "This list may not be empty." ] } }, "Non-numeric entry": { "summary": "session_numbers contiene una cadena que no es numérica", "value": { "session_numbers": [ "All session_numbers must be numeric." ] } }, "Privacy erasure cannot retain": { "summary": "deletion_instruction privacy_erasure combinado con retain_face_embeddings true", "value": { "retain_face_embeddings": [ "Privacy erasure cannot retain biometric templates." ] } }, "No finite retention duration": { "summary": "Se solicitó retención sin face_retention_days en la solicitud ni en la aplicación", "value": { "detail": "A finite biometric-template retention duration is required." } }, "Unknown filter": { "summary": "Una clave filter_* que no existe en List Sessions", "value": { "filter_reviewer": "Unknown filter." } }, "Unreadable filter value": { "summary": "Un valor de filtro que no se puede leer", "value": { "filter_date_from": [ "Enter a valid date." ] } } } } } }, "403": { "description": "Falta la clave de API. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado x-api-key, o la clave no es válida", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Se superó el límite de solicitudes de escritura compartido (300 solicitudes POST/PATCH/DELETE por minuto por clave de API). Revisa `Retry-After` y los encabezados de respuesta `X-RateLimit-*` antes de reintentar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Presupuesto de escritura agotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } }, "409": { "description": "Una sesión seleccionada forma parte de un informe regulatorio finalizado. No se elimina nada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/sessions/delete/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"session_numbers\": [\"1001\", \"1002\", \"1003\"]\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.batch_delete(\n session_numbers=[\"1001\", \"1002\", \"1003\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.batchDelete({\n session_numbers: [\"1001\", \"1002\", \"1003\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.BatchDelete(ctx, didit.SessionsBatchDeleteParams{\n\tSessionNumbers: didit.Some([]string{\"1001\", \"1002\", \"1003\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.SessionsBatchDeleteParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().batchDelete(SessionsBatchDeleteParams.builder()\n .sessionNumbers(List.of(\"1001\", \"1002\", \"1003\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->batchDelete([\n 'session_numbers' => ['1001', '1002', '1003'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.batch_delete(session_numbers: [\"1001\", \"1002\", \"1003\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.BatchDeleteAsync(new SessionsBatchDeleteParams\n{\n SessionNumbers = new string[] { \"1001\", \"1002\", \"1003\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/sessions/delete/{job_id}/": { "get": { "summary": "Obtener un trabajo de eliminación masiva de sesiones", "description": "Progreso de una eliminación masiva de sesiones a la que `POST /v3/sessions/delete/` respondió con `202` (más de 20 sesiones coincidentes, seleccionadas mediante `session_numbers` o con `delete_all`). Consulta cada pocos segundos mientras `status` sea `PENDING` o `PROCESSING`; detente cuando sea `COMPLETED` o `FAILED`.\n\nEl trabajo informa de cuántas sesiones terminaron en cada resultado y cuántas ha procesado, nunca de qué sesiones eliminó. Un trabajo `FAILED` indica el motivo en `error`; las sesiones a las que no había llegado siguen existiendo, así que repite la solicitud de eliminación para eliminarlas.\n\n**Autenticación:** clave de API en el encabezado `x-api-key`. Un trabajo solo es visible para la aplicación que lo creó; cualquier otro `job_id` devuelve `404`. Si faltan las credenciales o no son válidas, se devuelve `403`; esta API nunca devuelve `401`.", "operationId": "get_session_deletion_job", "x-didit-sdk": { "resource": "sessions", "method": "retrieve_deletion_job", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "El `job_id` devuelto con el `202` de `POST /v3/sessions/delete/`." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl 'https://verification.didit.me/v3/sessions/delete/JOB_ID/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.retrieve_deletion_job(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.retrieveDeletionJob(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.RetrieveDeletionJob(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().retrieveDeletionJob(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->retrieveDeletionJob('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.retrieve_deletion_job(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.RetrieveDeletionJobAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "El trabajo.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionDeletionJob" }, "examples": { "Processing": { "value": { "job_id": "5b8f2c1e-7d3a-4f6b-9e2c-1a0d8f7e6c5b", "status": "PROCESSING", "total": 250, "processed": 100, "outcomes": { "deleted": 82, "none": 18, "retained_with_user": 0, "ineligible_no_vendor_user": 0, "failed_retryable": 0, "already_deleted": 0 }, "deleted_child_verifications": 0, "error": null, "created_at": "2026-10-09T10:15:00Z", "completed_at": null } }, "Completed": { "value": { "job_id": "5b8f2c1e-7d3a-4f6b-9e2c-1a0d8f7e6c5b", "status": "COMPLETED", "total": 250, "processed": 250, "outcomes": { "deleted": 204, "none": 44, "retained_with_user": 0, "ineligible_no_vendor_user": 0, "failed_retryable": 0, "already_deleted": 2 }, "deleted_child_verifications": 0, "error": null, "created_at": "2026-10-09T10:15:00Z", "completed_at": "2026-10-09T10:16:40Z" } }, "Failed": { "value": { "job_id": "5b8f2c1e-7d3a-4f6b-9e2c-1a0d8f7e6c5b", "status": "FAILED", "total": 250, "processed": 100, "outcomes": { "deleted": 82, "none": 18, "retained_with_user": 0, "ineligible_no_vendor_user": 0, "failed_retryable": 0, "already_deleted": 0 }, "deleted_child_verifications": 0, "error": "The deletion stopped before it finished. The sessions it had not reached are still in place; repeat the request to delete them.", "created_at": "2026-10-09T10:15:00Z", "completed_at": "2026-10-09T10:15:52Z" } } } } } }, "403": { "description": "Falta la clave de API. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado x-api-key, o la clave no es válida", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ningún trabajo de eliminación con este `job_id` para la aplicación que hace la llamada. Los trabajos solo son visibles para la aplicación que los creó." } } } }, "/v3/sessions/{session_id}/reviews/": { "get": { "summary": "Listar las revisiones y el registro de actividad de la sesión", "description": "Devuelve el registro de auditoría / feed de actividad de una sesión de Verificación de usuarios (KYC), con las entradas más recientes primero, en un sobre paginado (`count` / `next` / `previous` / `results`, 50 entradas por página de forma predeterminada).\n\nLas entradas del feed las escribe cualquier actor que interviene en la sesión: decisiones manuales tomadas mediante `PATCH /v3/session/{session_id}/update-status/` (que registra `previous_status` → `new_status`), actividad de los revisores en la consola (comentarios con menciones `@email`, ediciones de datos de KYC/POA, subidas y eliminaciones de archivos, cambios de etiquetas, visualizaciones de la página de detalle), coincidencias de la monitorización AML continua y notas añadidas mediante `POST` en esta misma ruta. Leer este feed es el equivalente, desde la API, del panel **Activity** en la vista de sesión de la consola de Didit.\n\nAquí solo se pueden consultar sesiones de Verificación de usuarios (KYC); los ID de sesiones de Verificación de empresas (KYB) devuelven `404`.", "operationId": "list_session_reviews", "x-didit-sdk": { "resource": "sessions.reviews", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "description": "UUID de la sesión de Verificación de usuarios (KYC). Debe pertenecer a la misma aplicación que la clave de API: los UUID de otras aplicaciones, las sesiones eliminadas y los ID de sesión de Verificación de empresas (KYB) devuelven `404`.", "schema": { "type": "string", "format": "uuid", "example": "8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d" } }, { "name": "limit", "in": "query", "required": false, "description": "Tamaño de página. El valor predeterminado es `50`.", "schema": { "type": "integer", "default": 50, "example": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Número de entradas que se omiten desde el inicio del feed (ordenado). El valor predeterminado es `0`. Las URL `next` / `previous` de la respuesta incluyen los valores correctos para recorrer el feed.", "schema": { "type": "integer", "default": 0, "example": 0 } }, { "name": "ordering", "in": "query", "required": false, "description": "Orden de clasificación. De forma predeterminada, el feed muestra primero lo más reciente (`-created_at`); pasa `created_at` para leerlo empezando por lo más antiguo. Los valores desconocidos se ignoran sin aviso (se usa el orden predeterminado); también se aceptan otros nombres de campo del serializador.", "schema": { "type": "string", "default": "-created_at", "example": "created_at" } } ], "responses": { "200": { "description": "Historial de actividad paginado, del más reciente al más antiguo de forma predeterminada. `count` es el número total de entradas; `next` / `previous` son URLs de página listas para usar (`null` en los extremos). Un `count` de `0` con `results` vacío significa que todavía no se ha registrado ninguna actividad.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número total de entradas del feed de esta sesión (en todas las páginas).", "example": 3 }, "next": { "type": "string", "nullable": true, "description": "URL de la página siguiente, o `null` en la última página.", "example": null }, "previous": { "type": "string", "nullable": true, "description": "URL de la página anterior, o `null` en la primera página.", "example": null }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewItem" }, "description": "Entradas del feed de esta página." } } }, "examples": { "DecisionTrail": { "summary": "Aprobación manual más notas añadidas mediante la API", "value": { "count": 3, "next": null, "previous": null, "results": [ { "uuid": "de0561bc-5583-4409-9171-1a31a4c8a5f4", "activity_type": "STATUS_UPDATED", "actor_display": "API Client", "actor_email": null, "actor_type": "API_KEY", "new_status": "Approved", "previous_status": "In Review", "comment": "Document re-checked manually; address matches.", "mentioned_emails": [], "previous_value": { "status": "In Review" }, "new_value": { "status": "Approved" }, "changed_fields": [ "status" ], "metadata": null, "created_at": "2026-06-12T00:19:31.918735Z" }, { "uuid": "35370f58-5098-44ee-8a06-8c9af80b2455", "activity_type": "STATUS_UPDATED", "actor_display": "Unknown", "actor_email": null, "actor_type": "CONSOLE_USER", "new_status": null, "previous_status": null, "comment": "Note without status.", "mentioned_emails": [], "previous_value": null, "new_value": null, "changed_fields": [], "metadata": null, "created_at": "2026-06-12T00:18:44.504157Z" }, { "uuid": "00338f82-f1c5-4f57-8614-c49bb258af1a", "activity_type": "STATUS_UPDATED", "actor_display": "Unknown", "actor_email": null, "actor_type": "CONSOLE_USER", "new_status": "In Review", "previous_status": null, "comment": "Flagging for manual document re-check.", "mentioned_emails": [], "previous_value": null, "new_value": null, "changed_fields": [], "metadata": null, "created_at": "2026-06-12T00:18:44.466537Z" } ] } }, "PaginatedFirstPage": { "summary": "Primera página con limit=2: next contiene la URL de la página siguiente", "value": { "count": 4, "next": "https://verification.didit.me/v3/sessions/8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d/reviews/?limit=2&offset=2", "previous": null, "results": [ { "uuid": "de0561bc-5583-4409-9171-1a31a4c8a5f4", "activity_type": "STATUS_UPDATED", "actor_display": "API Client", "actor_email": null, "actor_type": "API_KEY", "new_status": "Approved", "previous_status": "In Review", "comment": "Document re-checked manually; address matches.", "mentioned_emails": [], "previous_value": { "status": "In Review" }, "new_value": { "status": "Approved" }, "changed_fields": [ "status" ], "metadata": null, "created_at": "2026-06-12T00:19:31.918735Z" }, { "uuid": "bd4e6227-bdd2-42b2-a726-1d12f785a457", "activity_type": "STATUS_UPDATED", "actor_display": "Unknown", "actor_email": null, "actor_type": "CONSOLE_USER", "new_status": null, "previous_status": null, "comment": null, "mentioned_emails": [], "previous_value": null, "new_value": null, "changed_fields": [], "metadata": null, "created_at": "2026-06-12T00:18:44.540238Z" } ] } }, "Empty": { "summary": "Sesión sin actividad registrada todavía", "value": { "count": 0, "next": null, "previous": null, "results": [] } } } } } }, "403": { "description": "Falta `x-api-key`, tiene un formato incorrecto, expiró o fue revocada. La autenticación se comprueba antes de buscar la sesión, por lo que si falta la clave se devuelve `403` incluso cuando el UUID de la sesión no existe.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You do not have permission to perform this action." } } }, "examples": { "InvalidKey": { "summary": "Encabezado x-api-key ausente o no válido", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Tu aplicación no puede ver ninguna sesión de Verificación de usuarios (KYC) con este UUID: el UUID no existe, la sesión se eliminó o pertenece a otra aplicación. Los ID de sesión de Verificación de empresas (KYB) también devuelven `404` aquí, ya que el feed de revisiones solo está disponible para sesiones KYC.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Session not found." } } }, "examples": { "NotFound": { "summary": "UUID de sesión desconocido, eliminado o de otra aplicación", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Límite de solicitudes superado. Consulta los encabezados de respuesta `Retry-After` y `X-RateLimit-*`. Consulta [Límite de solicitudes](/es/integration/rate-limiting)." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -s 'https://verification.didit.me/v3/sessions/8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d/reviews/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.sessions.reviews.list(\n \"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.sessions.reviews.list(\"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.Reviews.ListAutoPaging(ctx, \"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\", didit.SessionsReviewsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.sessions().reviews().list(\"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "sessions->reviews->list('8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.reviews.list(\"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Sessions.Reviews.ListAsync(\"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "summary": "Añadir una nota de revisión al registro de auditoría de una sesión", "description": "Añade una nota al registro de revisión y actividad de una sesión de Verificación de usuarios (KYC). **Este endpoint solo registra una entrada: nunca modifica la sesión.** El `status` de la sesión no cambia, no se ejecuta ninguna validación de transición de estado y no se dispara ningún webhook. Para aprobar, rechazar o reabrir realmente una sesión (lo que además escribe en este registro una entrada `STATUS_UPDATED` con autoría completa), usa `PATCH /v3/session/{session_id}/update-status/`.\n\nAmbos campos del cuerpo son opcionales y se acepta un objeto JSON vacío. `new_status` se guarda únicamente como etiqueta de la entrada y acepta cualquiera de los diez valores de estado de sesión (distingue mayúsculas y minúsculas). Las menciones `@email` dentro de `comment` se guardan solo como texto plano: en este endpoint no generan notificaciones y el campo `mentioned_emails` de la entrada queda vacío.\n\nNota sobre la autoría: las entradas creadas aquí no incluyen información del autor. En el registro muestran `actor_display: \"Unknown\"`, `actor_type: \"CONSOLE_USER\"` y `activity_type: \"STATUS_UPDATED\"` (valores predeterminados de almacenamiento), y el campo `user` del cuerpo de la respuesta `201` es `\"Unknown\"`.", "operationId": "create_session_review", "x-didit-sdk": { "resource": "sessions.reviews", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "Content-Type", "in": "header", "required": false, "description": "Establécelo en `application/json` cuando envíes un cuerpo JSON.", "schema": { "type": "string", "example": "application/json" } }, { "name": "session_id", "in": "path", "required": true, "description": "UUID de la sesión de Verificación de usuarios (KYC). Debe pertenecer a la misma aplicación que la clave de API: los UUID de otras aplicaciones, las sesiones eliminadas y los ID de sesión de Verificación de empresas (KYB) devuelven `404`.", "schema": { "type": "string", "format": "uuid", "example": "8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "new_status": { "type": "string", "nullable": true, "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Etiqueta de estado opcional que se registra en la entrada. Acepta cualquier valor de estado de sesión y distingue mayúsculas de minúsculas (`\"approved\"` se rechaza con `400`). Registrar un estado aquí **no** cambia el estado real de la sesión: para eso, usa el endpoint de actualización de estado.", "example": "In Review" }, "comment": { "type": "string", "nullable": true, "description": "Nota opcional en texto libre (sin límite de longitud aplicado). Se guarda tal cual; en este endpoint no se procesan las menciones `@email`.", "example": "Flagging for manual document re-check." } } }, "examples": { "NoteWithStatusLabel": { "summary": "Nota con una etiqueta de estado (el estado de la sesión no cambia)", "value": { "new_status": "In Review", "comment": "Flagging for manual document re-check." } }, "CommentOnly": { "summary": "Nota simple sin etiqueta de estado", "value": { "comment": "Customer emailed an updated utility bill; awaiting upload." } } } } } }, "responses": { "201": { "description": "Entrada registrada en el historial de auditoría de la sesión. La sesión en sí no cambia: su `status` conserva el valor anterior y no se envía ningún webhook. La nueva entrada también aparece al principio de `GET …/reviews/` (con `actor_display: \"Unknown\"`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "string", "description": "Nombre visible del autor de la entrada. Siempre es `\"Unknown\"` en las entradas creadas mediante este endpoint, porque no registra la atribución de ningún actor.", "example": "Unknown" }, "new_status": { "type": "string", "nullable": true, "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "La etiqueta de estado registrada en la entrada, o `null` si no se envió ninguna. El estado real de la sesión no se ve afectado.", "example": "In Review" }, "comment": { "type": "string", "nullable": true, "description": "La nota registrada en la entrada, o `null` si no se envió ninguna.", "example": "Flagging for manual document re-check." }, "created_at": { "type": "string", "format": "date-time", "description": "Cuándo se escribió la entrada, en ISO 8601 UTC.", "example": "2026-06-12T00:18:44.466537Z" } } }, "examples": { "NoteWithStatusLabel": { "summary": "Nota con una etiqueta de estado", "value": { "user": "Unknown", "new_status": "In Review", "comment": "Flagging for manual document re-check.", "created_at": "2026-06-12T00:18:44.466537Z" } }, "CommentOnly": { "summary": "Nota simple", "value": { "user": "Unknown", "new_status": null, "comment": "Note without status.", "created_at": "2026-06-12T00:18:44.504157Z" } } } } } }, "400": { "description": "Error de validación, devuelto como un mapa de mensajes por campo. La causa habitual es un valor de `new_status` que no es uno de los diez estados permitidos: la comprobación distingue entre mayúsculas y minúsculas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "new_status": { "type": "array", "items": { "type": "string" }, "example": [ "\"approved\" is not a valid choice." ] } } }, "examples": { "InvalidStatusChoice": { "summary": "Valor de estado en minúsculas o desconocido", "value": { "new_status": [ "\"approved\" is not a valid choice." ] } } } } } }, "403": { "description": "Falta `x-api-key`, tiene un formato incorrecto, expiró o fue revocada. La autenticación se comprueba antes de buscar la sesión, por lo que si falta la clave se devuelve `403` incluso cuando el UUID de la sesión no existe.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You do not have permission to perform this action." } } }, "examples": { "InvalidKey": { "summary": "Encabezado x-api-key ausente o no válido", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Tu aplicación no puede ver ninguna sesión de Verificación de usuarios (KYC) con este UUID: el UUID no existe, la sesión se eliminó o pertenece a otra aplicación. Los ID de sesión de Verificación de empresas (KYB) también devuelven `404` aquí, ya que el feed de revisiones solo está disponible para sesiones KYC.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Session not found." } } }, "examples": { "NotFound": { "summary": "UUID de sesión desconocido, eliminado o de otra aplicación", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Límite de solicitudes superado. Consulta los encabezados de respuesta `Retry-After` y `X-RateLimit-*`. Consulta [Límite de solicitudes](/es/integration/rate-limiting)." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "# Records an audit-trail note only -- the session's status does NOT change.\ncurl -s -X POST https://verification.didit.me/v3/sessions/8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d/reviews/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"new_status\": \"In Review\",\n \"comment\": \"Flagging for manual document re-check.\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.reviews.create(\n \"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\",\n new_status=\"In Review\",\n comment=\"Flagging for manual document re-check.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.reviews.create(\"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\", {\n new_status: \"In Review\",\n comment: \"Flagging for manual document re-check.\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Reviews.Create(ctx, \"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\", didit.SessionsReviewsCreateParams{\n\tNewStatus: didit.Some(didit.SessionsReviewsCreateParamsNewStatus(\"In Review\")),\n\tComment: didit.String(\"Flagging for manual document re-check.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsReviewsCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().reviews().create(\"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\", SessionsReviewsCreateParams.builder()\n .newStatus(SessionsReviewsCreateParams.NewStatus.of(\"In Review\"))\n .comment(\"Flagging for manual document re-check.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->reviews->create('8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d', [\n 'new_status' => 'In Review',\n 'comment' => 'Flagging for manual document re-check.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.reviews.create(\n \"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\",\n new_status: \"In Review\",\n comment: \"Flagging for manual document re-check.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Reviews.CreateAsync(\"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\", new SessionsReviewsCreateParams\n{\n NewStatus = new SessionsReviewsCreateParamsNewStatus(\"In Review\"),\n Comment = \"Flagging for manual document re-check.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/billing/balance/": { "get": { "summary": "Obtener el saldo de créditos", "description": "Obtiene el saldo de crédito prepago actual en USD (para toda la organización) junto con la configuración de recarga automática. Los importes son cadenas decimales: analízalos con una biblioteca decimal.", "operationId": "get_billing_balance", "x-didit-sdk": { "resource": "billing", "method": "retrieve_balance", "auth": "api_key", "server": true }, "tags": [ "Billing" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/billing/balance/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.billing.retrieve_balance()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.billing.retrieveBalance();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Billing.RetrieveBalance(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.billing().retrieveBalance();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "billing->retrieveBalance();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.billing.retrieve_balance\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Billing.RetrieveBalanceAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Saldo de créditos actual y configuración de recarga automática de la organización.", "content": { "application/json": { "schema": { "type": "object", "required": [ "balance", "auto_refill_enabled" ], "properties": { "balance": { "type": "string", "description": "Saldo de créditos prepago actual en USD, como cadena decimal de punto fijo. Disminuye a medida que se facturan las verificaciones y aumenta cuando se liquida una recarga." }, "auto_refill_enabled": { "type": "boolean", "description": "Si es `true`, Didit cargará automáticamente el método de pago guardado para añadir créditos cuando el saldo cruce `auto_refill_threshold`. Se configura desde Console → Facturación." }, "auto_refill_amount": { "type": "string", "nullable": true, "description": "Importe en USD que se cobrará y se añadirá al saldo en cada recarga automática, por su valor nominal. Se configura entre \\$50 y \\$10,000 en Console → Facturación. `null` cuando la recarga automática está desactivada o no está configurada." }, "auto_refill_threshold": { "type": "string", "nullable": true, "description": "Umbral de activación en USD. La recarga automática se activa cuando `balance` cae por debajo de este valor. `null` cuando la recarga automática está deshabilitada o no configurada." } } }, "examples": { "Healthy balance with auto-refill": { "value": { "balance": "1234.5600", "auto_refill_enabled": true, "auto_refill_amount": "500.00", "auto_refill_threshold": "100.00" } }, "Low balance, manual top-up only": { "value": { "balance": "12.0000", "auto_refill_enabled": false, "auto_refill_amount": null, "auto_refill_threshold": null } } } } } }, "403": { "description": "Falta la clave de API, no es válida o fue revocada, o la clave no puede leer los datos de facturación de esta organizació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." } } } } } }, "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": [] } ] } }, "/v3/billing/top-up/": { "post": { "summary": "Recargar créditos", "description": "Añade créditos mediante una sesión alojada de Stripe Checkout (**\\$50 a \\$10,000** por recarga). Las recargas están disponibles en los planes Free, Growth y Scale, se añaden por su valor nominal sin descuento ni bonificación y duran 12 meses; los contratos anuales Enterprise no pueden recargar. Redirige al cliente a la `checkout_session_url` devuelta.", "operationId": "billing_top_up", "x-didit-sdk": { "resource": "billing", "method": "top_up", "auth": "api_key", "server": true }, "tags": [ "Billing" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "amount_in_dollars" ], "properties": { "amount_in_dollars": { "type": "number", "minimum": 50, "maximum": 10000, "description": "Importe que se cobrará, en USD. **Debe estar entre 50 y 10,000.** El saldo recibe el mismo importe, sin descuento ni bonificación. Los impuestos se añaden automáticamente al pagar según la dirección de facturación del cliente." }, "success_url": { "type": "string", "format": "uri", "description": "URL a la que el checkout alojado redirige al cliente tras un pago correcto. Actualmente, el valor predeterminado es `https://console.didit.me`. Indica explícitamente una URL que funcione: el host predeterminado no está disponible. Añade el marcador literal `{CHECKOUT_SESSION_ID}` si quieres que el checkout alojado lo sustituya por el ID de sesión." }, "cancel_url": { "type": "string", "format": "uri", "description": "URL a la que el checkout alojado redirige al cliente cuando cancela o cierra la ventana de Checkout. Actualmente, el valor predeterminado es `https://console.didit.me`. Indica explícitamente una URL que funcione: el host predeterminado no está disponible." } } }, "examples": { "Minimum top-up": { "value": { "amount_in_dollars": 50 } }, "Custom amount with redirects": { "value": { "amount_in_dollars": 500, "success_url": "https://yourapp.com/billing/top-up/success", "cancel_url": "https://yourapp.com/billing/top-up/cancel" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/billing/top-up/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"amount_in_dollars\": 500,\n \"success_url\": \"https://yourapp.com/billing/success\",\n \"cancel_url\": \"https://yourapp.com/billing/cancel\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.billing.top_up(\n amount_in_dollars=50.0,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.billing.topUp({\n amount_in_dollars: 50.0,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Billing.TopUp(ctx, didit.BillingTopUpParams{\n\tAmountInDollars: 50.0,\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BillingTopUpParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.billing().topUp(BillingTopUpParams.builder()\n .amountInDollars(50.0)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "billing->topUp([\n 'amount_in_dollars' => 50.0,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.billing.top_up(amount_in_dollars: 50.0)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Billing.TopUpAsync(new BillingTopUpParams\n{\n AmountInDollars = 50.0,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Se creó la sesión de pago alojada. Redirige al usuario a `checkout_session_url` para completar el pago.", "content": { "application/json": { "schema": { "type": "object", "required": [ "checkout_session_id", "checkout_session_url" ], "properties": { "checkout_session_id": { "type": "string", "description": "Identificador de la sesión de pago alojada (p. ej., `cs_test_a1B2c3...`). Útil para la conciliación del lado del servidor." }, "checkout_session_url": { "type": "string", "format": "uri", "description": "URL de la página de pago alojada de un solo uso. Redirige al cliente aquí para completar el pago." } } }, "examples": { "Created": { "value": { "checkout_session_id": "cs_test_a1B2c3D4e5F6g7H8i9J0", "checkout_session_url": "https://checkout.example.com/c/pay/cs_test_a1B2c3D4e5F6g7H8i9J0" } } } } } }, "400": { "description": "Payload no válido: falta el importe, no es un número, es inferior al mínimo de \\$50 o superior al máximo de \\$10,000, o la organización tiene un contrato anual Enterprise. El cuerpo del error es un array JSON.", "content": { "application/json": { "examples": { "Missing amount": { "value": [ "amount_in_dollars is required." ] }, "Not a number": { "value": [ "amount_in_dollars must be a number." ] }, "Below minimum": { "value": [ "Amount must be at least $50." ] }, "Above maximum": { "value": [ "Amount must be at most $10,000." ] }, "Annual plan": { "value": [ "You have an annual plan. Contact your account manager to top up." ] } } } } }, "403": { "description": "Clave de API ausente, no válida o revocada, o la clave no puede crear sesiones de recarga para esta organización. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "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": [] } ] } }, "/v3/webhook/destinations/": { "get": { "summary": "Listar destinos de webhook", "description": "Lista todos los destinos de webhook (array sin paginar, del más antiguo al más reciente). Cada elemento incluye la configuración del destino, sus métricas de entrega de los últimos 30 días (`metrics_window_days`) con una entrada `daily_points` por día, y su estado de salud (`health_status`, `failing_streak`, `failing_since`, `last_success_at`). La lista no tiene objeto `summary` y nunca incluye el secreto de firma: cada elemento muestra solo `secret_last4`. Obtén un único destino (`GET /v3/webhook/destinations/{destination_uuid}/`) para leer `secret_shared_key`.", "operationId": "list_webhook_destinations", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/destinations/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.list()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.list();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.List(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().list();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->list();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.webhooks.destinations.list.each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.ListAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Lista de destinos de webhook (sin paginar, del más antiguo al más reciente).", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador estable del destino; úsalo como `{destination_uuid}` para actualizarlo o eliminarlo." }, "label": { "type": "string", "description": "Nombre legible que se muestra en la Console." }, "url": { "type": "string", "format": "uri", "description": "URL de destino que recibe solicitudes `POST` con el payload del webhook." }, "enabled": { "type": "boolean", "description": "Cuando es `false`, Didit omite sin avisar la entrega a este destino." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Versión del esquema del payload que se envía a este destino. `v3` es el formato actual y recomendado." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "subscribed_events_count": { "type": "integer", "description": "Longitud de `subscribed_events` almacenada en caché, útil para renderizar la interfaz." }, "deliveries_count": { "type": "integer", "description": "Intentos de entrega (reintentos incluidos) realizados a este destino en los últimos 30 días." }, "failed_deliveries_count": { "type": "integer", "description": "Intentos de entrega de los últimos 30 días a los que el destino respondió con HTTP 400 o superior, o no respondió (tiempo de espera agotado, conexión rechazada o dirección bloqueada)." }, "average_response_time_ms": { "type": "integer", "nullable": true, "description": "Tiempo de respuesta promedio en milisegundos de los últimos 30 días, redondeado a un entero. `null` cuando no hubo entregas en ese periodo." }, "error_rate_percentage": { "type": "integer", "description": "`round(failed_deliveries_count / deliveries_count * 100)` en los últimos 30 días; `0` cuando no hay entregas." }, "last_delivery_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de tiempo del intento de entrega más reciente (correcto o fallido). `null` si nunca se entregó." }, "metrics_window_days": { "type": "integer", "description": "Duración en días de la ventana que cubren `deliveries_count`, `failed_deliveries_count`, `average_response_time_ms`, `error_rate_percentage` y `daily_points`. Siempre `30`." }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Estado de las entregas. `failing`: 3 o más eventos consecutivos fallaron en su primer intento de entrega desde la última vez que el destino respondió correctamente (consulta `failing_streak`). `degraded`: el destino no está fallando, pero un intento de entrega falló en las últimas 24 horas y ningún intento posterior ha entregado ese evento; un reintento o un reenvío que lo entregue elimina este estado. `healthy`: ninguno de los dos casos anteriores. Es independiente de `enabled`. Un intento fallido es aquel que recibe una respuesta HTTP 400 o superior, o que no recibe ninguna respuesta." }, "failing_streak": { "type": "integer", "description": "Cuántos eventos consecutivos fallaron en su primer intento de entrega desde la última vez que el destino respondió correctamente, dentro de los últimos 30 días. Los reintentos no se cuentan, y cualquier intento correcto, incluido un reintento o un reenvío, pone fin a la racha. `0` cuando ningún evento ha fallado desde el último éxito." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se realizó el primer intento fallido de la `failing_streak` actual. `null` cuando `failing_streak` es `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo el destino respondió por última vez a una entrega con un estado HTTP inferior a 400, dentro de los últimos 30 días. `null` si no lo ha hecho en ese periodo." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Entorno de la aplicación a la que pertenece el destino." }, "daily_points": { "type": "array", "description": "Una entrada por día UTC de los últimos 30 días, de la más antigua a la más reciente, incluidos los días sin entregas. Cuenta cada intento, reintentos incluidos.", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "El día en UTC." }, "total_deliveries": { "type": "integer", "description": "Intentos de entrega realizados ese día." }, "failed_deliveries": { "type": "integer", "description": "Intentos realizados ese día que recibieron una respuesta HTTP 400 o superior, o que no recibieron respuesta." } } } }, "secret_last4": { "type": "string", "description": "Últimos cuatro caracteres del secreto de firma actual del destino, para que puedas distinguir los secretos. No basta para verificar una firma." }, "created_by_email": { "type": "string", "nullable": true, "description": "Correo electrónico del miembro de Business Console que creó el destino. `null` para un destino creado con una clave de API." }, "created_by_name": { "type": "string", "nullable": true, "description": "Nombre del miembro de Business Console que creó el destino. `null` para un destino creado con una clave de API." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "examples": { "Two destinations": { "value": [ { "uuid": "11111111-2222-3333-4444-555555555555", "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "enabled": true, "webhook_version": "v3", "subscribed_events": [ "status.updated", "data.updated" ], "subscribed_events_count": 2, "deliveries_count": 12453, "failed_deliveries_count": 14, "average_response_time_ms": 187, "error_rate_percentage": 0, "last_delivery_at": "2026-05-17T09:21:18Z", "metrics_window_days": 30, "health_status": "healthy", "failing_streak": 0, "failing_since": null, "last_success_at": "2026-05-17T09:21:18Z", "environment": "live", "daily_points": [ { "date": "2026-04-18", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-19", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-20", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-21", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-22", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-23", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-24", "total_deliveries": 415, "failed_deliveries": 9 }, { "date": "2026-04-25", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-26", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-27", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-28", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-29", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-30", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-01", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-02", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-03", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-04", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-05", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-06", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-07", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-08", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-09", "total_deliveries": 415, "failed_deliveries": 5 }, { "date": "2026-05-10", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-11", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-12", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-13", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-14", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-15", "total_deliveries": 416, "failed_deliveries": 0 }, { "date": "2026-05-16", "total_deliveries": 416, "failed_deliveries": 0 }, { "date": "2026-05-17", "total_deliveries": 416, "failed_deliveries": 0 } ], "secret_last4": "0xnQ", "created_by_email": null, "created_by_name": null, "created_at": "2026-01-04T08:00:00Z", "updated_at": "2026-04-22T14:09:11Z" }, { "uuid": "22222222-3333-4444-5555-666666666666", "label": "Staging mirror", "url": "https://staging.yourapp.com/webhooks/didit", "enabled": false, "webhook_version": "v3", "subscribed_events": [ "status.updated" ], "subscribed_events_count": 1, "deliveries_count": 0, "failed_deliveries_count": 0, "average_response_time_ms": null, "error_rate_percentage": 0, "last_delivery_at": null, "metrics_window_days": 30, "health_status": "healthy", "failing_streak": 0, "failing_since": null, "last_success_at": null, "environment": "live", "daily_points": [ { "date": "2026-04-18", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-19", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-20", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-21", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-22", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-23", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-24", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-25", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-26", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-27", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-28", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-29", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-30", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-01", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-02", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-03", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-04", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-05", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-06", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-07", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-08", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-09", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-10", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-11", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-12", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-13", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-14", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-15", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-16", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-17", "total_deliveries": 0, "failed_deliveries": 0 } ], "secret_last4": "k9Qe", "created_by_email": "reviewer@example.com", "created_by_name": "Example Reviewer", "created_at": "2026-03-12T10:15:02Z", "updated_at": "2026-03-12T10:15:02Z" } ] } } } } }, "403": { "description": "Clave de API ausente, con formato incorrecto, expirada o asociada a otra aplicación. Si falta la clave, se devuelve `403`; si es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Límite de solicitudes superado; espera y reintenta.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crear destino de webhook", "description": "Crea un destino de webhook. La respuesta incluye `secret_shared_key`, el secreto de firma HMAC generado automáticamente (también se puede leer más tarde mediante `GET /v3/webhook/destinations/{destination_uuid}/`). Envía siempre `subscribed_events` con al menos un evento (sin comodines): una lista vacía explícita se rechaza con 400, y omitir el campo crea un destino sin suscripción a ningún evento, que nunca recibe un webhook. El par `(application, url)` debe ser único entre los destinos de la aplicación.", "operationId": "create_webhook_destination", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/webhook/destinations/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"label\": \"Production session webhooks\",\n \"url\": \"https://yourapp.com/webhooks/didit\",\n \"webhook_version\": \"v3\",\n \"subscribed_events\": [\"status.updated\", \"data.updated\"]\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.create(\n label=\"Production session webhooks\",\n url=\"https://yourapp.com/webhooks/didit\",\n webhook_version=\"v3\",\n subscribed_events=[\"status.updated\", \"data.updated\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.create({\n label: \"Production session webhooks\",\n url: \"https://yourapp.com/webhooks/didit\",\n webhook_version: \"v3\",\n subscribed_events: [\"status.updated\", \"data.updated\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.Create(ctx, didit.WebhooksDestinationsCreateParams{\n\tLabel: \"Production session webhooks\",\n\tURL: \"https://yourapp.com/webhooks/didit\",\n\tWebhookVersion: didit.Some(didit.WebhooksDestinationsCreateParamsWebhookVersion(\"v3\")),\n\tSubscribedEvents: didit.Some([]didit.WebhookEvent{didit.WebhookEvent(\"status.updated\"), didit.WebhookEvent(\"data.updated\")}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.WebhookEvent;\nimport me.didit.types.WebhooksDestinationsCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().create(WebhooksDestinationsCreateParams.builder()\n .label(\"Production session webhooks\")\n .url(\"https://yourapp.com/webhooks/didit\")\n .webhookVersion(WebhooksDestinationsCreateParams.WebhookVersion.of(\"v3\"))\n .subscribedEvents(List.of(WebhookEvent.of(\"status.updated\"), WebhookEvent.of(\"data.updated\")))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->create([\n 'label' => 'Production session webhooks',\n 'url' => 'https://yourapp.com/webhooks/didit',\n 'webhook_version' => 'v3',\n 'subscribed_events' => ['status.updated', 'data.updated'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.create(\n label: \"Production session webhooks\",\n url: \"https://yourapp.com/webhooks/didit\",\n webhook_version: \"v3\",\n subscribed_events: [\"status.updated\", \"data.updated\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.CreateAsync(new WebhooksDestinationsCreateParams\n{\n Label = \"Production session webhooks\",\n Url = \"https://yourapp.com/webhooks/didit\",\n WebhookVersion = new WebhooksDestinationsCreateParamsWebhookVersion(\"v3\"),\n SubscribedEvents = new WebhookEvent[] { \"status.updated\", \"data.updated\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "label", "url" ], "properties": { "label": { "type": "string", "maxLength": 255, "description": "Nombre legible que se muestra en Console → Webhooks. Ayuda a distinguir los destinos cuando tienes varios (p. ej., \"Prod\", \"Staging mirror\")." }, "url": { "type": "string", "format": "uri", "description": "URL HTTPS que recibirá solicitudes `POST`. Debe ser única entre los destinos de la aplicación. Usa un endpoint estable y protegido: Didit reintenta las entregas fallidas con esperas progresivas (backoff).", "maxLength": 2000 }, "enabled": { "type": "boolean", "default": true, "description": "Cuando es `false`, el destino se guarda, pero Didit no le enviará ningún webhook. Útil para configuraciones de staging que quieras mantener en pausa." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Versión del esquema del payload que enviará Didit. `v3` es el formato actual y recomendado; las versiones anteriores se mantienen por compatibilidad con integraciones heredadas." }, "subscribed_events": { "allOf": [ { "$ref": "#/components/schemas/WebhookSubscribedEvents" } ], "description": "Eventos que se entregan. En la práctica es obligatorio: un `[]` explícito se rechaza con 400, y si omites el campo se crea un destino sin suscripciones que no recibe nada." } } }, "examples": { "session_updates": { "summary": "Actualizaciones de estado y de datos de la sesión", "value": { "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "webhook_version": "v3", "subscribed_events": [ "status.updated", "data.updated" ] } }, "transaction_updates": { "summary": "Actualizaciones de la monitorización de transacciones", "value": { "label": "Transaction monitoring webhooks", "url": "https://yourapp.com/webhooks/didit-transactions", "webhook_version": "v3", "subscribed_events": [ "transaction.created", "transaction.status.updated" ] } }, "entity_updates": { "summary": "Actualizaciones de entidades de usuario y empresa", "value": { "label": "Entity lifecycle webhooks", "url": "https://yourapp.com/webhooks/didit-entities", "webhook_version": "v3", "subscribed_events": [ "user.status.updated", "user.data.updated", "business.status.updated", "business.data.updated", "activity.created" ] } } } } } }, "responses": { "201": { "description": "Destino creado. `secret_shared_key` es el secreto de firma HMAC: guárdalo ahora.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador estable del destino. Úsalo como `{destination_uuid}` en las llamadas posteriores." }, "label": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "enabled": { "type": "boolean" }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ] }, "secret_shared_key": { "type": "string", "description": "Secreto de firma HMAC generado automáticamente y vinculado a este destino (token seguro para URL de 43 caracteres). Úsalo para verificar los encabezados de firma de los webhooks entrantes. Siempre se devuelve completo a quienes llaman con una clave de API; los usuarios de la Console necesitan el permiso `read:webhooks` y, de lo contrario, ven una cadena vacía." }, "secret_last4": { "type": "string", "description": "Últimos cuatro caracteres del secreto de firma actual del destino, para que puedas distinguir los secretos. No basta para verificar una firma." }, "previous_secret_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Se establece durante 24 horas después de rotar el secreto de firma del destino en la Business Console. Hasta ese momento, cada entrega al destino también incluye `X-Signature-Previous`, `X-Signature-V2-Previous` y `X-Signature-Simple-Previous`, generados con el secreto sustituido (consulta [Verificación de firma](/es/integration/webhooks#verificación-de-firma)). `null` cuando no se ha producido ninguna rotación en las últimas 24 horas." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "created_by_email": { "type": "string", "nullable": true, "description": "Correo electrónico del miembro de Business Console que creó el destino. `null` para un destino creado con una clave de API." }, "created_by_name": { "type": "string", "nullable": true, "description": "Nombre del miembro de Business Console que creó el destino. `null` para un destino creado con una clave de API." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Estado de las entregas. `failing`: 3 o más eventos consecutivos fallaron en su primer intento de entrega desde la última vez que el destino respondió correctamente (consulta `failing_streak`). `degraded`: el destino no está fallando, pero un intento de entrega falló en las últimas 24 horas y ningún intento posterior ha entregado ese evento; un reintento o un reenvío que lo entregue elimina este estado. `healthy`: ninguno de los dos casos anteriores. Es independiente de `enabled`. Un intento fallido es aquel que recibe una respuesta HTTP 400 o superior, o que no recibe ninguna respuesta." }, "failing_streak": { "type": "integer", "description": "Cuántos eventos consecutivos fallaron en su primer intento de entrega desde la última vez que el destino respondió correctamente, dentro de los últimos 30 días. Los reintentos no se cuentan, y cualquier intento correcto, incluido un reintento o un reenvío, pone fin a la racha. `0` cuando ningún evento ha fallado desde el último éxito." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se realizó el primer intento fallido de la `failing_streak` actual. `null` cuando `failing_streak` es `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo el destino respondió por última vez a una entrega con un estado HTTP inferior a 400, dentro de los últimos 30 días. `null` si no lo ha hecho en ese periodo." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Entorno de la aplicación a la que pertenece el destino." }, "summary": { "type": "object", "description": "Métricas de entrega de los últimos `metrics_window_days` (30) días. `last_delivery_at` es el intento más reciente, independientemente de cuándo se realizó.", "properties": { "total_deliveries": { "type": "integer" }, "failed_deliveries": { "type": "integer" }, "error_rate_percentage": { "type": "integer" }, "min_response_time_ms": { "type": "integer", "nullable": true }, "avg_response_time_ms": { "type": "integer", "nullable": true }, "max_response_time_ms": { "type": "integer", "nullable": true }, "last_delivery_at": { "type": "string", "format": "date-time", "nullable": true }, "metrics_window_days": { "type": "integer", "description": "Duración en días de la ventana que cubren las demás métricas del resumen. Siempre `30`." } } } } }, "examples": { "Created": { "value": { "uuid": "11111111-2222-3333-4444-555555555555", "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "enabled": true, "webhook_version": "v3", "secret_shared_key": "tno2NTeRC1ZK3sBOYlBJDyEzBVENl3pQ1AcZyAW0xnQ", "secret_last4": "0xnQ", "previous_secret_expires_at": null, "subscribed_events": [ "status.updated", "data.updated" ], "created_by_email": null, "created_by_name": null, "created_at": "2026-05-17T10:00:00Z", "updated_at": "2026-05-17T10:00:00Z", "health_status": "healthy", "failing_streak": 0, "failing_since": null, "last_success_at": null, "environment": "live", "summary": { "total_deliveries": 0, "failed_deliveries": 0, "error_rate_percentage": 0, "min_response_time_ms": null, "avg_response_time_ms": null, "max_response_time_ms": null, "last_delivery_at": null, "metrics_window_days": 30 } } } } } } }, "400": { "description": "La validación ha fallado; normalmente por una URL duplicada, `subscribed_events` ausente o no válido, o un nombre de evento desconocido.", "content": { "application/json": { "examples": { "Duplicate URL": { "value": { "url": [ "This webhook destination already exists for the application." ] } }, "Empty events list": { "value": { "subscribed_events": [ "At least one subscribed event is required." ] } }, "Unknown event": { "value": { "subscribed_events": [ "Unsupported webhook events: foo.bar" ] } } } } } }, "403": { "description": "Clave de API ausente, con formato incorrecto, expirada o asociada a otra aplicación. Si falta la clave, se devuelve `403`; si es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Límite de solicitudes superado; espera y reintenta.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/{destination_uuid}/": { "get": { "summary": "Obtener destino de webhook", "description": "Obtén un destino de webhook con su secreto de firma `secret_shared_key`, su estado de salud (`health_status`, `failing_streak`, `failing_since`, `last_success_at`) y un `summary` de entregas de los últimos 30 días. Quienes llaman con una clave de API siempre reciben el secreto completo; los usuarios de la consola sin `read:webhooks` ven una cadena vacía.", "operationId": "get_webhook_destination", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID del destino (el `uuid` que devuelven la creación o el listado).", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Detalles del destino de webhook.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "enabled": { "type": "boolean" }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ] }, "secret_shared_key": { "type": "string", "description": "Secreto de firma HMAC (token de 43 caracteres seguro para URL). Siempre se devuelve completo a quienes llaman con una clave de API; los usuarios de la consola necesitan `read:webhooks`; de lo contrario, se devuelve una cadena vacía." }, "secret_last4": { "type": "string", "description": "Últimos cuatro caracteres del secreto de firma actual del destino, para que puedas distinguir los secretos. No basta para verificar una firma." }, "previous_secret_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Se establece durante 24 horas después de rotar el secreto de firma del destino en la Business Console. Hasta ese momento, cada entrega al destino también incluye `X-Signature-Previous`, `X-Signature-V2-Previous` y `X-Signature-Simple-Previous`, generados con el secreto sustituido (consulta [Verificación de firma](/es/integration/webhooks#verificación-de-firma)). `null` cuando no se ha producido ninguna rotación en las últimas 24 horas." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "created_by_email": { "type": "string", "nullable": true, "description": "Correo electrónico del miembro de Business Console que creó el destino. `null` para un destino creado con una clave de API." }, "created_by_name": { "type": "string", "nullable": true, "description": "Nombre del miembro de Business Console que creó el destino. `null` para un destino creado con una clave de API." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Estado de las entregas. `failing`: 3 o más eventos consecutivos fallaron en su primer intento de entrega desde la última vez que el destino respondió correctamente (consulta `failing_streak`). `degraded`: el destino no está fallando, pero un intento de entrega falló en las últimas 24 horas y ningún intento posterior ha entregado ese evento; un reintento o un reenvío que lo entregue elimina este estado. `healthy`: ninguno de los dos casos anteriores. Es independiente de `enabled`. Un intento fallido es aquel que recibe una respuesta HTTP 400 o superior, o que no recibe ninguna respuesta." }, "failing_streak": { "type": "integer", "description": "Cuántos eventos consecutivos fallaron en su primer intento de entrega desde la última vez que el destino respondió correctamente, dentro de los últimos 30 días. Los reintentos no se cuentan, y cualquier intento correcto, incluido un reintento o un reenvío, pone fin a la racha. `0` cuando ningún evento ha fallado desde el último éxito." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se realizó el primer intento fallido de la `failing_streak` actual. `null` cuando `failing_streak` es `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo el destino respondió por última vez a una entrega con un estado HTTP inferior a 400, dentro de los últimos 30 días. `null` si no lo ha hecho en ese periodo." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Entorno de la aplicación a la que pertenece el destino." }, "summary": { "type": "object", "description": "Métricas de entrega de los últimos `metrics_window_days` (30) días. `last_delivery_at` es el intento más reciente, independientemente de cuándo se realizó.", "properties": { "total_deliveries": { "type": "integer" }, "failed_deliveries": { "type": "integer" }, "error_rate_percentage": { "type": "integer" }, "min_response_time_ms": { "type": "integer", "nullable": true }, "avg_response_time_ms": { "type": "integer", "nullable": true }, "max_response_time_ms": { "type": "integer", "nullable": true }, "last_delivery_at": { "type": "string", "format": "date-time", "nullable": true }, "metrics_window_days": { "type": "integer", "description": "Duración en días de la ventana que cubren las demás métricas del resumen. Siempre `30`." } } } } }, "examples": { "Healthy destination": { "value": { "uuid": "11111111-2222-3333-4444-555555555555", "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "enabled": true, "webhook_version": "v3", "secret_shared_key": "tno2NTeRC1ZK3sBOYlBJDyEzBVENl3pQ1AcZyAW0xnQ", "secret_last4": "0xnQ", "previous_secret_expires_at": null, "subscribed_events": [ "status.updated", "data.updated" ], "created_by_email": null, "created_by_name": null, "created_at": "2026-01-04T08:00:00Z", "updated_at": "2026-04-22T14:09:11Z", "health_status": "healthy", "failing_streak": 0, "failing_since": null, "last_success_at": "2026-05-17T09:21:18Z", "environment": "live", "summary": { "total_deliveries": 12453, "failed_deliveries": 14, "error_rate_percentage": 0, "min_response_time_ms": 41, "avg_response_time_ms": 187, "max_response_time_ms": 2103, "last_delivery_at": "2026-05-17T09:21:18Z", "metrics_window_days": 30 } } } } } } }, "403": { "description": "Clave de API ausente, con formato incorrecto, expirada o asociada a otra aplicación. Si falta la clave, se devuelve `403`; si es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ningún destino con este UUID, pertenece a otra aplicación o se ha eliminado.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "Límite de solicitudes superado; espera y reintenta.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualizar destino de webhook", "description": "Actualiza un destino de webhook. **`subscribed_events` se REEMPLAZA por completo, no se combina**: obtenlo primero, añade lo que necesites y vuelve a enviarlo. El secreto no se rota. Un `uuid` en el cuerpo se ignora: la ruta identifica el destino.", "operationId": "update_webhook_destination", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID del destino que se va a actualizar.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "description": "Nuevo nombre legible." }, "url": { "type": "string", "format": "uri", "description": "Nueva URL de destino. Debe ser única dentro de la aplicación." }, "enabled": { "type": "boolean", "description": "Establécelo en `false` para pausar las entregas a este destino sin eliminarlo." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Nueva versión del esquema del payload para las entregas futuras." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" } } }, "examples": { "Pause destination": { "value": { "enabled": false } }, "Add transaction events": { "value": { "subscribed_events": [ "status.updated", "data.updated", "transaction.created", "transaction.status.updated" ] } }, "Move target URL": { "value": { "label": "Production session webhooks v2", "url": "https://api.yourapp.com/webhooks/didit/v2" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"subscribed_events\": [\n \"status.updated\",\n \"data.updated\",\n \"transaction.created\"\n ]\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.update(\n \"11111111-2222-3333-4444-555555555555\",\n enabled=False,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.update(\"11111111-2222-3333-4444-555555555555\", {\n enabled: false,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WebhooksDestinationsUpdateParams{\n\tEnabled: didit.Bool(false),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.WebhooksDestinationsUpdateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().update(\"11111111-2222-3333-4444-555555555555\", WebhooksDestinationsUpdateParams.builder()\n .enabled(false)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->update('11111111-2222-3333-4444-555555555555', [\n 'enabled' => false,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.update(\n \"11111111-2222-3333-4444-555555555555\",\n enabled: false\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new WebhooksDestinationsUpdateParams\n{\n Enabled = false,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Destino de webhook actualizado. El cuerpo tiene la misma estructura que `GET /v3/webhook/destinations/{destination_uuid}/`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "enabled": { "type": "boolean" }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ] }, "secret_shared_key": { "type": "string" }, "secret_last4": { "type": "string", "description": "Últimos cuatro caracteres del secreto de firma actual del destino, para que puedas distinguir los secretos. No basta para verificar una firma." }, "previous_secret_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Se establece durante 24 horas después de rotar el secreto de firma del destino en la Business Console. Hasta ese momento, cada entrega al destino también incluye `X-Signature-Previous`, `X-Signature-V2-Previous` y `X-Signature-Simple-Previous`, generados con el secreto sustituido (consulta [Verificación de firma](/es/integration/webhooks#verificación-de-firma)). `null` cuando no se ha producido ninguna rotación en las últimas 24 horas." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "created_by_email": { "type": "string", "nullable": true, "description": "Correo electrónico del miembro de Business Console que creó el destino. `null` para un destino creado con una clave de API." }, "created_by_name": { "type": "string", "nullable": true, "description": "Nombre del miembro de Business Console que creó el destino. `null` para un destino creado con una clave de API." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Estado de las entregas. `failing`: 3 o más eventos consecutivos fallaron en su primer intento de entrega desde la última vez que el destino respondió correctamente (consulta `failing_streak`). `degraded`: el destino no está fallando, pero un intento de entrega falló en las últimas 24 horas y ningún intento posterior ha entregado ese evento; un reintento o un reenvío que lo entregue elimina este estado. `healthy`: ninguno de los dos casos anteriores. Es independiente de `enabled`. Un intento fallido es aquel que recibe una respuesta HTTP 400 o superior, o que no recibe ninguna respuesta." }, "failing_streak": { "type": "integer", "description": "Cuántos eventos consecutivos fallaron en su primer intento de entrega desde la última vez que el destino respondió correctamente, dentro de los últimos 30 días. Los reintentos no se cuentan, y cualquier intento correcto, incluido un reintento o un reenvío, pone fin a la racha. `0` cuando ningún evento ha fallado desde el último éxito." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se realizó el primer intento fallido de la `failing_streak` actual. `null` cuando `failing_streak` es `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo el destino respondió por última vez a una entrega con un estado HTTP inferior a 400, dentro de los últimos 30 días. `null` si no lo ha hecho en ese periodo." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Entorno de la aplicación a la que pertenece el destino." }, "summary": { "type": "object", "properties": { "total_deliveries": { "type": "integer" }, "failed_deliveries": { "type": "integer" }, "error_rate_percentage": { "type": "integer" }, "min_response_time_ms": { "type": "integer", "nullable": true }, "avg_response_time_ms": { "type": "integer", "nullable": true }, "max_response_time_ms": { "type": "integer", "nullable": true }, "last_delivery_at": { "type": "string", "format": "date-time", "nullable": true }, "metrics_window_days": { "type": "integer", "description": "Duración en días de la ventana que cubren las demás métricas del resumen. Siempre `30`." } }, "description": "Métricas de entrega de los últimos `metrics_window_days` (30) días. `last_delivery_at` es el intento más reciente, independientemente de cuándo se realizó." } } }, "examples": { "Paused": { "value": { "uuid": "11111111-2222-3333-4444-555555555555", "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "enabled": false, "webhook_version": "v3", "secret_shared_key": "tno2NTeRC1ZK3sBOYlBJDyEzBVENl3pQ1AcZyAW0xnQ", "secret_last4": "0xnQ", "previous_secret_expires_at": null, "subscribed_events": [ "status.updated", "data.updated" ], "created_by_email": null, "created_by_name": null, "created_at": "2026-01-04T08:00:00Z", "updated_at": "2026-05-17T11:02:55Z", "health_status": "healthy", "failing_streak": 0, "failing_since": null, "last_success_at": "2026-05-17T09:21:18Z", "environment": "live", "summary": { "total_deliveries": 12453, "failed_deliveries": 14, "error_rate_percentage": 0, "min_response_time_ms": 41, "avg_response_time_ms": 187, "max_response_time_ms": 2103, "last_delivery_at": "2026-05-17T09:21:18Z", "metrics_window_days": 30 } } } } } } }, "400": { "description": "La validación ha fallado (URL duplicada, lista de eventos vacía o desconocida, cuerpo mal formado).", "content": { "application/json": { "examples": { "Duplicate URL": { "value": { "url": [ "This webhook destination already exists for the application." ] } }, "Empty events": { "value": { "subscribed_events": [ "At least one subscribed event is required." ] } } } } } }, "403": { "description": "Clave de API ausente, con formato incorrecto, expirada o asociada a otra aplicación. Si falta la clave, se devuelve `403`; si es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ningún destino con este UUID (o se ha eliminado, o pertenece a otra aplicación).", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "Límite de solicitudes superado; espera y reintenta.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Eliminar destino de webhook", "description": "Elimina de forma permanente un destino de webhook, su secreto de firma y todo su registro de entregas. Esta acción no se puede deshacer. No se envía ningún webhook nuevo a la URL del destino; los demás destinos suscritos a los mismos eventos siguen recibiéndolos. Después, el destino ya no aparece en `GET /v3/webhook/destinations/`, y todas las rutas bajo `/v3/webhook/destinations/{destination_uuid}/`, incluidas sus entregas, el detalle de una entrega y su reenvío, responden 404. El `webhook_url` heredado de la aplicación pasa a ser la URL del destino habilitado más antiguo que quede, o se borra cuando no queda ningún destino habilitado. Volver a llamar a DELETE devuelve 404.", "operationId": "delete_webhook_destination", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID del destino que se va a eliminar.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.webhooks.destinations.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.webhooks.destinations.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Webhooks.Destinations.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.webhooks().destinations().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.webhooks.destinations.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Webhooks.Destinations.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ], "responses": { "204": { "description": "El destino, el secreto de firma y el registro de entregas se han eliminado de forma permanente. Sin cuerpo de respuesta." }, "403": { "description": "Clave de API ausente, con formato incorrecto, expirada o asociada a otra aplicación. Si falta la clave, se devuelve `403`; si es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ningún destino con este UUID para la aplicación (ya se eliminó o nunca existió).", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "Límite de solicitudes superado; espera y reintenta.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/wallet-screening/": { "post": { "summary": "Analizar una dirección de wallet", "description": "Ejecuta un análisis AML bajo demanda para una sola wallet o dirección cripto sin crear una transacción. Resuelve el proveedor de análisis de blockchain configurado en tu aplicación, analiza la dirección de forma síncrona y devuelve el resultado de riesgo normalizado. LIGHTNING solo está disponible con una conexión BYOK de Elliptic o Chainalysis añadida a través de Marketplace. No se escribe nada en la tabla de transacciones. Se factura un uso de monitorización AML por cada análisis correcto (las aplicaciones sandbox no se facturan).", "operationId": "screenWallet", "x-didit-sdk": { "resource": "wallet_screening", "method": "screen", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "wallet_address" ], "properties": { "wallet_address": { "type": "string", "description": "La dirección cripto o el identificador de red que se va a analizar. Debe corresponder a la red seleccionada (por ejemplo, una dirección de 40 caracteres hexadecimales con el prefijo `0x` para cadenas EVM). Alias: `address`.", "example": "0x94f1b9b64e2932f6a2db338f616844400cd58e8a" }, "blockchain": { "type": "string", "description": "Identificador de red opcional. Si se omite, la red se deduce del formato de la dirección: las direcciones `bc1`, `1` y `3` son de Bitcoin (BTC), las direcciones `T` son de Tron (TRX) y las claves públicas base58 son de Solana (SOL). Una dirección `0x` es válida en todas las redes EVM, por lo que, si se omite `blockchain` para ella, la respuesta es 422 con las redes candidatas en `candidate_chains`. El análisis gestionado admite BTC, ETH, LTC, XRP, BCH, DOGE, TRX, SOL, MATIC, BNB, BASE (Base), OP (Optimism), ARB (Arbitrum One), AVAX (Avalanche C-Chain), ADA (Cardano), XLM (Stellar) y HBAR (Hedera). USDT y USDC son alias heredados de Ethereum, no búsquedas en varias redes. La cobertura de los proveedores conectados varía. LIGHTNING requiere un proveedor conectado compatible. CELO (Celo), MODE (Mode) y PLUME (Plume) se analizan a través de una cuenta de TRM Labs conectada; el análisis gestionado responde 400 para ellas. Alias: `currency`.", "enum": [ "BTC", "LIGHTNING", "ETH", "LTC", "XRP", "BCH", "DOGE", "TRX", "SOL", "MATIC", "BNB", "USDT", "USDC", "BASE", "OP", "ARB", "AVAX", "ADA", "XLM", "HBAR", "CELO", "MODE", "PLUME" ], "example": "ETH" }, "direction": { "type": "string", "description": "Opcional. Indica si la dirección se analiza como contraparte entrante (depósito) o saliente (retiro). Acepta `inbound`, `outbound`, `deposit` o `withdrawal`. Si se omite, se realiza por defecto un análisis neutro previo a la transferencia. Este valor se pasa al proveedor solo como contexto; no cambia el `risk_score` ni la `severity` devueltos, ni los desgloses `source_of_funds`/`destination_of_funds`, que siempre se devuelven ambos independientemente de `direction`. Por tanto, cambiar u omitir `direction` no requiere volver a analizar una dirección.", "enum": [ "inbound", "outbound", "deposit", "withdrawal" ] } } }, "example": { "wallet_address": "0x94f1b9b64e2932f6a2db338f616844400cd58e8a", "blockchain": "ETH" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/wallet-screening/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"wallet_address\": \"0x94f1b9b64e2932f6a2db338f616844400cd58e8a\",\n \"blockchain\": \"ETH\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.wallet_screening.screen(\n wallet_address=\"0x94f1b9b64e2932f6a2db338f616844400cd58e8a\",\n blockchain=\"ETH\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.walletScreening.screen({\n wallet_address: \"0x94f1b9b64e2932f6a2db338f616844400cd58e8a\",\n blockchain: \"ETH\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.WalletScreening.Screen(ctx, didit.WalletScreeningScreenParams{\n\tWalletAddress: \"0x94f1b9b64e2932f6a2db338f616844400cd58e8a\",\n\tBlockchain: didit.Some(didit.WalletScreeningScreenParamsBlockchain(\"ETH\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.WalletScreeningScreenParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.walletScreening().screen(WalletScreeningScreenParams.builder()\n .walletAddress(\"0x94f1b9b64e2932f6a2db338f616844400cd58e8a\")\n .blockchain(WalletScreeningScreenParams.Blockchain.of(\"ETH\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "walletScreening->screen([\n 'wallet_address' => '0x94f1b9b64e2932f6a2db338f616844400cd58e8a',\n 'blockchain' => 'ETH',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.wallet_screening.screen(\n wallet_address: \"0x94f1b9b64e2932f6a2db338f616844400cd58e8a\",\n blockchain: \"ETH\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.WalletScreening.ScreenAsync(new WalletScreeningScreenParams\n{\n WalletAddress = \"0x94f1b9b64e2932f6a2db338f616844400cd58e8a\",\n Blockchain = new WalletScreeningScreenParamsBlockchain(\"ETH\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "El resultado normalizado del análisis de wallets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletScreeningResult" }, "example": { "provider": "merklescience", "screening_type": "WALLET_SCREENING", "risk_score": 95, "severity": "CRITICAL", "status": "SCREENED", "summary": "Merkle Science risk: Critical (5/5). SANCTIONS HIT. Dominant risk: sanctioned. Driven by: the address is attributed to Sanctions / OFAC (Example Sanctions)", "wallet_address": "0x94f1b9b64e2932f6a2db338f616844400cd58e8a", "transaction_hash": null, "blockchain": "ETH", "block_timestamp": null, "total_value_usd": null, "fee_usd": null, "sender_rows": [], "receiver_rows": [], "transaction_flows": [], "transaction_flows_status": null, "transaction_flows_error": null, "source_of_funds": [ { "category": "sanctioned", "percentage": 100.0, "amount_usd": 9813695.0, "entity_name": "Example Sanctions", "entity_type": "Sanctions", "entity_subtype": "OFAC", "hops": null, "description": "Sanctions / OFAC", "is_direct": true, "exposure_direction": "incoming", "exposure_type": "direct", "provider_entity_id": "118885", "provider_entity_type_id": "30", "provider_entity_subtype_id": "125", "country": "", "raw_amount": null, "raw_currency": null } ], "destination_of_funds": [ { "category": "defi", "percentage": 84.824453, "amount_usd": 7783414.38, "entity_name": "Example DeFi 7", "entity_type": "DeFi", "entity_subtype": "Bridges", "hops": null, "description": "DeFi / Bridges", "is_direct": false, "exposure_direction": "outgoing", "exposure_type": "indirect", "provider_entity_id": "118459", "provider_entity_type_id": "33", "provider_entity_subtype_id": "143", "country": "", "raw_amount": null, "raw_currency": null }, { "category": "defi", "percentage": 15.175547, "amount_usd": 1392494.37, "entity_name": "Example DeFi 2", "entity_type": "DeFi", "entity_subtype": "Yield Aggregator", "hops": null, "description": "DeFi / Yield Aggregator", "is_direct": false, "exposure_direction": "outgoing", "exposure_type": "indirect", "provider_entity_id": "90192", "provider_entity_type_id": "33", "provider_entity_subtype_id": "142", "country": "", "raw_amount": null, "raw_currency": null } ], "counterparty_connections": [ { "entity_name": "Example Sanctions", "entity_type": "Sanctions", "entity_subtype": "OFAC", "risk_level": "critical", "categories": [ "sanctioned" ], "received_usd": null, "sent_usd": null, "received_hops": null, "sent_hops": null, "percentage": 0.0, "is_direct": true, "country": null, "provider_entity_id": null }, { "entity_name": "Example Sanctions", "entity_type": "Sanctions", "entity_subtype": "OFAC", "risk_level": "critical", "categories": [ "sanctioned" ], "received_usd": null, "sent_usd": null, "received_hops": null, "sent_hops": null, "percentage": 0.0, "is_direct": true, "country": null, "provider_entity_id": null } ], "network_nodes": [], "network_edges": [], "sanctions_hit": true, "pep_counterparty": null, "dominant_risk_category": "sanctioned", "risk_factors": [ { "source": "attribution", "category": "sanctioned", "label": "Sanctions / OFAC", "entity_name": "Example Sanctions", "direction": "attribution", "exposure_type": "attribution", "amount_usd": null, "percentage": 0.0, "is_high_risk": true, "description": "the address is attributed to Sanctions / OFAC (Example Sanctions)" }, { "source": "exposure", "category": "sanctioned", "label": "Sanctions / OFAC", "entity_name": "Example Sanctions", "direction": "incoming", "exposure_type": "direct", "amount_usd": 9813695.0, "percentage": 51.679304, "is_high_risk": true, "description": "51.6793% direct incoming exposure to Sanctions / OFAC (Example Sanctions)" }, { "source": "exposure", "category": "defi", "label": "DeFi / Bridges", "entity_name": "Example DeFi 7", "direction": "outgoing", "exposure_type": "indirect", "amount_usd": 7783414.38, "percentage": 40.987766, "is_high_risk": false, "description": "40.9878% indirect outgoing exposure to DeFi / Bridges (Example DeFi 7)" }, { "source": "exposure", "category": "defi", "label": "DeFi / Yield Aggregator", "entity_name": "Example DeFi 2", "direction": "outgoing", "exposure_type": "indirect", "amount_usd": 1392494.37, "percentage": 7.33293, "is_high_risk": false, "description": "7.33293% indirect outgoing exposure to DeFi / Yield Aggregator (Example DeFi 2)" } ], "raw_response": { "...": "provider-specific details" }, "report_signature": "" } } } }, "400": { "description": "Error de validación: dirección de wallet mal formada, falta `wallet_address`, `blockchain` no compatible, `blockchain` omitido para una dirección cuyo formato no indica ninguna red, o LIGHTNING sin una conexión BYOK del Marketplace con Elliptic o Chainalysis." }, "401": { "description": "`x-api-key` ausente o no válido." }, "409": { "description": "No hay ningún proveedor AML configurado para la aplicación, o el proveedor configurado aún no admite el análisis de wallets. Configura primero la monitorización de transacciones." }, "422": { "description": "`blockchain` omitido para una dirección `0x`, que comparten todas las redes EVM. No se analiza ni se factura nada; vuelve a enviarla con `blockchain` establecido en uno de los valores de `candidate_chains`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "blockchain": { "type": "array", "items": { "type": "string" }, "example": [ "A 0x address is valid on every EVM chain. Send blockchain as one of: ETH, BNB, MATIC, BASE, ARB, OP, CELO, MODE, PLUME." ] }, "candidate_chains": { "type": "array", "items": { "type": "string" }, "example": [ "ETH", "BNB", "MATIC", "BASE", "ARB", "OP", "CELO", "MODE", "PLUME" ] } } } } } }, "502": { "description": "El proveedor AML no pudo completar el análisis. Vuelve a intentarlo más tarde." } } } }, "/v3/wallet-screening/pdf/": { "post": { "summary": "Generar el resultado de un análisis de wallets en PDF", "description": "Complemento sin estado de `POST /v3/wallet-screening/`: vuelve a enviar exactamente el cuerpo JSON que devolvió ese endpoint, incluida la `report_signature` que añadió, y recibe un PDF con la marca Didit del mismo resultado. No se llama a ningún proveedor y no se factura ni se guarda nada; solo se vuelve a generar un resultado que Didit ya produjo. La firma vincula el PDF a un resultado sin modificar: si editas `risk_score`, `severity`, `sanctions_hit` o cualquier otro campo firmado antes de reenviarlo, la solicitud falla con `400`.", "operationId": "screenWalletPdf", "x-didit-sdk": { "resource": "wallet_screening", "method": "screen_pdf", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "description": "El objeto JSON sin modificar que devuelve `POST /v3/wallet-screening/`, incluido `report_signature`.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WalletScreeningResult" } ], "required": [ "report_signature" ], "description": "Misma estructura que la respuesta de `POST /v3/wallet-screening/`: devuelve ese cuerpo de respuesta tal cual, incluido `report_signature`." } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "# $RESULT is the saved JSON body from POST /v3/wallet-screening/\ncurl -X POST 'https://verification.didit.me/v3/wallet-screening/pdf/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d \"$RESULT\" \\\n -o wallet_screening_report.pdf" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.wallet_screening.screen_pdf(\n provider=\"your-provider\",\n screening_type=\"WALLET_SCREENING\",\n risk_score=1,\n severity=\"UNKNOWN\",\n status=\"SCREENED\",\n summary=\"your-summary\",\n wallet_address=\"your-wallet-address\",\n blockchain=\"your-blockchain\",\n source_of_funds=[{}],\n destination_of_funds=[{}],\n counterparty_connections=[{}],\n sanctions_hit=True,\n dominant_risk_category=\"your-dominant-risk-category\",\n report_signature=\"your-report-signature\",\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.walletScreening.screenPdf({\n provider: \"your-provider\",\n screening_type: \"WALLET_SCREENING\",\n risk_score: 1,\n severity: \"UNKNOWN\",\n status: \"SCREENED\",\n summary: \"your-summary\",\n wallet_address: \"your-wallet-address\",\n blockchain: \"your-blockchain\",\n source_of_funds: [{}],\n destination_of_funds: [{}],\n counterparty_connections: [{}],\n sanctions_hit: true,\n dominant_risk_category: \"your-dominant-risk-category\",\n report_signature: \"your-report-signature\",\n});\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.WalletScreening.ScreenPDF(ctx, didit.WalletScreeningResultParam{\n\tProvider: \"your-provider\",\n\tScreeningType: \"WALLET_SCREENING\",\n\tRiskScore: 1,\n\tSeverity: \"UNKNOWN\",\n\tStatus: \"SCREENED\",\n\tSummary: \"your-summary\",\n\tWalletAddress: \"your-wallet-address\",\n\tBlockchain: \"your-blockchain\",\n\tSourceOfFunds: []didit.WalletScreeningResultParamSourceOfFunds{{}},\n\tDestinationOfFunds: []didit.WalletScreeningResultParamDestinationOfFunds{{}},\n\tCounterpartyConnections: []didit.WalletScreeningResultParamCounterpartyConnections{{}},\n\tSanctionsHit: true,\n\tDominantRiskCategory: didit.String(\"your-dominant-risk-category\"),\n\tReportSignature: \"your-report-signature\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.WalletScreeningResult;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.walletScreening().screenPdf(WalletScreeningResult.builder()\n .provider(\"your-provider\")\n .screeningType(WalletScreeningResult.ScreeningType.of(\"WALLET_SCREENING\"))\n .riskScore(1L)\n .severity(WalletScreeningResult.Severity.of(\"UNKNOWN\"))\n .status(WalletScreeningResult.Status.of(\"SCREENED\"))\n .summary(\"your-summary\")\n .walletAddress(\"your-wallet-address\")\n .blockchain(\"your-blockchain\")\n .sourceOfFunds(List.of(WalletScreeningResult.SourceOfFunds.builder()\n .build()))\n .destinationOfFunds(List.of(WalletScreeningResult.DestinationOfFunds.builder()\n .build()))\n .counterpartyConnections(List.of(WalletScreeningResult.CounterpartyConnections.builder()\n .build()))\n .sanctionsHit(true)\n .dominantRiskCategory(\"your-dominant-risk-category\")\n .reportSignature(\"your-report-signature\")\n .build())\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "walletScreening->screenPdf([\n 'provider' => 'your-provider',\n 'screening_type' => 'WALLET_SCREENING',\n 'risk_score' => 1,\n 'severity' => 'UNKNOWN',\n 'status' => 'SCREENED',\n 'summary' => 'your-summary',\n 'wallet_address' => 'your-wallet-address',\n 'blockchain' => 'your-blockchain',\n 'source_of_funds' => [[]],\n 'destination_of_funds' => [[]],\n 'counterparty_connections' => [[]],\n 'sanctions_hit' => true,\n 'dominant_risk_category' => 'your-dominant-risk-category',\n 'report_signature' => 'your-report-signature',\n]);\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.wallet_screening.screen_pdf(\n provider: \"your-provider\",\n screening_type: \"WALLET_SCREENING\",\n risk_score: 1,\n severity: \"UNKNOWN\",\n status: \"SCREENED\",\n summary: \"your-summary\",\n wallet_address: \"your-wallet-address\",\n blockchain: \"your-blockchain\",\n source_of_funds: [{}],\n destination_of_funds: [{}],\n counterparty_connections: [{}],\n sanctions_hit: true,\n dominant_risk_category: \"your-dominant-risk-category\",\n report_signature: \"your-report-signature\"\n)\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.WalletScreening.ScreenPdfAsync(new WalletScreeningResult\n{\n Provider = \"your-provider\",\n ScreeningType = \"WALLET_SCREENING\",\n RiskScore = 1,\n Severity = \"UNKNOWN\",\n Status = \"SCREENED\",\n Summary = \"your-summary\",\n WalletAddress = \"your-wallet-address\",\n Blockchain = \"your-blockchain\",\n SourceOfFunds = new WalletScreeningResultSourceOfFunds[] { new() },\n DestinationOfFunds = new WalletScreeningResultDestinationOfFunds[] { new() },\n CounterpartyConnections = new WalletScreeningResultCounterpartyConnections[] { new() },\n SanctionsHit = true,\n DominantRiskCategory = \"your-dominant-risk-category\",\n ReportSignature = \"your-report-signature\",\n});\nawait content.SaveToAsync(\"download.pdf\");" } ], "responses": { "200": { "description": "El documento PDF generado, devuelto directamente como binario `application/pdf`: no hay envoltorio JSON.", "headers": { "Content-Disposition": { "description": "`attachment; filename=wallet_screening_{address}.pdf`, derivado de `wallet_address` (o `transaction_hash`) del resultado reenviado.", "schema": { "type": "string", "example": "attachment; filename=wallet_screening_0x28c6c06298d514db0899.pdf" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "El cuerpo no es un objeto JSON con la estructura del resultado del análisis de wallets, o falta `report_signature` o no coincide con los campos reenviados (se editaron o truncaron antes del reenvío).", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Not an object": { "value": { "non_field_errors": [ "Expected a JSON object matching a wallet-screening result." ] } }, "Missing or invalid signature": { "value": { "report_signature": [ "This wallet-screening result is missing or fails its report signature - repost the exact JSON returned by the wallet-screening endpoint, unmodified." ] } } } } } }, "401": { "description": "`x-api-key` ausente o no válido." } } } }, "/v3/transactions/": { "get": { "summary": "Listar transacciones", "description": "Lista paginada de transacciones monitorizadas, de la más reciente a la más antigua (`txn_date` desc). `count` tiene un máximo de 100; usa `total_transactions` para obtener el número real de filas. Este endpoint no admite parámetros de filtrado ni de búsqueda.", "operationId": "listTransactions", "x-didit-sdk": { "resource": "transactions", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "description": "Tamaño de página. Si se omite, el valor predeterminado es 50. No hay un máximo obligatorio, pero mantén las páginas pequeñas para reducir la latencia." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Desplazamiento, empezando en cero, del primer registro que se devuelve. Es preferible seguir la URL `next` de la página anterior." }, { "name": "travel_rule_status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Devuelve solo las transacciones cuya transferencia de Travel Rule está exactamente en este estado (por ejemplo, `ON_HOLD` o `AWAITING_COUNTERPARTY`). `count` aplica este filtro; `total_transactions` sigue contando todas las transacciones de la aplicación." }, { "name": "assignee", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Separados por comas; una transacción coincide cuando cumple cualquiera de los valores. `unassigned` corresponde a lo que todavía no tiene nadie asignado, `rules` a lo que las reglas decidieron por sí solas sin un revisor, y el correo electrónico de un miembro coincide con el revisor asignado. `me` es el revisor que ha iniciado sesión en la Console, por lo que una clave de API que envíe `me` recibe `400`." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.transactions.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.transactions.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Transactions.ListAutoPaging(ctx, didit.TransactionsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.transactions().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "transactions->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Transactions.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Lista paginada de resúmenes de transacciones, de la más reciente a la más antigua.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Recuento limitado de transacciones coincidentes (exacto hasta 100, limitado a partir de ahí). Usa `total_transactions` para obtener el recuento real al paginar." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta de la página siguiente, o `null` en la última página." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta de la página anterior, o `null` en la primera página." }, "total_transactions": { "type": "integer", "description": "Recuento total exacto de transacciones (no eliminadas) de la aplicación. Presente en las respuestas paginadas." }, "results": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador estable de Didit para la transacción. Úsalo como `{transaction_id}` en las llamadas de detalle, notas y elementos relacionados." }, "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": "Identificador proporcionado por el cliente en la llamada de creación (máx. 128 caracteres). Único por aplicación." }, "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`)." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Veredicto de monitorización actual." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Sentido respecto al sujeto. Se almacena en mayúsculas independientemente de cómo se envíe." }, "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." }, "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, "description": "Código de moneda preferida que se usa para `preferred_currency_amount`: la moneda base de la aplicación, cualquier código ISO 4217 actualmente en circulación. Un código sin tipo de cambio disponible deja `preferred_currency_amount` en null, salvo que la solicitud haya proporcionado un `amount_in_default_currency` ya convertido." }, "payment_details": { "type": "string", "nullable": true, "description": "Referencia o concepto de pago en texto libre del envío." }, "score": { "type": "integer", "description": "Puntuación de riesgo (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." }, "subject_name": { "type": "string", "nullable": true, "description": "Nombre completo de la parte `APPLICANT`." }, "subject_vendor_data": { "type": "string", "nullable": true, "description": "Tu identificador interno de usuario o empresa para el solicitante." }, "subject_country": { "type": "string", "nullable": true, "description": "Código de país del solicitante, obtenido del `address.country` enviado (normalmente ISO 3166-1 alfa-3)." }, "counterparty_name": { "type": "string", "nullable": true, "description": "Nombre completo de la parte `COUNTERPARTY`, si la hay." }, "counterparty_vendor_data": { "type": "string", "nullable": true, "description": "Tu identificador interno de la contraparte." }, "counterparty_country": { "type": "string", "nullable": true, "description": "Código de país de la contraparte, obtenido del `address.country` enviado." }, "tags": { "type": "array", "description": "Etiquetas asociadas a la transacción (manualmente o mediante reglas).", "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." } } } }, "txn_date": { "type": "string", "format": "date-time", "description": "Cuándo se produjo la transacción (a partir de `transaction_at` en el momento de la creación)." }, "created_at": { "type": "string", "format": "date-time", "description": "Cuándo registró Didit el envío." }, "decision_reason_code": { "type": "string", "nullable": true, "description": "Motivo legible por máquina del `status` actual (por ejemplo, `WALLET_HIGH_RISK`)." }, "decision_reason_label": { "type": "string", "nullable": true, "description": "Etiqueta legible de `decision_reason_code`." }, "assigned_to_name": { "type": "string", "nullable": true, "description": "Nombre visible del revisor de la Console asignado a esta transacción." }, "travel_rule_status": { "type": "string", "nullable": true, "description": "Estado de la transferencia de Travel Rule de la transacción (por ejemplo, `COMPLETED`), o `null` cuando no tiene ninguna." }, "travel_rule": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TransactionTravelRule" } ], "description": "La transferencia de Travel Rule de la transacción, el mismo bloque que `travel_rule` en `GET /v3/transactions/{transaction_id}/`, o `null` cuando la transacción no tiene ninguna." } } } } } }, "examples": { "Single transaction": { "value": { "count": 1, "next": null, "previous": null, "total_transactions": 1, "results": [ { "uuid": "abcdef12-3456-4890-abcd-ef1234567890", "transaction_number": 4123, "txn_id": "your-txn-2026-05-17-001", "transaction_type": "finance", "action_type": "withdrawal", "status": "IN_REVIEW", "direction": "OUTBOUND", "amount": "1500", "currency": "EUR", "preferred_currency_amount": "1620.45", "preferred_currency_code": "USD", "payment_details": "Withdrawal to crypto wallet", "txn_date": "2026-05-17T08:42:00Z", "created_at": "2026-05-17T08:42:11Z", "score": 78, "severity": "HIGH", "decision_reason_code": "WALLET_HIGH_RISK", "decision_reason_label": "Destination wallet flagged as high risk", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "name": "Manual review", "color": "#F59E0B", "description": null, "source": "custom" } ], "subject_name": "Maria Garcia", "subject_vendor_data": "user-12345", "counterparty_name": null, "counterparty_vendor_data": null, "counterparty_country": null, "subject_country": null, "assigned_to_name": "Alex Reviewer", "travel_rule_status": null, "travel_rule": null } ] } } } } } }, "403": { "description": "Falta la clave de API, no es válida o fue revocada, o la clave no puede listar 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." } } } } } }, "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": [] } ] }, "post": { "summary": "Crear transacción", "description": "Envía una transacción para su monitorización AML y de riesgo síncrona. La transacción se crea como `APPROVED`; después, tus reglas (y el análisis de criptoactivos, cuando corresponde) se ejecutan en línea y pueden cambiar el `status` devuelto a `IN_REVIEW` o `DECLINED`. **`transaction_id` es tu clave de idempotencia** (máx. 128 caracteres, única por aplicación); reutilizarla devuelve 400. Cuando la operación se completa correctamente, se envía un webhook `transaction.created` para las aplicaciones de producción. Las aplicaciones de sandbox no se facturan y no emiten webhooks `transaction.created` ni `transaction.status.updated`. Los intercambios de Travel Rule en sandbox sí emiten webhooks `travel_rule.status.updated` con `environment: sandbox`. Una transferencia de Travel Rule se almacena y se devuelve antes de contactar con ninguna contraparte: `travel_rule.status` se devuelve como `AWAITING_COUNTERPARTY` (o `NOT_APPLICABLE` por debajo de tu umbral, `UNCONFIRMED_OWNERSHIP` para una wallet sin custodia declarada, `COMPLETED` cuando la otra wallet es tu propia wallet verificada) y `travel_rule.protocol` es null. A continuación, Didit elige el canal y envía el intercambio, y cada cambio de estado posterior de la transferencia, incluido `COUNTERPARTY_VASP_NOT_FOUND` cuando ningún canal llega a la contraparte, llega como un webhook `travel_rule.status.updated`. Tus reglas se vuelven a ejecutar cuando cambia el canal o el estado.", "operationId": "createTransaction", "tags": [ "Transactions" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/transactions/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"transaction_id\": \"your-txn-2026-05-17-001\",\n \"transaction_category\": \"finance\",\n \"transaction_details\": {\n \"direction\": \"outbound\",\n \"amount\": 1500,\n \"currency\": \"EUR\",\n \"action_type\": \"withdrawal\"\n },\n \"subject\": {\n \"entity_type\": \"individual\",\n \"vendor_data\": \"user-12345\",\n \"full_name\": \"Maria Garcia\"\n }\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.create(\n transaction_id=\"your-txn-2026-05-17-001\",\n transaction_category=\"finance\",\n transaction_details={\n \"direction\": \"outbound\",\n \"amount\": 1500.0,\n \"currency\": \"EUR\",\n \"action_type\": \"withdrawal\",\n },\n subject={\n \"entity_type\": \"individual\",\n \"vendor_data\": \"user-12345\",\n \"full_name\": \"Maria Garcia\",\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.create({\n transaction_id: \"your-txn-2026-05-17-001\",\n transaction_category: \"finance\",\n transaction_details: {\n direction: \"outbound\",\n amount: 1500.0,\n currency: \"EUR\",\n action_type: \"withdrawal\",\n },\n subject: {\n entity_type: \"individual\",\n vendor_data: \"user-12345\",\n full_name: \"Maria Garcia\",\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Create(ctx, didit.TransactionsCreateParams{\n\tTransactionID: \"your-txn-2026-05-17-001\",\n\tTransactionCategory: \"finance\",\n\tTransactionDetails: didit.TransactionsCreateParamsTransactionDetails{\n\t\tDirection: \"outbound\",\n\t\tAmount: 1500.0,\n\t\tCurrency: \"EUR\",\n\t\tActionType: didit.String(\"withdrawal\"),\n\t},\n\tSubject: didit.TransactionsCreateParamsSubject{\n\t\tEntityType: didit.String(\"individual\"),\n\t\tVendorData: \"user-12345\",\n\t\tFullName: \"Maria Garcia\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TransactionsCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().create(TransactionsCreateParams.builder()\n .transactionId(\"your-txn-2026-05-17-001\")\n .transactionCategory(TransactionsCreateParams.TransactionCategory.of(\"finance\"))\n .transactionDetails(TransactionsCreateParams.TransactionDetails.builder()\n .direction(TransactionsCreateParams.TransactionDetails.Direction.of(\"outbound\"))\n .amount(1500.0)\n .currency(\"EUR\")\n .actionType(\"withdrawal\")\n .build())\n .subject(TransactionsCreateParams.Subject.builder()\n .entityType(\"individual\")\n .vendorData(\"user-12345\")\n .fullName(\"Maria Garcia\")\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->create([\n 'transaction_id' => 'your-txn-2026-05-17-001',\n 'transaction_category' => 'finance',\n 'transaction_details' => [\n 'direction' => 'outbound',\n 'amount' => 1500.0,\n 'currency' => 'EUR',\n 'action_type' => 'withdrawal',\n ],\n 'subject' => [\n 'entity_type' => 'individual',\n 'vendor_data' => 'user-12345',\n 'full_name' => 'Maria Garcia',\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.create(\n transaction_id: \"your-txn-2026-05-17-001\",\n transaction_category: \"finance\",\n transaction_details: {\n direction: \"outbound\",\n amount: 1500.0,\n currency: \"EUR\",\n action_type: \"withdrawal\",\n },\n subject: {\n entity_type: \"individual\",\n vendor_data: \"user-12345\",\n full_name: \"Maria Garcia\",\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.CreateAsync(new TransactionsCreateParams\n{\n TransactionId = \"your-txn-2026-05-17-001\",\n TransactionCategory = \"finance\",\n TransactionDetails = new()\n {\n Direction = \"outbound\",\n Amount = 1500.0,\n Currency = \"EUR\",\n ActionType = \"withdrawal\",\n },\n Subject = new()\n {\n EntityType = \"individual\",\n VendorData = \"user-12345\",\n FullName = \"Maria Garcia\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "transaction_id": { "type": "string", "description": "Tu identificador único de esta transacción (máximo 128 caracteres).", "example": "your-txn-2026-05-17-001" }, "transaction_at": { "type": "string", "format": "date-time", "description": "Cuándo se produjo la transacción. Si se omite, se usa el momento actual." }, "time_zone": { "type": "string", "description": "Identificador de zona horaria IANA, p. ej. `Europe/Madrid`." }, "transaction_category": { "type": "string", "description": "Categoría de la transacción. También se aceptan alias en CamelCase (`travelRule`, `userPlatformEvent`, `gamblingBet`, …); el valor almacenado y devuelto está en camelCase para las categorías de varias palabras.", "example": "finance", "enum": [ "finance", "kyc", "travel_rule", "user_event", "audit_trail_event", "gambling_bet", "gambling_limit_change", "gambling_bonus_change", "travelRule" ] }, "transaction_details": { "type": "object", "description": "Datos financieros principales de la transacción.", "required": [ "direction", "amount", "currency" ], "properties": { "direction": { "type": "string", "description": "Sentido de la transacción respecto al sujeto. No distingue entre mayúsculas y minúsculas; se aceptan `in`/`out` como alias. Se devuelve en mayúsculas (`INBOUND`/`OUTBOUND`).", "example": "outbound", "enum": [ "inbound", "outbound", "in", "out" ] }, "amount": { "type": "number", "description": "Importe de la transacción (hasta 18 decimales). Envíalo como cadena decimal (p. ej., `\"0.123456789012345678\"`) cuando importe la precisión exacta: un número JSON se interpreta primero como un float binario, por lo que los dígitos que superan unos 15 dígitos significativos se redondean antes de almacenar el importe. Debe ser cero o mayor: la dirección indica el signo, y un importe negativo devuelve `400`.", "example": 1500 }, "currency": { "type": "string", "description": "Código de moneda. 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 usar 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 (por ejemplo, la unidad de cuenta ISO `XSU` o un símbolo cripto al que Didit no asigna precio), la conversión automática falla y `preferred_currency_amount` se devuelve como null, salvo que la solicitud haya incluido un `amount_in_default_currency` ya convertido.", "example": "EUR" }, "currency_kind": { "type": "string", "description": "Si la moneda es `fiat` o `crypto`." }, "amount_in_default_currency": { "type": "number", "nullable": true, "description": "Importe ya convertido a la moneda predeterminada. Si se omite, se intenta una conversión de divisas automática. Debe ser cero o mayor." }, "default_currency": { "type": "string", "description": "El código de moneda predeterminado para el importe convertido. Cualquier código ISO 4217 actualmente en circulación." }, "payment_details": { "type": "string", "nullable": true, "description": "Referencia o concepto de pago en texto libre." }, "payment_reference_id": { "type": "string", "nullable": true, "description": "Referencia del sistema de pago externo. Para el análisis AML de hashes de transacciones cripto, envía el hash de la transacción en blockchain y proporciona también `subject.payment_method.account_id` con la dirección relacionada." }, "action_type": { "type": "string", "nullable": true, "description": "Subtipo de la transacción, p. ej., `deposit`, `withdrawal`, `transfer`." }, "crypto_params": { "type": "object", "description": "Selección de la red cripto, independiente de la moneda (el símbolo del activo). Registrar un símbolo de token personalizado no garantiza la cobertura del hash de transacción para su contrato.", "properties": { "crypto_chain": { "type": "string", "description": "Red que se usa realmente para el análisis. El análisis gestionado admite BTC, ETH, LTC, XRP, BCH, DOGE, TRX, SOL, MATIC, BNB, BASE (Base), OP (Optimism), ARB (Arbitrum One), AVAX (Avalanche C-Chain), ADA (Cardano), XLM (Stellar) y HBAR (Hedera). También se aceptan los nombres habituales de las redes, por ejemplo POLYGON o POL para MATIC, BSC para BNB y TRON para TRX. Especifícala siempre para tokens multired. Si falta para USDT, USDC o ETH enviados con un hash de transacción 0x, Didit busca el hash en Ethereum, BNB Chain, Polygon, Base, Arbitrum y Optimism y lo analiza en la red donde lo encuentra; si ninguna red lo tiene, la transacción no se analiza y custom_values.aml_screening_status es FAILED, con el motivo en custom_values.aml_screening_error. Si falta para USDT o USDC analizados por wallet (sin hash de transacción), una dirección de Tron se analiza en Tron, una dirección de Solana en Solana y una dirección 0x en la primera de esas seis redes en la que haya enviado una transacción o tenga el token, o en Ethereum si no está activa en ninguna de ellas. La cobertura de los proveedores conectados varía; LIGHTNING requiere un proveedor conectado compatible.", "example": "BASE" } } } } }, "subject": { "type": "object", "description": "El sujeto (solicitante) de la transacción.", "required": [ "vendor_data", "full_name" ], "properties": { "entity_type": { "type": "string", "description": "Tipo de entidad: `individual` o `company`." }, "vendor_data": { "type": "string", "description": "Tu identificador interno de usuario o empresa.", "example": "user-12345" }, "full_name": { "type": "string", "description": "Nombre completo del sujeto.", "example": "Maria Garcia" }, "first_name": { "type": "string", "description": "Nombre de la persona." }, "last_name": { "type": "string", "description": "Apellido de la persona." }, "date_of_birth": { "type": "string", "format": "date", "description": "Fecha de nacimiento (YYYY-MM-DD)." }, "address": { "type": "object", "description": "Objeto de dirección.", "properties": { "country": { "type": "string", "description": "Código de país (se recomienda ISO 3166-1 alfa-3). Se copia en el `country_code` de la parte." }, "town": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" }, "post_code": { "type": "string" } } }, "institution_details": { "type": "object", "description": "Datos de la institución (para sujetos institucionales).", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "address": { "type": "object" } } }, "device_context": { "type": "object", "description": "Contexto del dispositivo capturado en el momento de la transacción. browser_family y platform deben enviarse como claves explícitas de nivel superior: no se derivan de user_agent. La solicitud también acepta el alias en camelCase device.", "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. Alias en CamelCase: userAgent." }, "browser_family": { "type": "string", "description": "Familia del navegador (p. ej., Chrome, Firefox, Safari). Debe enviarse explícitamente: no se deriva de user_agent. Alias en CamelCase: browserFamily." }, "browser_version": { "type": "string", "description": "Cadena de la versión del navegador. Debe enviarse explícitamente. Alias en CamelCase: browserVersion." }, "platform": { "type": "string", "description": "Identificador de la plataforma (web, ios, android, macos, windows, linux). Debe enviarse de forma explícita: no se deduce de user_agent." }, "os_family": { "type": "string", "description": "Familia del sistema operativo (p. ej., iOS, Android, Windows). Alias en CamelCase: osFamily." }, "os_version": { "type": "string", "description": "Cadena de versión del sistema operativo. Alias en CamelCase: osVersion." }, "accept_language": { "type": "string", "description": "Valor del encabezado Accept-Language. Alias en CamelCase: acceptLang." }, "session_id": { "type": "string", "description": "Identificador de la sesión actual del usuario. Se almacena en los metadatos. Alias en camelCase: sessionId." }, "session_age_ms": { "type": "number", "description": "Antigüedad de la sesión del usuario en milisegundos en el momento de la transacción. Alias en CamelCase: sessionAgeMs." }, "network_context": { "type": "object", "description": "Contexto de red con dirección IP y geolocalización. Un bloque ipInfo de nivel superior también se integra en este objeto.", "properties": { "ip_address": { "type": "string", "description": "Dirección IP del cliente. Alias en CamelCase: ip." }, "ip_country_code": { "type": "string", "description": "País de la IP resuelto por geolocalización (ISO 3166-1 alfa-3). Alias en CamelCase: countryCode3." }, "latitude": { "type": "number", "description": "Latitud geográfica de la IP. Alias en CamelCase: lat." }, "longitude": { "type": "number", "description": "Longitud geográfica de la IP. Alias en CamelCase: lon." } } } } }, "payment_method": { "type": "object", "description": "Método de pago que usa el sujeto.", "properties": { "method_type": { "type": "string", "description": "Tipo de método de pago: `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`." }, "account_id": { "type": "string", "description": "Identificador de la cuenta (p. ej., IBAN, dirección de wallet). Para el análisis cripto, debe contener la dirección de wallet de este participante. El análisis de hash de transacción entrante requiere la dirección de depósito del servicio o del cliente en el sujeto. El análisis saliente usa la wallet de destino de la contraparte. En una transferencia cripto en bitcoin o Lightning puede ser una solicitud de pago Lightning (factura BOLT11, oferta BOLT12, LNURL) o una Lightning Address: Didit guarda como cuenta el beneficiario que indica (\"\" cuando no indica ninguno) y lo que dice la solicitud en `chain_details.lightning` de la transferencia de Travel Rule. Como máximo 255 caracteres una vez guardado. En una transferencia cripto en bitcoin o Lightning puede ser una solicitud de pago Lightning (factura BOLT11, oferta BOLT12, LNURL) o una Lightning Address: Didit guarda como cuenta el beneficiario que indica (\"\" cuando no indica ninguno) y lo que dice la solicitud en `chain_details.lightning` de la transferencia de Travel Rule. Como máximo 255 caracteres una vez guardado." }, "memo": { "type": "string", "maxLength": 256, "description": "La etiqueta de destino o memo que forma parte de la wallet en una red con memo (XRP, XLM, EOS, ATOM, HBAR). En una misma dirección compartida de exchange, cada memo es un método de pago independiente. 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: indicar uno en ellas produce un `400`. Alias: `destinationTag` o `destination_tag`." }, "issuing_country": { "type": "string", "description": "Código de país ISO 3166-1 alpha-3 del emisor." } } } } }, "counterparty": { "type": "object", "description": "La contraparte de la transacción (opcional).", "properties": { "entity_type": { "type": "string", "description": "Tipo de entidad: `individual` o `company`." }, "vendor_data": { "type": "string", "description": "Tu identificador interno de la contraparte." }, "full_name": { "type": "string", "description": "Nombre completo de la contraparte." }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "address": { "type": "object", "description": "Objeto de dirección con `country` (ISO 3166-1 alfa-3)." }, "institution_details": { "type": "object" }, "device_context": { "type": "object", "description": "Contexto del dispositivo de la contraparte. browser_family y platform deben enviarse como claves explícitas de nivel superior, ya que no se derivan de user_agent.", "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. Alias en CamelCase: userAgent." }, "browser_family": { "type": "string", "description": "Familia del navegador (p. ej., Chrome, Firefox, Safari). Debe enviarse explícitamente: no se deriva de user_agent. Alias en CamelCase: browserFamily." }, "browser_version": { "type": "string", "description": "Cadena de la versión del navegador. Debe enviarse explícitamente. Alias en CamelCase: browserVersion." }, "platform": { "type": "string", "description": "Identificador de la plataforma (web, ios, android, macos, windows, linux). Debe enviarse de forma explícita: no se deduce de user_agent." }, "os_family": { "type": "string", "description": "Familia del sistema operativo (p. ej., iOS, Android, Windows). Alias en CamelCase: osFamily." }, "os_version": { "type": "string", "description": "Cadena de versión del sistema operativo. Alias en CamelCase: osVersion." }, "accept_language": { "type": "string", "description": "Valor del encabezado Accept-Language. Alias en CamelCase: acceptLang." }, "session_id": { "type": "string", "description": "Identificador de la sesión de la contraparte. Se almacena en los metadatos. Alias en camelCase: sessionId." }, "session_age_ms": { "type": "number", "description": "Antigüedad de la sesión del usuario en milisegundos en el momento de la transacción. Alias en CamelCase: sessionAgeMs." }, "network_context": { "type": "object", "description": "Contexto de red con dirección IP y geolocalización. Un bloque ipInfo de nivel superior también se integra en este objeto.", "properties": { "ip_address": { "type": "string", "description": "Dirección IP del cliente. Alias en CamelCase: ip." }, "ip_country_code": { "type": "string", "description": "País de la IP resuelto por geolocalización (ISO 3166-1 alfa-3). Alias en CamelCase: countryCode3." }, "latitude": { "type": "number", "description": "Latitud geográfica de la IP. Alias en CamelCase: lat." }, "longitude": { "type": "number", "description": "Longitud geográfica de la IP. Alias en CamelCase: lon." } } } } }, "payment_method": { "type": "object", "description": "Método de pago que usa la contraparte. En las transacciones travelRule, `method_type: \"unhosted_wallet\"` declara la wallet de la contraparte como wallet sin custodia: la transferencia omite el enrutamiento al VASP de la contraparte, se crea directamente en `UNCONFIRMED_OWNERSHIP` y (cuando `auto_wallet_verification` está activado) se genera automáticamente una sesión del widget de propiedad de la wallet, que se devuelve en el bloque `action_required` de la transacción.", "properties": { "method_type": { "type": "string", "description": "Tipo de método de pago: `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`. Usa `unhosted_wallet` para declarar una wallet sin custodia para la Travel Rule." }, "account_id": { "type": "string", "description": "Identificador de la cuenta (p. ej., IBAN o dirección de wallet). En una transferencia cripto en bitcoin o Lightning puede ser una solicitud de pago Lightning (factura BOLT11, oferta BOLT12, LNURL) o una Lightning Address: Didit guarda como cuenta el beneficiario que indica (\"\" cuando no indica ninguno) y lo que dice la solicitud en `chain_details.lightning` de la transferencia de Travel Rule. Como máximo 255 caracteres una vez guardado. En una transferencia cripto en bitcoin o Lightning puede ser una solicitud de pago Lightning (factura BOLT11, oferta BOLT12, LNURL) o una Lightning Address: Didit guarda como cuenta el beneficiario que indica (\"\" cuando no indica ninguno) y lo que dice la solicitud en `chain_details.lightning` de la transferencia de Travel Rule. Como máximo 255 caracteres una vez guardado." }, "memo": { "type": "string", "maxLength": 256, "description": "La etiqueta de destino o memo que forma parte de la wallet en una red con memo (XRP, XLM, EOS, ATOM, HBAR). En una misma dirección compartida de exchange, cada memo es un método de pago independiente. 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: indicar uno en ellas produce un `400`. Alias: `destinationTag` o `destination_tag`." }, "issuing_country": { "type": "string" } } } } }, "custom_properties": { "type": "object", "description": "Pares clave-valor arbitrarios adjuntos a la transacción. Cada clave se puede referenciar en las condiciones de las reglas con la ruta de campo `custom_values.`.", "additionalProperties": true, "example": { "merchant_id": "test", "bank_name": "test_2" } }, "travel_rule_details": { "type": "object", "description": "Datos de Travel Rule. Cuando Travel Rule está habilitada y transaction_category es travel_rule, Didit gestiona el intercambio por sí mismo: ignora status, protocol, required y obligations_count, y usa originator_data, beneficiary_data y metadata. En caso contrario, Didit almacena estos valores como un registro pasivo de Travel Rule. Mientras Travel Rule esté activada, una transferencia saliente igual o superior a tu umbral debe incluir lo que exige su régimen (EU TFR o la Recomendación 16 del FATF), que se comprueba en las partes que envías: si falta un campo, la respuesta es 400 en `travel_rule_details.originator_data` o `travel_rule_details.beneficiary_data`, por ejemplo \"EU TFR requires the originator name.\"", "required": [ "status" ], "properties": { "status": { "type": "string", "description": "Obligatorio siempre que envíes travel_rule_details. Uno de los estados de transferencia de la Travel Rule (por ejemplo, AWAITING_COUNTERPARTY, COMPLETED, NOT_APPLICABLE); también se aceptan y se asignan las grafías en minúsculas y en camelCase, y los valores heredados UNKNOWN, COMPLIANT, PENDING_ACTION, PENDING_COUNTERPARTY, FAILED y EXEMPT. Cualquier otro valor devuelve 400." }, "protocol": { "type": "string" }, "required": { "type": "boolean" }, "obligations_count": { "type": "integer" }, "originator_data": { "type": "object", "description": "Parte ordenante, como campos planos o como una persona IVMS 101. Si se trata de tu usuario con una verificación KYC aprobada, Didit reemplaza los campos que contiene la verificación por los valores verificados (consulta `metadata.originator_provenance`). Debe ser un objeto: cualquier otro valor devuelve `400`. En una red con memo, una clave `memo` indica el memo o la etiqueta de la wallet del ordenante." }, "beneficiary_data": { "type": "object", "description": "Parte beneficiaria, como campos planos o como una persona IVMS 101. Debe ser un objeto: cualquier otro valor devuelve un `400`. Para enrutar la transferencia, Didit lee `wallet_address` (si está vacío, se rellena con `counterparty.payment_method.account_id`), `chain` (se rellena con `transaction_details.crypto_params.crypto_chain` o con `currency` cuando esta nombra una cadena compatible), `name` (que recurre a `counterparty.full_name`), `travel_address`, `counterparty_vasp_name`, `counterparty_vasp_lei` y `counterparty_vasp_email`. En una red con memo, `memo` indica el memo o la etiqueta de la wallet del beneficiario. `wallet_address` y `memo` prevalecen sobre el método de pago de la contraparte." }, "metadata": { "type": "object" }, "utxo": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleUtxo" } ], "description": "Opcional, solo para cadenas UTXO (BTC, LTC, BCH, DOGE). Las entradas y salidas de la transacción, a partir de las cuales Didit deduce la wallet del ordenante y la salida del beneficiario cuando no las declaras." }, "originator": { "type": "object", "description": "Un bloque de ordenante IVMS 101: `originatorPersons` (una `naturalPerson` o `legalPerson`; una persona jurídica hace que la parte sea una empresa) y `accountNumber` (direcciones de wallet). Se usa para `originator_data` cuando ese objeto está vacío. Un bloque mal formado responde 400 con la clave de su ruta, por ejemplo `originator.originatorPersons`." }, "beneficiary": { "type": "object", "description": "Un bloque de beneficiario IVMS 101: `beneficiaryPersons` (una `naturalPerson` o `legalPerson`; una persona jurídica hace que la parte sea una empresa) y `accountNumber` (direcciones de wallet). Se usa para `beneficiary_data` cuando ese objeto está vacío. Un bloque mal formado responde 400 con la clave de su ruta, por ejemplo `beneficiary.beneficiaryPersons`." }, "ivms101": { "type": "object", "description": "Los bloques `originator` y `beneficiary` agrupados en un único objeto IVMS 101 (también se acepta `IVMS101`). Los bloques de nivel superior prevalecen sobre los del contenedor." } } }, "network_snapshot": { "type": "object", "description": "Instantánea precalculada del grafo de red.", "properties": { "nodes": { "type": "array", "items": { "type": "object" } }, "edges": { "type": "array", "items": { "type": "object" } }, "metrics": { "type": "object" } } }, "include_crypto_screening": { "type": "boolean", "nullable": true, "description": "Sobrescritura por transacción del análisis de blockchain de criptoactivos. Cuando es `true`, el análisis de criptoactivos se realiza independientemente del valor predeterminado de la aplicación. Cuando es `false`, el análisis de criptoactivos se omite aunque esté habilitado en la configuración de la aplicación. Cuando se omite o es `null`, se usa el valor predeterminado a nivel de aplicación configurado en la Console. El análisis de criptoactivos requiere `transaction_details.direction`, `currency_kind: \"crypto\"`, una cadena/moneda y la dirección de wallet que corresponde según la dirección de la transacción: el análisis entrante previo a la transferencia usa `counterparty.payment_method.account_id`, el análisis entrante por hash de transacción usa `subject.payment_method.account_id` y el análisis saliente usa `counterparty.payment_method.account_id`. Cuando `transaction_details.payment_reference_id` contiene un hash de transacción de blockchain, Didit realiza el análisis de la transacción y devuelve el enriquecimiento con el resumen de la transacción cuando está disponible." } }, "required": [ "transaction_id", "transaction_category", "transaction_details", "subject" ] }, "examples": { "Minimal fiat withdrawal": { "summary": "Payload mínimo aceptable para una transferencia fiat saliente", "value": { "transaction_id": "your-txn-2026-05-17-001", "transaction_category": "finance", "transaction_details": { "direction": "outbound", "amount": 1500, "currency": "EUR", "action_type": "withdrawal" }, "subject": { "entity_type": "individual", "vendor_data": "user-12345", "full_name": "Maria Garcia" } } }, "Crypto outbound with screening": { "summary": "Retiro saliente de criptoactivos a una wallet sin custodia, con análisis opcional (opt-in)", "value": { "transaction_id": "your-txn-2026-05-17-002", "transaction_category": "finance", "include_crypto_screening": true, "transaction_details": { "direction": "outbound", "amount": 0.5, "currency": "BTC", "currency_kind": "crypto", "amount_in_default_currency": 32500, "default_currency": "USD", "action_type": "withdrawal" }, "subject": { "entity_type": "individual", "vendor_data": "user-12345", "full_name": "Maria Garcia", "payment_method": { "method_type": "crypto_wallet", "account_id": "bc1qexampleexchangewalletaddressxyz", "issuing_country": "ESP" } }, "counterparty": { "entity_type": "individual", "payment_method": { "method_type": "unhosted_wallet", "account_id": "bc1qexampleexternalwalletaddressabc" } } } }, "Travel Rule transfer": { "summary": "Transferencia saliente de criptoactivos con datos del ordenante y del beneficiario según la Travel Rule", "value": { "transaction_id": "your-txn-2026-05-17-003", "transaction_category": "travel_rule", "transaction_details": { "direction": "outbound", "amount": 25000, "currency": "USDT", "currency_kind": "crypto", "action_type": "transfer" }, "subject": { "entity_type": "individual", "vendor_data": "user-12345", "full_name": "Maria Garcia", "date_of_birth": "1992-03-14", "address": { "country": "ESP", "town": "Madrid", "street": "Calle Mayor 1", "post_code": "28013" } }, "counterparty": { "entity_type": "individual", "full_name": "John Beneficiary", "institution_details": { "name": "Beneficiary VASP, Inc.", "code": "BVASP-US" } }, "travel_rule_details": { "status": "AWAITING_COUNTERPARTY", "protocol": "IVMS101", "required": true, "originator_data": { "name": "Maria Garcia" }, "beneficiary_data": { "name": "John Beneficiary" } } } } } } } }, "responses": { "201": { "description": "Transacción enviada y monitorizada. El cuerpo es el detalle completo de la transacción (con la misma estructura que `GET /v3/transactions/{transaction_id}/`) y refleja los resultados de las reglas ya aplicadas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetail" }, "examples": { "Approved with no rule hits": { "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": "APPROVED", "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": 0, "severity": null, "decision_reason_code": null, "decision_reason_label": null, "vendor_data": "user-12345", "metadata": { "subject": { "entity_type": "individual", "vendor_data": "user-12345", "full_name": "Maria Garcia", "address": {}, "institution_details": {}, "device_context": {} }, "counterparty": {} }, "props": {}, "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": [ { "uuid": "d4e5f6a7-8901-4bcd-9ef0-123456789abc", "activity_type": "TRANSACTION_CREATED", "source": "TRANSACTION", "status": "APPROVED", "title": "withdrawal", "description": "Transaction recorded.", "metadata": {}, "occurred_at": "2026-05-17T08:42:11Z" } ], "alerts": [], "rule_runs": [], "provider_results": [], "travel_rule": null, "network_snapshot": null, "remediation": null, "action_required": null, "cost_breakdown": null } }, "Flagged for review": { "value": { "uuid": "abcdef12-3456-4890-abcd-ef1234567891", "environment": "live", "transaction_number": 4124, "txn_id": "your-txn-2026-05-17-002", "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": "0.5", "currency": "BTC", "currency_type": "crypto", "amount_in_default_currency": "32500", "default_currency_code": "USD", "preferred_currency_amount": "32500", "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": [ { "uuid": "e5f6a7b8-9012-4cde-af01-23456789abcd", "rule": "f6a7b8c9-0123-4def-b012-3456789abcde", "rule_title": "High-risk wallet screening", "rule_description": null, "rule_category": "crypto", "matched": true, "is_test": false, "mode": "ACTIVE", "severity": "HIGH", "score_delta": 78, "status_target": "IN_REVIEW", "action_summary": "score +78; change_status:IN_REVIEW", "metadata": {}, "created_at": "2026-05-17T08:42:12Z" } ], "provider_results": [], "travel_rule": null, "network_snapshot": null, "remediation": null, "action_required": null, "cost_breakdown": null } } } } } }, "400": { "description": "La validación ha fallado (faltan campos obligatorios, `transaction_id` duplicado, valor de enumeración desconocido, moneda no válida, etc.).", "content": { "application/json": { "examples": { "Missing required field": { "value": { "transaction_details": { "amount": [ "This field is required." ] } } }, "Duplicate transaction_id": { "value": { "transaction_id": [ "A transaction with this transaction_id already exists." ] } }, "Invalid category": { "value": { "non_field_errors": [ "Unsupported transaction category." ] } }, "Missing subject identity": { "value": { "subject": [ "subject.vendor_data and subject.full_name are required." ] } }, "Blocklisted participant": { "value": { "vendor_data": [ "The individual 'user-12345' is in the blocklist and cannot participate in transactions." ] } } } } } }, "403": { "description": "Falta la clave de API, no es válida o fue revocada, o la clave no puede enviar transacciones para 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." } } } } } }, "409": { "description": "Otra solicitud con el mismo `transaction_id` creó la transacción mientras esta se procesaba, por lo que solo una de dos solicitudes simultáneas se completa con éxito. Consulta la transacción existente en lugar de volver a enviarla.", "content": { "application/json": { "examples": { "Concurrent duplicate": { "value": { "detail": "A transaction with this transaction_id already exists." } } } } } }, "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-didit-sdk": { "resource": "transactions", "method": "create", "auth": "api_key", "server": true } } }, "/v3/transactions/{transaction_id}/": { "get": { "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", "x-didit-sdk": { "resource": "transactions", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "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" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/abcdef12-3456-7890-abcd-ef1234567890/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.retrieve(\n \"abcdef12-3456-7890-abcd-ef1234567890\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.retrieve(\"abcdef12-3456-7890-abcd-ef1234567890\");\nconsole.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;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().retrieve(\"abcdef12-3456-7890-abcd-ef1234567890\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->retrieve('abcdef12-3456-7890-abcd-ef1234567890');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.retrieve(\"abcdef12-3456-7890-abcd-ef1234567890\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.RetrieveAsync(\"abcdef12-3456-7890-abcd-ef1234567890\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "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": [] } ] } }, "/v3/transactions/sdk-token/": { "post": { "summary": "Emitir un token de transacciones para el SDK", "description": "Emite un token de alcance limitado y corta duración que tu aplicación pasa a los SDK de Didit para que puedan enviar transacciones directamente desde el dispositivo del usuario final mediante `POST /v1/transactions/`. El token está vinculado a un único `vendor_data` (tu ID de usuario): en cada transacción enviada con él, el servidor impone la identidad del sujeto a partir de esa vinculación, de modo que un cliente manipulado no puede enviar transacciones en nombre de otro usuario. Emite los tokens desde tu backend; nunca incluyas la propia clave de API en una aplicación. También se aceptan alias en camelCase (`vendorData`, `ttlSeconds`, `maxUses`).", "operationId": "createTransactionSdkToken", "x-didit-sdk": { "resource": "transactions", "method": "create_sdk_token", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "vendor_data": { "type": "string", "description": "Tu identificador interno del usuario final al que se limita este token. Se aplica como identidad del sujeto de cada transacción enviada con el token.", "example": "user-042" }, "ttl_seconds": { "type": "integer", "default": 900, "maximum": 86400, "description": "Duración del token en segundos. Valor predeterminado: 900 (15 minutos); máximo: 86400 (24 horas)." }, "max_uses": { "type": "integer", "nullable": true, "description": "Número máximo de envíos correctos permitidos con este token. Omítelo o usa null para permitir usos ilimitados dentro del TTL." } }, "required": [ "vendor_data" ] }, "example": { "vendor_data": "user-042", "ttl_seconds": 900, "max_uses": 3 } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/transactions/sdk-token/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"vendor_data\": \"user-042\", \"ttl_seconds\": 900, \"max_uses\": 3}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.create_sdk_token(\n vendor_data=\"user-042\",\n ttl_seconds=900,\n max_uses=3,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.createSdkToken({\n vendor_data: \"user-042\",\n ttl_seconds: 900,\n max_uses: 3,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.CreateSDKToken(ctx, didit.TransactionsCreateSDKTokenParams{\n\tVendorData: \"user-042\",\n\tTTLSeconds: didit.Int(900),\n\tMaxUses: didit.Int(3),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TransactionsCreateSdkTokenParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().createSdkToken(TransactionsCreateSdkTokenParams.builder()\n .vendorData(\"user-042\")\n .ttlSeconds(900L)\n .maxUses(3L)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->createSdkToken([\n 'vendor_data' => 'user-042',\n 'ttl_seconds' => 900,\n 'max_uses' => 3,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.create_sdk_token(\n vendor_data: \"user-042\",\n ttl_seconds: 900,\n max_uses: 3\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.CreateSdkTokenAsync(new TransactionsCreateSdkTokenParams\n{\n VendorData = \"user-042\",\n TtlSeconds = 900,\n MaxUses = 3,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "El token emitido. Entrega `sdk_token` a tu aplicación; autentica los endpoints `/v1/transactions/` orientados al dispositivo mediante el encabezado `X-Transaction-Token` hasta `expires_at`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sdk_token": { "type": "string", "description": "El token de transacción con alcance limitado que debes pasar al SDK." }, "expires_at": { "type": "string", "format": "date-time", "description": "Cuándo deja de aceptarse el token." } } }, "example": { "sdk_token": "q7Zt...urlsafe", "expires_at": "2026-07-07T12:15:00Z" } } } }, "400": { "description": "Error de validación: falta `vendor_data` o `ttl_seconds` está fuera del rango permitido.", "content": { "application/json": { "examples": { "Missing vendor_data": { "value": { "vendor_data": [ "This field is required." ] } } } } } }, "403": { "description": "Falta la clave de API, no es válida o fue revocada.", "content": { "application/json": { "examples": { "Invalid API Key": { "value": { "detail": "Invalid API Key." } } } } } } } } }, "/v1/transactions/": { "post": { "summary": "Enviar una transacción desde un SDK", "description": "Endpoint orientado al dispositivo al que llaman los SDK de Didit para enviar una transacción directamente desde el dispositivo del usuario final. La autenticación se realiza con un token con alcance limitado de `POST /v3/transactions/sdk-token/`, enviado en el encabezado `X-Transaction-Token` en lugar de una clave de API, y el endpoint tiene CORS habilitado para que los navegadores puedan llamarlo desde otro origen. El payload usa los alias camelCase que se muestran a continuación (los métodos `submitTransaction` del SDK lo construyen por ti). Tres garantías del lado del servidor: la aplicación siempre se toma del token; la identidad del sujeto (`externalUserId`) siempre se impone a partir del `vendor_data` del token, por lo que se ignoran los valores suplantados del payload; y la inteligencia del dispositivo (la huella digital del dispositivo del SDK más la IP y el user agent derivados por el servidor) se asocia automáticamente al sujeto.", "operationId": "submitTransactionFromSdk", "x-didit-sdk": { "resource": "transactions", "method": "submit_from_device", "auth": "device_token", "server": false }, "tags": [ "Transactions" ], "security": [ { "TransactionTokenAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "txnId": { "type": "string", "description": "Tu identificador único de esta transacción (se asigna a `transaction_id`, máximo 128 caracteres).", "example": "wd-2026-07-07-0042" }, "txnDate": { "type": "string", "format": "date-time", "description": "Cuándo se produjo la transacción (corresponde a `transaction_at`). Si se omite, se usa el momento actual." }, "zoneId": { "type": "string", "description": "Identificador de zona horaria IANA (se asigna a `time_zone`), p. ej. `Europe/Madrid`." }, "type": { "type": "string", "description": "Categoría de la transacción (se corresponde con `transaction_category`), p. ej., `finance`, `kyc`, `travelRule`, `userPlatformEvent`, `gamblingBet`.", "example": "travelRule" }, "info": { "type": "object", "description": "Datos financieros principales de la transacción (corresponde a `transaction_details`).", "required": [ "direction", "amount", "currency" ], "properties": { "direction": { "type": "string", "description": "Sentido respecto al sujeto. No distingue entre mayúsculas y minúsculas; se aceptan `in`/`out` como alias. Se devuelve en mayúsculas (`INBOUND`/`OUTBOUND`).", "example": "out" }, "amount": { "type": "number", "description": "Importe de la transacción (hasta 18 decimales). También se acepta una cadena decimal, y es la única forma de conservar más de unos 15 dígitos significativos: un número JSON se interpreta primero como un float binario, por lo que `0.123456789012345678` se almacena como `0.12345678901234568`.", "example": 0.25 }, "currency": { "type": "string", "description": "Código de moneda. 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 usar 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 (por ejemplo, la unidad de cuenta ISO `XSU` o un símbolo cripto al que Didit no asigna precio), la conversión automática falla y `preferred_currency_amount` se devuelve como null, salvo que la solicitud haya incluido un `amountInDefaultCurrency` ya convertido.", "example": "ETH" }, "currencyType": { "type": "string", "description": "Si la moneda es `fiat` o `crypto` (se corresponde con `currency_kind`)." }, "amountInDefaultCurrency": { "type": "number", "nullable": true, "description": "Importe ya convertido a la moneda predeterminada (se asigna a `amount_in_default_currency`). Si se omite, se intenta una conversión de divisas automática." }, "defaultCurrencyCode": { "type": "string", "description": "El código de moneda predeterminado para el importe convertido (corresponde a `default_currency`). Cualquier código ISO 4217 actualmente en circulación." }, "paymentDetails": { "type": "string", "nullable": true, "description": "Referencia o concepto de pago en texto libre (se asigna a `payment_details`)." }, "paymentTxnId": { "type": "string", "nullable": true, "description": "Referencia de pago externa (se corresponde con `payment_reference_id`); el hash de la transacción on-chain en las transacciones cripto." }, "type": { "type": "string", "nullable": true, "description": "Subtipo de la transacción (se corresponde con `action_type`), p. ej., `deposit`, `withdrawal`, `transfer`." }, "cryptoParams": { "type": "object", "description": "Parámetros específicos de cripto, p. ej. `{\"crypto_chain\": \"ETH\"}`." } } }, "subject": { "type": "object", "description": "El sujeto (solicitante) de la transacción. Aquí se ignora `externalUserId`: la identidad del sujeto siempre se impone a partir del `vendor_data` del token.", "required": [ "fullName" ], "properties": { "type": { "type": "string", "description": "Tipo de entidad (se asigna a `entity_type`): `individual` (valor predeterminado) o `company`." }, "externalUserId": { "type": "string", "description": "Se ignora en el sujeto: el servidor lo aplica a partir del `vendor_data` del token." }, "fullName": { "type": "string", "example": "Jane Doe" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "dob": { "type": "string", "format": "date", "description": "Fecha de nacimiento (YYYY-MM-DD; se asigna a `date_of_birth`)." }, "address": { "type": "object", "description": "Objeto de dirección con `country` (ISO 3166-1 alfa-3), `town`, `state`, `street`, `post_code`." }, "institutionInfo": { "type": "object", "description": "Datos de la institución para participantes institucionales (se corresponde con `institution_details`)." }, "device": { "type": "object", "description": "Contexto de dispositivo explícito opcional. Se combina con la información del dispositivo capturada automáticamente; en caso de conflicto, prevalecen los campos derivados por el servidor." }, "paymentMethod": { "type": "object", "description": "Método de pago que usa el sujeto (se asigna a `payment_method`).", "properties": { "type": { "type": "string", "description": "Tipo de método de pago (se asigna a `method_type`), p. ej. `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`." }, "accountId": { "type": "string", "description": "Identificador de la cuenta (se corresponde con `account_id`): IBAN, huella de tarjeta o dirección de wallet." }, "issuingCountry": { "type": "string", "description": "Código de país ISO 3166-1 alpha-3 del emisor (se corresponde con `issuing_country`)." } } } } }, "counterparty": { "type": "object", "description": "La contraparte de la transacción (opcional). Tiene la misma estructura que `subject`; aquí `externalUserId` tiene sentido.", "properties": { "type": { "type": "string", "description": "Tipo de entidad (se asigna a `entity_type`): `individual` o `company`." }, "externalUserId": { "type": "string", "description": "Tu identificador interno de la contraparte (corresponde a `vendor_data`)." }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "dob": { "type": "string", "format": "date" }, "address": { "type": "object" }, "institutionInfo": { "type": "object" }, "device": { "type": "object" }, "paymentMethod": { "type": "object", "description": "Método de pago que usa la contraparte (se asigna a `payment_method`). En las transacciones travelRule, `type: \"unhosted_wallet\"` declara la wallet de la contraparte como wallet sin custodia: la transferencia omite el enrutamiento al VASP de la contraparte, se crea directamente en `UNCONFIRMED_OWNERSHIP` y (cuando `auto_wallet_verification` está activado) se genera automáticamente una sesión del widget de propiedad de la wallet, que se devuelve en `action_required` para que el SDK pueda abrirla.", "properties": { "type": { "type": "string", "description": "Tipo de método de pago (se asigna a `method_type`), p. ej. `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`. Usa `unhosted_wallet` para declarar una wallet sin custodia a efectos de la Travel Rule." }, "accountId": { "type": "string", "description": "Identificador de la cuenta (se corresponde con `account_id`): IBAN, huella de tarjeta o dirección de wallet." }, "issuingCountry": { "type": "string" } } } } }, "props": { "type": "object", "additionalProperties": true, "description": "Pares clave-valor personalizados (se asignan a `custom_properties`). Cada clave puede referenciarse en las condiciones de las reglas como `custom_values.`." }, "travelRule": { "type": "object", "description": "Detalles de Travel Rule (se corresponde con `travel_rule_details`). Cuando Travel Rule está habilitada para la aplicación, Didit ignora cualquier `status` que envíes y gestiona el intercambio por sí mismo.", "required": [ "status" ], "properties": { "status": { "type": "string" }, "protocol": { "type": "string" }, "required": { "type": "boolean" }, "obligationsCount": { "type": "integer" }, "originatorData": { "type": "object" }, "beneficiaryData": { "type": "object" }, "metadata": { "type": "object" } } }, "includeCryptoScreening": { "type": "boolean", "nullable": true, "description": "Sobrescritura por transacción del análisis de blockchain de criptoactivos (corresponde a `include_crypto_screening`)." }, "fingerprint_v2": { "type": "object", "description": "El payload de huella digital del dispositivo `didit-fp-v2`. Los SDK lo inyectan automáticamente; solo es relevante cuando llamas directamente a la API wire." } }, "required": [ "txnId", "type", "info", "subject" ] }, "example": { "txnId": "wd-2026-07-07-0042", "type": "travelRule", "info": { "direction": "out", "amount": "0.25", "currency": "ETH", "currencyType": "crypto", "cryptoParams": { "crypto_chain": "ETH" } }, "subject": { "fullName": "Jane Doe" }, "counterparty": { "fullName": "Ana Diaz", "paymentMethod": { "type": "unhosted_wallet", "accountId": "0xBeneficiaryWallet01" } }, "travelRule": { "status": "AWAITING_COUNTERPARTY", "beneficiaryData": { "wallet_address": "0xBeneficiaryWallet01", "name": "Ana Diaz" } }, "includeCryptoScreening": true } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v1/transactions/ \\\n -H 'X-Transaction-Token: SDK_TOKEN' -H 'Content-Type: application/json' \\\n -d '{\"txnId\": \"wd-2026-07-07-0042\", \"type\": \"travelRule\", \"info\": {\"direction\": \"out\", \"amount\": \"0.25\", \"currency\": \"ETH\", \"currencyType\": \"crypto\"}, \"subject\": {\"fullName\": \"Jane Doe\"}, \"counterparty\": {\"fullName\": \"Ana Diaz\", \"paymentMethod\": {\"type\": \"unhosted_wallet\", \"accountId\": \"0xBeneficiaryWallet01\"}}, \"travelRule\": {\"status\": \"AWAITING_COUNTERPARTY\", \"beneficiaryData\": {\"wallet_address\": \"0xBeneficiaryWallet01\", \"name\": \"Ana Diaz\"}}, \"includeCryptoScreening\": true}'" }, { "lang": "javascript", "label": "Web SDK", "source": "import { DiditSdk } from '@didit-protocol/sdk-web';\n\nconst result = await DiditSdk.shared.submitTransaction({\n transactionToken: sdkToken,\n transaction: {\n txnId: 'wd-2026-07-07-0042',\n category: 'travelRule',\n details: { direction: 'out', amount: '0.25', currency: 'ETH', currencyType: 'crypto' },\n subject: { fullName: 'Jane Doe' },\n counterparty: { fullName: 'Ana Diaz', paymentMethod: { type: 'unhosted_wallet', accountId: '0xBeneficiaryWallet01' } },\n travelRule: { status: 'AWAITING_COUNTERPARTY', beneficiaryData: { wallet_address: '0xBeneficiaryWallet01', name: 'Ana Diaz' } },\n includeCryptoScreening: true\n },\n onActionCompleted: (refreshed) => console.log(refreshed.status)\n});" } ], "responses": { "201": { "description": "Transacción enviada y monitorizada. Tiene la misma estructura de detalle que `GET /v3/transactions/{transaction_id}/`, incluido el bloque `action_required` cuando el usuario final debe completar una acción de seguimiento (los SDK la inician automáticamente de forma predeterminada).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetail" }, "examples": { "Wallet ownership required": { "value": { "uuid": "22222222-3333-4444-5555-666666666666", "txn_id": "wd-2026-07-07-0042", "transaction_type": "travelRule", "direction": "OUTBOUND", "status": "APPROVED", "amount": "0.25", "currency": "ETH", "travel_rule": { "uuid": "33333333-4444-5555-6666-777777777777", "status": "UNCONFIRMED_OWNERSHIP", "required": true }, "action_required": { "type": "wallet_ownership", "url": "https://verify.didit.me/wallet-ownership/3s9x...urlsafe", "widget_session_id": "77777777-8888-9999-aaaa-bbbbbbbbbbbb", "expires_at": "2026-07-07T13:00:00Z" } } } } } } }, "400": { "description": "La validación ha fallado (faltan campos obligatorios, `txnId` duplicado, categoría desconocida).", "content": { "application/json": { "examples": { "Missing fields": { "value": { "transaction_details": { "currency": [ "This field is required." ] } } }, "Duplicate txnId": { "value": { "transaction_id": [ "A transaction with this transaction_id already exists." ] } } } } } }, "401": { "description": "Se rechazó el token de transacción: falta, es desconocido, está revocado, superó su `max_uses` o expiró. Las respuestas de token expirado siempre contienen la palabra `expired` en el detalle, y así es como los SDK distinguen los errores `expired_token` de los `invalid_token`.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "Invalid transaction token." } }, "Expired token": { "value": { "detail": "Transaction token expired." } } } } } }, "409": { "description": "Otra solicitud con el mismo `txnId` creó la transacción mientras esta se procesaba, por lo que solo una de dos solicitudes simultáneas se completa con éxito. Consulta la transacción existente en lugar de volver a enviarla.", "content": { "application/json": { "examples": { "Concurrent duplicate": { "value": { "detail": "A transaction with this transaction_id already exists." } } } } } } } } }, "/v1/transactions/{transaction_id}/": { "get": { "summary": "Obtener una transacción desde un SDK", "description": "Endpoint de lectura orientado al dispositivo, autenticado con el mismo `X-Transaction-Token` que se usa para el envío. Los SDK lo consultan periódicamente cuando termina un flujo de acción iniciado automáticamente o se cierra su ventana, de modo que el estado final nunca depende de una sola notificación. Devuelve el mismo detalle de la transacción que la respuesta del envío, incluido el bloque `action_required` actual (`null` una vez resuelta la acción).", "operationId": "getTransactionFromSdk", "x-didit-sdk": { "resource": "transactions", "method": "retrieve_from_device", "auth": "device_token", "server": false }, "tags": [ "Transactions" ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "UUID estable de Didit de la transacción (el `uuid` de la respuesta del envío, **no** tu `txnId`).", "schema": { "type": "string", "format": "uuid" }, "example": "22222222-3333-4444-5555-666666666666" } ], "security": [ { "TransactionTokenAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v1/transactions/22222222-3333-4444-5555-666666666666/' \\\n -H 'X-Transaction-Token: SDK_TOKEN'" } ], "responses": { "200": { "description": "El detalle completo de la transacción, incluido `action_required` (`null` una vez resuelta la acción pendiente).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetail" } } } }, "401": { "description": "Se rechazó el token de transacción: falta, es desconocido, está revocado, superó su `max_uses` o expiró.", "content": { "application/json": { "examples": { "Expired token": { "value": { "detail": "Transaction token expired." } } } } } }, "404": { "description": "No existe ninguna transacción con este UUID para la aplicación del token, o el segmento de la ruta no es un UUID válido.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } } } } }, "/v3/businesses/": { "get": { "summary": "Listar empresas", "description": "Lista las [empresas](/entities/businesses) que Didit agrupa a partir de las sesiones KYB que comparten el mismo `vendor_data` (cadena de texto libre, NO un UUID), además de las empresas creadas mediante la API. Paginado y ordenado por `last_session_at` en orden descendente. Este endpoint no admite parámetros de filtrado ni de búsqueda: obtén las páginas y filtra en el cliente.", "operationId": "list_businesses", "x-didit-sdk": { "resource": "businesses", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Businesses" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "description": "Tamaño de página. Si se omite, el valor predeterminado es 50. No hay un máximo obligatorio, pero mantén las páginas pequeñas para reducir la latencia." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Desplazamiento, empezando en cero, del primer registro que se devuelve. Es preferible seguir la URL `next` de la página anterior en lugar de calcularlo a mano." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/businesses/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.businesses.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.businesses.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Businesses.ListAutoPaging(ctx, didit.BusinessesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.businesses().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "businesses->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.businesses.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Businesses.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Lista paginada de empresas con su estado, número de sesiones y desglose por función.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de filas coincidentes: exacto hasta 100, limitado a 100 a partir de ahí por rendimiento. No lo uses para detectar la última página; comprueba en su lugar que `next` sea `null`." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta de la página siguiente, o `null` en la última página." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta de la página anterior, o `null` en la primera página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessListItem" } } } }, "examples": { "Example": { "value": { "count": 1, "next": null, "previous": null, "results": [ { "didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890", "vendor_data": "company-123", "display_name": null, "legal_name": "Acme Trading Ltd", "registration_number": "12345678", "country_code": "GB", "effective_name": "Acme Trading Ltd", "status": "ACTIVE", "session_count": 2, "approved_count": 1, "declined_count": 0, "in_review_count": 1, "features": { "KYB": "Approved" }, "features_list": [ { "feature": "KYB", "status": "Approved" } ], "last_session_at": "2026-03-15T10:30:00Z", "last_activity_at": "2026-03-15T10:30:00Z", "first_session_at": "2026-01-10T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "name": "VIP", "color": "#2567FF" } ], "created_at": "2026-01-10T08:00:00Z" } ] } } } } } }, "403": { "description": "Falta la clave de API, no es válida o fue revocada, o la clave no puede listar las empresas 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." } } } } } }, "429": { "description": "Límite de solicitudes superado; espera y reintenta cuando haya pasado el intervalo indicado en `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/customization/": { "get": { "summary": "Obtener la personalización de marca", "description": "Devuelve la configuración de marca blanca de la aplicación determinada a partir de la clave de API: colores, fuentes, radios de borde, URL de logotipos y opciones de UI/UX. La configuración del dominio personalizado y del correo electrónico de marca blanca se gestiona solo en la Business Console y no forma parte de esta respuesta.", "operationId": "get_customization", "x-didit-sdk": { "resource": "customization", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Customization" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/customization/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.customization.retrieve()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.customization.retrieve();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Customization.Retrieve(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.customization().retrieve();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "customization->retrieve();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.customization.retrieve\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Customization.RetrieveAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Personalización de marca actual de la aplicación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandingCustomization" }, "examples": { "Default branding": { "value": { "color_primary": "#000000", "color_secondary": "#9DA1A1", "color_background": "#FFFFFF", "color_panel": "#2567FF", "color_panel_10": "#1A1A1A", "color_on_panel_1": "#9DA1A1", "color_on_panel_2": "#F4F4F6", "color_on_background": "#000000", "color_button_1": "#2567FF", "color_button_2": "#F8F8F8", "color_button_text_1": "#FFFFFF", "color_button_text_2": "#000000", "color_pill_text": "#111827", "border_radius_panel": 10, "border_radius_buttons": 12, "font_family": "Inter", "font_weight": "regular", "font_url": "https://fonts.googleapis.com/css2?family=Inter", "logo_square": null, "logo_rectangular": null, "logo_rectangular_dark": null, "favicon": null, "app_public_name": "Acme Verify", "privacy_policy_url": "https://acme.com/privacy", "skip_welcome_screen": false, "disable_login_with_didit": false, "hide_progress_bar": false, "callback_seconds": 3 } } } } } }, "403": { "description": "Clave de API ausente, con formato incorrecto, expirada o asociada a otra aplicación. Si falta la clave, se devuelve `403`; si es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Límite de solicitudes superado. Reintenta con retroceso exponencial." } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualizar la personalización de marca", "description": "Actualización parcial de la marca blanca de la aplicación. Envía `application/json` para cambiar colores, fuentes, radios y opciones de la interfaz, o `multipart/form-data` para subir imágenes del logotipo. Solo se cambian los campos que incluyas. El dominio personalizado y el correo electrónico de marca blanca no se pueden configurar con este endpoint; usa la Business Console para ello.", "operationId": "update_customization", "x-didit-sdk": { "resource": "customization", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Customization" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandingCustomizationUpdate" }, "examples": { "Update colors and font": { "summary": "Cambiar los colores y la fuente de la marca", "value": { "color_primary": "#123456", "color_button_1": "#2567FF", "font_family": "AR One Sans", "border_radius_buttons": 16 } }, "Update UI options": { "summary": "Cambiar el nombre público y las opciones del flujo", "value": { "app_public_name": "Acme Verify", "privacy_policy_url": "https://acme.com/privacy", "skip_welcome_screen": true, "hide_progress_bar": true, "callback_seconds": 5 } }, "Remove a logo": { "summary": "Eliminar el logotipo rectangular actual", "value": { "delete_logo_rectangular": true } }, "Remove the dark-mode logo": { "summary": "Eliminar el logotipo actual del modo oscuro", "value": { "delete_logo_rectangular_dark": true } } } }, "multipart/form-data": { "schema": { "type": "object", "description": "Usa multipart/form-data solo para subir imágenes de logotipo. Los campos de marca anteriores también pueden enviarse como campos de formulario en la misma solicitud.", "properties": { "image_square": { "type": "string", "format": "binary", "description": "Logotipo cuadrado (relación de aspecto 1:1). PNG, JPG o WebP, de al menos 512 px en el lado más largo y como máximo **1 MB**." }, "image_rectangular": { "type": "string", "format": "binary", "description": "Logotipo rectangular (relación de aspecto 2:1). PNG, JPG o WebP, de al menos 512 px en el lado largo y como máximo **1 MB**." }, "image_rectangular_dark": { "type": "string", "format": "binary", "description": "Logotipo rectangular para el modo oscuro (relación de aspecto 2:1), que se muestra sobre un fondo oscuro. PNG, JPG o WebP, de al menos 512 px en el lado largo y como máximo **1 MB**. Se devuelve como `logo_rectangular_dark`." }, "image_favicon": { "type": "string", "format": "binary", "description": "Imagen del favicon. Máximo **500 KB**." } } }, "example": { "image_rectangular": "(binary PNG logo, 2:1)", "image_rectangular_dark": "(binary PNG logo for dark mode, 2:1)", "image_favicon": "(binary favicon)" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/customization/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"color_primary\": \"#123456\", \"font_family\": \"AR One Sans\"}'" }, { "lang": "curl", "label": "curl (logo upload)", "source": "curl -X PATCH 'https://verification.didit.me/v3/customization/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'image_rectangular=@logo.png' \\\n -F 'image_rectangular_dark=@logo-dark.png' \\\n -F 'image_favicon=@favicon.ico'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.customization.update(\n image_rectangular=open(\"image_rectangular.jpg\", \"rb\"),\n image_rectangular_dark=open(\"image_rectangular_dark.jpg\", \"rb\"),\n image_favicon=open(\"image_favicon.jpg\", \"rb\"),\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.customization.update({\n image_rectangular: await fileFromPath(\"image_rectangular.jpg\"),\n image_rectangular_dark: await fileFromPath(\"image_rectangular_dark.jpg\"),\n image_favicon: await fileFromPath(\"image_favicon.jpg\"),\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Customization.Update(ctx, didit.CustomizationUpdateParams{\n\tImageRectangular: didit.Some(didit.FileFromPath(\"image_rectangular.jpg\")),\n\tImageRectangularDark: didit.Some(didit.FileFromPath(\"image_rectangular_dark.jpg\")),\n\tImageFavicon: didit.Some(didit.FileFromPath(\"image_favicon.jpg\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.CustomizationUpdateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.customization().update(CustomizationUpdateParams.builder()\n .imageRectangular(Path.of(\"image_rectangular.jpg\"))\n .imageRectangularDark(Path.of(\"image_rectangular_dark.jpg\"))\n .imageFavicon(Path.of(\"image_favicon.jpg\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "customization->update([\n 'image_rectangular' => File::fromPath('image_rectangular.jpg'),\n 'image_rectangular_dark' => File::fromPath('image_rectangular_dark.jpg'),\n 'image_favicon' => File::fromPath('image_favicon.jpg'),\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.customization.update(\n image_rectangular: Pathname(\"image_rectangular.jpg\"),\n image_rectangular_dark: Pathname(\"image_rectangular_dark.jpg\"),\n image_favicon: Pathname(\"image_favicon.jpg\")\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Customization.UpdateAsync(new CustomizationUpdateParams\n{\n ImageRectangular = FileUpload.FromPath(\"image_rectangular.jpg\"),\n ImageRectangularDark = FileUpload.FromPath(\"image_rectangular_dark.jpg\"),\n ImageFavicon = FileUpload.FromPath(\"image_favicon.jpg\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Personalización de marca actualizada. Se devuelve el objeto de personalización de marca COMPLETO (todos los campos, no solo los que cambiaste).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandingCustomization" }, "examples": { "Updated": { "value": { "color_primary": "#123456", "color_secondary": "#9DA1A1", "color_background": "#FFFFFF", "color_panel": "#2567FF", "color_panel_10": "#1A1A1A", "color_on_panel_1": "#9DA1A1", "color_on_panel_2": "#F4F4F6", "color_on_background": "#000000", "color_button_1": "#2567FF", "color_button_2": "#F8F8F8", "color_button_text_1": "#FFFFFF", "color_button_text_2": "#000000", "color_pill_text": "#111827", "border_radius_panel": 10, "border_radius_buttons": 16, "font_family": "AR One Sans", "font_weight": "400", "font_url": "https://fonts.googleapis.com/css2?family=AR+One+Sans", "logo_square": null, "logo_rectangular": "https://cdn.didit.me/white_label/logo_rectangular/...", "logo_rectangular_dark": null, "favicon": null, "app_public_name": "Acme Verify", "privacy_policy_url": "https://acme.com/privacy", "skip_welcome_screen": true, "disable_login_with_didit": false, "hide_progress_bar": false, "callback_seconds": 3 } } } } } }, "400": { "description": "Cuerpo no válido. Por ejemplo: un color hexadecimal mal formado, una familia o un grosor de fuente desconocidos, un campo exclusivo de Business Console (`domain`, `from_email`, `verify_domain`, `force_remove_domain`, `verify_email_domain`, `force_remove_email_domain` y sus campos complementarios de solo lectura), o un logotipo subido que no es una imagen PNG, JPG o WebP, mide menos de 512 px en su lado largo, pesa más de 1 MB o tiene una relación de aspecto incorrecta. También se devuelve al establecer `disable_login_with_didit` en `false` mientras hay un dominio personalizado configurado.", "content": { "application/json": { "examples": { "Bad color": { "value": { "color_primary": [ "Invalid color format. Use '#RRGGBB' or '#RRGGBBAA' format." ] } }, "Bad logo": { "value": { "image_rectangular": [ "Image aspect ratio must be 2:1. Got 1024x1024 image dimensions" ] } }, "Unsupported logo format": { "summary": "No es una imagen PNG, JPG ni WebP (por ejemplo, un SVG)", "value": { "image_rectangular_dark": [ "Upload a PNG, JPG or WebP image." ] } }, "Logo too small": { "summary": "Menos de 512 px en el lado largo", "value": { "image_rectangular": [ "Image must be at least 512 px on its long side. Got 400x200 image dimensions" ] } }, "Logo too large": { "summary": "Más de 1 MB", "value": { "image_square": [ "File size should not exceed 1 MB" ] } }, "Console-only field": { "value": { "domain": [ "Manage this field in the Business Console." ] } }, "Bad font weight": { "value": { "font_weight": [ "Font weight 950 is not available for Inter. Available weights are: 100, 200, 300, 400, 500, 600, 700, 800, 900" ] } } } } } }, "403": { "description": "Clave de API ausente, con formato incorrecto, expirada o asociada a otra aplicación. Si falta la clave, se devuelve `403`; si es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Límite de solicitudes superado. Reintenta con retroceso exponencial." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/businesses/{vendor_data}/": { "get": { "summary": "Obtener una empresa", "description": "Obtiene una [empresa](/entities/businesses) por `vendor_data` (coincidencia exacta). Añade `metadata` y `updated_at` respecto a la vista de lista. Las empresas eliminadas devuelven 404.", "operationId": "get_business", "x-didit-sdk": { "resource": "businesses", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Businesses" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tu identificador único de la empresa: una cadena de texto libre (NO un UUID), que se compara exactamente tal como se envía.", "example": "company-123" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/businesses/company-123/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.retrieve(\n \"company-123\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.retrieve(\"company-123\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.Retrieve(ctx, \"company-123\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().retrieve(\"company-123\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->retrieve('company-123');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.retrieve(\"company-123\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.RetrieveAsync(\"company-123\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Detalle completo de la empresa, incluidos los metadatos y los datos agregados de las sesiones.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessDetailItem" }, "examples": { "Active business": { "value": { "didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890", "vendor_data": "company-123", "display_name": null, "legal_name": "Acme Trading Ltd", "registration_number": "12345678", "country_code": "GB", "effective_name": "Acme Trading Ltd", "status": "ACTIVE", "session_count": 2, "approved_count": 1, "declined_count": 0, "in_review_count": 1, "features": { "KYB": "Approved" }, "features_list": [ { "feature": "KYB", "status": "Approved" } ], "last_session_at": "2026-03-15T10:30:00Z", "last_activity_at": "2026-03-15T10:30:00Z", "first_session_at": "2026-01-10T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "name": "VIP", "color": "#2567FF" } ], "created_at": "2026-01-10T08:00:00Z", "metadata": { "industry": "fintech" }, "updated_at": "2026-03-15T10:30:00Z" } } } } } }, "403": { "description": "Falta la clave de API, no es válida o fue revocada, o la clave no puede leer las empresas 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 empresa (no eliminada) con el `vendor_data` proporcionado para esta aplicación.", "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": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualizar empresa", "description": "Actualización parcial de una empresa: `display_name`, `legal_name`, `registration_number`, `country_code`, `status`, `metadata`. `metadata` se reemplaza por completo. Establecer `status` en `BLOCKED` añade el `vendor_data` a la lista de bloqueo del sistema; salir de `BLOCKED` elimina esa entrada. Cada edición queda registrada en la actividad de la empresa: un cambio de estado con el `reason` opcional, y un cambio en `display_name`, `legal_name`, `registration_number`, `country_code` o `metadata` como una actualización del perfil.", "operationId": "update_business", "x-didit-sdk": { "resource": "businesses", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Businesses" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tu identificador único de la empresa (cadena de texto libre, NO un UUID).", "example": "company-123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Cuerpo de actualización parcial. Indica solo los campos que quieras cambiar.", "properties": { "display_name": { "type": "string", "nullable": true, "description": "Nombre visible descriptivo que se muestra en la consola (tiene prioridad sobre `legal_name` en la interfaz)." }, "legal_name": { "type": "string", "nullable": true, "description": "Razón social oficial obtenida del registro o introducida manualmente." }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registro o de constitución de la empresa." }, "country_code": { "type": "string", "nullable": true, "description": "País de constitución (ISO 3166-1 alfa-2, p. ej., `GB`, `US`)." }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Estado del ciclo de vida de la empresa. Establecer `BLOCKED` añade automáticamente el `vendor_data` a la lista de bloqueo del sistema; cambiar de `BLOCKED` a otro estado elimina esa entrada de la lista de bloqueo." }, "metadata": { "type": "object", "nullable": true, "description": "Objeto JSON arbitrario que adjuntas a la empresa. **Reemplaza por completo** los metadatos existentes al actualizar: combínalos en el cliente si solo quieres añadir claves." }, "reason": { "type": "string", "nullable": true, "maxLength": 1000, "description": "Por qué cambió el estado. Se registra en la entrada de cambio de estado de **Activity** de la empresa en Business Console, solo cuando el estado cambia realmente. Los webhooks no lo incluyen." } } }, "examples": { "Update name": { "summary": "Actualizar nombre visible", "value": { "display_name": "Acme Corp" } }, "Flag for review": { "summary": "Cambiar estado", "value": { "status": "FLAGGED" } }, "Add metadata": { "summary": "Reemplazar el JSON de metadatos", "value": { "metadata": { "industry": "fintech", "risk_level": "low" } } }, "Fix registry data": { "summary": "Corregir campos extraídos", "value": { "legal_name": "Acme Trading International Ltd", "registration_number": "12345678", "country_code": "GB" } }, "Flag with reason": { "summary": "Marcar la empresa y registrar el motivo", "value": { "status": "FLAGGED", "reason": "Ownership structure under review" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/businesses/company-123/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"display_name\": \"Acme Corp\", \"status\": \"FLAGGED\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.update(\n \"company-123\",\n display_name=\"Acme Corp\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.update(\"company-123\", {\n display_name: \"Acme Corp\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.Update(ctx, \"company-123\", didit.BusinessesUpdateParams{\n\tDisplayName: didit.String(\"Acme Corp\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BusinessesUpdateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().update(\"company-123\", BusinessesUpdateParams.builder()\n .displayName(\"Acme Corp\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->update('company-123', [\n 'display_name' => 'Acme Corp',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.update(\n \"company-123\",\n display_name: \"Acme Corp\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.UpdateAsync(\"company-123\", new BusinessesUpdateParams\n{\n DisplayName = \"Acme Corp\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Empresa actualizada. Se devuelve el registro completo y actualizado de la empresa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessDetailItem" }, "examples": { "Updated": { "value": { "didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890", "vendor_data": "company-123", "display_name": "Acme Corp", "legal_name": "Acme Trading Ltd", "registration_number": "12345678", "country_code": "GB", "effective_name": "Acme Corp", "status": "FLAGGED", "session_count": 2, "approved_count": 1, "declined_count": 0, "in_review_count": 1, "features": { "KYB": "Approved" }, "features_list": [ { "feature": "KYB", "status": "Approved" } ], "last_session_at": "2026-03-15T10:30:00Z", "last_activity_at": "2026-03-15T10:30:00Z", "first_session_at": "2026-01-10T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "name": "VIP", "color": "#2567FF" } ], "created_at": "2026-01-10T08:00:00Z", "metadata": { "industry": "fintech", "risk_level": "low" }, "updated_at": "2026-03-15T10:30:00Z" } } } } } }, "400": { "description": "Cuerpo no válido: normalmente un `status` desconocido, un `metadata` mal formado o un `reason` de más de 1000 caracteres.", "content": { "application/json": { "examples": { "Bad status": { "value": { "status": [ "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" ] } }, "Bad metadata": { "value": { "metadata": [ "Metadata must be a JSON object." ] } }, "Reason too long": { "value": { "reason": [ "Ensure this field has no more than 1000 characters." ] } } } } } }, "403": { "description": "Falta la clave de API, no es válida o fue revocada, o la clave no puede actualizar las empresas 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 empresa (no eliminada) con el `vendor_data` proporcionado para esta aplicación.", "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": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/businesses/{vendor_data}/update-status/": { "patch": { "summary": "Actualizar el estado de la empresa", "description": "Cambia solo el `status` del ciclo de vida de una empresa: `ACTIVE`, `FLAGGED` o `BLOCKED` (no los estados de sesión). `BLOCKED` añade el `vendor_data` a la lista de bloqueo del sistema; salir de `BLOCKED` elimina esa entrada. Cada cambio se registra en la actividad de la empresa, con el `reason` opcional. Enviar el estado actual no cambia nada y no registra ningún `reason`. El webhook `business.status.updated` no incluye `reason`.", "operationId": "update_business_status", "x-didit-sdk": { "resource": "businesses", "method": "update_status", "auth": "api_key", "server": true }, "tags": [ "Businesses" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tu identificador único de la empresa (cadena de texto libre, NO un UUID).", "example": "company-123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityStatusUpdateRequest" }, { "type": "object", "properties": { "reason": { "type": "string", "nullable": true, "maxLength": 1000, "description": "Por qué cambió el estado. Se registra en la entrada de cambio de estado de **Activity** de la empresa en Business Console, solo cuando el estado cambia realmente. Los webhooks no lo incluyen." } } } ] }, "examples": { "Flag": { "summary": "Marcar la empresa para revisión", "value": { "status": "FLAGGED" } }, "Block": { "summary": "Bloquear la empresa (la añade a la lista de bloqueo del sistema)", "value": { "status": "BLOCKED" } }, "Reactivate": { "summary": "Reactivar la empresa", "value": { "status": "ACTIVE" } }, "Block with reason": { "summary": "Bloquear la empresa y registrar el motivo", "value": { "status": "BLOCKED", "reason": "Registry shows the company dissolved" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/businesses/company-123/update-status/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"status\": \"BLOCKED\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.update_status(\n \"company-123\",\n status=\"FLAGGED\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.updateStatus(\"company-123\", {\n status: \"FLAGGED\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.UpdateStatus(ctx, \"company-123\", didit.BusinessesUpdateStatusParams{\n\tStatus: \"FLAGGED\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BusinessesUpdateStatusParams;\nimport me.didit.types.EntityStatusUpdateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().updateStatus(\"company-123\", BusinessesUpdateStatusParams.builder()\n .status(EntityStatusUpdateRequest.Status.of(\"FLAGGED\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->updateStatus('company-123', [\n 'status' => 'FLAGGED',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.update_status(\n \"company-123\",\n status: \"FLAGGED\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.UpdateStatusAsync(\"company-123\", new BusinessesUpdateStatusParams\n{\n Status = \"FLAGGED\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Estado de la empresa actualizado. Se devuelve el registro completo de la empresa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessDetailItem" }, "examples": { "Blocked": { "value": { "didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890", "vendor_data": "company-123", "display_name": null, "legal_name": "Acme Trading Ltd", "registration_number": "12345678", "country_code": "GB", "effective_name": "Acme Trading Ltd", "status": "BLOCKED", "session_count": 2, "approved_count": 1, "declined_count": 0, "in_review_count": 1, "features": { "KYB": "Approved" }, "features_list": [ { "feature": "KYB", "status": "Approved" } ], "last_session_at": "2026-03-15T10:30:00Z", "last_activity_at": "2026-03-15T10:30:00Z", "first_session_at": "2026-01-10T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "name": "VIP", "color": "#2567FF" } ], "created_at": "2026-01-10T08:00:00Z", "metadata": { "industry": "fintech" }, "updated_at": "2026-03-15T10:30:00Z" } } } } } }, "400": { "description": "`status` ausente o no válido, o un `reason` de más de 1000 caracteres.", "content": { "application/json": { "examples": { "Missing status": { "value": { "status": [ "This field is required." ] } }, "Bad status": { "value": { "status": [ "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" ] } }, "Reason too long": { "value": { "reason": [ "Ensure this field has no more than 1000 characters." ] } } } } } }, "403": { "description": "Falta la clave de API, no es válida o fue revocada, o la clave no puede actualizar las empresas 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 empresa (no eliminada) con el `vendor_data` proporcionado para esta aplicación.", "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": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/businesses/delete/": { "post": { "summary": "Eliminar empresas en lote", "description": "**Elimina permanentemente** empresas: esta acción no se puede deshacer. Para bloquearlas, es preferible usar [Actualizar el estado de la empresa](#patch-/v3/businesses/-vendor_data-/update-status/) con `BLOCKED`.\n\n**Informes regulatorios presentados:** si los datos seleccionados forman parte de un informe regulatorio finalizado, se rechaza toda la solicitud con `409` y no se elimina nada. El cuerpo usa `code: in_filed_report` e identifica cada informe con `uuid`, `report_number`, `report_type` y `case_uuid`. Elimina los informes y repite la solicitud.", "operationId": "batch_delete_businesses", "x-didit-sdk": { "resource": "businesses", "method": "batch_delete", "auth": "api_key", "server": true }, "tags": [ "Businesses" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Proporciona `vendor_data_list`, `didit_internal_id_list` o `delete_all: true`. Precedencia cuando se envían varios: `delete_all` > `vendor_data_list` > `didit_internal_id_list` (solo se usa el selector de mayor precedencia).", "properties": { "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Tus propios identificadores que se van a eliminar, comparados exactamente como se enviaron." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "UUID internos de Didit (`didit_internal_id`) que se van a eliminar." }, "delete_all": { "type": "boolean", "default": false, "description": "Si es `true`, elimina todas las empresas de la aplicación. No se puede combinar con los selectores de lista." } } }, "examples": { "Specific businesses": { "summary": "Eliminar por vendor_data", "value": { "vendor_data_list": [ "company-123", "company-456" ] } }, "Specific internal IDs": { "summary": "Eliminar por didit_internal_id", "value": { "didit_internal_id_list": [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "b2c3d4e5-f6a7-8901-bcde-f12345678901" ] } }, "All businesses": { "summary": "Borrar todas las empresas de esta aplicación", "value": { "delete_all": true } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/businesses/delete/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"vendor_data_list\": [\"company-123\", \"company-456\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.batch_delete(\n vendor_data_list=[\"company-123\", \"company-456\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.batchDelete({\n vendor_data_list: [\"company-123\", \"company-456\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.BatchDelete(ctx, didit.BusinessesBatchDeleteParams{\n\tVendorDataList: didit.Some([]string{\"company-123\", \"company-456\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.BusinessesBatchDeleteParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().batchDelete(BusinessesBatchDeleteParams.builder()\n .vendorDataList(List.of(\"company-123\", \"company-456\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->batchDelete([\n 'vendor_data_list' => ['company-123', 'company-456'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.batch_delete(vendor_data_list: [\"company-123\", \"company-456\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.BatchDeleteAsync(new BusinessesBatchDeleteParams\n{\n VendorDataList = new string[] { \"company-123\", \"company-456\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Empresas eliminadas. Devuelve el número de filas eliminadas realmente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "integer", "description": "Número de empresas eliminadas (excluye los valores de vendor_data que no coincidieron con nada)." } } }, "examples": { "Deleted some": { "value": { "deleted": 2 } }, "Nothing matched": { "value": { "deleted": 0 } } } } } }, "400": { "description": "No se proporcionó ningún selector (`vendor_data_list`, `didit_internal_id_list` y `delete_all` faltan todos o están vacíos). El cuerpo del error es un array JSON.", "content": { "application/json": { "examples": { "Missing selector": { "value": [ "Provide vendor_data_list, didit_internal_id_list, or set delete_all=true." ] } } } } }, "403": { "description": "Falta la clave de API, no es válida o fue revocada, o la clave no puede eliminar empresas 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." } } } } } }, "429": { "description": "Límite de solicitudes superado; espera y reintenta cuando haya pasado el intervalo indicado en `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } }, "409": { "description": "La selección incluye una empresa que figura en un informe regulatorio finalizado. No se elimina nada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/users/aml-monitoring/": { "post": { "summary": "Activar o desactivar la monitorización AML continua para usuarios", "description": "Activa o desactiva la monitorización AML continua para los usuarios seleccionados, con la misma semántica que la Business Console. Se mantiene exactamente un análisis AML monitorizado por usuario, de modo que un perfil que se verificó varias veces se monitoriza y se factura una sola vez; al desactivarla, la monitorización se desactiva en todos los análisis del perfil. Los usuarios sin ningún análisis AML se analizan primero (facturado como un análisis AML normal) cuando tienen el nombre completo, la fecha de nacimiento y el país necesarios; de lo contrario, se informan como `skipped_no_identity_data`.\n\nEstablece `estimate_only: true` para previsualizar recuentos y costes sin escribir nada. Las selecciones de 20 perfiles o menos se resuelven en línea y devuelven `200` con el trabajo completado; las selecciones más grandes devuelven `202` y se ejecutan en segundo plano: consulta periódicamente [Obtener trabajo de monitorización AML](#get-/v3/aml-monitoring/jobs/-job_id-/) con el `job_id` devuelto. La activación se rechaza con `403` cuando el saldo de la organización no cubre la estimación. Los identificadores que no coinciden con nada se enumeran en `unmatched` y nunca hacen fallar la solicitud: una selección que no coincide con nada se completa como un trabajo vacío (`total` 0), la misma convención que los endpoints de eliminación por lotes.", "operationId": "toggle_users_aml_monitoring", "x-didit-sdk": { "resource": "users", "method": "set_aml_monitoring", "auth": "api_key", "server": true }, "tags": [ "AML Ongoing Monitoring" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "is_enabled" ], "description": "Selecciona usuarios con `vendor_data_list`, `didit_internal_id_list` o ambas (las dos listas se combinan con OR). Como máximo 1000 identificadores por solicitud entre ambas listas.", "properties": { "is_enabled": { "type": "boolean", "description": "true para activar la monitorización, false para desactivarla." }, "estimate_only": { "type": "boolean", "default": false, "description": "Si es true, devuelve la estimación del costo y no realiza ninguna escritura: ni análisis, ni facturación, ni tarea." }, "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Tus propios identificadores de los usuarios que se van a activar o desactivar, comparados exactamente como se enviaron." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs internos de Didit de los usuarios que se van a activar o desactivar: el `didit_internal_id` que devuelven los endpoints de creación, obtención y listado." } } }, "examples": { "Estimate first": { "summary": "Vista previa del coste sin escribir nada", "value": { "is_enabled": true, "estimate_only": true, "vendor_data_list": [ "user-123", "user-456" ] } }, "Enable": { "summary": "Activar la monitorización para dos usuarios", "value": { "is_enabled": true, "vendor_data_list": [ "user-123", "user-456" ] } }, "Disable": { "summary": "Desactivar la monitorización por ID interno de Didit", "value": { "is_enabled": false, "didit_internal_id_list": [ "3f1c0d3e-8f0a-4c2e-9a3d-9b1f5f4a2c11" ] } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/users/aml-monitoring/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"is_enabled\": true, \"vendor_data_list\": [\"user-123\", \"user-456\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.users.set_aml_monitoring(\n is_enabled=True,\n estimate_only=True,\n vendor_data_list=[\"user-123\", \"user-456\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.users.setAmlMonitoring({\n is_enabled: true,\n estimate_only: true,\n vendor_data_list: [\"user-123\", \"user-456\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.SetAMLMonitoring(ctx, didit.UsersSetAMLMonitoringParams{\n\tIsEnabled: true,\n\tEstimateOnly: didit.Bool(true),\n\tVendorDataList: didit.Some([]string{\"user-123\", \"user-456\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.UsersSetAmlMonitoringParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.users().setAmlMonitoring(UsersSetAmlMonitoringParams.builder()\n .isEnabled(true)\n .estimateOnly(true)\n .vendorDataList(List.of(\"user-123\", \"user-456\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->setAmlMonitoring([\n 'is_enabled' => true,\n 'estimate_only' => true,\n 'vendor_data_list' => ['user-123', 'user-456'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.users.set_aml_monitoring(\n is_enabled: true,\n estimate_only: true,\n vendor_data_list: [\"user-123\", \"user-456\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Users.SetAmlMonitoringAsync(new UsersSetAmlMonitoringParams\n{\n IsEnabled = true,\n EstimateOnly = true,\n VendorDataList = new string[] { \"user-123\", \"user-456\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La estimación (cuando `estimate_only` es true) o el trabajo completado para una selección procesada en línea.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringToggleResult" } } } }, "202": { "description": "Las selecciones más grandes se ejecutan en segundo plano. Consulta periódicamente el endpoint del trabajo con `job_id`; `results` se va completando a medida que se procesan los perfiles.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringJob" } } } }, "400": { "description": "Error de validación: falta `is_enabled`, no hay selector o hay más de 1000 identificadores entre ambas listas." }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "Saldo insuficiente para habilitar la monitorización de esta selección. La respuesta incluye la `estimate` para que puedas recargar el importe correcto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "estimate": { "type": "object", "description": "Vista previa del coste. Se devuelve directamente cuando estimate_only es true (no se escribe nada).", "properties": { "users_total": { "type": "integer", "description": "Perfiles que coinciden con la selección." }, "already_enabled": { "type": "integer", "description": "Perfiles ya monitorizados (no hay nada que hacer al activar; son los que se desactivan al desactivar)." }, "with_existing_aml": { "type": "integer", "description": "Perfiles cuyo análisis AML existente pasará a estar monitorizado (sin un nuevo análisis)." }, "needing_screening": { "type": "integer", "description": "Perfiles sin ningún análisis AML que se analizarán primero (se factura como un análisis AML normal)." }, "skipped_no_identity_data": { "type": "integer", "description": "Perfiles que no se pueden analizar porque faltan datos de identidad." }, "skipped_blocked": { "type": "integer", "description": "Usuarios bloqueados que se omitirán (siempre 0 para empresas)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Costo único de los nuevos análisis." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Coste anual de monitorización de los perfiles que pasarán a estar monitorizados." }, "balance_sufficient": { "type": "boolean", "description": "Si el saldo de la organización cubre el análisis más el primer año de monitorización." } } } } } } } } } } }, "/v3/businesses/aml-monitoring/": { "post": { "summary": "Activar o desactivar la monitorización AML continua para empresas", "description": "Activa o desactiva la monitorización AML continua para las empresas seleccionadas, con la misma semántica que la Business Console. Se mantiene exactamente un análisis AML monitorizado por empresa, de modo que un perfil que se verificó varias veces se monitoriza y se factura una sola vez; al desactivarla, la monitorización se desactiva en todos los análisis del perfil. Las empresas sin ningún análisis AML se analizan primero (facturado como un análisis AML normal) cuando tienen el nombre legal o comercial necesario; de lo contrario, se informan como `skipped_no_identity_data`.\n\nEstablece `estimate_only: true` para previsualizar recuentos y costes sin escribir nada. Las selecciones de 20 perfiles o menos se resuelven en línea y devuelven `200` con el trabajo completado; las selecciones más grandes devuelven `202` y se ejecutan en segundo plano: consulta periódicamente [Obtener trabajo de monitorización AML](#get-/v3/aml-monitoring/jobs/-job_id-/) con el `job_id` devuelto. La activación se rechaza con `403` cuando el saldo de la organización no cubre la estimación. Los identificadores que no coinciden con nada se enumeran en `unmatched` y nunca hacen fallar la solicitud: una selección que no coincide con nada se completa como un trabajo vacío (`total` 0), la misma convención que los endpoints de eliminación por lotes.", "operationId": "toggle_businesses_aml_monitoring", "x-didit-sdk": { "resource": "businesses", "method": "set_aml_monitoring", "auth": "api_key", "server": true }, "tags": [ "AML Ongoing Monitoring" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "is_enabled" ], "description": "Selecciona empresas con `vendor_data_list`, `didit_internal_id_list` o ambas (las dos listas se combinan con OR). Como máximo 1000 identificadores por solicitud entre ambas listas.", "properties": { "is_enabled": { "type": "boolean", "description": "true para activar la monitorización, false para desactivarla." }, "estimate_only": { "type": "boolean", "default": false, "description": "Si es true, devuelve la estimación del costo y no realiza ninguna escritura: ni análisis, ni facturación, ni tarea." }, "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Tus propios identificadores de las empresas que se van a activar o desactivar, comparados exactamente como se enviaron." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs internos de Didit de las empresas que se van a activar o desactivar: el `didit_internal_id` que devuelven los endpoints de creación, obtención y listado." } } }, "examples": { "Estimate first": { "summary": "Vista previa del coste sin escribir nada", "value": { "is_enabled": true, "estimate_only": true, "vendor_data_list": [ "company-123", "company-456" ] } }, "Enable": { "summary": "Activar la monitorización para dos empresas", "value": { "is_enabled": true, "vendor_data_list": [ "company-123", "company-456" ] } }, "Disable": { "summary": "Desactivar la monitorización por ID interno de Didit", "value": { "is_enabled": false, "didit_internal_id_list": [ "3f1c0d3e-8f0a-4c2e-9a3d-9b1f5f4a2c11" ] } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/businesses/aml-monitoring/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"is_enabled\": true, \"vendor_data_list\": [\"company-123\", \"company-456\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.set_aml_monitoring(\n is_enabled=True,\n estimate_only=True,\n vendor_data_list=[\"company-123\", \"company-456\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.setAmlMonitoring({\n is_enabled: true,\n estimate_only: true,\n vendor_data_list: [\"company-123\", \"company-456\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.SetAMLMonitoring(ctx, didit.BusinessesSetAMLMonitoringParams{\n\tIsEnabled: true,\n\tEstimateOnly: didit.Bool(true),\n\tVendorDataList: didit.Some([]string{\"company-123\", \"company-456\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.BusinessesSetAmlMonitoringParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().setAmlMonitoring(BusinessesSetAmlMonitoringParams.builder()\n .isEnabled(true)\n .estimateOnly(true)\n .vendorDataList(List.of(\"company-123\", \"company-456\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->setAmlMonitoring([\n 'is_enabled' => true,\n 'estimate_only' => true,\n 'vendor_data_list' => ['company-123', 'company-456'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.set_aml_monitoring(\n is_enabled: true,\n estimate_only: true,\n vendor_data_list: [\"company-123\", \"company-456\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.SetAmlMonitoringAsync(new BusinessesSetAmlMonitoringParams\n{\n IsEnabled = true,\n EstimateOnly = true,\n VendorDataList = new string[] { \"company-123\", \"company-456\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La estimación (cuando `estimate_only` es true) o el trabajo completado para una selección procesada en línea.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringToggleResult" } } } }, "202": { "description": "Las selecciones más grandes se ejecutan en segundo plano. Consulta periódicamente el endpoint del trabajo con `job_id`; `results` se va completando a medida que se procesan los perfiles.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringJob" } } } }, "400": { "description": "Error de validación: falta `is_enabled`, no hay selector o hay más de 1000 identificadores entre ambas listas." }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "Saldo insuficiente para habilitar la monitorización de esta selección. La respuesta incluye la `estimate` para que puedas recargar el importe correcto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "estimate": { "type": "object", "description": "Vista previa del coste. Se devuelve directamente cuando estimate_only es true (no se escribe nada).", "properties": { "users_total": { "type": "integer", "description": "Perfiles que coinciden con la selección." }, "already_enabled": { "type": "integer", "description": "Perfiles ya monitorizados (no hay nada que hacer al activar; son los que se desactivan al desactivar)." }, "with_existing_aml": { "type": "integer", "description": "Perfiles cuyo análisis AML existente pasará a estar monitorizado (sin un nuevo análisis)." }, "needing_screening": { "type": "integer", "description": "Perfiles sin ningún análisis AML que se analizarán primero (se factura como un análisis AML normal)." }, "skipped_no_identity_data": { "type": "integer", "description": "Perfiles que no se pueden analizar porque faltan datos de identidad." }, "skipped_blocked": { "type": "integer", "description": "Usuarios bloqueados que se omitirán (siempre 0 para empresas)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Costo único de los nuevos análisis." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Coste anual de monitorización de los perfiles que pasarán a estar monitorizados." }, "balance_sufficient": { "type": "boolean", "description": "Si el saldo de la organización cubre el análisis más el primer año de monitorización." } } } } } } } } } } }, "/v3/aml-monitoring/jobs/{job_id}/": { "get": { "summary": "Obtener un trabajo de monitorización AML continua", "description": "Estado, contadores de resultados y resultados por registro de un trabajo de activación o desactivación de la monitorización iniciado desde `POST /v3/users/aml-monitoring/` o `POST /v3/businesses/aml-monitoring/`. Consulta cada par de segundos mientras `status` sea `PENDING` o `PROCESSING`; `results` está completo cuando pasa a `COMPLETED`.", "operationId": "get_aml_monitoring_job", "x-didit-sdk": { "resource": "aml_monitoring", "method": "retrieve_job", "auth": "api_key", "server": true }, "tags": [ "AML Ongoing Monitoring" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "El `job_id` que devuelve el endpoint de activación." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl 'https://verification.didit.me/v3/aml-monitoring/jobs/JOB_ID/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.aml_monitoring.retrieve_job(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.amlMonitoring.retrieveJob(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.AMLMonitoring.RetrieveJob(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.amlMonitoring().retrieveJob(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "amlMonitoring->retrieveJob('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.aml_monitoring.retrieve_job(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.AmlMonitoring.RetrieveJobAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "El trabajo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ] }, "is_enabled": { "type": "boolean", "description": "true cuando el trabajo activa la monitorización, false cuando la desactiva." }, "target_type": { "type": "string", "enum": [ "user", "business" ], "description": "Qué familia de perfiles activa o desactiva el trabajo." }, "total": { "type": "integer", "description": "Perfiles que procesa el trabajo." }, "processed": { "type": "integer", "description": "Perfiles procesados hasta el momento." }, "outcomes": { "type": "object", "description": "Contadores de resultados por registro. Cada perfil seleccionado corresponde exactamente a un contador; no se omite nada de forma silenciosa.", "properties": { "enabled": { "type": "integer", "description": "Monitorización activada en un análisis AML existente." }, "screened_and_enabled": { "type": "integer", "description": "Se creó un nuevo análisis AML (facturado) y se activó la monitorización en él." }, "already_enabled": { "type": "integer", "description": "La monitorización ya estaba activa; no se cambió nada y no se facturó nada." }, "disabled": { "type": "integer", "description": "Monitorización desactivada en todos los análisis AML del perfil." }, "skipped_no_identity_data": { "type": "integer", "description": "Omitido: al perfil le faltan el nombre completo, la fecha de nacimiento y el país (usuarios) o un nombre (empresas) necesarios para el análisis." }, "skipped_blocked": { "type": "integer", "description": "Omitido: el usuario está bloqueado." }, "skipped_sandbox": { "type": "integer", "description": "Omitido: aplicación de sandbox, no se crea ningún análisis." }, "failed_provider": { "type": "integer", "description": "No se pudo completar el análisis; reinténtalo más tarde." }, "failed_insufficient_balance": { "type": "integer", "description": "El saldo se agotó mientras se ejecutaba el trabajo." } } }, "results": { "type": "array", "description": "Una entrada por perfil procesado, en orden de procesamiento. Crece mientras se ejecuta el trabajo; está completa cuando el estado es COMPLETED. Se registra para los trabajos iniciados a través de la API; un trabajo iniciado desde la Business Console solo informa contadores.", "items": { "type": "object", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "ID interno de Didit del perfil." }, "vendor_data": { "type": "string", "nullable": true, "description": "Tu propio identificador del perfil." }, "outcome": { "type": "string", "enum": [ "enabled", "screened_and_enabled", "already_enabled", "disabled", "skipped_no_identity_data", "skipped_blocked", "skipped_sandbox", "failed_provider", "failed_insufficient_balance" ] } } } }, "error": { "type": "string", "nullable": true, "description": "Mensaje de error genérico cuando el estado es FAILED; la causa detallada se conserva en la plataforma." }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true } } } } } }, "401": { "description": "Clave de API ausente o no válida." }, "404": { "description": "No existe ese trabajo para esta aplicación." } } } }, "/v3/users/{vendor_data}/update-status/": { "patch": { "summary": "Actualizar el estado del usuario", "description": "Cambia solo el `status` del ciclo de vida de un usuario: `ACTIVE`, `FLAGGED` o `BLOCKED` (no los estados de sesión). `BLOCKED` añade el `vendor_data` a la lista de bloqueo del sistema; salir de `BLOCKED` elimina esa entrada. Cada cambio se registra como una actividad `STATUS_CHANGED` en el usuario, con el `reason` opcional como su `comment`. Enviar el estado actual no cambia nada y no registra ningún `reason`. El webhook `user.status.updated` no incluye `reason`.", "operationId": "update_user_status", "x-didit-sdk": { "resource": "users", "method": "update_status", "auth": "api_key", "server": true }, "tags": [ "Users" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tu identificador único del usuario." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityStatusUpdateRequest" }, { "type": "object", "properties": { "reason": { "type": "string", "nullable": true, "maxLength": 1000, "description": "Por qué cambió el estado. Se registra en la entrada de cambio de estado de la actividad del usuario (`comments[].comment` y **Activity** en Business Console), solo cuando el estado cambia realmente. Los webhooks no lo incluyen." } } } ] }, "examples": { "Activate": { "summary": "Reactivar al usuario", "value": { "status": "ACTIVE" } }, "Flag": { "summary": "Marcar al usuario para revisión", "value": { "status": "FLAGGED" } }, "Block": { "summary": "Bloquear el usuario (lo añade a la lista de bloqueo del sistema)", "value": { "status": "BLOCKED" } }, "Block with reason": { "summary": "Bloquear el usuario y registrar el motivo", "value": { "status": "BLOCKED", "reason": "Chargeback fraud pattern confirmed" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/update-status/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"status\": \"BLOCKED\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.users.update_status(\n \"user-123\",\n status=\"ACTIVE\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.users.updateStatus(\"user-123\", {\n status: \"ACTIVE\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.UpdateStatus(ctx, \"user-123\", didit.UsersUpdateStatusParams{\n\tStatus: \"ACTIVE\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.EntityStatusUpdateRequest;\nimport me.didit.types.UsersUpdateStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.users().updateStatus(\"user-123\", UsersUpdateStatusParams.builder()\n .status(EntityStatusUpdateRequest.Status.of(\"ACTIVE\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->updateStatus('user-123', [\n 'status' => 'ACTIVE',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.users.update_status(\n \"user-123\",\n status: \"ACTIVE\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Users.UpdateStatusAsync(\"user-123\", new UsersUpdateStatusParams\n{\n Status = \"ACTIVE\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Estado del usuario actualizado. Se devuelve el registro completo del usuario.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailItem" }, "examples": { "Blocked": { "value": { "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418", "vendor_data": "user-abc-123", "display_name": null, "full_name": "John Michael Doe", "date_of_birth": "1990-05-15", "effective_name": "John Michael Doe", "status": "BLOCKED", "metadata": { "tier": "premium", "source": "website" }, "portrait_image_url": "https:///...", "session_count": 3, "approved_count": 2, "declined_count": 0, "in_review_count": 1, "issuing_states": [ "USA" ], "approved_emails": [ "john@example.com" ], "approved_phones": [ "+14155551234" ], "features": { "ID_VERIFICATION": "Approved", "LIVENESS": "Approved", "FACE_MATCH": "Approved", "AML": "Approved" }, "features_list": [ { "feature": "ID_VERIFICATION", "status": "Approved" }, { "feature": "LIVENESS", "status": "Approved" }, { "feature": "FACE_MATCH", "status": "Approved" }, { "feature": "AML", "status": "Approved" } ], "last_session_at": "2025-06-15T10:30:00Z", "last_activity_at": "2025-06-15T10:30:00Z", "first_session_at": "2025-06-01T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "tag": { "uuid": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b", "name": "VIP", "color": "#2567FF", "description": null, "source": "custom", "created_at": "2025-05-01T09:00:00Z", "updated_at": "2025-05-01T09:00:00Z" }, "added_by_email": "analyst@acme.com", "added_by_name": "Jane Analyst", "created_at": "2025-06-02T11:00:00Z" } ], "comments": [ { "uuid": "c1111111-2222-4333-8444-555555555555", "comment_type": "STATUS_CHANGED", "comment": "Chargeback fraud pattern confirmed", "actor_email": null, "actor_name": null, "previous_status": "ACTIVE", "new_status": "BLOCKED", "previous_value": null, "new_value": null, "changed_fields": [], "metadata": null, "mentioned_emails": [], "created_at": "2025-06-15T10:30:00Z" } ], "created_at": "2025-06-01T08:00:00Z", "updated_at": "2025-06-15T10:30:00Z" } } } } } }, "400": { "description": "`status` ausente o no válido, o un `reason` de más de 1000 caracteres.", "content": { "application/json": { "examples": { "Missing status": { "value": { "status": [ "This field is required." ] } }, "Bad status": { "value": { "status": [ "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" ] } }, "Reason too long": { "value": { "reason": [ "Ensure this field has no more than 1000 characters." ] } } } } } }, "401": { "description": "No se proporcionaron credenciales. El middleware de autenticación rechaza las solicitudes a rutas `/v3/users/*` sin un encabezado `x-api-key` (o un token `Authorization: Bearer`) antes de que lleguen a la API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "La clave no puede actualizar usuarios de esta aplicación. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ningún usuario (no eliminado) con el `vendor_data` proporcionado para esta aplicación.", "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": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/businesses/create/": { "post": { "summary": "Crear empresa", "description": "Crea previamente una [empresa](/entities/businesses) *sin* una sesión de KYB. Todos los campos son opcionales, pero siempre deberías enviar `vendor_data`: sin él, el registro no se puede vincular a sesiones ni a transacciones. Cuando se proporciona, `vendor_data` debe ser único entre las empresas no eliminadas (coincidencia exacta; los conflictos devuelven 400). No es idempotente.", "operationId": "create_business", "x-didit-sdk": { "resource": "businesses", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Businesses" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu identificador único de esta empresa (cadena de texto libre, NO un UUID). Es opcional, pero muy recomendable. Si lo indicas, debe ser único entre las empresas no eliminadas de la aplicación; se compara exactamente tal como se envía." }, "display_name": { "type": "string", "nullable": true, "maxLength": 255, "description": "Nombre visible descriptivo que se muestra en la consola (tiene prioridad sobre `legal_name` en la interfaz)." }, "legal_name": { "type": "string", "nullable": true, "maxLength": 255, "description": "Razón social oficial de la empresa." }, "registration_number": { "type": "string", "nullable": true, "maxLength": 100, "description": "Número de registro o de constitución de la empresa." }, "country_code": { "type": "string", "nullable": true, "maxLength": 10, "description": "País de constitución (ISO 3166-1 alfa-2, p. ej., `GB`, `US`)." }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "default": "ACTIVE", "description": "Estado inicial del ciclo de vida. El valor predeterminado es `ACTIVE`." }, "metadata": { "type": "object", "nullable": true, "description": "Objeto JSON arbitrario que adjuntas a la empresa. Por defecto es `{}`." } } }, "examples": { "Basic": { "summary": "Mínimo recomendado", "value": { "vendor_data": "company-456", "legal_name": "New Corp Ltd", "country_code": "US" } }, "Full": { "summary": "Todos los campos", "value": { "vendor_data": "company-789", "display_name": "New Corp", "legal_name": "New Corp International Ltd", "registration_number": "98765432", "country_code": "DE", "status": "ACTIVE", "metadata": { "industry": "fintech", "tier": "enterprise" } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/businesses/create/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"vendor_data\": \"company-456\", \"legal_name\": \"New Corp Ltd\", \"country_code\": \"US\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.create(\n vendor_data=\"company-456\",\n legal_name=\"New Corp Ltd\",\n country_code=\"US\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.create({\n vendor_data: \"company-456\",\n legal_name: \"New Corp Ltd\",\n country_code: \"US\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.Create(ctx, didit.BusinessesCreateParams{\n\tVendorData: didit.String(\"company-456\"),\n\tLegalName: didit.String(\"New Corp Ltd\"),\n\tCountryCode: didit.String(\"US\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BusinessesCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().create(BusinessesCreateParams.builder()\n .vendorData(\"company-456\")\n .legalName(\"New Corp Ltd\")\n .countryCode(\"US\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->create([\n 'vendor_data' => 'company-456',\n 'legal_name' => 'New Corp Ltd',\n 'country_code' => 'US',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.create(\n vendor_data: \"company-456\",\n legal_name: \"New Corp Ltd\",\n country_code: \"US\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.CreateAsync(new BusinessesCreateParams\n{\n VendorData = \"company-456\",\n LegalName = \"New Corp Ltd\",\n CountryCode = \"US\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Empresa creada. Se devuelve el registro completo de la empresa (con la misma estructura que Get Business).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessDetailItem" }, "examples": { "Created": { "value": { "didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890", "vendor_data": "company-456", "display_name": null, "legal_name": "New Corp Ltd", "registration_number": null, "country_code": "US", "effective_name": "New Corp Ltd", "status": "ACTIVE", "session_count": 0, "approved_count": 0, "declined_count": 0, "in_review_count": 0, "features": {}, "features_list": [], "last_session_at": null, "last_activity_at": "2026-03-15T10:30:00Z", "first_session_at": null, "tags": [], "created_at": "2026-03-15T10:30:00Z", "metadata": {}, "updated_at": "2026-03-15T10:30:00Z" } } } } } }, "400": { "description": "Cuerpo no válido: normalmente un `vendor_data` duplicado, un `status` desconocido o un `metadata` con formato incorrecto.", "content": { "application/json": { "examples": { "Duplicate": { "value": { "vendor_data": [ "A business with this vendor_data already exists." ] } }, "Bad status": { "value": { "status": [ "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" ] } }, "Bad metadata": { "value": { "metadata": [ "Metadata must be a JSON object." ] } } } } } }, "403": { "description": "Clave de API ausente, no válida o revocada, o la clave no puede crear empresas para esta aplicación. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Límite de solicitudes superado; espera y reintenta cuando haya pasado el intervalo indicado en `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/users/create/": { "post": { "summary": "Crear usuario", "description": "Crea un [usuario](/entities/users) por `vendor_data`, antes de una sesión de verificación o sin ella. `vendor_data` debe ser único entre los usuarios de la aplicación (un duplicado devuelve `400`). No es idempotente.\n\n**Datos de contacto:** `email` y `phone_number` se guardan en `metadata.contact`, y `country` en `metadata.address`. Si envías `first_name` o `last_name` sin `full_name`, Didit los une en `full_name`.\n\n**Enlace de verificación:** con `send_verification_link: true`, Didit también crea una sesión de verificación para la persona en `workflow_id` y le envía el enlace por correo electrónico a `email`. La sesión ejecuta las mismas comprobaciones que [Crear sesión](/es/sessions-api/create-session), como la lista de bloqueo y tu saldo de créditos. La persona y la sesión se crean juntas o no se crea ninguna: si alguna comprobación falla, no se escribe nada y no se envía ningún correo. El campo `verification_link` de la respuesta describe la sesión y es `null` cuando no solicitas un enlace.\n\n**Acceso con clave de API:** una clave de API con alcance limitado necesita permiso de escritura en `users`. Con `send_verification_link: true` también necesita permiso de escritura en `sessions`; de lo contrario, la llamada responde `403` antes de escribir nada. Las claves con acceso completo no se ven afectadas. Consulta [Claves de API](/es/console/api-keys).", "operationId": "create_user", "x-didit-sdk": { "resource": "users", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Users" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "vendor_data" ], "properties": { "vendor_data": { "type": "string", "description": "Tu identificador único de este usuario (cadena de texto libre, NO un UUID). Debe ser único entre los usuarios de la aplicación; se compara exactamente tal como se envía." }, "full_name": { "type": "string", "nullable": true, "maxLength": 512, "description": "Nombre legal completo del usuario." }, "display_name": { "type": "string", "nullable": true, "description": "Nombre visible descriptivo que se muestra en la consola (tiene prioridad sobre `full_name` en la interfaz).", "maxLength": 255 }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Fecha de nacimiento en formato `YYYY-MM-DD`." }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "default": "ACTIVE", "description": "Estado inicial del ciclo de vida. El valor predeterminado es `ACTIVE`." }, "metadata": { "type": "object", "nullable": true, "description": "Objeto JSON arbitrario que adjuntas al usuario. Por defecto es `{}`." }, "approved_emails": { "type": "array", "items": { "type": "string" }, "description": "Direcciones de correo electrónico de confianza previa para este usuario, por ejemplo `[\"john@example.com\"]`." }, "approved_phones": { "type": "array", "items": { "type": "string" }, "description": "Números de teléfono de confianza previa para este usuario, por ejemplo `[\"+14155551234\"]`." }, "issuing_states": { "type": "array", "items": { "type": "string" }, "description": "Países emisores registrados previamente (ISO 3166-1 alpha-3), por ejemplo `[\"USA\"]`." }, "first_name": { "type": "string", "maxLength": 255, "description": "Nombre de pila. Cuando no se envía `full_name`, Didit une `first_name` y `last_name` con un espacio en `full_name`. No se devuelve como campo independiente." }, "last_name": { "type": "string", "maxLength": 255, "description": "Apellido. Se une con `first_name` para formar `full_name` cuando no se envía `full_name`. No se devuelve como campo independiente." }, "email": { "type": "string", "format": "email", "description": "Correo electrónico de contacto, que se guarda en `metadata.contact.email` (reemplaza cualquier `email` que envíes dentro de `metadata.contact`). Es obligatorio cuando `send_verification_link` es `true`: el enlace se envía a esta dirección. Si `metadata.contact` no es un objeto JSON, la llamada responde `400` en este campo." }, "phone_number": { "type": "string", "maxLength": 32, "description": "Número de teléfono de contacto, que se guarda en `metadata.contact.phone_number`. Si `metadata.contact` no es un objeto JSON, la llamada responde `400` en este campo." }, "country": { "type": "string", "maxLength": 3, "description": "País como código ISO 3166, alfa-2 o alfa-3 (`ES` o `ESP`). Se guarda en mayúsculas en `metadata.address.country`. Si `metadata.address` no es un objeto JSON, la llamada responde `400` en este campo." }, "send_verification_link": { "type": "boolean", "default": false, "description": "Si es `true`, Didit crea una sesión de verificación para la persona en `workflow_id` y le envía el enlace por correo electrónico a `email`. Requiere `email` y `workflow_id`. Una clave de API con alcance limitado también necesita permiso de escritura en `sessions`." }, "workflow_id": { "type": "string", "format": "uuid", "description": "El flujo de la sesión de verificación. Obligatorio cuando `send_verification_link` es `true`. Debe verificar a una persona: se rechaza un flujo de Verificación de empresas (KYB). En caso contrario, se ignora." }, "language": { "type": "string", "maxLength": 10, "description": "Idioma del correo electrónico de verificación, como código de [idioma admitido](/es/integration/supported-languages). Inglés si se omite. Se ignora cuando `send_verification_link` no es `true`." } } }, "examples": { "Basic": { "summary": "Crear con información básica", "value": { "vendor_data": "user-abc-123", "full_name": "John Doe" } }, "Full": { "summary": "Todos los campos", "value": { "vendor_data": "user-abc-456", "full_name": "Jane Smith", "display_name": "Jane S.", "date_of_birth": "1990-05-15", "status": "ACTIVE", "metadata": { "tier": "premium", "source": "api" }, "approved_emails": [ "jane@example.com" ] } }, "Contact details": { "summary": "Nombre, correo electrónico, teléfono y país", "value": { "vendor_data": "user-abc-789", "first_name": "Julia", "last_name": "Martin", "email": "julia.martin@example.com", "phone_number": "+34600000000", "country": "ES" } }, "With verification link": { "summary": "Crear la persona y enviarle por correo un enlace de verificación", "value": { "vendor_data": "user-abc-789", "first_name": "Julia", "last_name": "Martin", "email": "julia.martin@example.com", "send_verification_link": true, "workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "language": "es" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/users/create/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"vendor_data\": \"user-abc-123\", \"full_name\": \"John Doe\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.users.create(\n vendor_data=\"user-abc-123\",\n full_name=\"John Doe\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.users.create({\n vendor_data: \"user-abc-123\",\n full_name: \"John Doe\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Create(ctx, didit.UsersCreateParams{\n\tVendorData: \"user-abc-123\",\n\tFullName: didit.String(\"John Doe\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.UsersCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.users().create(UsersCreateParams.builder()\n .vendorData(\"user-abc-123\")\n .fullName(\"John Doe\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->create([\n 'vendor_data' => 'user-abc-123',\n 'full_name' => 'John Doe',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.users.create(\n vendor_data: \"user-abc-123\",\n full_name: \"John Doe\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Users.CreateAsync(new UsersCreateParams\n{\n VendorData = \"user-abc-123\",\n FullName = \"John Doe\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Usuario creado. El registro completo del usuario (con la misma estructura que Get User), más `verification_link`: la sesión de verificación que Didit envió por correo electrónico cuando `send_verification_link` era `true`; en caso contrario, `null`.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserDetailItem" }, { "type": "object", "required": [ "verification_link" ], "properties": { "verification_link": { "type": "object", "nullable": true, "description": "La sesión de verificación que Didit creó y envió por correo electrónico a la persona. Siempre presente: `null` cuando `send_verification_link` no era `true`.", "required": [ "session_id", "session_number", "status", "url", "workflow_id", "email" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID de la sesión de verificación." }, "session_number": { "type": "integer", "description": "Número secuencial de la sesión dentro de tu aplicación." }, "status": { "type": "string", "description": "Estado de la sesión; `Not Started` para una sesión recién creada." }, "url": { "type": "string", "format": "uri", "description": "El enlace de verificación que Didit envió por correo electrónico a la persona." }, "workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "El flujo que ejecuta la sesión." }, "email": { "type": "string", "format": "email", "description": "La dirección a la que se envió el enlace." } } } } } ] }, "examples": { "Created": { "value": { "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418", "vendor_data": "user-abc-123", "display_name": null, "full_name": "John Doe", "date_of_birth": null, "effective_name": "John Doe", "status": "ACTIVE", "metadata": {}, "portrait_image_url": null, "session_count": 0, "approved_count": 0, "declined_count": 0, "in_review_count": 0, "issuing_states": [], "approved_emails": [], "approved_phones": [], "features": {}, "features_list": [], "last_session_at": null, "last_activity_at": "2025-06-15T10:30:00Z", "first_session_at": null, "tags": [], "comments": [], "created_at": "2025-06-15T10:30:00Z", "updated_at": "2025-06-15T10:30:00Z", "verification_link": null } }, "Created with verification link": { "value": { "didit_internal_id": "9b2f6c1e-3d4a-4e5f-8a7b-1c2d3e4f5a6b", "vendor_data": "user-abc-789", "display_name": null, "full_name": "Julia Martin", "date_of_birth": null, "effective_name": "Julia Martin", "status": "ACTIVE", "metadata": { "contact": { "email": "julia.martin@example.com" } }, "portrait_image_url": null, "session_count": 1, "approved_count": 0, "declined_count": 0, "in_review_count": 0, "issuing_states": [], "approved_emails": [], "approved_phones": [], "features": {}, "features_list": [], "last_session_at": "2025-06-15T10:30:00Z", "last_activity_at": "2025-06-15T10:30:00Z", "first_session_at": "2025-06-15T10:30:00Z", "tags": [], "comments": [], "created_at": "2025-06-15T10:30:00Z", "updated_at": "2025-06-15T10:30:00Z", "verification_link": { "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa7", "session_number": 43762, "status": "Not Started", "url": "https://verify.didit.me/en/session/3FaJ9wLqX2Mz", "workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "email": "julia.martin@example.com" } } } } } } }, "400": { "description": "Cuerpo no válido, con los errores agrupados por campo: normalmente un `vendor_data` duplicado, un campo obligatorio ausente o un valor mal formado. Con `send_verification_link: true`, también un `email` o `workflow_id` ausente, un flujo desconocido o de Verificación de empresas (KYB), un `language` no admitido (con la clave `contact_details.email_lang`), un `vendor_data` en la lista de bloqueo o créditos insuficientes para iniciar la sesión. No se escribe nada.", "content": { "application/json": { "examples": { "Duplicate": { "value": { "vendor_data": [ "A user with this vendor_data already exists." ] } }, "Missing vendor_data": { "value": { "vendor_data": [ "This field is required." ] } }, "Bad metadata": { "value": { "metadata": [ "Metadata must be a JSON object." ] } }, "Bad status": { "value": { "status": [ "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" ] } }, "Bad country": { "value": { "country": [ "Use an ISO 3166 country code, like ES or ESP." ] } }, "Contact not an object": { "value": { "email": [ "metadata.contact must be a JSON object to store this value." ] } }, "Address not an object": { "value": { "country": [ "metadata.address must be a JSON object to store this value." ] } }, "Link without email or workflow": { "value": { "email": [ "An email address is required to send a verification link." ], "workflow_id": [ "Pick the workflow to send a verification link for." ] } }, "Unknown workflow": { "value": { "workflow_id": [ "Invalid workflow_id." ] } }, "Business workflow": { "value": { "workflow_id": [ "This workflow verifies a business. Pick a workflow that verifies a person to send them a verification link." ] } }, "Blocklisted vendor_data": { "value": { "vendor_data": "This user or business has been blocked and cannot create new verification sessions." } }, "Insufficient credits": { "value": { "detail": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "401": { "description": "No se proporcionaron credenciales. El middleware de autenticación rechaza las solicitudes a rutas `/v3/users/*` sin un encabezado `x-api-key` (o un token `Authorization: Bearer`) antes de que lleguen a la API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Clave de API no válida o revocada, o la clave no puede crear usuarios para esta aplicación. Una clave de API con alcance limitado necesita permiso de escritura en `users`, y también de escritura en `sessions` cuando `send_verification_link` es `true`; no se escribe nada. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } }, "No sessions write": { "summary": "Una clave con alcance limitado solicita un enlace de verificación sin permiso de escritura en sessions", "value": { "detail": "This API key has no write access to sessions." } } } } } }, "429": { "description": "Límite de solicitudes superado; espera y reintenta cuando haya pasado el intervalo indicado en `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/": { "post": { "summary": "Subir el rostro del usuario", "description": "Adjunta una imagen facial importada y de confianza a un perfil de User existente. Úsalo después de crear u obtener un User por `vendor_data` y leer su `didit_internal_id`. El rostro subido se almacena en el perfil de User y se indexa para la detección de duplicados y la búsqueda facial. No se añade a una lista de bloqueo facial.", "operationId": "upload_user_face", "x-didit-sdk": { "resource": "users", "method": "upload_face", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Users" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización propietaria de la aplicación." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación a la que pertenece el perfil del usuario." }, { "name": "didit_internal_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID interno de usuario de Didit, devuelto como `didit_internal_id` por `GET /v3/users/{vendor_data}/` y `POST /v3/users/create/`." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "image" ], "properties": { "image": { "type": "string", "format": "byte", "description": "Imagen facial JPG o PNG sin procesar codificada en base64. No incluyas un prefijo `data:image/...;base64,`. Tamaño máximo decodificado: 2 MB." }, "comment": { "type": "string", "description": "Nota opcional, visible para los operadores, sobre el rostro subido.", "default": "" } } }, "examples": { "Imported face": { "summary": "Adjuntar un rostro importado de un proveedor anterior", "value": { "image": "/9j/4AAQSkZJRgABAQEA...", "comment": "Imported from previous KYC provider" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/vendor-users/by-id/f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418/faces/upload/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"image\": \"/9j/4AAQSkZJRgABAQEA...\", \"comment\": \"Imported from previous KYC provider\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.users.upload_face(\n \"11111111-2222-3333-4444-555555555555\",\n image=\"/9j/4AAQSkZJRgABAQEA...\",\n comment=\"Imported from previous KYC provider\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.users.uploadFace(\"11111111-2222-3333-4444-555555555555\", {\n image: \"/9j/4AAQSkZJRgABAQEA...\",\n comment: \"Imported from previous KYC provider\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Users.UploadFace(ctx, \"11111111-2222-3333-4444-555555555555\", didit.UsersUploadFaceParams{\n\tImage: \"/9j/4AAQSkZJRgABAQEA...\",\n\tComment: didit.String(\"Imported from previous KYC provider\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.UsersUploadFaceParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.users().uploadFace(\"11111111-2222-3333-4444-555555555555\", UsersUploadFaceParams.builder()\n .image(\"/9j/4AAQSkZJRgABAQEA...\")\n .comment(\"Imported from previous KYC provider\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->uploadFace('11111111-2222-3333-4444-555555555555', [\n 'image' => '/9j/4AAQSkZJRgABAQEA...',\n 'comment' => 'Imported from previous KYC provider',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.users.upload_face(\n \"11111111-2222-3333-4444-555555555555\",\n image: \"/9j/4AAQSkZJRgABAQEA...\",\n comment: \"Imported from previous KYC provider\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Users.UploadFaceAsync(\"11111111-2222-3333-4444-555555555555\", new UsersUploadFaceParams\n{\n Image = \"/9j/4AAQSkZJRgABAQEA...\",\n Comment = \"Imported from previous KYC provider\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Rostro subido y vinculado al perfil del usuario.", "content": { "application/json": { "schema": { "type": "object", "required": [ "uuid", "image_url", "comment", "uploaded_by", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID del registro facial de usuario subido." }, "image_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL firmada de la imagen facial subida." }, "comment": { "type": "string", "nullable": true, "description": "Comentario proporcionado al subir el rostro." }, "uploaded_by": { "type": "string", "nullable": true, "description": "Correo electrónico o identificador del actor que subió el archivo, cuando esté disponible." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de tiempo de la subida." } } }, "examples": { "Uploaded": { "value": { "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "image_url": "https://signed-url.example/face.jpg", "comment": "Imported from previous KYC provider", "uploaded_by": "api", "created_at": "2026-05-18T12:00:00Z" } } } } } }, "400": { "description": "Cuerpo de la solicitud o imagen no válidos. Causas habituales: base64 no válido, imagen no válida, ningún rostro detectable, imagen de más de 2 MB, embedding ausente o el usuario ya tiene 5 rostros subidos.", "content": { "application/json": { "examples": { "No face": { "value": { "image": "No face detected in the image. Please upload a clear photo with a visible face." } }, "Too many faces": { "value": { "detail": "Maximum of 5 faces per user reached." } }, "Too large": { "value": { "image": "Image exceeds maximum size of 2 MB." } } } } } }, "401": { "description": "Clave de API ausente o no válida.", "content": { "application/json": { "examples": { "Missing key": { "value": { "detail": "Authentication credentials were not provided." } } } } } }, "403": { "description": "La credencial es válida, pero no puede escribir perfiles de usuario para esta aplicación.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existe ningún usuario con ese `didit_internal_id` en la aplicación.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Límite de solicitudes superado; espera y reintenta.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/update-data/": { "patch": { "summary": "Actualizar los datos de KYC extraídos del documento de identidad en una sesión de verificación", "description": "Corrige los campos de identidad extraídos (OCR / NFC) del documento de identidad del usuario (nombres mal leídos, fechas, números de documento, etc.) una vez finalizada la verificación. Quienes suelen llamarlo son un analista de cumplimiento que trabaja desde tu propio back office o un proceso automatizado de conciliación. Todos los campos del cuerpo son opcionales: solo se escriben las claves que envías y todo lo demás queda intacto (semántica `PATCH`).\n\nLa sesión debe pertenecer a tu aplicación y estar en estado `Approved`, `Declined`, `In Review` o `Kyc Expired`. Las sesiones en cualquier otro estado (por ejemplo, todavía en `In Progress`) devuelven `404` con `\"No Session matches the given query.\"`, a diferencia del `\"Not found.\"` que se devuelve para un `sessionId` desconocido o eliminado. La sesión también debe tener un registro de verificación de identidad (KYC): las sesiones cuyo flujo de verificación (workflow) nunca ejecutó un paso de verificación de identidad devuelven `404` (`\"The session does not have a KYC.\"`). En flujos de grafo con varios pasos de verificación de identidad, indica un paso concreto con `node_id` (parámetro de consulta o campo del cuerpo); si se omite, se modifica el registro KYC más reciente.\n\nEn cada llamada se recalculan dos campos derivados: `full_name` (a partir de `first_name` + `last_name`) y `issuing_state_name` (a partir de `issuing_state`). Si cambia el campo de texto libre `address`, el servidor también puede volver a geocodificarlo y actualizar `parsed_address` (no se hace en las sesiones de sandbox). `extra_fields` y `parsed_address` se combinan clave por clave en lugar de reemplazarse; consulta las descripciones de cada campo para ver la semántica de `null` para eliminar.\n\nEnviar al menos un campo válido dispara el [webhook](/es/integration/webhooks) `data.updated` (disparador `manual_review`), incluso cuando los valores enviados coinciden con los almacenados. Cuando los valores cambian realmente, se añade a las `reviews` de la sesión una entrada de actividad `KYC_DATA_UPDATED` que registra los campos modificados con sus valores anteriores y nuevos, visible en [Obtener decisión](#get-/v3/session/-sessionId-/decision/) y en la cronología de actividad de la consola. El estado y la decisión de la sesión **no** se vuelven a evaluar; usa [Actualizar estado](#patch-/v3/session/-sessionId-/update-status/) para cambiar el resultado. Se acepta un cuerpo JSON vacío (`{}`), que simplemente devuelve los datos KYC actuales sin disparar el webhook.\n\nAcepta una clave de API o un token de usuario de la consola; en ambos casos, la credencial necesita el permiso `write:sessions`. Los fallos de autenticación y de permisos devuelven `403`: esta API nunca responde `401`. Ten en cuenta que la búsqueda de la sesión se ejecuta antes de comprobar las credenciales, por lo que un `sessionId` desconocido devuelve `404` incluso sin credenciales. Este endpoint tiene un límite de solicitudes propio de 10 solicitudes por minuto por clave de API (las solicitudes no válidas también cuentan); también se aplica el presupuesto compartido de escritura de 300 solicitudes por minuto.", "operationId": "patch_v3_session_update_data", "x-didit-sdk": { "resource": "sessions", "method": "update_data", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de Verificación de usuarios (KYC) cuyos datos extraídos del documento estás corrigiendo. Los ID de sesión de empresa (KYB) no son válidos aquí: para los datos de la empresa, usa [Actualizar datos de la empresa KYB](#patch-/v3/session/-sessionId-/kyb/-companyUuid-/update-data/).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nodo del grafo del flujo cuyo registro KYC se va a modificar, para flujos basados en grafo con varios pasos de verificación de identidad (también se acepta como campo `node_id` en el cuerpo). Si se omite, se modifica el registro KYC más reciente de la sesión. Si no existe ningún KYC para el nodo indicado, la llamada devuelve `404` (`\"The session does not have a KYC for node ''.\"`).", "schema": { "type": "string", "example": "feature_ocr" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Todos los campos son opcionales: envía solo lo que quieras cambiar.", "properties": { "document_type": { "type": "string", "description": "Código del tipo de documento. Acepta los códigos cortos indicados en el enum, además de seis alias en forma larga que el servidor normaliza antes de la validación: `Passport` → `P`, `Identity Card` → `ID`, `Driver's License` → `DL`, `Residence Permit` → `RP`, `Health Insurance Card` → `HIC`, `Tax Card` → `TC`. Cualquier otro valor (incluido `PASSPORT` en mayúsculas) devuelve `400`.", "enum": [ "P", "DL", "ID", "RP", "SSC", "HIC", "WP", "TC", "VISA", "PSC", "BC", "OTHER" ], "nullable": true, "example": "P" }, "document_subtype": { "type": "string", "maxLength": 128, "nullable": true, "description": "Subtipo de documento según el registro de documentos, incluido el prefijo de región cuando el registro distingue variantes regionales." }, "document_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Número de documento tal como aparece impreso en el documento de identidad.", "example": "PAB123456" }, "personal_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Número de identificación personal o nacional cuando el documento lo incluye (p. ej., el DNI español en un pasaporte).", "example": "99999999R" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Fecha de nacimiento en formato `YYYY-MM-DD`. Cualquier otro formato devuelve `400`.", "example": "1980-01-01" }, "date_of_issue": { "type": "string", "format": "date", "nullable": true, "description": "Fecha de emisión del documento en formato `YYYY-MM-DD`." }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "description": "Fecha de caducidad del documento en `YYYY-MM-DD`." }, "issuing_state": { "type": "string", "nullable": true, "description": "País emisor como código ISO 3166-1 alpha-3. No distingue entre mayúsculas y minúsculas (`esp` se almacena como `ESP`); el `issuing_state_name` legible que se muestra en [Get Decision](#get-/v3/session/-sessionId-/decision/) se recalcula a partir de este valor. Los códigos no válidos devuelven `400`.", "example": "ESP" }, "first_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nombre(s) de pila. El `full_name` almacenado se vuelve a calcular como `first_name + ' ' + last_name` en cada llamada a este endpoint.", "example": "Carmen" }, "last_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Apellido(s). También se usa para recalcular `full_name`.", "example": "Espanola Espanola" }, "gender": { "type": "string", "enum": [ "M", "F", "U" ], "nullable": true, "description": "Sexo tal como figura impreso en el documento: `M` (masculino), `F` (femenino) o `U` (desconocido). Cualquier otro valor, incluido `X`, devuelve `400`." }, "address": { "type": "string", "maxLength": 255, "nullable": true, "description": "Dirección en texto libre tal como aparece impresa en el documento. Cuando este valor cambia (solo en sesiones que no son de sandbox) y la dirección estructurada todavía falta o está incompleta, el servidor la vuelve a geocodificar de forma síncrona antes de responder: el cuerpo de la respuesta 200 ya refleja el `parsed_address` actualizado. La nueva geocodificación también requiere que `issuing_state` esté presente en el registro de KYC." }, "place_of_birth": { "type": "string", "maxLength": 255, "nullable": true, "description": "Lugar de nacimiento tal como aparece impreso en el documento." }, "nationality": { "type": "string", "maxLength": 32, "nullable": true, "description": "Nacionalidad tal como figura impresa en el documento. Texto libre de hasta 32 caracteres: normalmente un código ISO 3166-1 alfa-3 (p. ej., `ESP`), pero no se valida como tal." }, "marital_status": { "type": "string", "enum": [ "SINGLE", "MARRIED", "DIVORCED", "WIDOWED", "UNKNOWN" ], "description": "Estado civil, cuando el documento lo incluye. Cualquier otro valor devuelve `400`." }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Sobrescrituras por clave de los campos adicionales específicos del documento (p. ej., `blood_group`, `dl_categories`, `mrz_string`). Las claves se combinan con el mapa de sobrescrituras existente: envía una clave con un valor para establecerla, o con `null` / `\"\"` para eliminar esa clave de la vista combinada. Envía el campo completo como `null` para borrar todas las sobrescrituras aplicadas anteriormente. Debe ser un objeto JSON; de lo contrario, se devuelve `400`. La respuesta siempre devuelve la vista combinada (los valores extraídos por OCR con tus sobrescrituras aplicadas)." }, "parsed_address": { "type": "object", "nullable": true, "description": "Dirección estructurada. Solo se aceptan estas claves anidadas: `address_type`, `city`, `region`, `street_1`, `street_2`, `postal_code`, `country`; cualquier otra clave devuelve `400`. Semántica por clave: un valor establece la clave y `null` la elimina. `formatted_address` se recalcula en el servidor uniendo `street_1`, `street_2`, `city`, `region`, `postal_code` y `country`, y se devuelve en la respuesta; no puedes establecerlo directamente.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Clasificación libre de la dirección (p. ej., `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Estado / provincia / comunidad autónoma." }, "street_1": { "type": "string", "nullable": true, "example": "Avda de Madrid 34" }, "street_2": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true, "example": "28013" }, "country": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alfa-2. Las entradas en minúsculas se normalizan a mayúsculas; los códigos alfa-3 se rechazan con `400`.", "example": "ES" } } } } }, "examples": { "Correct name and DOB": { "summary": "Corregir el nombre, la fecha de nacimiento y la dirección estructurada mal leídos por OCR", "value": { "first_name": "Carmen", "last_name": "Espanola Espanola", "date_of_birth": "1980-01-01", "issuing_state": "ESP", "marital_status": "MARRIED", "extra_fields": { "blood_group": "O+" }, "parsed_address": { "street_1": "Avda de Madrid 34", "city": "Madrid", "postal_code": "28013", "country": "ES" } } }, "Remove an extra field": { "summary": "Eliminar una clave de campo adicional y conservar el resto", "value": { "extra_fields": { "blood_group": null } } }, "Long-form document type": { "summary": "El alias en forma larga se normaliza al código corto (aquí, P)", "value": { "document_type": "Passport" } } } } } }, "responses": { "200": { "description": "Datos KYC actualizados. Devuelve el **registro KYC actual completo** (cada campo actualizable con su valor almacenado, además de los `extra_fields` combinados y el `parsed_address` actual), no solo los campos que enviaste. El webhook `data.updated` se dispara cuando el payload contenía al menos un campo válido.", "content": { "application/json": { "schema": { "type": "object", "properties": { "document_type": { "type": "string", "description": "Código del tipo de documento. Acepta los códigos cortos indicados en el enum, además de seis alias en forma larga que el servidor normaliza antes de la validación: `Passport` → `P`, `Identity Card` → `ID`, `Driver's License` → `DL`, `Residence Permit` → `RP`, `Health Insurance Card` → `HIC`, `Tax Card` → `TC`. Cualquier otro valor (incluido `PASSPORT` en mayúsculas) devuelve `400`.", "enum": [ "P", "DL", "ID", "RP", "SSC", "HIC", "WP", "TC", "VISA", "PSC", "BC", "OTHER" ], "nullable": true, "example": "P" }, "document_subtype": { "type": "string", "maxLength": 128, "nullable": true, "description": "Subtipo de documento según el registro de documentos, incluido el prefijo de región cuando el registro distingue variantes regionales." }, "document_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Número de documento tal como aparece impreso en el documento de identidad.", "example": "PAB123456" }, "personal_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Número de identificación personal o nacional cuando el documento lo incluye (p. ej., el DNI español en un pasaporte).", "example": "99999999R" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Fecha de nacimiento en formato `YYYY-MM-DD`. Cualquier otro formato devuelve `400`.", "example": "1980-01-01" }, "date_of_issue": { "type": "string", "format": "date", "nullable": true, "description": "Fecha de emisión del documento en formato `YYYY-MM-DD`." }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "description": "Fecha de caducidad del documento en `YYYY-MM-DD`." }, "issuing_state": { "type": "string", "nullable": true, "description": "País emisor como código ISO 3166-1 alpha-3. No distingue entre mayúsculas y minúsculas (`esp` se almacena como `ESP`); el `issuing_state_name` legible que se muestra en [Get Decision](#get-/v3/session/-sessionId-/decision/) se recalcula a partir de este valor. Los códigos no válidos devuelven `400`.", "example": "ESP" }, "first_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nombre(s) de pila. El `full_name` almacenado se vuelve a calcular como `first_name + ' ' + last_name` en cada llamada a este endpoint.", "example": "Carmen" }, "last_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Apellido(s). También se usa para recalcular `full_name`.", "example": "Espanola Espanola" }, "gender": { "type": "string", "enum": [ "M", "F", "U" ], "nullable": true, "description": "Sexo tal como figura impreso en el documento: `M` (masculino), `F` (femenino) o `U` (desconocido). Cualquier otro valor, incluido `X`, devuelve `400`." }, "address": { "type": "string", "maxLength": 255, "nullable": true, "description": "Dirección en texto libre tal como aparece impresa en el documento. Cuando este valor cambia (solo en sesiones que no son de sandbox) y la dirección estructurada todavía falta o está incompleta, el servidor la vuelve a geocodificar en segundo plano durante la misma solicitud y puede sobrescribir `parsed_address` con el resultado del geocodificador." }, "place_of_birth": { "type": "string", "maxLength": 255, "nullable": true, "description": "Lugar de nacimiento tal como aparece impreso en el documento." }, "nationality": { "type": "string", "maxLength": 32, "nullable": true, "description": "Nacionalidad tal como figura impresa en el documento. Texto libre de hasta 32 caracteres: normalmente un código ISO 3166-1 alfa-3 (p. ej., `ESP`), pero no se valida como tal." }, "marital_status": { "type": "string", "enum": [ "SINGLE", "MARRIED", "DIVORCED", "WIDOWED", "UNKNOWN" ], "description": "Estado civil, cuando el documento lo incluye. Cualquier otro valor devuelve `400`." }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Vista combinada de los campos adicionales del documento: los valores extraídos por OCR con todas las modificaciones del operador aplicadas. Las claves eliminadas mediante una modificación `null` no aparecen en este mapa." }, "parsed_address": { "type": "object", "nullable": true, "description": "Dirección estructurada actual (sin las claves internas de control), o `null` si no existe. Incluye el `formatted_address` recalculado junto con las siete claves editables.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Clasificación libre de la dirección (p. ej., `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Estado / provincia / comunidad autónoma." }, "street_1": { "type": "string", "nullable": true, "example": "Avda de Madrid 34" }, "street_2": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true, "example": "28013" }, "country": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alfa-2. Las entradas en minúsculas se normalizan a mayúsculas; los códigos alfa-3 se rechazan con `400`.", "example": "ES" }, "formatted_address": { "type": "string", "nullable": true, "description": "Forma unida y legible de la dirección estructurada. Se recalcula en el servidor después de cada edición de `parsed_address`.", "example": "Avda de Madrid 34, Madrid, 28013, ES" } } } } }, "examples": { "Updated KYC": { "summary": "Registro KYC completo tras la corrección", "value": { "document_type": "P", "document_subtype": null, "document_number": "PAB123456", "personal_number": "99999999R", "date_of_birth": "1980-01-01", "date_of_issue": "2021-02-09", "expiration_date": "2031-02-08", "issuing_state": "ESP", "first_name": "Carmen", "last_name": "Espanola Espanola", "gender": "F", "address": "AVDA DE MADRID 34, MADRID, MADRID 28013", "place_of_birth": "MADRID", "nationality": "ESP", "marital_status": "MARRIED", "extra_fields": { "mrz_string": "P\": [\"\"]}`; los errores en claves anidadas de `parsed_address` / `extra_fields` usan un objeto como valor: `{\"parsed_address\": {\"\": \"\"}}`.", "content": { "application/json": { "examples": { "Invalid gender": { "summary": "gender debe ser M, F o U", "value": { "gender": [ "\"X\" is not a valid choice." ] } }, "Invalid document type": { "summary": "No es un código corto ni un alias en formato largo", "value": { "document_type": [ "\"PASSPORT\" is not a valid choice." ] } }, "Invalid issuing state": { "summary": "issuing_state no es un código ISO 3166-1 alpha-3", "value": { "issuing_state": [ "Invalid ISO 3166-1 alpha-3 country code for issuing_state." ] } }, "Invalid marital status": { "summary": "marital_status no es un valor del enum", "value": { "marital_status": [ "\"ENGAGED\" is not a valid choice." ] } }, "Bad date format": { "summary": "Las fechas deben tener el formato YYYY-MM-DD", "value": { "date_of_birth": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } }, "Unsupported parsed_address key": { "summary": "Solo se permiten las siete claves documentadas", "value": { "parsed_address": { "zipcode": "Unsupported key. Allowed keys: address_type, city, region, street_1, street_2, postal_code, country" } } }, "Invalid parsed_address country": { "summary": "El país anidado debe estar en formato alfa-2, no alfa-3", "value": { "parsed_address": { "country": "Invalid ISO 3166-1 alpha-2 country code." } } }, "extra_fields not an object": { "summary": "extra_fields debe ser un objeto JSON", "value": { "extra_fields": [ "This field must be a JSON object." ] } } } } } }, "403": { "description": "Faltan las credenciales o los permisos son insuficientes. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente o no válido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La credencial no tiene write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Sesión desconocida, sesión en un estado no editable o ningún registro de KYC que modificar. Cada caso tiene un mensaje `detail` distinto (consulta los ejemplos). La búsqueda de sesión desconocida se ejecuta antes de las comprobaciones de credenciales.", "content": { "application/json": { "examples": { "Unknown session": { "summary": "No hay ninguna sesión con este ID en tu aplicación (o se eliminó)", "value": { "detail": "Not found." } }, "Wrong session state": { "summary": "La sesión existe, pero no está en estado Approved / Declined / In Review / Kyc Expired", "value": { "detail": "No Session matches the given query." } }, "No KYC record": { "summary": "El flujo nunca ejecutó un paso de verificación de identidad", "value": { "detail": "The session does not have a KYC." } }, "No KYC for node": { "summary": "Se indicó node_id, pero no existe ningún KYC para él", "value": { "detail": "The session does not have a KYC for node 'feature_missing'." } } } } } }, "429": { "description": "Se superó el límite de solicitudes dedicado: 10 actualizaciones de datos de KYC por minuto por clave de API (las solicitudes rechazadas cuentan para el cupo). El cupo compartido de escritura de 300/min también puede activarse con su propio mensaje. Revisa `Retry-After` y los encabezados de respuesta `X-RateLimit-*` antes de reintentar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Cupo de actualizaciones KYC agotado", "value": { "detail": "Session KYC data update rate limit exceeded. You can make up to 10 requests per minute." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-data/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"first_name\": \"Carmen\",\n \"last_name\": \"Espanola Espanola\",\n \"date_of_birth\": \"1980-01-01\",\n \"issuing_state\": \"ESP\",\n \"parsed_address\": {\n \"street_1\": \"Avda de Madrid 34\",\n \"city\": \"Madrid\",\n \"postal_code\": \"28013\",\n \"country\": \"ES\"\n }\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_data(\n \"11111111-2222-3333-4444-555555555555\",\n date_of_birth=\"1980-01-01\",\n issuing_state=\"ESP\",\n first_name=\"Carmen\",\n last_name=\"Espanola Espanola\",\n marital_status=\"MARRIED\",\n extra_fields={\"blood_group\": \"O+\"},\n parsed_address={\n \"city\": \"Madrid\",\n \"street_1\": \"Avda de Madrid 34\",\n \"postal_code\": \"28013\",\n \"country\": \"ES\",\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateData(\"11111111-2222-3333-4444-555555555555\", {\n date_of_birth: \"1980-01-01\",\n issuing_state: \"ESP\",\n first_name: \"Carmen\",\n last_name: \"Espanola Espanola\",\n marital_status: \"MARRIED\",\n extra_fields: { blood_group: \"O+\" },\n parsed_address: {\n city: \"Madrid\",\n street_1: \"Avda de Madrid 34\",\n postal_code: \"28013\",\n country: \"ES\",\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateData(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsUpdateDataParams{\n\tDateOfBirth: didit.String(\"1980-01-01\"),\n\tIssuingState: didit.String(\"ESP\"),\n\tFirstName: didit.String(\"Carmen\"),\n\tLastName: didit.String(\"Espanola Espanola\"),\n\tMaritalStatus: didit.Some(didit.SessionsUpdateDataParamsMaritalStatus(\"MARRIED\")),\n\tExtraFields: didit.Some(map[string]any{\"blood_group\": \"O+\"}),\n\tParsedAddress: didit.Some(didit.SessionsUpdateDataParamsParsedAddress{\n\t\tCity: didit.String(\"Madrid\"),\n\t\tStreet1: didit.String(\"Avda de Madrid 34\"),\n\t\tPostalCode: didit.String(\"28013\"),\n\t\tCountry: didit.String(\"ES\"),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsUpdateDataParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateData(\"11111111-2222-3333-4444-555555555555\", SessionsUpdateDataParams.builder()\n .dateOfBirth(LocalDate.parse(\"1980-01-01\"))\n .issuingState(\"ESP\")\n .firstName(\"Carmen\")\n .lastName(\"Espanola Espanola\")\n .maritalStatus(SessionsUpdateDataParams.MaritalStatus.of(\"MARRIED\"))\n .extraFields(Map.of(\"blood_group\", \"O+\"))\n .parsedAddress(SessionsUpdateDataParams.ParsedAddress.builder()\n .city(\"Madrid\")\n .street1(\"Avda de Madrid 34\")\n .postalCode(\"28013\")\n .country(\"ES\")\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateData('11111111-2222-3333-4444-555555555555', [\n 'date_of_birth' => '1980-01-01',\n 'issuing_state' => 'ESP',\n 'first_name' => 'Carmen',\n 'last_name' => 'Espanola Espanola',\n 'marital_status' => 'MARRIED',\n 'extra_fields' => ['blood_group' => 'O+'],\n 'parsed_address' => [\n 'city' => 'Madrid',\n 'street_1' => 'Avda de Madrid 34',\n 'postal_code' => '28013',\n 'country' => 'ES',\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_data(\n \"11111111-2222-3333-4444-555555555555\",\n date_of_birth: \"1980-01-01\",\n issuing_state: \"ESP\",\n first_name: \"Carmen\",\n last_name: \"Espanola Espanola\",\n marital_status: \"MARRIED\",\n extra_fields: { blood_group: \"O+\" },\n parsed_address: {\n city: \"Madrid\",\n street_1: \"Avda de Madrid 34\",\n postal_code: \"28013\",\n country: \"ES\",\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateDataAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsUpdateDataParams\n{\n DateOfBirth = \"1980-01-01\",\n IssuingState = \"ESP\",\n FirstName = \"Carmen\",\n LastName = \"Espanola Espanola\",\n MaritalStatus = new SessionsUpdateDataParamsMaritalStatus(\"MARRIED\"),\n ExtraFields = new Dictionary { [\"blood_group\"] = \"O+\" },\n ParsedAddress = new SessionsUpdateDataParamsParsedAddress\n {\n City = \"Madrid\",\n Street1 = \"Avda de Madrid 34\",\n PostalCode = \"28013\",\n Country = \"ES\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/features/{nodeId}/update-status/": { "patch": { "summary": "Actualizar el estado de una función individual (paso)", "description": "Establece el estado de una única función de verificación (paso) dentro de una sesión. Indica la función mediante su `nodeId` del grafo del flujo de verificación (workflow). En los flujos que no son de grafo, cuyos pasos no tienen nodo, usa `default` y pasa también `feature_type` para indicar a qué paso te refieres.\n\nFunciona tanto para sesiones de Verificación de usuarios (KYC) como de Verificación de empresas (KYB) y para todos los tipos de paso: ID/OCR, Prueba de vida, Coincidencia facial, NFC, AML, Prueba de domicilio, Teléfono, Correo electrónico, Validación de base de datos, Cuestionario y las comprobaciones de registro / documentos / personas clave de KYB. Este endpoint **no** está disponible para las sesiones de API independientes (`session_type = API`).\n\n`new_status` debe ser `Approved`, `Declined` o `In Review`, y debe ser distinto del estado actual de la función.\n\n**Cuándo se aplica la anulación.** Sin `defer_until_flow_finishes` (o con `false`), la anulación se aplica de inmediato, como siempre; si la persona sigue en el flujo, se registra como `forced`. Con `defer_until_flow_finishes: true` mientras la persona sigue en el flujo (la sesión está en `Not Started`, `In Progress` o `Resubmitted` y no ha terminado), la anulación se guarda como `pending_until_flow_finishes` y se aplica cuando termina el flujo, después de que el flujo llegue a su propia decisión. En una sesión cuyo flujo ya terminó, se aplica de inmediato en cualquier caso. En cambio, una anulación en espera se cancela cuando la persona repite su paso antes de terminar, cuando una anulación más reciente sobre la misma comprobación la reemplaza, cuando la sesión sale del flujo sin terminarlo (abandonada, expirada o decidida a mitad del flujo) o cuando la cancelas con `POST /v3/session/{sessionId}/features/overrides/{overrideId}/cancel/`. Consulta las anulaciones de una sesión con `GET /v3/session/{sessionId}/features/overrides/`.\n\n**Efecto en la sesión.** Una sesión que ya tiene una decisión la conserva: solo cambia la comprobación. Cuando la sesión aún no tiene decisión y su flujo está esperando exactamente este paso, aplicar la anulación completa el paso: el flujo avanza, se ejecutan los pasos siguientes y un nodo de estado puede establecer la decisión de la sesión y disparar `status.updated`.\n\n**Webhooks y actividad.** Se dispara un webhook `data.updated` cuando se aplica la anulación (de inmediato o cuando termina el flujo), nunca mientras está en espera ni cuando se cancela. Cada anulación se registra en la actividad de la sesión como `FEATURE_OVERRIDE_PENDING`, `FEATURE_OVERRIDE_APPLIED` o `FEATURE_OVERRIDE_CANCELLED`, junto con quién la hizo; la entrada de la solicitud incluye tu `comment`.\n\nAutentícate con tu clave de API (`x-api-key`) o con un encabezado de autorización de usuario que tenga el privilegio `write:sessions`; una clave de API con alcance limitado necesita acceso de escritura a las decisiones.", "operationId": "patch_v3_session_update_feature_status", "x-didit-sdk": { "resource": "sessions", "method": "update_feature_status", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sesión de verificación. Acepta ID de sesión tanto de usuario (KYC) como de empresa (KYB): el servicio resuelve el ID en ambos tipos de sesión.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "in": "path", "name": "nodeId", "required": true, "description": "ID del nodo del grafo del flujo correspondiente a la función que se va a actualizar (por ejemplo, `feature_ocr_1`). Usa el valor literal `default` para flujos que no se basan en grafo (de un solo paso), en los que la función no tiene ID de nodo.", "schema": { "type": "string", "example": "feature_ocr_1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "new_status" ], "properties": { "new_status": { "type": "string", "description": "Estado de destino para esta función. Debe ser distinto del valor actual.", "enum": [ "Approved", "Declined", "In Review" ], "example": "Approved" }, "comment": { "type": "string", "description": "Nota opcional en texto libre que se registra en el historial de revisión de la sesión para este cambio de función.", "example": "Document manually verified by compliance." }, "feature_type": { "type": "string", "enum": [ "ID_VERIFICATION", "OCR", "OCR_BACK", "NFC", "LIVENESS", "FACE", "AGE_ESTIMATION", "AGE_VERIFICATION", "FACE_SEARCH", "FACE_MATCH", "IP_ANALYSIS", "AML", "PHONE", "PHONE_VERIFICATION", "EMAIL", "EMAIL_VERIFICATION", "POA", "PROOF_OF_ADDRESS", "DATABASE_VALIDATION", "DATA_VALIDATION", "QUESTIONNAIRE", "DOCUMENT_AI", "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE", "BANK_VERIFICATION", "GEOLOCATION" ], "description": "Qué tipo de paso se quiere seleccionar. Es obligatorio en los flujos que no son de grafo (`nodeId` = `default`), donde los pasos no tienen nodo propio; en los demás casos es opcional. Un valor desconocido devuelve `400`.", "example": "LIVENESS" }, "defer_until_flow_finishes": { "type": "boolean", "default": false, "description": "Mientras la persona sigue en el flujo, guarda la anulación como `pending_until_flow_finishes` y aplícala cuando el flujo termine, en lugar de hacerlo de inmediato. Si se omite o es `false`, la anulación se aplica de inmediato. En una sesión cuyo flujo ya terminó, se aplica de inmediato en ambos casos.", "example": false } } }, "examples": { "Apply Now": { "summary": "Aprobar el paso de ID de inmediato", "value": { "new_status": "Approved", "comment": "Document manually verified by compliance." } }, "Wait For The Flow": { "summary": "Aprobar el paso de prueba de vida cuando la persona termine el flujo", "value": { "new_status": "Approved", "comment": "Liveness retried with a reviewer present.", "defer_until_flow_finishes": true } }, "Non-graph Workflow": { "summary": "Apuntar al paso de prueba de vida de un flujo sin nodos (nodeId = default)", "value": { "new_status": "In Review", "feature_type": "LIVENESS" } } } } } }, "responses": { "200": { "description": "Se registró la anulación. `new_status` es el estado de la comprobación tal como está almacenado: el solicitado una vez aplicada la anulación, o el que no ha cambiado mientras espera a que termine el flujo. `override` indica qué ocurrió.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid" }, "node_id": { "type": "string", "nullable": true, "description": "El nodo del flujo del paso actualizado, o `null` para un paso sin nodo (la ruta `default` en un flujo que no es de grafo).", "example": "feature_ocr_1" }, "feature_type": { "type": "string", "description": "Nombre del modelo de la función actualizada (p. ej., `KYC`, `Face`, `FaceMatch`, `AML`, `POA`).", "example": "KYC" }, "new_status": { "type": "string", "description": "El estado almacenado de la comprobación: el solicitado una vez aplicada la anulación manual, o el original sin cambios mientras la anulación espera a que termine el flujo.", "example": "Approved" }, "override": { "$ref": "#/components/schemas/FeatureStatusOverride" } }, "required": [ "session_id", "node_id", "feature_type", "new_status", "override" ] }, "examples": { "Applied": { "summary": "La anulación se aplicó de inmediato", "value": { "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "node_id": "feature_ocr_1", "feature_type": "KYC", "new_status": "Approved", "override": { "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "node_id": "feature_ocr_1", "feature_type": "", "feature_model": "KYC", "previous_status": "In Review", "new_status": "Approved", "state": "applied", "forced": false, "reason": "Document manually verified by compliance.", "requested_by": { "email": "reviewer@example.com", "name": "Alex Reviewer", "type": "CONSOLE_USER" }, "requested_at": "2026-10-13T09:15:00Z", "applied_at": "2026-10-13T09:15:00Z", "cancelled_at": null, "cancel_reason": null } } }, "Waiting For The Flow": { "summary": "defer_until_flow_finishes mientras la persona sigue en el flujo", "value": { "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "node_id": "feature_liveness_1", "feature_type": "Face", "new_status": "Declined", "override": { "id": "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3", "node_id": "feature_liveness_1", "feature_type": "", "feature_model": "Face", "previous_status": "Declined", "new_status": "Approved", "state": "pending_until_flow_finishes", "forced": false, "reason": "Liveness retried with a reviewer present.", "requested_by": { "email": "reviewer@example.com", "name": "Alex Reviewer", "type": "CONSOLE_USER" }, "requested_at": "2026-10-13T09:15:00Z", "applied_at": null, "cancelled_at": null, "cancel_reason": null } } } } } } }, "400": { "description": "Error de validación. Se devuelve cuando `new_status` no es válido o no cambia, cuando `feature_type` es desconocido o cuando la sesión es una sesión de API independiente.", "content": { "application/json": { "examples": { "Same Status": { "summary": "new_status es igual al estado actual", "value": { "new_status": [ "The new status is the same as the current status." ] } }, "API Session": { "summary": "El estado de la función no se puede cambiar en las sesiones de API independientes", "value": [ "Cannot change feature status for API sessions." ] }, "Unknown feature_type": { "summary": "feature_type no es un tipo de paso conocido", "value": { "feature_type": [ "Unknown feature_type 'SELFIE'." ] } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Clave de API con alcance limitado con la fecha de caducidad vencida", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Faltan las credenciales o los permisos son insuficientes.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente o no válido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La clave de API no tiene el permiso write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Clave de API con alcance limitado sin acceso de escritura a las decisiones", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "No se encontró la sesión, o no tiene ninguna función con el `nodeId` indicado.", "content": { "application/json": { "examples": { "Session Not Found": { "summary": "session_id desconocido", "value": { "detail": "Session not found." } }, "Feature Not Found": { "summary": "No hay ninguna función para este node_id", "value": { "detail": "No feature found with node_id 'feature_ocr_1' in this session." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/features/feature_ocr_1/update-status/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"new_status\": \"Approved\",\n \"comment\": \"Document manually verified by compliance.\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_feature_status(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_ocr_1\",\n new_status=\"Approved\",\n comment=\"Document manually verified by compliance.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateFeatureStatus(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_ocr_1\",\n {\n new_status: \"Approved\",\n comment: \"Document manually verified by compliance.\",\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateFeatureStatus(ctx, \"11111111-2222-3333-4444-555555555555\", \"feature_ocr_1\", didit.SessionsUpdateFeatureStatusParams{\n\tNewStatus: \"Approved\",\n\tComment: didit.String(\"Document manually verified by compliance.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsUpdateFeatureStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateFeatureStatus(\"11111111-2222-3333-4444-555555555555\", \"feature_ocr_1\", SessionsUpdateFeatureStatusParams.builder()\n .newStatus(SessionsUpdateFeatureStatusParams.NewStatus.of(\"Approved\"))\n .comment(\"Document manually verified by compliance.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateFeatureStatus('11111111-2222-3333-4444-555555555555', 'feature_ocr_1', [\n 'new_status' => 'Approved',\n 'comment' => 'Document manually verified by compliance.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_feature_status(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_ocr_1\",\n new_status: \"Approved\",\n comment: \"Document manually verified by compliance.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateFeatureStatusAsync(\"11111111-2222-3333-4444-555555555555\", \"feature_ocr_1\", new SessionsUpdateFeatureStatusParams\n{\n NewStatus = \"Approved\",\n Comment = \"Document manually verified by compliance.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/update-aml-hit-status/": { "patch": { "summary": "Actualizar el estado de revisión de una coincidencia AML", "description": "Establece el estado de revisión de un **único resultado AML** (una posible coincidencia con sanciones, PEP, listas de vigilancia o medios adversos) devuelto por el análisis AML, sin cambiar la decisión general de la sesión. Identifica el resultado por su `hit_id` (el `id` de una entrada del array `hits` de la comprobación AML; consulta la decisión de la sesión). Se sigue aceptando un id de resultado devuelto en el formato anterior; la respuesta siempre nombra el resultado por su `id` actual.\n\n`review_status` es uno de `Unreviewed`, `Confirmed Match`, `False Positive` o `Inconclusive`. Las decisiones del revisor se conservan en las actualizaciones de la monitorización continua, de modo que un resultado que marques como `False Positive` se mantiene así cuando el proveedor vuelve a analizarlo.\n\nUna llamada exitosa dispara un webhook `data.updated` y añade una entrada de actividad (con atribución del autor) al historial de revisión de la sesión. En los flujos basados en grafos con varias comprobaciones AML, pasa `node_id` para apuntar a una comprobación concreta.\n\nAutentícate con tu clave de API (`x-api-key`) o con un encabezado de autorización de usuario; cualquiera de los dos debe tener el privilegio `write:sessions`.", "operationId": "patch_v3_session_update_aml_hit_status", "x-didit-sdk": { "resource": "sessions", "method": "update_aml_hit_status", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sesión de verificación. Acepta ID de sesión tanto de usuario (KYC) como de empresa (KYB): el servicio resuelve el ID en ambos tipos de sesión.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "in": "query", "name": "node_id", "required": false, "description": "ID del nodo del grafo del flujo. Solo es obligatorio cuando la sesión tiene varios análisis AML (uno por nodo); omítelo en sesiones con un único análisis AML.", "schema": { "type": "string", "example": "feature_aml_1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "hit_id", "review_status" ], "properties": { "hit_id": { "type": "string", "description": "El `id` de la coincidencia en el array `hits` de la comprobación AML (`hit_...`). Se sigue aceptando un id de coincidencia devuelto en el formato anterior.", "example": "hit_7c1e9a40b2d35f86e0a4c912" }, "review_status": { "type": "string", "description": "El nuevo estado de revisión de la coincidencia.", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ], "example": "False Positive" }, "node_id": { "type": "string", "description": "ID de nodo del grafo opcional. Úsalo (aquí o como parámetro de consulta) cuando la sesión tenga varias comprobaciones AML.", "example": "feature_aml_1" } } }, "example": { "hit_id": "hit_7c1e9a40b2d35f86e0a4c912", "review_status": "False Positive" } } } }, "responses": { "200": { "description": "Se actualizó el estado de revisión de la coincidencia.", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "hit_id", "review_status" ], "properties": { "message": { "type": "string", "description": "Siempre `Hit status updated successfully`." }, "hit_id": { "type": "string", "description": "El `id` de la coincidencia actualizada, tal como lo devuelve la decisión de la sesión, también cuando la solicitud identificó la coincidencia con un id en el formato anterior." }, "review_status": { "type": "string", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ], "description": "El estado de revisión que ahora tiene guardado la coincidencia." } } }, "example": { "message": "Hit status updated successfully", "hit_id": "hit_7c1e9a40b2d35f86e0a4c912", "review_status": "False Positive" } } } }, "400": { "description": "Error de validación: `hit_id` está vacío o `review_status` no es uno de los valores permitidos.", "content": { "application/json": { "example": { "review_status": [ "\"Maybe\" is not a valid choice." ] } } } }, "403": { "description": "Faltan las credenciales o los permisos son insuficientes. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente o no válido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La clave de API no tiene el permiso write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No se encontró la sesión, la sesión no tiene ninguna comprobación AML (opcionalmente para el `node_id` indicado) o ninguna coincidencia corresponde a `hit_id`.", "content": { "application/json": { "examples": { "No AML Check": { "summary": "La sesión no tiene ninguna comprobación AML", "value": { "detail": "The session does not have an AML check." } }, "Hit Not Found": { "summary": "hit_id desconocido", "value": { "detail": "Hit with ID 'hit_9d2e7f41c0a8b3e65d1f0c47' not found in the AML check." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-aml-hit-status/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"hit_id\": \"abc123\",\n \"review_status\": \"False Positive\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_aml_hit_status(\n \"11111111-2222-3333-4444-555555555555\",\n hit_id=\"hit_7c1e9a40b2d35f86e0a4c912\",\n review_status=\"False Positive\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateAmlHitStatus(\"11111111-2222-3333-4444-555555555555\", {\n hit_id: \"hit_7c1e9a40b2d35f86e0a4c912\",\n review_status: \"False Positive\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateAMLHitStatus(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsUpdateAMLHitStatusParams{\n\tHitID: \"hit_7c1e9a40b2d35f86e0a4c912\",\n\tReviewStatus: \"False Positive\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsUpdateAmlHitStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateAmlHitStatus(\"11111111-2222-3333-4444-555555555555\", SessionsUpdateAmlHitStatusParams.builder()\n .hitId(\"hit_7c1e9a40b2d35f86e0a4c912\")\n .reviewStatus(SessionsUpdateAmlHitStatusParams.ReviewStatus.of(\"False Positive\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateAmlHitStatus('11111111-2222-3333-4444-555555555555', [\n 'hit_id' => 'hit_7c1e9a40b2d35f86e0a4c912',\n 'review_status' => 'False Positive',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_aml_hit_status(\n \"11111111-2222-3333-4444-555555555555\",\n hit_id: \"hit_7c1e9a40b2d35f86e0a4c912\",\n review_status: \"False Positive\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateAmlHitStatusAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsUpdateAmlHitStatusParams\n{\n HitId = \"hit_7c1e9a40b2d35f86e0a4c912\",\n ReviewStatus = \"False Positive\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/bulk-update-aml-hit-status/": { "patch": { "summary": "Actualizar en bloque los estados de revisión de coincidencias AML", "description": "Actualiza el estado de revisión de **varios resultados AML** en una sola llamada. Proporciona `hit_updates`, una lista de pares `{ hit_id, review_status }`. `review_status` es uno de `Unreviewed`, `Confirmed Match`, `False Positive` o `Inconclusive`.\n\nLa actualización es de todo o nada: si algún `hit_id` no se encuentra en el análisis AML, la solicitud devuelve `404` y no se modifica ningún resultado. Una llamada exitosa dispara un único webhook `data.updated` y registra una sola entrada de actividad que cubre todos los cambios. En los flujos de grafo con varios análisis AML, pasa `node_id` para apuntar a un análisis concreto.\n\nAutentícate con tu clave de API (`x-api-key`) o con un encabezado de autorización de usuario: cualquiera de los dos debe tener el privilegio `write:sessions`.", "operationId": "patch_v3_session_bulk_update_aml_hit_status", "x-didit-sdk": { "resource": "sessions", "method": "bulk_update_aml_hit_status", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sesión de verificación. Acepta ID de sesión tanto de usuario (KYC) como de empresa (KYB): el servicio resuelve el ID en ambos tipos de sesión.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "in": "query", "name": "node_id", "required": false, "description": "ID del nodo del grafo del flujo. Solo es obligatorio cuando la sesión tiene varios análisis AML (uno por nodo); omítelo en sesiones con un único análisis AML.", "schema": { "type": "string", "example": "feature_aml_1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "hit_updates" ], "properties": { "hit_updates": { "type": "array", "description": "Lista no vacía de actualizaciones de coincidencias.", "items": { "type": "object", "required": [ "hit_id", "review_status" ], "properties": { "hit_id": { "type": "string", "example": "hit_7c1e9a40b2d35f86e0a4c912", "description": "El `id` de la coincidencia en el array `hits` de la comprobación AML (`hit_...`). Se sigue aceptando un id de coincidencia devuelto en el formato anterior." }, "review_status": { "type": "string", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ], "example": "Confirmed Match" } } } }, "node_id": { "type": "string", "description": "ID de nodo del grafo opcional. Úsalo (aquí o como parámetro de consulta) cuando la sesión tenga varias comprobaciones AML.", "example": "feature_aml_1" } } }, "example": { "hit_updates": [ { "hit_id": "hit_7c1e9a40b2d35f86e0a4c912", "review_status": "Confirmed Match" }, { "hit_id": "hit_3b8f20d6a91c4e75f0b2d6a8", "review_status": "False Positive" } ] } } } }, "responses": { "200": { "description": "Se actualizaron todas las coincidencias.", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "updated_hits" ], "properties": { "message": { "type": "string", "description": "`Updated {n} hit(s) successfully`, donde `n` es el número de entradas de `hit_updates`." }, "updated_hits": { "type": "array", "items": { "type": "string" }, "description": "El `id` de la coincidencia que nombra cada entrada de `hit_updates`, tal como lo devuelve la decisión de la sesión, en el orden de la solicitud, incluidas las coincidencias cuyo estado no cambió." } } }, "example": { "message": "Updated 2 hit(s) successfully", "updated_hits": [ "hit_7c1e9a40b2d35f86e0a4c912", "hit_3b8f20d6a91c4e75f0b2d6a8" ] } } } }, "400": { "description": "Error de validación: `hit_updates` está vacío, o a una entrada le falta `hit_id` / `review_status` o contiene un valor no válido.", "content": { "application/json": { "example": { "hit_updates": [ "hit_updates cannot be empty" ] } } } }, "403": { "description": "Faltan las credenciales o los permisos son insuficientes. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente o no válido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La clave de API no tiene el permiso write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No se encontró la sesión, la sesión no tiene ninguna comprobación AML o uno o más `hit_id` no existen (en ese caso no se modifica ninguna coincidencia).", "content": { "application/json": { "example": { "detail": "Hits not found: hit_9d2e7f41c0a8b3e65d1f0c47" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/bulk-update-aml-hit-status/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"hit_updates\": [\n { \"hit_id\": \"abc123\", \"review_status\": \"Confirmed Match\" },\n { \"hit_id\": \"def456\", \"review_status\": \"False Positive\" }\n ]\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.bulk_update_aml_hit_status(\n \"11111111-2222-3333-4444-555555555555\",\n hit_updates=[{\n \"hit_id\": \"hit_7c1e9a40b2d35f86e0a4c912\",\n \"review_status\": \"Confirmed Match\",\n }, {\n \"hit_id\": \"hit_3b8f20d6a91c4e75f0b2d6a8\",\n \"review_status\": \"False Positive\",\n }],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.bulkUpdateAmlHitStatus(\"11111111-2222-3333-4444-555555555555\", {\n hit_updates: [{\n hit_id: \"hit_7c1e9a40b2d35f86e0a4c912\",\n review_status: \"Confirmed Match\",\n }, {\n hit_id: \"hit_3b8f20d6a91c4e75f0b2d6a8\",\n review_status: \"False Positive\",\n }],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.BulkUpdateAMLHitStatus(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsBulkUpdateAMLHitStatusParams{\n\tHitUpdates: []didit.SessionsBulkUpdateAMLHitStatusParamsHitUpdates{{\n\t\tHitID: \"hit_7c1e9a40b2d35f86e0a4c912\",\n\t\tReviewStatus: \"Confirmed Match\",\n\t}, {\n\t\tHitID: \"hit_3b8f20d6a91c4e75f0b2d6a8\",\n\t\tReviewStatus: \"False Positive\",\n\t}},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.SessionsBulkUpdateAmlHitStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().bulkUpdateAmlHitStatus(\"11111111-2222-3333-4444-555555555555\", SessionsBulkUpdateAmlHitStatusParams.builder()\n .hitUpdates(List.of(\n SessionsBulkUpdateAmlHitStatusParams.HitUpdates.builder()\n .hitId(\"hit_7c1e9a40b2d35f86e0a4c912\")\n .reviewStatus(SessionsBulkUpdateAmlHitStatusParams.HitUpdates.ReviewStatus.of(\"Confirmed Match\"))\n .build(),\n SessionsBulkUpdateAmlHitStatusParams.HitUpdates.builder()\n .hitId(\"hit_3b8f20d6a91c4e75f0b2d6a8\")\n .reviewStatus(SessionsBulkUpdateAmlHitStatusParams.HitUpdates.ReviewStatus.of(\"False Positive\"))\n .build()))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->bulkUpdateAmlHitStatus('11111111-2222-3333-4444-555555555555', [\n 'hit_updates' => [[\n 'hit_id' => 'hit_7c1e9a40b2d35f86e0a4c912',\n 'review_status' => 'Confirmed Match',\n ], [\n 'hit_id' => 'hit_3b8f20d6a91c4e75f0b2d6a8',\n 'review_status' => 'False Positive',\n ]],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.bulk_update_aml_hit_status(\n \"11111111-2222-3333-4444-555555555555\",\n hit_updates: [{\n hit_id: \"hit_7c1e9a40b2d35f86e0a4c912\",\n review_status: \"Confirmed Match\",\n }, {\n hit_id: \"hit_3b8f20d6a91c4e75f0b2d6a8\",\n review_status: \"False Positive\",\n }]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.BulkUpdateAmlHitStatusAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsBulkUpdateAmlHitStatusParams\n{\n HitUpdates = new SessionsBulkUpdateAmlHitStatusParamsHitUpdates[]\n {\n new()\n {\n HitId = \"hit_7c1e9a40b2d35f86e0a4c912\",\n ReviewStatus = \"Confirmed Match\",\n },\n new()\n {\n HitId = \"hit_3b8f20d6a91c4e75f0b2d6a8\",\n ReviewStatus = \"False Positive\",\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/update-poa-data/": { "patch": { "summary": "Actualizar los datos de Prueba de domicilio extraídos del documento POA en una sesión de verificación", "description": "Corrige los campos extraídos del documento de Prueba de domicilio del usuario (factura de servicios, extracto bancario u otro justificante de domicilio) una vez finalizada la verificación: emisor, fechas, el nombre impreso, la propia dirección y los datos bancarios. Todos los campos del cuerpo son opcionales: solo se escriben las claves que envías y todo lo demás se mantiene intacto (semántica de `PATCH`).\n\nLa sesión debe pertenecer a tu aplicación y estar en estado `Approved`, `Declined`, `In Review` o `Kyc Expired`. Las sesiones en cualquier otro estado (por ejemplo, todavía en `In Progress`) devuelven `404` con `\"No Session matches the given query.\"`, a diferencia del `\"Not found.\"` que se devuelve para un `sessionId` desconocido o eliminado. La sesión también debe tener un registro de POA: las sesiones cuyo flujo de verificación (workflow) nunca ejecutó un paso de Prueba de domicilio devuelven `404` (`\"The session does not have a POA.\"`). En los flujos de grafo con varios pasos de POA, indica un paso concreto con `node_id` (parámetro de consulta o campo del cuerpo); si se omite, se modifica el registro de POA más reciente.\n\n`extra_fields` se fusiona clave por clave: nueve claves conocidas (`bank_iban`, `additional_names`, …) se escriben directamente en columnas dedicadas de POA, cualquier otra clave se conserva como un campo extra personalizado, y `null` / `\"\"` elimina una clave. `poa_parsed_address` solo acepta las siete claves documentadas y recalcula `formatted_address` / `poa_formatted_address` después de cada edición. Si cambia el campo de texto libre `poa_address`, el servidor también puede volver a geocodificarlo y actualizar la dirección estructurada (esto se omite en las sesiones de sandbox).\n\nA diferencia de la variante KYC de este endpoint, el [webhook](/es/integration/webhooks) `data.updated` (disparador `manual_review`) solo se envía cuando al menos un valor almacenado **cambia realmente**: volver a enviar valores idénticos no produce ningún efecto ni aviso. Cuando los valores cambian, se añade a los `reviews` de la sesión una entrada de actividad `POA_DATA_UPDATED` que registra los campos modificados con sus valores anteriores y nuevos, visible en [Obtener decisión](#get-/v3/session/-sessionId-/decision/) y en la cronología de actividad de la consola. El estado y la decisión de la sesión **no** se vuelven a evaluar: usa [Actualizar estado](#patch-/v3/session/-sessionId-/update-status/) para cambiar el resultado.\n\nAcepta una clave de API o un token de usuario de la consola; en ambos casos, la credencial necesita el permiso `write:sessions`. Tanto los fallos de autenticación como los de permisos devuelven `403`: esta API nunca responde `401`. Ten en cuenta que la búsqueda de la sesión se ejecuta antes de comprobar las credenciales, por lo que un `sessionId` desconocido devuelve `404` incluso sin credenciales. Este endpoint tiene un límite de solicitudes propio de 10 solicitudes por minuto por clave de API (las solicitudes no válidas también cuentan); además, se aplica el presupuesto compartido de escritura de 300 solicitudes por minuto.\n\nUn cuerpo JSON vacío `{}` no produce ningún efecto: devuelve `200` con el registro de POA actual sin enviar el webhook (`has_changes` sigue siendo false).", "operationId": "patch_v3_session_update_poa_data", "x-didit-sdk": { "resource": "sessions", "method": "update_poa_data", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de Verificación de usuarios (KYC) cuyo registro de prueba de domicilio adjunto estás corrigiendo.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nodo del grafo del flujo cuyo registro POA se va a modificar, para flujos basados en grafo con varios pasos de prueba de domicilio (también se acepta como campo `node_id` en el cuerpo). Si se omite, se modifica el registro POA más reciente de la sesión. Si no existe ningún POA para el nodo indicado, la llamada devuelve `404` (`\"The session does not have a POA for node ''.\"`).", "schema": { "type": "string", "example": "feature_poa" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Todos los campos son opcionales: envía solo lo que quieras cambiar.", "properties": { "issuing_state": { "type": "string", "nullable": true, "description": "País que emitió el documento de prueba de domicilio, ISO 3166-1 alfa-3. No distingue entre mayúsculas y minúsculas (se normaliza a mayúsculas); los códigos no válidos devuelven `400`.", "example": "ESP" }, "document_type": { "type": "string", "enum": [ "UTILITY_BILL", "BANK_STATEMENT", "GOVERNMENT_ISSUED_DOCUMENT", "OTHER_POA_DOCUMENT", "UNKNOWN" ], "description": "Categoría del documento de POA. Los valores van en mayúsculas: las variantes en minúsculas como `utility_bill` devuelven `400`.", "example": "UTILITY_BILL" }, "document_language": { "type": "string", "maxLength": 50, "nullable": true, "description": "Idioma del documento, normalmente un código ISO 639-1 (p. ej., `es`). Texto libre: no se valida como código de idioma.", "example": "es" }, "issuer": { "type": "string", "maxLength": 255, "nullable": true, "description": "Organización que emitió el documento (empresa de servicios públicos, banco, organismo gubernamental).", "example": "Energy Provider S.A." }, "issue_date": { "type": "string", "format": "date", "nullable": true, "description": "Fecha de emisión del documento de prueba de domicilio en formato `YYYY-MM-DD`. Cualquier otro formato devuelve `400`.", "example": "2026-04-12" }, "poa_address": { "type": "string", "nullable": true, "description": "Dirección en texto libre tal como aparece impresa en el documento. Cuando este valor cambia (solo en sesiones que no son de sandbox) y la dirección estructurada todavía falta o está incompleta, el servidor la vuelve a geocodificar en segundo plano durante la misma solicitud y puede sobrescribir `poa_parsed_address` / `poa_formatted_address` con el resultado del geocodificador. La nueva geocodificación también requiere que `issuing_state` esté presente en el registro de prueba de domicilio.", "example": "Avda de Madrid 34, 28013 Madrid" }, "name_on_document": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nombre del destinatario tal como figura impreso en el documento.", "example": "Carmen Espanola" }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Datos adicionales propios del documento, combinados clave por clave. Nueve claves corresponden a columnas dedicadas de prueba de domicilio: `bank_account_number`, `bank_iban`, `bank_sort_code`, `bank_routing_number`, `bank_swift_bic`, `bank_branch_name`, `bank_branch_address`, `document_phone_number` y `additional_names` (debe ser una lista de cadenas o `null`; de lo contrario, `400`). Cualquier otra clave se guarda como campo adicional personalizado. Semántica por clave: un valor establece la clave; `null` o `\"\"` la elimina. Debe ser un objeto JSON; de lo contrario, `400`." }, "poa_parsed_address": { "type": "object", "nullable": true, "description": "Dirección estructurada. Solo se aceptan estas claves anidadas: `address_type`, `city`, `region`, `street_1`, `street_2`, `postal_code`, `country`; cualquier otra clave devuelve `400`. Semántica por clave: un valor establece la clave y `null` la elimina. `formatted_address` (y el `poa_formatted_address` de nivel superior) se recalcula en el servidor uniendo `street_1`, `street_2`, `city`, `region`, `postal_code` y `country`; no puedes establecerlo directamente.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Clasificación libre de la dirección (p. ej., `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Estado / provincia / comunidad autónoma." }, "street_1": { "type": "string", "nullable": true, "example": "Avda de Madrid 34" }, "street_2": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true, "example": "28013" }, "country": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alfa-2. Las entradas en minúsculas se normalizan a mayúsculas; los códigos alfa-3 se rechazan con `400`.", "example": "ES" } } } } }, "examples": { "Correct issuer and address": { "summary": "Corregir la clasificación del documento, el emisor y la dirección estructurada", "value": { "issuing_state": "ESP", "document_type": "BANK_STATEMENT", "issuer": "Banco Example S.A.", "issue_date": "2026-05-02", "name_on_document": "Carmen Espanola", "poa_address": "Avda de Madrid 34, 28013 Madrid", "extra_fields": { "bank_iban": "ES9121000418450200051332", "additional_names": [ "Carmen E. Espanola" ] }, "poa_parsed_address": { "street_1": "Avda de Madrid 34", "city": "Madrid", "postal_code": "28013", "country": "ES" } } }, "Remove a banking detail": { "summary": "Eliminar una clave de campo adicional y conservar el resto", "value": { "extra_fields": { "bank_iban": null } } } } } } }, "responses": { "200": { "description": "Datos de POA actualizados. Devuelve el **registro de POA actual completo** (cada campo actualizable con su valor almacenado, además del mapa `extra_fields` completo, `poa_parsed_address` y `poa_formatted_address`), no solo los campos que enviaste. El webhook `data.updated` se dispara solo cuando al menos un valor cambió realmente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "issuing_state": { "type": "string", "nullable": true, "description": "País que emitió el documento de prueba de domicilio, ISO 3166-1 alfa-3. No distingue entre mayúsculas y minúsculas (se normaliza a mayúsculas); los códigos no válidos devuelven `400`.", "example": "ESP" }, "document_type": { "type": "string", "enum": [ "UTILITY_BILL", "BANK_STATEMENT", "GOVERNMENT_ISSUED_DOCUMENT", "OTHER_POA_DOCUMENT", "UNKNOWN" ], "description": "Categoría del documento de POA. Los valores van en mayúsculas: las variantes en minúsculas como `utility_bill` devuelven `400`.", "example": "UTILITY_BILL" }, "document_language": { "type": "string", "maxLength": 50, "nullable": true, "description": "Idioma del documento, normalmente un código ISO 639-1 (p. ej., `es`). Texto libre: no se valida como código de idioma.", "example": "es" }, "issuer": { "type": "string", "maxLength": 255, "nullable": true, "description": "Organización que emitió el documento (empresa de servicios públicos, banco, organismo gubernamental).", "example": "Energy Provider S.A." }, "issue_date": { "type": "string", "format": "date", "nullable": true, "description": "Fecha de emisión del documento de prueba de domicilio en formato `YYYY-MM-DD`. Cualquier otro formato devuelve `400`.", "example": "2026-04-12" }, "poa_address": { "type": "string", "nullable": true, "description": "Dirección en texto libre tal como aparece impresa en el documento. Cuando este valor cambia (solo en sesiones que no son de sandbox) y la dirección estructurada todavía falta o está incompleta, el servidor la vuelve a geocodificar en segundo plano durante la misma solicitud y puede sobrescribir `poa_parsed_address` / `poa_formatted_address` con el resultado del geocodificador.", "example": "Avda de Madrid 34, 28013 Madrid" }, "name_on_document": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nombre del destinatario tal como figura impreso en el documento.", "example": "Carmen Espanola" }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Siempre presente en la respuesta: las nueve claves conocidas (con `null` en las que no están definidas y `additional_names` con `[]` por defecto) más cualquier clave personalizada almacenada previamente." }, "poa_parsed_address": { "type": "object", "nullable": true, "description": "Dirección estructurada actual, o `null` si no existe. Incluye el `formatted_address` recalculado junto con las siete claves editables. Se devuelve tal como está almacenada: tras una geocodificación en el servidor, puede contener claves de control (p. ej., `raw_results`) junto a las claves editables.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Clasificación libre de la dirección (p. ej., `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Estado / provincia / comunidad autónoma." }, "street_1": { "type": "string", "nullable": true, "example": "Avda de Madrid 34" }, "street_2": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true, "example": "28013" }, "country": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alfa-2. Las entradas en minúsculas se normalizan a mayúsculas; los códigos alfa-3 se rechazan con `400`.", "example": "ES" }, "formatted_address": { "type": "string", "nullable": true, "description": "Forma unida y legible de la dirección estructurada. Se recalcula en el servidor después de cada edición de `poa_parsed_address`.", "example": "Avda de Madrid 34, Madrid, 28013, ES" } } }, "poa_formatted_address": { "type": "string", "nullable": true, "description": "Copia de nivel superior del `formatted_address` recalculado, que se mantiene sincronizada cuando cambia la dirección estructurada.", "example": "Avda de Madrid 34, Madrid, 28013, ES" } } }, "examples": { "Updated POA": { "summary": "Registro POA completo tras la corrección", "value": { "issuing_state": "ESP", "document_type": "BANK_STATEMENT", "document_language": "es", "issuer": "Banco Example S.A.", "issue_date": "2026-05-02", "poa_address": "Avda de Madrid 34, 28013 Madrid", "name_on_document": "Carmen Espanola", "extra_fields": { "bank_account_number": null, "bank_iban": "ES9121000418450200051332", "bank_sort_code": null, "bank_routing_number": null, "bank_swift_bic": null, "bank_branch_name": null, "bank_branch_address": null, "document_phone_number": null, "additional_names": [ "Carmen E. Espanola" ] }, "poa_parsed_address": { "city": "Madrid", "street_1": "Avda de Madrid 34", "postal_code": "28013", "country": "ES", "formatted_address": "Avda de Madrid 34, Madrid, 28013, ES" }, "poa_formatted_address": "Avda de Madrid 34, Madrid, 28013, ES" } } } } } }, "400": { "description": "Error de validación. Los errores de campo llegan como `{\"\": [\"\"]}`; los errores en claves anidadas de `poa_parsed_address` / `extra_fields` usan un objeto como valor: `{\"extra_fields\": {\"\": \"\"}}`.", "content": { "application/json": { "examples": { "Invalid document type": { "summary": "El enum va en mayúsculas: las variantes en minúsculas se rechazan", "value": { "document_type": [ "\"utility_bill\" is not a valid choice." ] } }, "Invalid issuing state": { "summary": "issuing_state no es un código ISO 3166-1 alpha-3", "value": { "issuing_state": [ "Invalid ISO 3166-1 alpha-3 country code for issuing_state." ] } }, "additional_names not a list": { "summary": "additional_names acepta una lista de cadenas o null", "value": { "extra_fields": { "additional_names": "Must be a list or null." } } }, "Unsupported poa_parsed_address key": { "summary": "Solo se permiten las siete claves documentadas", "value": { "poa_parsed_address": { "zipcode": "Unsupported key. Allowed keys: address_type, city, region, street_1, street_2, postal_code, country" } } }, "Bad date format": { "summary": "Las fechas deben tener el formato YYYY-MM-DD", "value": { "issue_date": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } } } } } }, "403": { "description": "Faltan las credenciales o los permisos son insuficientes. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente o no válido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La credencial no tiene write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Sesión desconocida, sesión en un estado no editable o ningún registro de POA que modificar. Cada caso tiene un mensaje `detail` distinto (consulta los ejemplos). La búsqueda de sesión desconocida se ejecuta antes de las comprobaciones de credenciales.", "content": { "application/json": { "examples": { "Unknown session": { "summary": "No hay ninguna sesión con este ID en tu aplicación (o se eliminó)", "value": { "detail": "Not found." } }, "Wrong session state": { "summary": "La sesión existe, pero no está en estado Approved / Declined / In Review / Kyc Expired", "value": { "detail": "No Session matches the given query." } }, "No POA record": { "summary": "El flujo nunca ejecutó un paso de Prueba de domicilio", "value": { "detail": "The session does not have a POA." } }, "No POA for node": { "summary": "Se indicó node_id, pero no existe ninguna POA para él", "value": { "detail": "The session does not have a POA for node 'feature_missing'." } } } } } }, "429": { "description": "Se superó el límite de solicitudes dedicado: 10 actualizaciones de datos de POA por minuto por clave de API (las solicitudes rechazadas cuentan para el cupo). El cupo compartido de escritura de 300/min también puede activarse con su propio mensaje. Revisa `Retry-After` y los encabezados de respuesta `X-RateLimit-*` antes de reintentar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Límite de actualizaciones de POA agotado", "value": { "detail": "Session POA data update rate limit exceeded. You can make up to 10 requests per minute." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-poa-data/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"issuing_state\": \"ESP\",\n \"document_type\": \"BANK_STATEMENT\",\n \"issuer\": \"Banco Example S.A.\",\n \"issue_date\": \"2026-05-02\",\n \"name_on_document\": \"Carmen Espanola\",\n \"poa_address\": \"Avda de Madrid 34, 28013 Madrid\",\n \"extra_fields\": {\n \"bank_iban\": \"ES9121000418450200051332\"\n },\n \"poa_parsed_address\": {\n \"city\": \"Madrid\",\n \"postal_code\": \"28013\",\n \"country\": \"ES\"\n }\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_poa_data(\n \"11111111-2222-3333-4444-555555555555\",\n issuing_state=\"ESP\",\n document_type=\"BANK_STATEMENT\",\n issuer=\"Banco Example S.A.\",\n issue_date=\"2026-05-02\",\n poa_address=\"Avda de Madrid 34, 28013 Madrid\",\n name_on_document=\"Carmen Espanola\",\n extra_fields={\"bank_iban\": \"ES9121000418450200051332\", \"additional_names\": [\"Carmen E. Espanola\"]},\n poa_parsed_address={\n \"city\": \"Madrid\",\n \"street_1\": \"Avda de Madrid 34\",\n \"postal_code\": \"28013\",\n \"country\": \"ES\",\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updatePoaData(\"11111111-2222-3333-4444-555555555555\", {\n issuing_state: \"ESP\",\n document_type: \"BANK_STATEMENT\",\n issuer: \"Banco Example S.A.\",\n issue_date: \"2026-05-02\",\n poa_address: \"Avda de Madrid 34, 28013 Madrid\",\n name_on_document: \"Carmen Espanola\",\n extra_fields: { bank_iban: \"ES9121000418450200051332\", additional_names: [\"Carmen E. Espanola\"] },\n poa_parsed_address: {\n city: \"Madrid\",\n street_1: \"Avda de Madrid 34\",\n postal_code: \"28013\",\n country: \"ES\",\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdatePOAData(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsUpdatePOADataParams{\n\tIssuingState: didit.String(\"ESP\"),\n\tDocumentType: didit.Some(didit.SessionsUpdatePOADataParamsDocumentType(\"BANK_STATEMENT\")),\n\tIssuer: didit.String(\"Banco Example S.A.\"),\n\tIssueDate: didit.String(\"2026-05-02\"),\n\tPOAAddress: didit.String(\"Avda de Madrid 34, 28013 Madrid\"),\n\tNameOnDocument: didit.String(\"Carmen Espanola\"),\n\tExtraFields: didit.Some(map[string]any{\"bank_iban\": \"ES9121000418450200051332\", \"additional_names\": []any{\"Carmen E. Espanola\"}}),\n\tPOAParsedAddress: didit.Some(didit.SessionsUpdatePOADataParamsPOAParsedAddress{\n\t\tCity: didit.String(\"Madrid\"),\n\t\tStreet1: didit.String(\"Avda de Madrid 34\"),\n\t\tPostalCode: didit.String(\"28013\"),\n\t\tCountry: didit.String(\"ES\"),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsUpdatePoaDataParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updatePoaData(\"11111111-2222-3333-4444-555555555555\", SessionsUpdatePoaDataParams.builder()\n .issuingState(\"ESP\")\n .documentType(SessionsUpdatePoaDataParams.DocumentType.of(\"BANK_STATEMENT\"))\n .issuer(\"Banco Example S.A.\")\n .issueDate(LocalDate.parse(\"2026-05-02\"))\n .poaAddress(\"Avda de Madrid 34, 28013 Madrid\")\n .nameOnDocument(\"Carmen Espanola\")\n .extraFields(Map.of(\"bank_iban\", \"ES9121000418450200051332\", \"additional_names\", List.of(\"Carmen E. Espanola\")))\n .poaParsedAddress(SessionsUpdatePoaDataParams.PoaParsedAddress.builder()\n .city(\"Madrid\")\n .street1(\"Avda de Madrid 34\")\n .postalCode(\"28013\")\n .country(\"ES\")\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updatePoaData('11111111-2222-3333-4444-555555555555', [\n 'issuing_state' => 'ESP',\n 'document_type' => 'BANK_STATEMENT',\n 'issuer' => 'Banco Example S.A.',\n 'issue_date' => '2026-05-02',\n 'poa_address' => 'Avda de Madrid 34, 28013 Madrid',\n 'name_on_document' => 'Carmen Espanola',\n 'extra_fields' => ['bank_iban' => 'ES9121000418450200051332', 'additional_names' => ['Carmen E. Espanola']],\n 'poa_parsed_address' => [\n 'city' => 'Madrid',\n 'street_1' => 'Avda de Madrid 34',\n 'postal_code' => '28013',\n 'country' => 'ES',\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_poa_data(\n \"11111111-2222-3333-4444-555555555555\",\n issuing_state: \"ESP\",\n document_type: \"BANK_STATEMENT\",\n issuer: \"Banco Example S.A.\",\n issue_date: \"2026-05-02\",\n poa_address: \"Avda de Madrid 34, 28013 Madrid\",\n name_on_document: \"Carmen Espanola\",\n extra_fields: { bank_iban: \"ES9121000418450200051332\", additional_names: [\"Carmen E. Espanola\"] },\n poa_parsed_address: {\n city: \"Madrid\",\n street_1: \"Avda de Madrid 34\",\n postal_code: \"28013\",\n country: \"ES\",\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdatePoaDataAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsUpdatePoaDataParams\n{\n IssuingState = \"ESP\",\n DocumentType = new SessionsUpdatePoaDataParamsDocumentType(\"BANK_STATEMENT\"),\n Issuer = \"Banco Example S.A.\",\n IssueDate = \"2026-05-02\",\n PoaAddress = \"Avda de Madrid 34, 28013 Madrid\",\n NameOnDocument = \"Carmen Espanola\",\n ExtraFields = new Dictionary { [\"bank_iban\"] = \"ES9121000418450200051332\", [\"additional_names\"] = new object[] { \"Carmen E. Espanola\" } },\n PoaParsedAddress = new SessionsUpdatePoaDataParamsPoaParsedAddress\n {\n City = \"Madrid\",\n Street1 = \"Avda de Madrid 34\",\n PostalCode = \"28013\",\n Country = \"ES\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/kyb/{companyUuid}/update-data/": { "patch": { "summary": "Actualizar los datos de la empresa extraídos del registro en una sesión de Verificación de empresas (KYB)", "description": "Corrige los datos de la empresa extraídos del registro en una sesión de Verificación de empresas (KYB) (nombre de la empresa, número de registro, direcciones, estado y datos de contacto), identificada por `companyUuid`. Suelen llamarlo un analista de cumplimiento que corrige una lectura errónea del registro o tu back office al sincronizar datos de empresa corregidos. Todos los campos del cuerpo son opcionales (semántica `PATCH`). Un cuerpo JSON vacío (`{}`) no hace nada y solo devuelve el registro actual de la empresa.\n\nLas ediciones se escriben en dos lugares a la vez. Los campos con una columna canónica de empresa actualizan esa columna: nombre, número de registro, país, fecha de constitución, número fiscal, tipo, estados, campos de capital (`registered_capital`, `registered_capital_amount`, `registered_capital_currency`), nombres alternativos, naturaleza de la actividad, sitio web, correo electrónico, teléfono, LEI, ubicación y `legal_address` → `registered_address`. Además, **todas** las claves enviadas se fusionan en la instantánea `registry_data` (las fechas, como cadenas ISO) para que la vista \"extraído del registro\" refleje la corrección. Los campos sin columna (`region`, `registration_date`, `dissolution_date`, `control_scheme`) solo se guardan en `registry_data`. `user_provided_data` (lo que el usuario final confirmó en el flujo alojado) nunca se modifica, y `last_console_edit_at` se registra en cada PATCH no vacío.\n\nA diferencia de los endpoints de actualización de KYC/POA, **no hay restricción por estado de la sesión**: la empresa puede editarse en cualquier momento del ciclo de vida de la sesión de empresa. La empresa debe pertenecer a la sesión indicada en la ruta (si no, se devuelve `404` con `\"KYB company does not belong to the given session.\"`) y a tu aplicación. Cada PATCH no vacío dispara el [webhook](/es/integration/webhooks) `data.updated` en la sesión de empresa (disparador `console_registry_edit`), incluso cuando los valores enviados son iguales a los almacenados. El estado y la decisión de la sesión **no** se vuelven a evaluar, y no se registra ninguna entrada de revisión ni de auditoría.\n\nAcepta una clave de API o un token de usuario de la consola. En ambos casos, la credencial necesita el permiso `write:businesses`. Tanto los fallos de autenticación como los de permisos devuelven `403`: esta API nunca responde `401`. La búsqueda de la sesión se ejecuta antes de comprobar las credenciales, así que un `sessionId` desconocido devuelve `404` aunque falten las credenciales. Se aplica el presupuesto de escritura compartido de 300 solicitudes por minuto por clave de API.\n\nPara las sesiones de Verificación de usuarios, el equivalente de KYC es `PATCH /v3/session/{sessionId}/update-data/`. Para cambiar la propia decisión de la sesión, usa `PATCH /v3/session/{sessionId}/update-status/`.", "operationId": "patch_v3_session_kyb_company_update_data", "x-didit-sdk": { "resource": "sessions", "method": "update_kyb_company_data", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión principal de Verificación de empresas (KYB).", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "companyUuid", "in": "path", "required": true, "description": "UUID del registro de la empresa que se va a actualizar (`registry_checks[].company.uuid` en la decisión de la sesión de empresa). Debe pertenecer a la sesión referenciada por `sessionId`.", "schema": { "type": "string", "format": "uuid", "example": "88888888-9999-aaaa-bbbb-cccccccccccc" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Todos los campos son opcionales: envía solo lo que quieras cambiar. Los campos proporcionados actualizan las columnas canónicas de la empresa (cuando existen) y se combinan en la instantánea `registry_data`.", "properties": { "company_name": { "type": "string", "maxLength": 255, "description": "Nombre legal de la empresa. Se escribe en la columna canónica y en la instantánea del registro.", "example": "Docs Probe Corp" }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro oficial en el registro de empresas.", "example": "DPC-001" }, "country_code": { "type": "string", "maxLength": 2, "description": "País de constitución, ISO 3166-1 alfa-2. No distingue entre mayúsculas y minúsculas (`us` se almacena como `US`). Los códigos alfa-3 superan el límite de 2 caracteres y devuelven `400`.", "example": "US" }, "region": { "type": "string", "maxLength": 10, "nullable": true, "description": "Etiqueta de subdivisión o región cuando el registro tiene una (p. ej., un estado de EE. UU.). Solo se guarda en la instantánea del registro: no tiene columna canónica." }, "incorporation_date": { "type": "string", "format": "date", "description": "Fecha de constitución en formato `YYYY-MM-DD`. Es opcional, como todos los demás campos: el `PATCH` es parcial. Cualquier otro formato de fecha devuelve `400`.", "example": "2015-04-12" }, "registration_date": { "type": "string", "format": "date", "nullable": true, "description": "Fecha de registro cuando el registro la distingue de la constitución. Se almacena únicamente en la instantánea del registro." }, "dissolution_date": { "type": "string", "format": "date", "nullable": true, "description": "Fecha de disolución de las empresas que ya no están activas. Solo se guarda en la instantánea del registro." }, "tax_number": { "type": "string", "maxLength": 100, "description": "Número de identificación fiscal." }, "legal_address": { "type": "string", "description": "Dirección legal o registrada. En el servidor se asigna como alias a la columna canónica `registered_address`: la respuesta la devuelve en `registered_address`, mientras que la instantánea del registro conserva la clave `legal_address` que enviaste.", "example": "1 Example Plaza, Wilmington, DE 19801" }, "company_type": { "type": "string", "maxLength": 100, "description": "Tipo de entidad jurídica (p. ej., `Limited Liability Company`, `PLC`, `GmbH`).", "example": "Limited Liability Company" }, "registry_status": { "type": "string", "enum": [ "active", "dissolved", "deregistered", "see full details", "authorised", "appointed representative", "unauthorised", "inactive", "no longer authorised", "closed", "struck off" ], "nullable": true, "description": "Estado de la empresa según el registro. En minúsculas; algunos valores contienen espacios (p. ej., `struck off`, `no longer authorised`). Cualquier otro valor devuelve `400`.", "example": "active" }, "verification_status": { "type": "string", "enum": [ "verified", "failed", "unknown" ], "nullable": true, "description": "Resultado de la verificación en el registro. Cualquier otro valor devuelve `400`.", "example": "verified" }, "alternative_names": { "type": "string", "description": "Nombres comerciales, denominaciones sociales anteriores y nombres DBA (texto libre)." }, "nature_of_business": { "type": "string", "description": "Descripción breve de la actividad de la empresa.", "example": "Software development" }, "registered_capital": { "type": "string", "maxLength": 100, "description": "Capital social legible (p. ej. `USD 50000`). Usa `registered_capital_amount` + `registered_capital_currency` para valores estructurados, o este campo para texto libre.", "example": "USD 50000" }, "registered_capital_amount": { "type": "number", "format": "double", "nullable": true, "description": "Importe numérico del capital social (hasta 20 dígitos y 2 decimales). Establece la columna `registered_capital_amount` y se replica en `registry_data` como cadena decimal; la respuesta lo devuelve como cadena decimal (p. ej., `\"1500000.50\"`)." }, "registered_capital_currency": { "type": "string", "maxLength": 3, "nullable": true, "description": "Código de moneda ISO 4217 de `registered_capital_amount`. No distingue mayúsculas de minúsculas (`usd` se almacena como `USD`); los valores que no tienen exactamente 3 letras devuelven `400` con el mensaje de ISO 4217. Establece la columna canónica `registered_capital_currency` y se replica en `registry_data`.", "example": "USD" }, "website": { "type": "string", "maxLength": 500, "description": "Sitio web de la empresa. Se aceptan dominios sin protocolo y se normalizan con el prefijo `https://` (`docsprobe.example.com` se guarda como `https://docsprobe.example.com`); los valores que aun así no superan la validación de URL devuelven `400`.", "example": "https://docsprobe.example.com" }, "email": { "type": "string", "format": "email", "description": "Correo electrónico de contacto que consta en el registro.", "example": "legal@docsprobe.example.com" }, "phone": { "type": "string", "maxLength": 50, "description": "Teléfono de contacto. Solo puede contener `+`, dígitos, espacios, guiones, puntos o paréntesis, con un total de entre 7 y 15 dígitos; de lo contrario, responde `400`.", "example": "+1 302 555 0143" }, "legal_entity_identifier": { "type": "string", "maxLength": 50, "description": "LEI, cuando la empresa tiene uno." }, "location_of_registration": { "type": "string", "maxLength": 255, "description": "Ciudad o subdivisión del registro oficial." }, "vat_number": { "type": "string", "maxLength": 64, "description": "Número de IVA de la UE. Solo se incorpora a la instantánea de `registry_data`: editarlo aquí no vuelve a ejecutar la validación del IVA y de la identificación fiscal, por lo que `vat_validation_status` y los demás campos de resultado `vat_*` no cambian." }, "control_scheme": { "type": "string", "description": "Esquema de control o gobierno corporativo, cuando el registro lo expone. Solo se guarda en la instantánea del registro." } } }, "examples": { "Correct registry data": { "summary": "Corregir los campos de la empresa extraídos del registro", "value": { "company_name": "Docs Probe Corp", "registration_number": "DPC-001", "country_code": "US", "incorporation_date": "2015-04-12", "company_type": "Limited Liability Company", "legal_address": "1 Example Plaza, Wilmington, DE 19801", "registry_status": "active", "verification_status": "verified", "website": "docsprobe.example.com", "email": "legal@docsprobe.example.com", "phone": "+1 302 555 0143", "registered_capital": "USD 50000", "nature_of_business": "Software development" } }, "Single field": { "summary": "Solo se escriben las claves que envías", "value": { "registry_status": "dissolved" } }, "No-op": { "summary": "Un cuerpo vacío devuelve el registro actual sin disparar el webhook", "value": {} } } } } }, "responses": { "200": { "description": "Datos de la empresa actualizados (o devueltos sin cambios si el cuerpo está vacío). Devuelve el registro completo de la empresa KYB, con la misma estructura que `registry_checks[].company` en la decisión de la sesión de empresa. Ten en cuenta que `legal_address` se devuelve como `registered_address`. `registered_capital_amount`/`registered_capital_currency` rellenan sus columnas canónicas y se replican en `registry_data`.", "content": { "application/json": { "schema": { "type": "object", "description": "Registro completo de la empresa en KYB, con la misma estructura que el objeto `company` dentro de `registry_checks[]` en la decisión de la sesión de empresa.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador del registro de la empresa (el parámetro de ruta `companyUuid`)." }, "node_id": { "type": "string", "nullable": true, "description": "Nodo del grafo del flujo al que pertenece este registro de empresa, cuando el flujo se basa en un grafo." }, "status": { "type": "string", "description": "Estado del ciclo de vida de la función de verificación en el registro (por ejemplo, `Not Finished`, `Approved`, `Declined`, `In Review`)." }, "registry_status": { "type": "string", "nullable": true, "description": "Estado de la empresa según el registro (p. ej., `active`, `dissolved`, `struck off`)." }, "data_resolved": { "type": "boolean", "description": "`true` cuando los datos de la empresa están completos: siempre `true` para empresas introducidas manualmente; para empresas obtenidas del registro, `true` una vez resuelta la consulta al registro." }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true, "description": "País de constitución en formato ISO 3166-1 alfa-2." }, "region": { "type": "string", "nullable": true }, "company_type": { "type": "string", "nullable": true }, "incorporation_date": { "type": "string", "format": "date", "nullable": true }, "registered_address": { "type": "string", "nullable": true, "description": "Dirección registrada canónica: se actualiza cuando envías `legal_address`." }, "tax_number": { "type": "string", "nullable": true }, "risk_level": { "type": "string", "nullable": true }, "verification_status": { "type": "string", "nullable": true, "description": "`verified`, `failed` o `unknown`." }, "is_from_registry": { "type": "boolean", "description": "`true` cuando la empresa se rellenó previamente a partir de una búsqueda en el registro en lugar de introducirse manualmente." }, "fetch_status": { "type": "string", "nullable": true, "description": "Ciclo de vida de la consulta al registro para empresas obtenidas del registro (`pending` / `resolved`); `null` para las entradas manuales." }, "alternative_names": { "type": "string", "nullable": true, "description": "Nombres alternativos, comerciales, anteriores o en el idioma original de la empresa, como texto, cuando se informan." }, "nature_of_business": { "type": "string", "nullable": true }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Columna canónica. Se devuelve como cadena decimal (p. ej., `\"2750000.00\"`)." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Columna canónica. La establece el flujo del registro o las ediciones desde la consola o la API mediante este endpoint." }, "website": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "legal_entity_identifier": { "type": "string", "nullable": true }, "location_of_registration": { "type": "string", "nullable": true }, "vat_number": { "type": "string", "nullable": true, "description": "Número de IVA de la UE, cuando se recopila durante el paso de registro alojado o se edita después." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Resultado de validar el número de IVA o, si no lo hay, el `tax_number`, al enviar al registro. `valid` / `invalid`: lo decide el registro oficial del país (VIES de la UE, Noruega, Suiza, Brasil, Colombia, Costa Rica, Ecuador, Paraguay; Polonia también mediante su registro nacional de IVA). `format_valid` / `invalid_format`: lo deciden las reglas de formato y dígito de control del país cuando no se puede consultar ningún registro. `could_not_validate`: el registro no estaba disponible. `not_applicable`: no hay número, el país no tiene registro ni reglas, o es una sesión de sandbox." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "El número que se comprobó, tal como lo conoce la fuente (por ejemplo, el número de IVA derivado de un SIREN francés o de un RSIN neerlandés). `null` cuando no se realizó ninguna comprobación." }, "vat_validation_source": { "type": "string", "nullable": true, "enum": [ "eu_vies", "pl_vat_white_list", "no_brreg", "ch_uid_register", "br_receita_federal", "co_rues", "cr_hacienda", "ec_sri", "py_dnit", "format_rules", null ], "description": "La fuente que determinó `vat_validation_status`: un registro oficial o `format_rules`. `null` cuando no se ejecutó ninguna comprobación." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Nombre registrado en la fuente que validó el número, cuando la fuente lo revela. Solo se informa cuando el estado es `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Dirección registrada en la fuente que validó el número, cuando esta la facilita. Solo se establece cuando el estado es `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de tiempo de la comprobación. `null` cuando no se ejecutó ninguna comprobación." }, "financial_summary": { "type": "object", "nullable": true, "additionalProperties": true }, "officers": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Directores / administradores vinculados a la empresa, incluido el progreso de KYC de cada persona." }, "beneficial_owners": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Beneficiarios finales vinculados a la empresa, incluido el progreso de KYC de cada persona." }, "addresses": { "type": "array", "nullable": true, "items": { "type": "object", "additionalProperties": true }, "description": "Detalle de la dirección según el registro, cuando el registro devolvió alguno." }, "industries": { "type": "array", "nullable": true, "items": { "type": "object", "additionalProperties": true }, "description": "Clasificación sectorial del registro, cuando está disponible." }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Fechas de presentación ante el registro, cuando están disponibles. Las declaraciones anuales y las juntas generales usan last_annual_return_date y last_agm_date; son distintas de las cuentas financieras." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Lo que el usuario final escribió durante el paso alojado de confirmación del registro. Este endpoint nunca lo modifica." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo el usuario final confirmó los datos de la empresa en el flujo alojado." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Se registra en cada PATCH correcto y no vacío, para que las interfaces puedan mostrar el contexto \"editado por un operador\"." }, "is_editable": { "type": "boolean", "description": "`true` mientras el usuario final todavía puede editar los datos obtenidos del registro en el flujo alojado (obtenidos del registro y aún no confirmados)." } } }, "examples": { "Updated company": { "summary": "Registro completo de la empresa tras la corrección", "value": { "uuid": "6b9479f5-6769-46c8-baf1-df63bbbc5f8c", "node_id": null, "status": "Not Finished", "registry_status": "active", "data_resolved": true, "company_name": "Docs Probe Corp", "registration_number": "DPC-001", "country_code": "US", "region": null, "company_type": "Limited Liability Company", "incorporation_date": "2015-04-12", "registered_address": "1 Example Plaza, Wilmington, DE 19801", "tax_number": null, "risk_level": null, "verification_status": "verified", "is_from_registry": false, "fetch_status": null, "alternative_names": null, "nature_of_business": "Software development", "registered_capital": "USD 50000", "registered_capital_amount": null, "registered_capital_currency": "USD", "website": "https://docsprobe.example.com", "email": "legal@docsprobe.example.com", "phone": "+1 302 555 0143", "legal_entity_identifier": null, "location_of_registration": null, "financial_summary": null, "officers": [], "beneficial_owners": [], "addresses": null, "industries": null, "accounts": null, "registry_data": { "company_name": "Docs Probe Corp", "registration_number": "DPC-001", "country_code": "US", "incorporation_date": "2015-04-12", "legal_address": "1 Example Plaza, Wilmington, DE 19801", "company_type": "Limited Liability Company", "registry_status": "active", "verification_status": "verified", "nature_of_business": "Software development", "registered_capital": "USD 50000", "registered_capital_currency": "USD", "website": "https://docsprobe.example.com", "email": "legal@docsprobe.example.com", "phone": "+1 302 555 0143" }, "user_provided_data": null, "confirmed_by_user_at": null, "last_console_edit_at": "2026-06-12T00:02:34.276061Z", "is_editable": false } } } } } }, "400": { "description": "Error de validación. Los errores de campo llegan como `{\"\": [\"\"]}`. Las comprobaciones de longitud máxima se ejecutan antes que las de formato, por lo que `country_code: \"USA\"` informa del límite de 2 caracteres en lugar del mensaje ISO.", "content": { "application/json": { "examples": { "Alpha-3 country code": { "summary": "country_code debe ser alpha-2: la comprobación de longitud se ejecuta primero", "value": { "country_code": [ "Ensure this field has no more than 2 characters." ] } }, "Non-alphabetic country code": { "summary": "2 caracteres, pero no letras", "value": { "country_code": [ "country_code must be a 2-letter ISO 3166-1 alpha-2 code." ] } }, "Invalid currency": { "summary": "3 caracteres, pero no un código ISO 4217", "value": { "registered_capital_currency": [ "Currency must be a 3-letter ISO 4217 code (e.g. USD, EUR, GBP)." ] } }, "Invalid phone": { "summary": "El teléfono no supera la comprobación de formato o de número de dígitos", "value": { "phone": [ "Invalid phone number format." ] } }, "Invalid registry status": { "summary": "registry_status no es un valor del enum", "value": { "registry_status": [ "\"liquidated\" is not a valid choice." ] } }, "Invalid email": { "summary": "Dirección de correo electrónico con formato incorrecto", "value": { "email": [ "Enter a valid email address." ] } }, "Invalid website": { "summary": "El valor no supera la validación de URL incluso después de normalizarlo con https://", "value": { "website": [ "Enter a valid URL." ] } }, "Bad date format": { "summary": "Las fechas deben tener el formato YYYY-MM-DD", "value": { "incorporation_date": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } } } } } }, "403": { "description": "Faltan las credenciales o los permisos son insuficientes. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente o no válido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La credencial no tiene write:businesses", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Sesión desconocida, empresa desconocida o una empresa que pertenece a otra sesión. Cada caso tiene un mensaje `detail` distinto (consulta los ejemplos). La búsqueda de sesión desconocida se ejecuta antes de las comprobaciones de credenciales.", "content": { "application/json": { "examples": { "Unknown session": { "summary": "No hay ninguna sesión con este ID en tu aplicación (o se eliminó)", "value": { "detail": "Not found." } }, "Unknown company": { "summary": "No hay ninguna empresa con este UUID en tu aplicación", "value": { "detail": "No KYBCompany matches the given query." } }, "Company / session mismatch": { "summary": "companyUuid existe pero pertenece a otra sesión", "value": { "detail": "KYB company does not belong to the given session." } } } } } }, "429": { "description": "Se superó el límite de solicitudes de escritura compartido (300 solicitudes POST/PATCH/DELETE por minuto por clave de API). Revisa `Retry-After` y los encabezados de respuesta `X-RateLimit-*` antes de reintentar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Presupuesto de escritura agotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/33333333-4444-5555-6666-777777777777/kyb/88888888-9999-aaaa-bbbb-cccccccccccc/update-data/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"company_name\": \"Docs Probe Corp\",\n \"registration_number\": \"DPC-001\",\n \"country_code\": \"US\",\n \"incorporation_date\": \"2015-04-12\",\n \"company_type\": \"Limited Liability Company\",\n \"legal_address\": \"1 Example Plaza, Wilmington, DE 19801\",\n \"registry_status\": \"active\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_kyb_company_data(\n \"33333333-4444-5555-6666-777777777777\",\n \"88888888-9999-aaaa-bbbb-cccccccccccc\",\n company_name=\"Docs Probe Corp\",\n registration_number=\"DPC-001\",\n country_code=\"US\",\n incorporation_date=\"2015-04-12\",\n legal_address=\"1 Example Plaza, Wilmington, DE 19801\",\n company_type=\"Limited Liability Company\",\n registry_status=\"active\",\n verification_status=\"verified\",\n nature_of_business=\"Software development\",\n registered_capital=\"USD 50000\",\n website=\"docsprobe.example.com\",\n email=\"legal@docsprobe.example.com\",\n phone=\"+1 302 555 0143\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateKybCompanyData(\n \"33333333-4444-5555-6666-777777777777\",\n \"88888888-9999-aaaa-bbbb-cccccccccccc\",\n {\n company_name: \"Docs Probe Corp\",\n registration_number: \"DPC-001\",\n country_code: \"US\",\n incorporation_date: \"2015-04-12\",\n legal_address: \"1 Example Plaza, Wilmington, DE 19801\",\n company_type: \"Limited Liability Company\",\n registry_status: \"active\",\n verification_status: \"verified\",\n nature_of_business: \"Software development\",\n registered_capital: \"USD 50000\",\n website: \"docsprobe.example.com\",\n email: \"legal@docsprobe.example.com\",\n phone: \"+1 302 555 0143\",\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateKYBCompanyData(ctx, \"33333333-4444-5555-6666-777777777777\", \"88888888-9999-aaaa-bbbb-cccccccccccc\", didit.SessionsUpdateKYBCompanyDataParams{\n\tCompanyName: didit.String(\"Docs Probe Corp\"),\n\tRegistrationNumber: didit.String(\"DPC-001\"),\n\tCountryCode: didit.String(\"US\"),\n\tIncorporationDate: didit.String(\"2015-04-12\"),\n\tLegalAddress: didit.String(\"1 Example Plaza, Wilmington, DE 19801\"),\n\tCompanyType: didit.String(\"Limited Liability Company\"),\n\tRegistryStatus: didit.Some(didit.SessionsUpdateKYBCompanyDataParamsRegistryStatus(\"active\")),\n\tVerificationStatus: didit.Some(didit.SessionsUpdateKYBCompanyDataParamsVerificationStatus(\"verified\")),\n\tNatureOfBusiness: didit.String(\"Software development\"),\n\tRegisteredCapital: didit.String(\"USD 50000\"),\n\tWebsite: didit.String(\"docsprobe.example.com\"),\n\tEmail: didit.String(\"legal@docsprobe.example.com\"),\n\tPhone: didit.String(\"+1 302 555 0143\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport me.didit.Didit;\nimport me.didit.types.SessionsUpdateKybCompanyDataParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateKybCompanyData(\"33333333-4444-5555-6666-777777777777\", \"88888888-9999-aaaa-bbbb-cccccccccccc\", SessionsUpdateKybCompanyDataParams.builder()\n .companyName(\"Docs Probe Corp\")\n .registrationNumber(\"DPC-001\")\n .countryCode(\"US\")\n .incorporationDate(LocalDate.parse(\"2015-04-12\"))\n .legalAddress(\"1 Example Plaza, Wilmington, DE 19801\")\n .companyType(\"Limited Liability Company\")\n .registryStatus(SessionsUpdateKybCompanyDataParams.RegistryStatus.of(\"active\"))\n .verificationStatus(SessionsUpdateKybCompanyDataParams.VerificationStatus.of(\"verified\"))\n .natureOfBusiness(\"Software development\")\n .registeredCapital(\"USD 50000\")\n .website(\"docsprobe.example.com\")\n .email(\"legal@docsprobe.example.com\")\n .phone(\"+1 302 555 0143\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateKybCompanyData('33333333-4444-5555-6666-777777777777', '88888888-9999-aaaa-bbbb-cccccccccccc', [\n 'company_name' => 'Docs Probe Corp',\n 'registration_number' => 'DPC-001',\n 'country_code' => 'US',\n 'incorporation_date' => '2015-04-12',\n 'legal_address' => '1 Example Plaza, Wilmington, DE 19801',\n 'company_type' => 'Limited Liability Company',\n 'registry_status' => 'active',\n 'verification_status' => 'verified',\n 'nature_of_business' => 'Software development',\n 'registered_capital' => 'USD 50000',\n 'website' => 'docsprobe.example.com',\n 'email' => 'legal@docsprobe.example.com',\n 'phone' => '+1 302 555 0143',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_kyb_company_data(\n \"33333333-4444-5555-6666-777777777777\",\n \"88888888-9999-aaaa-bbbb-cccccccccccc\",\n company_name: \"Docs Probe Corp\",\n registration_number: \"DPC-001\",\n country_code: \"US\",\n incorporation_date: \"2015-04-12\",\n legal_address: \"1 Example Plaza, Wilmington, DE 19801\",\n company_type: \"Limited Liability Company\",\n registry_status: \"active\",\n verification_status: \"verified\",\n nature_of_business: \"Software development\",\n registered_capital: \"USD 50000\",\n website: \"docsprobe.example.com\",\n email: \"legal@docsprobe.example.com\",\n phone: \"+1 302 555 0143\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateKybCompanyDataAsync(\"33333333-4444-5555-6666-777777777777\", \"88888888-9999-aaaa-bbbb-cccccccccccc\", new SessionsUpdateKybCompanyDataParams\n{\n CompanyName = \"Docs Probe Corp\",\n RegistrationNumber = \"DPC-001\",\n CountryCode = \"US\",\n IncorporationDate = \"2015-04-12\",\n LegalAddress = \"1 Example Plaza, Wilmington, DE 19801\",\n CompanyType = \"Limited Liability Company\",\n RegistryStatus = new SessionsUpdateKybCompanyDataParamsRegistryStatus(\"active\"),\n VerificationStatus = new SessionsUpdateKybCompanyDataParamsVerificationStatus(\"verified\"),\n NatureOfBusiness = \"Software development\",\n RegisteredCapital = \"USD 50000\",\n Website = \"docsprobe.example.com\",\n Email = \"legal@docsprobe.example.com\",\n Phone = \"+1 302 555 0143\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/kyb/parties/{partyUuid}/": { "patch": { "summary": "Omitir (o volver a exigir) una parte de Personas clave en una sesión de Verificación de empresas (KYB)", "description": "Exime de verificación a una parte de las personas clave, o vuelve a incluirla en el alcance. Es la vía de escape del operador para una parte que nunca podrá completar su propia comprobación, casi siempre porque se eliminó la sesión de KYC individual asignada a un UBO o director, lo que congela el estado de ese elemento hijo y deja el KYB detenido en `Awaiting User` sin nada que pueda hacerlo avanzar.\n\nEstablecer `is_skipped: true` saca a la parte de la agregación de personas clave y recalcula de inmediato el `KYBKeyPeopleCheck` y el estado de la sesión principal, para que la sesión de empresa pueda resolverse y después aprobarse o rechazarse. Enviar `is_skipped: false` vuelve a incluir a la parte en el alcance y la comprobación vuelve a esperarla.\n\nA diferencia de la omisión que ve el solicitante en la pantalla alojada de personas clave, este endpoint **no** está condicionado por la configuración `allow_skip` del rol: ese indicador limita lo que puede decidir el solicitante, no lo que puede anular tu analista. `requires_verification` se deja intacto a propósito, de modo que una parte anulada aparece como `requires_verification: true` **y** `is_skipped: true`, y el registro sigue mostrando lo que exigían las reglas.\n\nLa parte debe pertenecer a la sesión de la ruta (en caso contrario, `404` con `\"Party does not belong to the given session.\"`) y a tu aplicación. Un PATCH que realmente cambia el indicador dispara el [webhook](/es/integration/webhooks) `data.updated` en la sesión de empresa con el disparador `console_key_people_skip`; un PATCH que establece el indicador en su valor actual no tiene efecto y devuelve la parte tal cual.\n\nAcepta una clave de API o un token de usuario de la consola; en ambos casos, la credencial necesita el permiso `write:businesses`.", "operationId": "patch_v3_session_kyb_party_update", "x-didit-sdk": { "resource": "sessions", "method": "update_kyb_party", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión principal de Verificación de empresas (KYB).", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "partyUuid", "in": "path", "required": true, "description": "UUID de la parte de Personas clave que se va a actualizar (`key_people_checks[].submitted.parties[].uuid` en la decisión de la sesión de empresa). Debe pertenecer a la sesión referenciada por `sessionId`.", "schema": { "type": "string", "format": "uuid", "example": "0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "is_skipped" ], "properties": { "is_skipped": { "type": "boolean", "description": "`true` exime a la parte de la verificación para que la comprobación de personas clave pueda resolverse sin ella; `false` la vuelve a incluir en el alcance.", "example": true } } } } } }, "responses": { "200": { "description": "Parte actualizada (o devuelta sin cambios cuando el indicador ya tenía este valor). Devuelve la parte, con la misma estructura que una entrada de `key_people_checks[].submitted.parties[]` en la decisión de la sesión de empresa.", "content": { "application/json": { "schema": { "type": "object", "description": "Registro de parte de personas clave: la misma estructura que una entrada de `key_people_checks[].submitted.parties[]` en la decisión de la sesión de empresa.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador de la parte." }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Si la parte es una persona física o una empresa." }, "name": { "type": "string", "description": "Nombre visible de la parte." }, "is_skipped": { "type": "boolean", "description": "Si la parte está exenta de verificación." }, "requires_verification": { "type": "boolean", "description": "Lo que exigían las reglas de rol y umbral. Este endpoint no lo modifica." }, "kyc_session_status": { "type": "string", "nullable": true, "description": "Estado de la sesión KYC individual vinculada, fijado en el momento de la eliminación si la sesión se eliminó." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "Enlace a la sesión KYC individual vinculada. `null` cuando no existe o cuando se eliminó." }, "kyc_session_deleted": { "type": "boolean", "description": "La sesión KYC individual vinculada se eliminó, por lo que nunca podrá resolverse." }, "kyb_sub_session_deleted": { "type": "boolean", "description": "Equivalente de `kyc_session_deleted` para partes corporativas." } } } } } }, "400": { "description": "Error de validación en el cuerpo de la solicitud. `is_skipped` es el único campo que lee este endpoint y es obligatorio. Los errores de campo llegan como `{\"\": [\"\"]}`. La validación del cuerpo se ejecuta *después* de la búsqueda de la parte, por lo que un `is_skipped` mal formado enviado a una parte que no existe devuelve `404`, no `400`.", "content": { "application/json": { "examples": { "Missing is_skipped": { "summary": "Cuerpo vacío, o un cuerpo que omite `is_skipped`", "value": { "is_skipped": [ "This field is required." ] } }, "Non-boolean is_skipped": { "summary": "El valor no es un booleano: `\"maybe\"`, `2`, `[]`. Se aceptan los booleanos, además de `\"true\"`/`\"false\"`, `1`/`0` y `\"yes\"`/`\"no\"`", "value": { "is_skipped": [ "Must be a valid boolean." ] } }, "Null is_skipped": { "summary": "`is_skipped` está presente pero es `null`", "value": { "is_skipped": [ "This field may not be null." ] } } } } } }, "403": { "description": "Faltan las credenciales o los permisos son insuficientes. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente o no válido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La credencial no tiene write:businesses", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Parte desconocida, o una parte que pertenece a otra sesión. Cada caso tiene un mensaje `detail` distinto (consulta los ejemplos). Las comprobaciones de credenciales y permisos se ejecutan antes de buscar la parte, por lo que una llamada no autorizada devuelve `403` en lugar de `404`. No hay una búsqueda de sesión independiente: un `sessionId` desconocido combinado con una parte tuya devuelve el mensaje de discrepancia.", "content": { "application/json": { "examples": { "Unknown party": { "summary": "No hay ninguna parte con este UUID en tu aplicación", "value": { "detail": "Not found." } }, "Party / session mismatch": { "summary": "partyUuid existe, pero depende de otra sesión", "value": { "detail": "Party does not belong to the given session." } } } } } }, "429": { "description": "Se superó el límite de solicitudes de escritura compartido (300 solicitudes POST/PATCH/DELETE por minuto por clave de API). Revisa `Retry-After` y los encabezados de respuesta `X-RateLimit-*` antes de reintentar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Presupuesto de escritura agotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_kyb_party(\n \"33333333-4444-5555-6666-777777777777\",\n \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\",\n is_skipped=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateKybParty(\n \"33333333-4444-5555-6666-777777777777\",\n \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\",\n {\n is_skipped: true,\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateKYBParty(ctx, \"33333333-4444-5555-6666-777777777777\", \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\", didit.SessionsUpdateKYBPartyParams{\n\tIsSkipped: true,\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsUpdateKybPartyParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateKybParty(\"33333333-4444-5555-6666-777777777777\", \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\", SessionsUpdateKybPartyParams.builder()\n .isSkipped(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateKybParty('33333333-4444-5555-6666-777777777777', '0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41', [\n 'is_skipped' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_kyb_party(\n \"33333333-4444-5555-6666-777777777777\",\n \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\",\n is_skipped: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateKybPartyAsync(\"33333333-4444-5555-6666-777777777777\", \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\", new SessionsUpdateKybPartyParams\n{\n IsSkipped = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/travel-rule/settings/": { "get": { "summary": "Obtener la configuración de Travel Rule", "description": "Lee la configuración de Travel Rule de la aplicación y su perfil de VASP. En la primera lectura, crea automáticamente una fila de configuración predeterminada (desactivada) y un perfil vacío.", "operationId": "getTravelRuleSettings", "x-didit-sdk": { "resource": "travel_rule", "method": "retrieve_settings", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/settings/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.retrieve_settings()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.retrieveSettings();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.RetrieveSettings(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().retrieveSettings();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->retrieveSettings();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.retrieve_settings\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.RetrieveSettingsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Configuración actual de Travel Rule y perfil de VASP.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleSettingsDetail" }, "examples": { "Disabled (default)": { "value": { "is_enabled": false, "jurisdiction": "EU", "name_matching_strictness": "DEFAULT", "confirmation_timeout_hours": 48, "timeout_outcome": "HOLD", "threshold_amount": "0.00", "inbound_auto_accept": true, "allow_self_declaration": true, "allow_screenshot_proof": true, "auto_wallet_verification": true, "vasp_attribution_enabled": true, "legal_name": "", "lei": "", "compliance_email": "", "is_discoverable": true, "counterparty_screening_enabled": false, "sunrise_policy": "", "sunrise_jurisdictions": [ "CO", "KH", "VN" ], "non_responsive_policy": "", "travel_address": "", "disabled_networks": [], "networks": { "gtr": { "rail": "GTR", "mode": "unavailable", "state": "didit_onboarding", "reason": "didit_membership_not_live", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 }, "trust": { "rail": "TRUST", "mode": "unavailable", "state": "unavailable", "reason": "own_membership_only", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 }, "verifyvasp": { "rail": "VERIFYVASP", "mode": "unavailable", "state": "didit_onboarding", "reason": "didit_membership_not_live", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 }, "sygna": { "rail": "SYGNA", "mode": "unavailable", "state": "didit_onboarding", "reason": "didit_membership_not_live", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 } }, "didit_network": { "listed": false, "missing": [ "travel_rule_off", "legal_name_missing", "compliance_email_missing" ], "compliance_email_confirmed": false } } } } } } } } }, "put": { "summary": "Actualizar la configuración de Travel Rule", "description": "Crea o actualiza la configuración de Travel Rule de la aplicación y su perfil de VASP. Es una actualización parcial: envía solo los campos que quieras cambiar. Establecer `is_enabled: true` requiere un `legal_name` no vacío (ya almacenado o incluido en la misma solicitud); de lo contrario, devuelve 400.", "operationId": "updateTravelRuleSettings", "x-didit-sdk": { "resource": "travel_rule", "method": "update_settings", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleSettingsUpdate" }, "example": { "is_enabled": true, "legal_name": "Origin CASP SL", "jurisdiction": "EU", "name_matching_strictness": "DEFAULT", "confirmation_timeout_hours": 48, "timeout_outcome": "HOLD", "is_discoverable": true } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PUT https://verification.didit.me/v3/travel-rule/settings/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"is_enabled\": true, \"legal_name\": \"Origin CASP SL\", \"jurisdiction\": \"EU\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.update_settings(\n is_enabled=True,\n legal_name=\"Origin CASP SL\",\n jurisdiction=\"EU\",\n name_matching_strictness=\"DEFAULT\",\n confirmation_timeout_hours=48,\n timeout_outcome=\"HOLD\",\n is_discoverable=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.updateSettings({\n is_enabled: true,\n legal_name: \"Origin CASP SL\",\n jurisdiction: \"EU\",\n name_matching_strictness: \"DEFAULT\",\n confirmation_timeout_hours: 48,\n timeout_outcome: \"HOLD\",\n is_discoverable: true,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.UpdateSettings(ctx, didit.TravelRuleSettingsUpdate{\n\tIsEnabled: didit.Bool(true),\n\tLegalName: didit.String(\"Origin CASP SL\"),\n\tJurisdiction: didit.String(\"EU\"),\n\tNameMatchingStrictness: didit.Some(didit.TravelRuleSettingsUpdateNameMatchingStrictness(\"DEFAULT\")),\n\tConfirmationTimeoutHours: didit.Int(48),\n\tTimeoutOutcome: didit.Some(didit.TravelRuleSettingsUpdateTimeoutOutcome(\"HOLD\")),\n\tIsDiscoverable: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleSettingsUpdate;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().updateSettings(TravelRuleSettingsUpdate.builder()\n .isEnabled(true)\n .legalName(\"Origin CASP SL\")\n .jurisdiction(\"EU\")\n .nameMatchingStrictness(TravelRuleSettingsUpdate.NameMatchingStrictness.of(\"DEFAULT\"))\n .confirmationTimeoutHours(48L)\n .timeoutOutcome(TravelRuleSettingsUpdate.TimeoutOutcome.of(\"HOLD\"))\n .isDiscoverable(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->updateSettings([\n 'is_enabled' => true,\n 'legal_name' => 'Origin CASP SL',\n 'jurisdiction' => 'EU',\n 'name_matching_strictness' => 'DEFAULT',\n 'confirmation_timeout_hours' => 48,\n 'timeout_outcome' => 'HOLD',\n 'is_discoverable' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.update_settings(\n is_enabled: true,\n legal_name: \"Origin CASP SL\",\n jurisdiction: \"EU\",\n name_matching_strictness: \"DEFAULT\",\n confirmation_timeout_hours: 48,\n timeout_outcome: \"HOLD\",\n is_discoverable: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.UpdateSettingsAsync(new TravelRuleSettingsUpdate\n{\n IsEnabled = true,\n LegalName = \"Origin CASP SL\",\n Jurisdiction = \"EU\",\n NameMatchingStrictness = new TravelRuleSettingsUpdateNameMatchingStrictness(\"DEFAULT\"),\n ConfirmationTimeoutHours = 48,\n TimeoutOutcome = new TravelRuleSettingsUpdateTimeoutOutcome(\"HOLD\"),\n IsDiscoverable = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Configuración y perfil actualizados, con la misma estructura que GET.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleSettingsDetail" } } } }, "400": { "description": "Error de validación, p. ej., activar sin un legal_name, una sunrise_policy o non_responsive_policy distinta de HOLD, REJECT, PROCEED o vacía, un campo desconocido en `matching_rules`, o una opción de `data_sharing_fields` que no permite cumplir las obligaciones del ordenante del régimen de tu jurisdicción (los errores se agrupan por tipo de entidad en `data_sharing_fields`).", "content": { "application/json": { "schema": { "type": "object" }, "example": { "legal_name": [ "legal_name is required to enable travel rule." ] } } } } } } }, "/v3/travel-rule/settings/compliance-email/confirmation/": { "post": { "summary": "Envía la confirmación del correo de cumplimiento", "description": "Envía por correo electrónico un enlace de confirmación de un solo uso al compliance_email de tu perfil de VASP. Al abrir el enlace y pulsar su botón de confirmación se confirma la dirección, algo que la red de Didit necesita antes de listar tu perfil. Una nueva solicitud reemplaza el enlace anterior; el enlace deja de funcionar cuando cambia el correo de cumplimiento. Un correo por minuto por dirección.", "operationId": "sendTravelRuleComplianceEmailConfirmation", "x-didit-sdk": { "resource": "travel_rule", "method": "send_compliance_email_confirmation", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/settings/compliance-email/confirmation/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.send_compliance_email_confirmation()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.sendComplianceEmailConfirmation();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.SendComplianceEmailConfirmation(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().sendComplianceEmailConfirmation();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->sendComplianceEmailConfirmation();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.send_compliance_email_confirmation\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.SendComplianceEmailConfirmationAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "202": { "description": "Se envió el correo electrónico de confirmación.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sent_to": { "type": "string", "format": "email" } } }, "example": { "sent_to": "compliance@your-vasp.example" } } } }, "400": { "description": "No hay ningún correo electrónico de cumplimiento configurado, o ya está confirmado.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "examples": { "No compliance email": { "value": { "compliance_email": [ "Set a compliance email before confirming it." ] } }, "Already confirmed": { "value": { "compliance_email": [ "This compliance email is already confirmed." ] } } } } } }, "429": { "description": "Se envió una confirmación a esta dirección hace menos de un minuto." }, "503": { "description": "No se pudo enviar el correo electrónico. No cambió nada; vuelve a intentarlo en un momento." } } } }, "/v3/travel-rule/wallet-addresses/": { "get": { "summary": "Listar entradas de la libreta de direcciones de wallets", "description": "Lista paginada de la libreta de direcciones de wallets de Travel Rule de tu aplicación, de la más reciente a la más antigua.", "operationId": "listTravelRuleWalletAddresses", "x-didit-sdk": { "resource": "travel_rule.wallet_addresses", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/wallet-addresses/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.travel_rule.wallet_addresses.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.travelRule.walletAddresses.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.TravelRule.WalletAddresses.ListAutoPaging(ctx, didit.TravelRuleWalletAddressesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.travelRule().walletAddresses().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletAddresses->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.wallet_addresses.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.TravelRule.WalletAddresses.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Entradas paginadas de la libreta de direcciones de wallets.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WalletAddressEntry" } } } } } } } } }, "post": { "summary": "Registrar una dirección de wallet", "description": "Añade una entrada a tu libreta de direcciones de wallets de Travel Rule para que las transferencias entrantes por la vía INTERNAL puedan resolverse con ella.", "operationId": "createTravelRuleWalletAddress", "x-didit-sdk": { "resource": "travel_rule.wallet_addresses", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressEntryCreate" }, "example": { "address": "0xBeneficiaryWallet01", "chain": "ETH", "holder_name": "Ana Diaz", "holder_vendor_data": "user-042", "self_declared": true } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/wallet-addresses/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"address\": \"0xBeneficiaryWallet01\", \"chain\": \"ETH\", \"holder_name\": \"Ana Diaz\", \"self_declared\": true}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.wallet_addresses.create(\n address=\"0xBeneficiaryWallet01\",\n chain=\"ETH\",\n holder_vendor_data=\"user-042\",\n holder_name=\"Ana Diaz\",\n self_declared=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.walletAddresses.create({\n address: \"0xBeneficiaryWallet01\",\n chain: \"ETH\",\n holder_vendor_data: \"user-042\",\n holder_name: \"Ana Diaz\",\n self_declared: true,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.WalletAddresses.Create(ctx, didit.WalletAddressEntryCreate{\n\tAddress: \"0xBeneficiaryWallet01\",\n\tChain: didit.String(\"ETH\"),\n\tHolderVendorData: didit.String(\"user-042\"),\n\tHolderName: didit.String(\"Ana Diaz\"),\n\tSelfDeclared: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.WalletAddressEntryCreate;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().walletAddresses().create(WalletAddressEntryCreate.builder()\n .address(\"0xBeneficiaryWallet01\")\n .chain(\"ETH\")\n .holderVendorData(\"user-042\")\n .holderName(\"Ana Diaz\")\n .selfDeclared(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletAddresses->create([\n 'address' => '0xBeneficiaryWallet01',\n 'chain' => 'ETH',\n 'holder_vendor_data' => 'user-042',\n 'holder_name' => 'Ana Diaz',\n 'self_declared' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.wallet_addresses.create(\n address: \"0xBeneficiaryWallet01\",\n chain: \"ETH\",\n holder_vendor_data: \"user-042\",\n holder_name: \"Ana Diaz\",\n self_declared: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.WalletAddresses.CreateAsync(new WalletAddressEntryCreate\n{\n Address = \"0xBeneficiaryWallet01\",\n Chain = \"ETH\",\n HolderVendorData = \"user-042\",\n HolderName = \"Ana Diaz\",\n SelfDeclared = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "La entrada creada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressEntry" } } } }, "400": { "description": "Wallet duplicada (dirección, cadena y memo) para esta aplicación, un memo o una X-address que la cadena no admite, falta `address`, un `travel_address` no válido, `self_declared: true` mientras `allow_self_declaration` está desactivado, o `self_declared: true` mientras `ownership_validation_mode` es `FULL`.", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Duplicate entry": { "value": { "address": [ "A wallet address entry with this address and chain already exists." ] } }, "Invalid travel address": { "value": { "travel_address": [ "Invalid travel address." ] } }, "Self-declaration disabled": { "value": { "self_declared": [ "Self-declared ownership is disabled for this application." ] } } } } } } } } }, "/v3/travel-rule/wallet-addresses/{entry_uuid}/": { "patch": { "summary": "Actualizar los metadatos del titular de la dirección de wallet", "description": "Actualización parcial de holder_name, holder_vendor_data, entity_type y travel_address. Establecer travel_address asocia una dirección de enrutamiento TRP a la entrada; los valores no válidos se rechazan con 400. La respuesta devuelve solo estos cuatro campos.", "operationId": "updateTravelRuleWalletAddress", "x-didit-sdk": { "resource": "travel_rule.wallet_addresses", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "entry_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressEntryUpdate" }, "example": { "holder_name": "Ana Updated", "travel_address": "ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH https://verification.didit.me/v3/travel-rule/wallet-addresses/{entry_uuid}/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"holder_name\": \"Ana Updated\", \"travel_address\": \"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.wallet_addresses.update(\n \"11111111-2222-3333-4444-555555555555\",\n holder_name=\"Ana Updated\",\n travel_address=\"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.walletAddresses.update(\"11111111-2222-3333-4444-555555555555\", {\n holder_name: \"Ana Updated\",\n travel_address: \"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.WalletAddresses.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WalletAddressEntryUpdateParam{\n\tHolderName: didit.String(\"Ana Updated\"),\n\tTravelAddress: didit.String(\"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.WalletAddressEntryUpdate;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().walletAddresses().update(\"11111111-2222-3333-4444-555555555555\", WalletAddressEntryUpdate.builder()\n .holderName(\"Ana Updated\")\n .travelAddress(\"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletAddresses->update('11111111-2222-3333-4444-555555555555', [\n 'holder_name' => 'Ana Updated',\n 'travel_address' => 'ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.wallet_addresses.update(\n \"11111111-2222-3333-4444-555555555555\",\n holder_name: \"Ana Updated\",\n travel_address: \"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.WalletAddresses.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new WalletAddressEntryUpdate\n{\n HolderName = \"Ana Updated\",\n TravelAddress = \"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Los campos actualizados.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressEntryUpdate" } } } }, "400": { "description": "`travel_address` no es una travel address válida.", "content": { "application/json": { "examples": { "Invalid travel address": { "value": { "travel_address": [ "Invalid travel address." ] } } } } } }, "404": { "description": "Entrada desconocida o eliminada." } } }, "delete": { "summary": "Eliminar una dirección de wallet", "description": "Elimina la entrada junto con sus pruebas de propiedad y las capturas de pantalla que almacenaban. Deja de generar coincidencias con nuevas transferencias de inmediato y la dirección queda libre para volver a registrarse. Las transferencias que ya usaron la wallet conservan su propio registro de ella y se leen igual. La eliminación es irreversible.", "operationId": "deleteTravelRuleWalletAddress", "x-didit-sdk": { "resource": "travel_rule.wallet_addresses", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "entry_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE https://verification.didit.me/v3/travel-rule/wallet-addresses/{entry_uuid}/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.travel_rule.wallet_addresses.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.travelRule.walletAddresses.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.TravelRule.WalletAddresses.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.travelRule().walletAddresses().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletAddresses->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.wallet_addresses.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.TravelRule.WalletAddresses.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ], "responses": { "204": { "description": "Eliminado." }, "404": { "description": "Entrada desconocida o ya eliminada." }, "503": { "description": "`wallet_address_deletion_incomplete`: no se pudo eliminar un archivo almacenado, por lo que la eliminación se detuvo antes de terminar. La entrada de la libreta de direcciones sigue existiendo; reintenta la misma solicitud para completarla.", "content": { "application/json": { "example": { "detail": "A stored file could not be deleted, so the deletion stopped before it finished. Try again.", "code": "wallet_address_deletion_incomplete" } } } } } } }, "/v3/travel-rule/vasps/": { "get": { "summary": "Buscar en el directorio de VASP", "description": "Búsqueda paginada y ordenada por nombre en el directorio de VASP: las entradas del directorio compartido, que Didit construye a partir del registro provisional MiCA de ESMA, el directorio público de TRISA, el registro global de LEI y su propia curación, además de los miembros de la red de Didit. Cada fila incluye las rutas que tu aplicación tiene hoy hacia esa entrada. El perfil de tu propia aplicación nunca aparece en la lista. Las filas también incluyen la evaluación de diligencia debida compartida y la decisión, el análisis de la entidad y los cuestionarios propios de tu aplicación.", "operationId": "listTravelRuleVasps", "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string", "maxLength": 255 }, "description": "Un fragmento de nombre o alias (sin distinguir mayúsculas de minúsculas), un LEI exacto o un dominio (example.com o una URL de ese dominio). Los miembros de la red Didit coinciden por su razón social, su LEI o el dominio de su correo electrónico de cumplimiento." }, { "name": "network", "in": "query", "schema": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA", "TRISA" ] }, "description": "Solo las entradas del directorio que el directorio de miembros de una red incluye actualmente." }, { "name": "jurisdiction", "in": "query", "schema": { "type": "string" }, "description": "Código de país ISO 3166 alfa-2 o alfa-3. Cualquier otro valor devuelve 400." }, { "name": "reachable", "in": "query", "schema": { "type": "boolean" }, "description": "true: solo los VASP a los que tu aplicación tiene una ruta disponible (incluidos los miembros de la red de Didit). false: solo las entradas del directorio a las que hoy no puede llegar." }, { "name": "kind", "in": "query", "schema": { "type": "string", "enum": [ "directory", "didit" ] }, "description": "Solo entradas del directorio, o solo miembros de la red de Didit." }, { "name": "risk", "in": "query", "schema": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "description": "Solo las entradas del directorio cuyo risk_level está en esta franja. Los miembros de la red de Didit, que no reciben puntuación, nunca coinciden." }, { "name": "responsiveness", "in": "query", "schema": { "type": "string", "enum": [ "RESPONSIVE", "UNRESPONSIVE", "UNKNOWN" ] }, "description": "Solo las entradas del directorio cuyo responsiveness.status es este valor. Los miembros de la red de Didit nunca coinciden." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/travel-rule/vasps/?search=counterparty&reachable=true' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.travel_rule.list_vasps():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.travelRule.listVasps()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.TravelRule.ListVASPsAutoPaging(ctx, didit.TravelRuleListVASPsParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.travelRule().listVasps()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "travelRule->listVasps() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.list_vasps.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.TravelRule.ListVaspsAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Resultados paginados del directorio de VASP, ordenados por nombre.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/VaspDirectoryEntry" } } } } } } }, "400": { "description": "Un filtro no es válido: el cuerpo indica cada campo, por ejemplo, un código de red o de país, una banda de riesgo o un estado de capacidad de respuesta desconocidos.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "example": { "jurisdiction": [ "Use an ISO 3166 alpha-2 or alpha-3 country code." ], "network": [ "\"SWIFT\" is not a valid choice." ] } } } } }, "x-didit-sdk": { "resource": "travel_rule", "method": "list_vasps", "auth": "api_key", "server": true } } }, "/v3/travel-rule/vasps/{vasp_id}/": { "get": { "summary": "Obtener una entrada del directorio de VASP", "description": "Una entrada del directorio o un miembro de la red de Didit según el id que devolvió la búsqueda, con los mismos campos y las rutas que tu aplicación tiene hacia él.", "operationId": "getTravelRuleVasp", "x-didit-sdk": { "resource": "travel_rule", "method": "retrieve_vasp", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "El id de una fila de GET /v3/travel-rule/vasps/." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.retrieve_vasp(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.retrieveVasp(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.RetrieveVASP(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().retrieveVasp(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->retrieveVasp('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.retrieve_vasp(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.RetrieveVaspAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La entrada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaspDirectoryEntry" } } } }, "404": { "description": "Ninguna entrada ni ningún miembro listado de la red de Didit tiene este id.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry has this id." } } } } } } }, "/v3/travel-rule/vasps/{vasp_id}/decision/": { "get": { "summary": "Obtener tu decisión sobre un VASP", "description": "La decisión de tu aplicación sobre una contraparte (una entrada del directorio o un miembro de la red de Didit): aprobada, restringida o bloqueada. Una entidad de una marca sin decisión propia sigue la decisión de la marca, indicada en inherited_from. Es privada de tu aplicación.", "operationId": "getTravelRuleVaspDecision", "x-didit-sdk": { "resource": "travel_rule", "method": "retrieve_vasp_decision", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "El id de una fila de GET /v3/travel-rule/vasps/: una entrada del directorio o un miembro de la red Didit." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/decision/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.retrieve_vasp_decision(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.retrieveVaspDecision(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.RetrieveVASPDecision(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().retrieveVaspDecision(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->retrieveVaspDecision('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.retrieve_vasp_decision(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.RetrieveVaspDecisionAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La decisión que se aplica, o null.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyDecisionResponse" }, "examples": { "Own decision": { "value": { "decision": { "decision": "APPROVED", "reason": "Licensed in DE, questionnaire reviewed", "decided_by": "", "updated_at": "2026-10-14T10:05:00Z", "inherited_from": null } } }, "Inherited from the brand": { "value": { "decision": { "decision": "BLOCKED", "reason": "Group refused after review", "decided_by": "", "updated_at": "2026-10-14T10:05:00Z", "inherited_from": { "id": "5e4d3c2b-1a0f-4e9d-8c7b-6a5f4e3d2c1b", "name": "Example Group" } } } }, "No decision": { "value": { "decision": null } } } } } }, "404": { "description": "Ninguna entrada del directorio ni ningún miembro listado de la red de Didit tiene este id. Tu propio perfil de VASP nunca es una contraparte tuya.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } } } }, "put": { "summary": "Establece tu decisión sobre un VASP", "description": "Toma o cambia la decisión de tu aplicación sobre una contraparte: APPROVED, RESTRICTED o BLOCKED, con un motivo opcional. Nunca modifica la entrada compartida del directorio y actúa solo a través de tus reglas de transacciones (counterparty_dd_status). Una decisión sobre una marca también se aplica a cada una de sus entidades que no tenga una decisión propia.", "operationId": "updateTravelRuleVaspDecision", "x-didit-sdk": { "resource": "travel_rule", "method": "update_vasp_decision", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "El id de una fila de GET /v3/travel-rule/vasps/: una entrada del directorio o un miembro de la red Didit." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyDecisionRequest" }, "example": { "decision": "BLOCKED", "reason": "Unlicensed in its home jurisdiction" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PUT https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/decision/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"decision\": \"BLOCKED\", \"reason\": \"Unlicensed in its home jurisdiction\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.update_vasp_decision(\n \"11111111-2222-3333-4444-555555555555\",\n decision=\"BLOCKED\",\n reason=\"Unlicensed in its home jurisdiction\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.updateVaspDecision(\"11111111-2222-3333-4444-555555555555\", {\n decision: \"BLOCKED\",\n reason: \"Unlicensed in its home jurisdiction\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.UpdateVASPDecision(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleCounterpartyDecisionRequest{\n\tDecision: \"BLOCKED\",\n\tReason: didit.String(\"Unlicensed in its home jurisdiction\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleCounterpartyDecisionRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().updateVaspDecision(\"11111111-2222-3333-4444-555555555555\", TravelRuleCounterpartyDecisionRequest.builder()\n .decision(TravelRuleCounterpartyDecisionRequest.Decision.of(\"BLOCKED\"))\n .reason(\"Unlicensed in its home jurisdiction\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->updateVaspDecision('11111111-2222-3333-4444-555555555555', [\n 'decision' => 'BLOCKED',\n 'reason' => 'Unlicensed in its home jurisdiction',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.update_vasp_decision(\n \"11111111-2222-3333-4444-555555555555\",\n decision: \"BLOCKED\",\n reason: \"Unlicensed in its home jurisdiction\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.UpdateVaspDecisionAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleCounterpartyDecisionRequest\n{\n Decision = \"BLOCKED\",\n Reason = \"Unlicensed in its home jurisdiction\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La decisión tal como se aplica ahora.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyDecisionResponse" }, "example": { "decision": { "decision": "BLOCKED", "reason": "Unlicensed in its home jurisdiction", "decided_by": "", "updated_at": "2026-10-14T10:05:00Z", "inherited_from": null } } } } }, "400": { "description": "Falta la decisión o no es APPROVED, RESTRICTED ni BLOCKED, o el motivo supera los 255 caracteres.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "example": { "decision": [ "\"MAYBE\" is not a valid choice." ] } } } }, "404": { "description": "Ninguna entrada del directorio ni ningún miembro listado de la red de Didit tiene este id. Tu propio perfil de VASP nunca es una contraparte tuya.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } } } }, "delete": { "summary": "Eliminar tu decisión sobre un VASP", "description": "Elimina la decisión propia de tu aplicación sobre una contraparte. La respuesta muestra la decisión que se aplica a partir de entonces: null o, en el caso de una entidad de una marca, la decisión de la marca, que la entidad vuelve a seguir.", "operationId": "clearTravelRuleVaspDecision", "x-didit-sdk": { "resource": "travel_rule", "method": "clear_vasp_decision", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "El id de una fila de GET /v3/travel-rule/vasps/: una entrada del directorio o un miembro de la red Didit." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/decision/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.clear_vasp_decision(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.clearVaspDecision(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.ClearVASPDecision(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().clearVaspDecision(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->clearVaspDecision('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.clear_vasp_decision(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.ClearVaspDecisionAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La decisión se borró; el cuerpo muestra la decisión que se aplica ahora.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyDecisionResponse" }, "example": { "decision": null } } } }, "404": { "description": "Ninguna contraparte tiene este id, o tu aplicación no tiene una decisión propia sobre ella (una decisión que solo hereda de su marca no se puede eliminar aquí: elimina la de la marca).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Unknown id": { "value": { "detail": "No directory entry or Didit network member has this id." } }, "No decision of its own": { "value": { "detail": "This application has no decision of its own on this counterparty." } } } } } } } } }, "/v3/travel-rule/vasps/{vasp_id}/screening/": { "get": { "summary": "Obtener el análisis de entidad de un VASP", "description": "Indica si el análisis de la contraparte está activado para tu aplicación, cuánto le cuesta un análisis a tu organización, cuánto tiempo sigue vigente un resultado y tu último análisis de sanciones y medios adversos de la contraparte. Consultarlo es gratuito.", "operationId": "getTravelRuleVaspScreening", "x-didit-sdk": { "resource": "travel_rule", "method": "retrieve_vasp_screening", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "El id de una fila de GET /v3/travel-rule/vasps/: una entrada del directorio o un miembro de la red Didit." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/screening/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.retrieve_vasp_screening(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.retrieveVaspScreening(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.RetrieveVASPScreening(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().retrieveVaspScreening(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->retrieveVaspScreening('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.retrieve_vasp_screening(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.RetrieveVaspScreeningAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Tu configuración de análisis, su precio y tu análisis más reciente.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyScreeningStatus" }, "example": { "enabled": true, "price": "0.20", "fresh_days": 30, "screening": { "id": "7a1d2c3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d", "status": "Approved", "total_hits": 0, "score": null, "screened_at": "2026-10-14T09:58:00Z", "fresh": true, "flagged": false } } } } }, "403": { "description": "El contrato de tu organización no tiene una tarifa configurada para el análisis de contrapartes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No contract rate is configured for this usage type." } } } }, "404": { "description": "Ninguna entrada del directorio ni ningún miembro listado de la red de Didit tiene este id. Tu propio perfil de VASP nunca es una contraparte tuya.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } } } }, "post": { "summary": "Analizar un VASP", "description": "Analiza la entidad contraparte frente a sanciones y medios adversos para tu aplicación. Requiere activación: counterparty_screening_enabled debe estar activado en la configuración de Travel Rule. Cada nuevo análisis se factura al precio de Análisis AML de empresas de tu organización. Si existe un análisis de menos de 30 días, se devuelve ese análisis (200, sin cargo), salvo que envíes refresh: true. Solo se ejecuta un análisis de una misma contraparte a la vez por aplicación. El resultado es privado para tu aplicación. Las aplicaciones de sandbox nunca se analizan.", "operationId": "screenTravelRuleVasp", "x-didit-sdk": { "resource": "travel_rule", "method": "screen_vasp", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "El id de una fila de GET /v3/travel-rule/vasps/: una entrada del directorio o un miembro de la red Didit." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyScreeningRequest" }, "example": { "refresh": false } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/screening/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"refresh\": false}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.screen_vasp(\n \"11111111-2222-3333-4444-555555555555\",\n refresh=False,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.screenVasp(\"11111111-2222-3333-4444-555555555555\", {\n refresh: false,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.ScreenVASP(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleCounterpartyScreeningRequest{\n\tRefresh: didit.Bool(false),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleCounterpartyScreeningRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().screenVasp(\"11111111-2222-3333-4444-555555555555\", TravelRuleCounterpartyScreeningRequest.builder()\n .refresh(false)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->screenVasp('11111111-2222-3333-4444-555555555555', [\n 'refresh' => false,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.screen_vasp(\n \"11111111-2222-3333-4444-555555555555\",\n refresh: false\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.ScreenVaspAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleCounterpartyScreeningRequest\n{\n Refresh = false,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Ya existía un análisis reciente y se devolvió. No se facturó nada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyScreeningResult" }, "example": { "outcome": "reused", "screening": { "id": "7a1d2c3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d", "status": "Approved", "total_hits": 0, "score": null, "screened_at": "2026-10-14T09:58:00Z", "fresh": true, "flagged": false } } } } }, "201": { "description": "Se ejecutó un nuevo análisis y se facturó.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyScreeningResult" }, "example": { "outcome": "screened", "screening": { "id": "7a1d2c3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d", "status": "In Review", "total_hits": 2, "score": 85.0, "screened_at": "2026-10-14T09:58:00Z", "fresh": true, "flagged": true } } } } }, "400": { "description": "El cuerpo no es válido o la contraparte no tiene un nombre que analizar.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "example": { "detail": [ "This counterparty has no name to screen." ] } } } }, "403": { "description": "El saldo de tu organización no alcanza para cubrir el análisis (código insufficient_credits; no se ejecutó nada ni se facturó nada), o tu contrato no tiene una tarifa configurada para él.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string" } } }, "example": { "detail": "You don't have enough credits to perform this request. Please top up at https://business.didit.me", "code": "insufficient_credits" } } } }, "404": { "description": "Ninguna entrada del directorio ni ningún miembro listado de la red de Didit tiene este id. Tu propio perfil de VASP nunca es una contraparte tuya.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } }, "409": { "description": "No se ejecutó nada y no se facturó nada: el análisis de contrapartes está desactivado para tu aplicación, la aplicación es de sandbox o ya hay un análisis de esta contraparte en curso.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Screening off": { "value": { "detail": "Counterparty screening is turned off. Enable it in the Travel Rule settings first." } }, "Sandbox application": { "value": { "detail": "Counterparty screening does not run for sandbox applications." } }, "Already running": { "value": { "detail": "A screening of this counterparty is already running. Try again in a moment." } } } } } }, "502": { "description": "No se pudo completar el análisis. No se facturó nada; vuelve a intentarlo en unos momentos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "The screening provider did not answer. Try again in a moment." } } } } } } }, "/v3/travel-rule/vasps/{vasp_id}/questionnaires/": { "get": { "summary": "Listar cuestionarios de diligencia debida con un VASP", "description": "Todos los cuestionarios de diligencia debida que tu aplicación envió a la contraparte, del más reciente al más antiguo, con su estado y, una vez respondidos, las respuestas. Son privados de tu aplicación.", "operationId": "listTravelRuleVaspQuestionnaires", "x-didit-sdk": { "resource": "travel_rule", "method": "list_vasp_questionnaires", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "El id de una fila de GET /v3/travel-rule/vasps/: una entrada del directorio o un miembro de la red Didit." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/questionnaires/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.list_vasp_questionnaires(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.listVaspQuestionnaires(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.ListVASPQuestionnaires(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().listVaspQuestionnaires(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->listVaspQuestionnaires('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.list_vasp_questionnaires(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.ListVaspQuestionnairesAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Tus cuestionarios con esta contraparte.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyQuestionnaireList" }, "example": { "questionnaires": [ { "id": "3f9e8d7c-6b5a-4c3d-9e2f-1a0b9c8d7e6f", "status": "SENT", "form_version": "1", "sent_to": "travelrule@counterparty.example", "sent_at": "2026-10-14T10:00:00Z", "expires_at": "2026-11-13T10:00:00Z", "answered_at": null, "valid_until": null, "current": false, "answers": {} }, { "id": "8b7a6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d", "status": "ANSWERED", "form_version": "1", "sent_to": "travelrule@counterparty.example", "sent_at": "2026-09-02T08:00:00Z", "expires_at": "2026-10-02T08:00:00Z", "answered_at": "2026-09-04T15:20:00Z", "valid_until": "2027-09-04T15:20:00Z", "current": true, "answers": { "legal_name": "Example Counterparty VASP, incorporated in the example jurisdiction.", "licensing": "Crypto-asset service provider authorised under MiCA by its national regulator, licence active.", "jurisdictions": "EU and EEA. We do not serve the United States.", "aml_program": "Written AML/CFT policy, annual independent review, last completed in March 2026.", "compliance_officer": "Head of Compliance, reachable at compliance@counterparty.example.", "sanctions_screening": "Customers at onboarding and daily; counterparties on every transfer.", "transaction_monitoring": "Rule-based monitoring with analyst review; suspicious activity reports filed with the FIU.", "travel_rule": "TRP and email; we answer requests within one business day.", "custody": "Segregated customer wallets held with a qualified custodian, insured.", "ownership": "No shareholder holds 25 percent or more; parent company Example Holding Group.", "record_keeping": "Five-year record-keeping for Travel Rule and transaction data, as our regulator requires.", "data_protection": "Encrypted at rest and in transit, stored in the EU." } } ] } } } }, "404": { "description": "Ninguna entrada del directorio ni ningún miembro listado de la red de Didit tiene este id. Tu propio perfil de VASP nunca es una contraparte tuya.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } } } }, "post": { "summary": "Enviar un cuestionario de diligencia debida a un VASP", "description": "Envía por correo electrónico el cuestionario estándar de diligencia debida de Didit a una dirección de cumplimiento registrada de la contraparte, con un enlace de respuesta de un solo uso. La contraparte tiene 30 días para responder todas las preguntas; las respuestas siguen vigentes durante 365 días. Un nuevo envío sustituye tu cuestionario anterior sin responder a la misma contraparte, cuyo enlace deja de funcionar. Un correo electrónico por minuto por dirección.", "operationId": "sendTravelRuleVaspQuestionnaire", "x-didit-sdk": { "resource": "travel_rule", "method": "send_vasp_questionnaire", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "El id de una fila de GET /v3/travel-rule/vasps/: una entrada del directorio o un miembro de la red Didit." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyQuestionnaireRequest" }, "example": { "sent_to": "travelrule@counterparty.example" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/questionnaires/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"sent_to\": \"travelrule@counterparty.example\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.send_vasp_questionnaire(\n \"11111111-2222-3333-4444-555555555555\",\n sent_to=\"travelrule@counterparty.example\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.sendVaspQuestionnaire(\"11111111-2222-3333-4444-555555555555\", {\n sent_to: \"travelrule@counterparty.example\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.SendVASPQuestionnaire(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleCounterpartyQuestionnaireRequest{\n\tSentTo: didit.String(\"travelrule@counterparty.example\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleCounterpartyQuestionnaireRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().sendVaspQuestionnaire(\"11111111-2222-3333-4444-555555555555\", TravelRuleCounterpartyQuestionnaireRequest.builder()\n .sentTo(\"travelrule@counterparty.example\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->sendVaspQuestionnaire('11111111-2222-3333-4444-555555555555', [\n 'sent_to' => 'travelrule@counterparty.example',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.send_vasp_questionnaire(\n \"11111111-2222-3333-4444-555555555555\",\n sent_to: \"travelrule@counterparty.example\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.SendVaspQuestionnaireAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleCounterpartyQuestionnaireRequest\n{\n SentTo = \"travelrule@counterparty.example\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "202": { "description": "El cuestionario se envió por correo electrónico.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyQuestionnaire" }, "example": { "id": "3f9e8d7c-6b5a-4c3d-9e2f-1a0b9c8d7e6f", "status": "SENT", "form_version": "1", "sent_to": "travelrule@counterparty.example", "sent_at": "2026-10-14T10:00:00Z", "expires_at": "2026-11-13T10:00:00Z", "answered_at": null, "valid_until": null, "current": false, "answers": {} } } } }, "400": { "description": "sent_to no es una dirección de correo electrónico válida o no es una dirección de cumplimiento registrada para la contraparte, o la contraparte no tiene ninguna dirección de cumplimiento registrada.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "examples": { "Not on record": { "value": { "sent_to": [ "Send the questionnaire to a compliance address on record for this counterparty." ] } }, "No address": { "value": { "sent_to": [ "No compliance address is on record for this counterparty. Add a contact for it first." ] } } } } } }, "404": { "description": "Ninguna entrada del directorio ni ningún miembro listado de la red de Didit tiene este id. Tu propio perfil de VASP nunca es una contraparte tuya.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } }, "429": { "description": "Se envió un cuestionario a esta dirección hace menos de un minuto." }, "503": { "description": "No se pudo enviar el correo electrónico y no se creó ningún cuestionario. Vuelve a intentarlo en un momento." } } } }, "/v3/transactions/{transaction_id}/travel-rule/": { "patch": { "summary": "Finalizar, cancelar, reenviar o actualizar la wallet del ordenante de una transferencia de Travel Rule", "description": "Envía `payment_txn_id` para informar el hash on-chain y pasar una transferencia saliente COMPLETED a FINISHED (su transferencia homóloga del rail INTERNAL también pasa a FINISHED), `{\"action\": \"cancel\"}` para cancelar una transferencia que no esté en un estado final, o `{\"action\": \"resend\"}` para volver a enrutar una transferencia saliente bloqueada en COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE o NOT_ENOUGH_COUNTERPARTY_DATA (antes mejora los datos de la contraparte, por ejemplo añade una travel_address a la entrada de la wallet de destino). resend solo se aplica a transferencias salientes. `{\"action\": \"update_compliance_email\", \"compliance_email\": \"desk@example.com\"}` reemplaza el correo de cumplimiento de una transferencia saliente que esté en uno de esos tres estados, la solución para `reason: email_undeliverable`: el estado no cambia y el siguiente `resend` envía la solicitud a esa dirección. Un reenvío se pone en cola, no se ejecuta dentro de la solicitud: la respuesta muestra la transferencia de nuevo en AWAITING_COUNTERPARTY con una entrada `resend queued` en la cronología y una `delivery` en cola, y el lugar al que se envió llega como un webhook `travel_rule.status.updated`. Cuando la transferencia se envió por GTR, VerifyVASP o Sygna Bridge, la red recibe el hash on-chain o la cancelación después de la respuesta, con reintentos; `delivery` muestra el estado de ese mensaje. `{\"action\": \"update_originator_wallet\", \"wallet_address\": \"...\"}` registra la wallet desde la que realmente salieron los fondos en una transferencia saliente, por ejemplo la dirección desde la que se difundió un retiro UTXO en lugar de la wallet principal que declaraste. Solo cambia el registro: no se vuelve a enviar nada a la contraparte y el estado se mantiene. El ordenante pasa a ser `chain_details.originator` con `source: updated`, el cambio se añade a la `timeline` con la wallet anterior y la nueva, y la transferencia homóloga del rail INTERNAL se actualiza de la misma forma. `{\"action\": \"beneficiary_vasp\", \"beneficiary_vasp\": \"\"}` te permite indicar tú mismo la contraparte cuando el descubrimiento no pudo hacerlo, en una transferencia saliente en COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE o NOT_ENOUGH_COUNTERPARTY_DATA: la transferencia se enruta a ese VASP y se vuelve a enviar.", "operationId": "patchTravelRuleTransfer", "x-didit-sdk": { "resource": "transactions.travel_rule", "method": "update_transfer", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "UUID estable de Didit de la transacción a la que pertenece la transferencia.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTransferPatchRequest" }, "examples": { "Finish": { "value": { "payment_txn_id": "0xchainhash" } }, "Cancel": { "value": { "action": "cancel" } }, "Resend": { "value": { "action": "resend" } }, "Update compliance email": { "value": { "action": "update_compliance_email", "compliance_email": "desk@example.com" } }, "Update originator wallet": { "value": { "action": "update_originator_wallet", "wallet_address": "bc1qOriginatorInputAddress01" } }, "Name the counterparty": { "value": { "action": "beneficiary_vasp", "beneficiary_vasp": "9f1c2b34-5d6e-4f70-8a91-b2c3d4e5f607" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH https://verification.didit.me/v3/transactions/{transaction_id}/travel-rule/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"payment_txn_id\": \"0xchainhash\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.travel_rule.update_transfer(\n \"11111111-2222-3333-4444-555555555555\",\n payment_txn_id=\"0xchainhash\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.travelRule.updateTransfer(\"11111111-2222-3333-4444-555555555555\", {\n payment_txn_id: \"0xchainhash\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.TravelRule.UpdateTransfer(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleTransferPatchRequest{\n\tPaymentTxnID: didit.String(\"0xchainhash\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleTransferPatchRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().travelRule().updateTransfer(\"11111111-2222-3333-4444-555555555555\", TravelRuleTransferPatchRequest.builder()\n .paymentTxnId(\"0xchainhash\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->travelRule->updateTransfer('11111111-2222-3333-4444-555555555555', [\n 'payment_txn_id' => '0xchainhash',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.travel_rule.update_transfer(\n \"11111111-2222-3333-4444-555555555555\",\n payment_txn_id: \"0xchainhash\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.TravelRule.UpdateTransferAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleTransferPatchRequest\n{\n PaymentTxnId = \"0xchainhash\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La transferencia actualizada. Después de `update_compliance_email`, su estado no cambia y conserva `reason: email_undeliverable` hasta el siguiente `resend`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTransferDetail" } } } }, "400": { "description": "No se proporcionó ni payment_txn_id ni una acción admitida, falta `compliance_email` o no es una dirección de correo electrónico en `update_compliance_email`, o, para `update_originator_wallet`, falta wallet_address, hay una wallet o un memo que la cadena de la transferencia no puede transportar o hay una wallet que no es una de las entradas UTXO de la transferencia, o falta `beneficiary_vasp` o no es un ID de VASP válido del directorio.", "content": { "application/json": { "examples": { "No action": { "value": { "detail": [ "Provide payment_txn_id, action=cancel, action=resend, action=beneficiary_vasp, action=update_originator_wallet or action=update_compliance_email." ] } }, "Invalid compliance email": { "value": { "compliance_email": [ "Enter a valid email address." ] } } } } } }, "404": { "description": "Transacción desconocida, la transacción no tiene ninguna transferencia de Travel Rule o (acción `beneficiary_vasp`) ninguna entrada del directorio tiene ese id." }, "409": { "description": "La transferencia no está en un estado que permita esta operación (p. ej., no está en COMPLETED/saliente para finalizar, ya está en un estado final para cancelar, o no es una transferencia saliente en un estado que permita el reenvío para reenviar). `update_compliance_email` responde `409` para una transferencia entrante, y para una saliente fuera de COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE y NOT_ENOUGH_COUNTERPARTY_DATA. `update_originator_wallet` responde `409` para una transferencia entrante, cancelada o expirada. `beneficiary_vasp` responde `409` salvo que la transferencia sea saliente y esté en COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE o NOT_ENOUGH_COUNTERPARTY_DATA.", "content": { "application/json": { "examples": { "Cancel from a terminal status": { "value": { "detail": "Transfer is already in a terminal state." } }, "Resend not allowed": { "value": { "detail": "Transfer cannot be resent from its current state." } }, "Finish not allowed": { "value": { "detail": "Transfer must be an outbound transfer in COMPLETED status to finish." } }, "Compliance email cannot change": { "value": { "detail": "The compliance email of this transfer cannot change from its current state." } } } } } } } } }, "/v3/transactions/{transaction_id}/travel-rule/ownership/": { "post": { "summary": "Confirmar o negar la propiedad de la wallet", "description": "Resuelve una transferencia que espera la confirmación de propiedad de la wallet: llámalo en tu propio lado de la transferencia cuando esté en UNCONFIRMED_OWNERSHIP, o cuando sea una transferencia entrante en ON_HOLD. Confirmar marca la entrada correspondiente de la libreta de direcciones de wallets como de propiedad verificada (para una transferencia entrante en ON_HOLD sin entrada, Didit crea una a partir de beneficiary_data.wallet_address) y ejecuta la comparación del nombre del beneficiario en ambos lados de la transferencia; denegar rechaza ambos lados. Una transferencia entrante cuyo depósito ya se liquidó pasa a FINISHED cuando la comparación tiene éxito. Cuando la wallet de la contraparte se declaró como wallet sin custodia (counterparty.payment_method.method_type: unhosted_wallet), confirmar registra que el cliente verificó quién controla esa wallet y completa la transferencia (COMPLETED) en ambas direcciones, o FINISHED en el caso de un depósito entrante cuyo hash on-chain ya se conoce. La wallet verificada es la de la contraparte: el destino de un retiro saliente, o el origen (la wallet del ordenante) de un depósito entrante. Si todavía no está en tu libreta de direcciones de wallets, Didit la añade como de propiedad verificada a nombre de la contraparte; si la libreta ya la tiene registrada con un nombre de titular distinto, la transferencia pasa a COUNTERPARTY_MISMATCHED_DATA. Para una transferencia TRP entrante en UNCONFIRMED_OWNERSHIP, ON_HOLD o COUNTERPARTY_MISMATCHED_DATA, Didit envía en su lugar tu decisión al VASP de origen: aprobar devuelve la dirección de pago (wallet_address, o la dirección de la entrada coincidente) y pasa la transferencia a COMPLETED, y denegar la rechaza. La misma llamada también decide una transferencia entrante que envió una contraparte de GTR o Sygna Bridge y que espera tu revisión (`UNCONFIRMED_OWNERSHIP`, `ON_HOLD` o `COUNTERPARTY_MISMATCHED_DATA`): `confirmed: true` la aprueba (pasa `wallet_address` cuando la transferencia no indica ninguna) y `confirmed: false` la rechaza, y se responde a la red después de la respuesta, con reintentos. VerifyVASP recibe su respuesta en el momento en que la solicita, por lo que una transferencia de VerifyVASP que necesitaría tu revisión se rechaza de inmediato y no se puede decidir más tarde.", "operationId": "confirmTravelRuleOwnership", "x-didit-sdk": { "resource": "transactions.travel_rule", "method": "confirm_ownership", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "UUID estable de Didit de la transacción que tu aplicación mantiene para esta transferencia: la transacción del lado del beneficiario en una transferencia por la vía INTERNAL, o la transacción que creaste (saliente o entrante) cuando la wallet de la contraparte se declaró como wallet sin custodia.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleOwnershipConfirmRequest" }, "example": { "confirmed": true } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/transactions/{transaction_id}/travel-rule/ownership/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"confirmed\": true}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.travel_rule.confirm_ownership(\n \"11111111-2222-3333-4444-555555555555\",\n confirmed=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.travelRule.confirmOwnership(\"11111111-2222-3333-4444-555555555555\", {\n confirmed: true,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.TravelRule.ConfirmOwnership(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleOwnershipConfirmRequest{\n\tConfirmed: true,\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleOwnershipConfirmRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().travelRule().confirmOwnership(\"11111111-2222-3333-4444-555555555555\", TravelRuleOwnershipConfirmRequest.builder()\n .confirmed(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->travelRule->confirmOwnership('11111111-2222-3333-4444-555555555555', [\n 'confirmed' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.travel_rule.confirm_ownership(\n \"11111111-2222-3333-4444-555555555555\",\n confirmed: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.TravelRule.ConfirmOwnershipAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleOwnershipConfirmRequest\n{\n Confirmed = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La transferencia actualizada. En una transferencia entrante, los originator_data/beneficiary_data de la contraparte permanecen enmascarados (`data_masked: true`) hasta que se confirma la propiedad; después, `data_unmasked` registra cuándo, por qué y quién lo hizo.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTransferDetail" } } } }, "409": { "description": "La transferencia no está a la espera de confirmación de propiedad, ninguna entrada de la libreta de direcciones de wallets coincide con su wallet de contraparte, una transferencia INTERNAL de otro cliente de Didit necesita una prueba de control (un mensaje firmado o un depósito de prueba) antes de poder confirmarse, o una transferencia de red ya se respondió a través de su red (una transferencia de VerifyVASP, o una transferencia de GTR o Sygna Bridge que tú o Didit ya decidieron).", "content": { "application/json": { "examples": { "Not awaiting confirmation": { "value": { "detail": "Transfer is not awaiting ownership confirmation." } }, "No matching address book entry": { "value": { "detail": "wallet address entry no longer available" } } } } } }, "400": { "description": "Error de validación: falta confirmed, una aprobación TRP entrante no tiene wallet_address ni ninguna dirección que usar en su lugar, o se envió `confirmed: true` en una transferencia declarada desde una wallet sin custodia que no indica ninguna wallet de contraparte y no se envió `wallet_address`.", "content": { "application/json": { "examples": { "No payment address": { "value": { "wallet_address": [ "wallet_address is required to approve." ] } } } } } }, "404": { "description": "Transacción desconocida, o la transacción no tiene ninguna transferencia de Travel Rule." }, "502": { "description": "Solo para transferencias TRP entrantes: Didit no pudo entregar tu decisión al VASP ordenante, por lo que el estado de la transferencia no cambia.", "content": { "application/json": { "examples": { "Callback not delivered": { "value": { "detail": "Counterparty inquiry-resolution callback could not be delivered." } } } } } } } } }, "/v3/transactions/{transaction_id}/travel-rule/messages/": { "get": { "summary": "Listar mensajes de Travel Rule", "description": "Mensajes y solicitudes de documentos intercambiados con el VASP de la contraparte sobre esta transferencia.", "operationId": "listTravelRuleMessages", "x-didit-sdk": { "resource": "transactions.travel_rule", "method": "list_messages", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "UUID estable de Didit de la transacción a la que pertenece la transferencia.", "schema": { "type": "string", "format": "uuid" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/transactions/{transaction_id}/travel-rule/messages/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.travel_rule.list_messages(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.travelRule.listMessages(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.TravelRule.ListMessages(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().travelRule().listMessages(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->travelRule->listMessages('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.travel_rule.list_messages(\"11111111-2222-3333-4444-555555555555\").each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.TravelRule.ListMessagesAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Los mensajes, del más antiguo al más reciente.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleMessage" } } } } }, "404": { "description": "Transacción o token desconocidos, o la transacción no tiene ninguna transferencia de Travel Rule." } } }, "post": { "summary": "Enviar un mensaje de Travel Rule o una solicitud de documentos", "description": "Envía un mensaje o una solicitud de documentos al VASP de la contraparte. Funciona en transferencias INTERNAL (el otro cliente de Didit lo ve en su lado del par) y en transferencias EMAIL (se envía un correo a la contraparte, que responde en el portal de recogida). Una transferencia por TRP, GTR, TRUST, VerifyVASP o Sygna no admite mensajes, porque esos protocolos no los tienen. Límites: 100 mensajes por transferencia, 5000 caracteres por cuerpo, 10 documentos solicitados y 5 archivos de 10 MB cada uno.", "operationId": "createTravelRuleMessage", "x-didit-sdk": { "resource": "transactions.travel_rule", "method": "create_message", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "UUID estable de Didit de la transacción a la que pertenece la transferencia.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleMessageCreateRequest" }, "example": { "kind": "DOCUMENT_REQUEST", "body": "Please confirm the date of birth of the beneficiary.", "requested_documents": [ "Proof of address" ] } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TravelRuleMessageCreateRequest" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/transactions/{transaction_id}/travel-rule/messages/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"kind\": \"DOCUMENT_REQUEST\", \"body\": \"Please confirm the date of birth of the beneficiary.\", \"requested_documents\": [\"Proof of address\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.travel_rule.create_message(\n \"11111111-2222-3333-4444-555555555555\",\n kind=\"DOCUMENT_REQUEST\",\n body=\"Please confirm the date of birth of the beneficiary.\",\n requested_documents=[\"Proof of address\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.travelRule.createMessage(\"11111111-2222-3333-4444-555555555555\", {\n kind: \"DOCUMENT_REQUEST\",\n body: \"Please confirm the date of birth of the beneficiary.\",\n requested_documents: [\"Proof of address\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.TravelRule.CreateMessage(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleMessageCreateRequest{\n\tKind: didit.Some(didit.TravelRuleMessageCreateRequestKind(\"DOCUMENT_REQUEST\")),\n\tBody: didit.String(\"Please confirm the date of birth of the beneficiary.\"),\n\tRequestedDocuments: didit.Some([]string{\"Proof of address\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.TravelRuleMessageCreateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().travelRule().createMessage(\"11111111-2222-3333-4444-555555555555\", TravelRuleMessageCreateRequest.builder()\n .kind(TravelRuleMessageCreateRequest.Kind.of(\"DOCUMENT_REQUEST\"))\n .body(\"Please confirm the date of birth of the beneficiary.\")\n .requestedDocuments(List.of(\"Proof of address\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->travelRule->createMessage('11111111-2222-3333-4444-555555555555', [\n 'kind' => 'DOCUMENT_REQUEST',\n 'body' => 'Please confirm the date of birth of the beneficiary.',\n 'requested_documents' => ['Proof of address'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.travel_rule.create_message(\n \"11111111-2222-3333-4444-555555555555\",\n kind: \"DOCUMENT_REQUEST\",\n body: \"Please confirm the date of birth of the beneficiary.\",\n requested_documents: [\"Proof of address\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.TravelRule.CreateMessageAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleMessageCreateRequest\n{\n Kind = new TravelRuleMessageCreateRequestKind(\"DOCUMENT_REQUEST\"),\n Body = \"Please confirm the date of birth of the beneficiary.\",\n RequestedDocuments = new string[] { \"Proof of address\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "El mensaje almacenado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleMessage" } } } }, "400": { "description": "Cuerpo no válido, un tipo o tamaño de archivo no aceptado, más de 100 mensajes en la transferencia o un `reply_to` que no es un mensaje de esta transferencia.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "requested_documents": [ "Name at least one document the counterparty should send." ] } } } }, "404": { "description": "Transacción o token desconocidos, o la transacción no tiene ninguna transferencia de Travel Rule." }, "409": { "description": "Ningún mensaje puede llegar a la contraparte. `detail` indica el motivo: la transferencia se realiza por una red (TRP, GTR, TRUST, VerifyVASP o Sygna), todavía no tiene contraparte, los datos de una transferencia INTERNAL no coincidieron con el titular de la wallet y por eso nada llegó al destinatario, o el enlace de recogida de una transferencia EMAIL ha expirado o la transferencia está cerrada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } } } }, "/v3/travel-rule/pickup/{token}/": { "get": { "summary": "Obtener la información de recogida del canal de correo electrónico", "description": "Público, sin autenticación. Permite que una VASP contraparte que no usa Didit previsualice el intercambio pendiente desde el enlace de recogida enviado por correo electrónico. El propio token es la autenticación.", "operationId": "getTravelRulePickup", "x-didit-sdk": { "resource": "travel_rule", "method": "retrieve_pickup", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contact", "in": "query", "required": false, "schema": { "type": "string" }, "description": "El valor `?contact=` del enlace, es decir, el contacto al que se envió el enlace. Se devuelve sin cambios como `contact`; no se valida." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl https://verification.didit.me/v3/travel-rule/pickup/{token}/" } ], "responses": { "200": { "description": "Vista previa de la recogida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRulePickupInfo" }, "example": { "reference": "33333333-4444-5555-6666-777777777777", "requested_at": "2026-07-05T10:00:00Z", "originator_vasp_name": "Origin CASP SL", "originator_vasp_lei": "529900EXAMPLEORIG001", "recipient_vasp_name": "Example Counterparty VASP", "language": "es", "amount": "0.250000000000000000", "currency": "ETH", "fiat_amount": "", "fiat_currency": "", "chain": "ETH", "beneficiary_wallet": "0xede2d7e4f5b097e6391ab6bbcf2f47a53f4778cb", "status": "AWAITING_COUNTERPARTY", "ivms_version": "ivms101.2023", "deadline_at": "2026-07-07T10:00:00Z", "reminders_sent": 0, "contact": "", "decline_reasons": [ "data_mismatch", "not_our_customer", "wallet_not_hosted", "sanctions", "risk_appetite", "jurisdiction", "insufficient_data", "other" ], "join_invitation": { "eligible": false, "url": "" }, "originator_data": { "name": "Jane Doe", "wallet_address": "0x77ccff0cc624a53cd8b8d8703ced826710211ec7" }, "beneficiary_data": { "name": "Ana Diaz", "wallet_address": "0xede2d7e4f5b097e6391ab6bbcf2f47a53f4778cb" }, "ivms_request": { "originator": { "originatorPersons": [ { "naturalPerson": { "name": { "nameIdentifier": [ { "primaryIdentifier": "Doe", "secondaryIdentifier": "Jane", "nameIdentifierType": "LEGL" } ] } } } ], "accountNumber": [ "0x77ccff0cc624a53cd8b8d8703ced826710211ec7" ] }, "beneficiary": { "beneficiaryPersons": [ { "naturalPerson": { "name": { "nameIdentifier": [ { "primaryIdentifier": "Diaz", "secondaryIdentifier": "Ana", "nameIdentifierType": "LEGL" } ] } } } ], "accountNumber": [ "0xede2d7e4f5b097e6391ab6bbcf2f47a53f4778cb" ] } }, "data_masked": false } } } }, "404": { "description": "Token desconocido." }, "410": { "description": "El plazo se ha cerrado: la contraparte ya respondió, la transferencia salió de AWAITING_COUNTERPARTY o venció la fecha límite." } } } }, "/v3/travel-rule/pickup/{token}/respond/": { "post": { "summary": "Responder a una recogida por la vía de correo electrónico", "description": "Público, sin autenticación. Acepta o rechaza el intercambio desde el enlace de recogida enviado por correo electrónico. Al aceptar, beneficiary_name se comprueba con la política name_matching_strictness del ordenante.", "operationId": "respondTravelRulePickup", "x-didit-sdk": { "resource": "travel_rule", "method": "respond_pickup", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contact", "in": "query", "required": false, "schema": { "type": "string" }, "description": "El valor `?contact=` del enlace. Se usa cuando el cuerpo no envía `contact`." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRulePickupRespondRequest" }, "example": { "decision": "accept", "beneficiary_name": "Carlos Ruiz" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/pickup/{token}/respond/ \\\n -H 'Content-Type: application/json' \\\n -d '{\"decision\": \"accept\", \"beneficiary_name\": \"Carlos Ruiz\"}'" } ], "responses": { "200": { "description": "El estado resultante del intercambio: COMPLETED o COUNTERPARTY_MISMATCHED_DATA tras una aceptación, COUNTERPARTY_VASP_GENERAL_DECLINE tras un rechazo, que además devuelve `decline_reason`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "decline_reason": { "type": "string", "description": "Presente tras un rechazo." } } }, "examples": { "accepted": { "value": { "status": "COMPLETED" } }, "declined": { "value": { "status": "COUNTERPARTY_VASP_GENERAL_DECLINE", "decline_reason": "not_our_customer" } } } } } }, "400": { "description": "Un campo no es válido: por ejemplo, falta `decision` o no es `accept` ni `decline`, falta `decline_detail` en un rechazo con `decline_reason: other`, un `ivms_response` que no es un objeto IVMS 101 o supera los 16384 caracteres, o un `contact` del cuerpo que no es un UUID (`{\"contact\": [\"Must be a valid UUID.\"]}`).", "content": { "application/json": { "example": { "decline_detail": [ "Say what the reason is when you choose another reason." ] } } } }, "404": { "description": "Token desconocido." }, "410": { "description": "El plazo se ha cerrado: la contraparte ya respondió, la transferencia salió de AWAITING_COUNTERPARTY o venció la fecha límite." } } } }, "/v3/travel-rule/pickup/{token}/messages/": { "get": { "summary": "Listar mensajes de recogida", "description": "Público, sin autenticación. Los mensajes de una transferencia por el canal EMAIL tal como los lee la VASP contraparte: lo que envió el cliente es `INBOUND` y va firmado con el nombre de la VASP del cliente. El token es la autenticación.", "operationId": "listTravelRulePickupMessages", "x-didit-sdk": { "resource": "travel_rule", "method": "list_pickup_messages", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl https://verification.didit.me/v3/travel-rule/pickup/{token}/messages/" } ], "responses": { "200": { "description": "Los mensajes, del más antiguo al más reciente, del lado de la contraparte.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleMessage" } } } } }, "404": { "description": "Token desconocido." }, "410": { "description": "El enlace de recogida ha expirado o la transferencia está cerrada." } } }, "post": { "summary": "Responder en el portal de recogida", "description": "Público, sin autenticación. La VASP contraparte responde en una transferencia por el canal EMAIL. El cuerpo es el mismo que el de los mensajes de la transacción; los adjuntos deben ser PDF, PNG, JPEG o WebP. El token es la autenticación.", "operationId": "createTravelRulePickupMessage", "x-didit-sdk": { "resource": "travel_rule", "method": "create_pickup_message", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleMessageCreateRequest" }, "example": { "kind": "MESSAGE", "body": "Attached is the proof of address of the wallet holder." } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TravelRuleMessageCreateRequest" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/pickup/{token}/messages/ \\\n -H 'Content-Type: application/json' \\\n -d '{\"kind\": \"MESSAGE\", \"body\": \"Attached is the proof of address of the wallet holder.\"}'" } ], "responses": { "201": { "description": "El mensaje almacenado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleMessage" } } } }, "400": { "description": "Cuerpo no válido, un tipo o tamaño de archivo no aceptado, más de 100 mensajes en la transferencia o un `reply_to` que no es un mensaje de esta transferencia.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "requested_documents": [ "Name at least one document the counterparty should send." ] } } } }, "404": { "description": "Token desconocido." }, "410": { "description": "El enlace de recogida ha expirado o la transferencia está cerrada." } } } }, "/v3/travel-rule/inbound/": { "post": { "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", "x-didit-sdk": { "resource": "travel_rule", "method": "register_inbound", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "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" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/inbound/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"chain\":\"ETH\",\"txid\":\"0xdeposit-hash\",\"wallet_address\":\"0xYourDepositWallet\",\"amount\":\"500.00\",\"currency\":\"USDC\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.register_inbound(\n chain=\"ETH\",\n txid=\"0xdeposit-hash\",\n wallet_address=\"0xYourDepositWallet\",\n amount=\"500.00\",\n currency=\"USDC\",\n originator_data={\"name\": \"Origin CASP SL\"},\n beneficiary_data={\"name\": \"Ana Diaz\"},\n originating_vasp={\n \"name\": \"Origin CASP SL\",\n \"lei\": \"\",\n \"travel_address\": \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.registerInbound({\n chain: \"ETH\",\n txid: \"0xdeposit-hash\",\n wallet_address: \"0xYourDepositWallet\",\n amount: \"500.00\",\n currency: \"USDC\",\n originator_data: { name: \"Origin CASP SL\" },\n beneficiary_data: { name: \"Ana Diaz\" },\n originating_vasp: {\n name: \"Origin CASP SL\",\n lei: \"\",\n travel_address: \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n },\n});\nconsole.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;\nimport me.didit.Didit;\nimport me.didit.types.TravelRuleInboundRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().registerInbound(TravelRuleInboundRequest.builder()\n .chain(\"ETH\")\n .txid(\"0xdeposit-hash\")\n .walletAddress(\"0xYourDepositWallet\")\n .amount(\"500.00\")\n .currency(\"USDC\")\n .originatorData(Map.of(\"name\", \"Origin CASP SL\"))\n .beneficiaryData(Map.of(\"name\", \"Ana Diaz\"))\n .originatingVasp(TravelRuleInboundRequest.OriginatingVasp.builder()\n .name(\"Origin CASP SL\")\n .lei(\"\")\n .travelAddress(\"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\")\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->registerInbound([\n 'chain' => 'ETH',\n 'txid' => '0xdeposit-hash',\n 'wallet_address' => '0xYourDepositWallet',\n 'amount' => '500.00',\n 'currency' => 'USDC',\n 'originator_data' => ['name' => 'Origin CASP SL'],\n 'beneficiary_data' => ['name' => 'Ana Diaz'],\n 'originating_vasp' => [\n 'name' => 'Origin CASP SL',\n 'lei' => '',\n 'travel_address' => 'ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC',\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.register_inbound(\n chain: \"ETH\",\n txid: \"0xdeposit-hash\",\n wallet_address: \"0xYourDepositWallet\",\n amount: \"500.00\",\n currency: \"USDC\",\n originator_data: { name: \"Origin CASP SL\" },\n beneficiary_data: { name: \"Ana Diaz\" },\n originating_vasp: {\n name: \"Origin CASP SL\",\n lei: \"\",\n travel_address: \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.RegisterInboundAsync(new TravelRuleInboundRequest\n{\n Chain = \"ETH\",\n Txid = \"0xdeposit-hash\",\n WalletAddress = \"0xYourDepositWallet\",\n Amount = \"500.00\",\n Currency = \"USDC\",\n OriginatorData = new Dictionary { [\"name\"] = \"Origin CASP SL\" },\n BeneficiaryData = new Dictionary { [\"name\"] = \"Ana Diaz\" },\n OriginatingVasp = new TravelRuleInboundRequestOriginatingVasp\n {\n Name = \"Origin CASP SL\",\n Lei = \"\",\n TravelAddress = \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "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)." ] } } } } } } } } } }, "/v3/travel-rule/test-vasp/inbound/": { "post": { "summary": "Disparar una transferencia entrante desde el Didit Test VASP (sandbox)", "description": "Solo aplicaciones sandbox. El Didit Test VASP envía a tu aplicación una transferencia entrante de Travel Rule, para que puedas probar de principio a fin el lado receptor de un intercambio antes de pasar a producción. La transferencia se registra y se decide con la misma lógica que se aplica a una transferencia entrante real desde una red frente a tu libreta de direcciones de wallets, por lo que la bandeja de entrada, la decisión y el flujo de propiedad de la wallet se comportan igual que en producción. Nada sale de Didit. Una aplicación en producción recibe 400. Vuelve a enviar la misma `reference` para obtener la transferencia que registró la primera llamada en lugar de una segunda.", "operationId": "triggerTravelRuleTestVaspInbound", "x-didit-sdk": { "resource": "transactions.travel_rule", "method": "trigger_test_vasp_inbound", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTestVaspInboundRequest" }, "example": { "beneficiary_wallet_address": "0xYourSandboxWallet", "scenario": "accept", "amount": "1", "reference": "demo-001" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/test-vasp/inbound/ \\\n -H 'x-api-key: YOUR_SANDBOX_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"beneficiary_wallet_address\":\"0xYourSandboxWallet\",\"scenario\":\"accept\",\"reference\":\"demo-001\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.travel_rule.trigger_test_vasp_inbound(\n beneficiary_wallet_address=\"0xYourSandboxWallet\",\n scenario=\"accept\",\n amount=\"1\",\n reference=\"demo-001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.travelRule.triggerTestVaspInbound({\n beneficiary_wallet_address: \"0xYourSandboxWallet\",\n scenario: \"accept\",\n amount: \"1\",\n reference: \"demo-001\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.TravelRule.TriggerTestVASPInbound(ctx, didit.TravelRuleTestVASPInboundRequest{\n\tBeneficiaryWalletAddress: \"0xYourSandboxWallet\",\n\tScenario: didit.Some(didit.TravelRuleTestVASPInboundRequestScenario(\"accept\")),\n\tAmount: didit.String(\"1\"),\n\tReference: didit.String(\"demo-001\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleTestVaspInboundRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().travelRule().triggerTestVaspInbound(TravelRuleTestVaspInboundRequest.builder()\n .beneficiaryWalletAddress(\"0xYourSandboxWallet\")\n .scenario(TravelRuleTestVaspInboundRequest.Scenario.of(\"accept\"))\n .amount(\"1\")\n .reference(\"demo-001\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->travelRule->triggerTestVaspInbound([\n 'beneficiary_wallet_address' => '0xYourSandboxWallet',\n 'scenario' => 'accept',\n 'amount' => '1',\n 'reference' => 'demo-001',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.travel_rule.trigger_test_vasp_inbound(\n beneficiary_wallet_address: \"0xYourSandboxWallet\",\n scenario: \"accept\",\n amount: \"1\",\n reference: \"demo-001\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.TravelRule.TriggerTestVaspInboundAsync(new TravelRuleTestVaspInboundRequest\n{\n BeneficiaryWalletAddress = \"0xYourSandboxWallet\",\n Scenario = new TravelRuleTestVaspInboundRequestScenario(\"accept\"),\n Amount = \"1\",\n Reference = \"demo-001\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "La transferencia entrante se registró y se decidió. Una repetición con la misma `reference` devuelve el mismo cuerpo.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTestVaspInboundResponse" } } } }, "400": { "description": "Cuerpo no válido, un `scenario` desconocido o no admitido, o la aplicación es una aplicación de producción.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "No se pudo registrar la transferencia, por ejemplo porque Travel Rule no está habilitada para la aplicación.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } } } }, "/v3/travel-rule/widget-session/": { "post": { "summary": "Emitir una sesión del widget de propiedad de wallet", "description": "Genera una URL/token del widget alojado de propiedad de wallet. Envía al cliente a la url devuelta para que demuestre el control de una wallet (firma de mensaje, prueba Satoshi, captura de pantalla o autodeclaración). En esta versión, el widget solo funciona en web: abre la url en el navegador del sistema o en una pestaña personalizada, nunca dentro de un webview de un SDK móvil.", "operationId": "createTravelRuleWidgetSession", "x-didit-sdk": { "resource": "travel_rule", "method": "create_widget_session", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetSessionCreate" }, "example": { "wallet_address": "0xd3b62acb76fb27a7f8961ec40fa11746b113aca9", "chain": "ETH", "holder_name": "Jane Doe", "vendor_data": "user-042", "transaction_id": "99999999-aaaa-bbbb-cccc-dddddddddddd", "expires_in_minutes": 60 } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/widget-session/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"wallet_address\":\"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9\",\"chain\":\"ETH\",\"holder_name\":\"Jane Doe\",\"transaction_id\":\"99999999-aaaa-bbbb-cccc-dddddddddddd\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.create_widget_session(\n wallet_address=\"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9\",\n chain=\"ETH\",\n holder_name=\"Jane Doe\",\n vendor_data=\"user-042\",\n transaction_id=\"99999999-aaaa-bbbb-cccc-dddddddddddd\",\n expires_in_minutes=60,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.createWidgetSession({\n wallet_address: \"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9\",\n chain: \"ETH\",\n holder_name: \"Jane Doe\",\n vendor_data: \"user-042\",\n transaction_id: \"99999999-aaaa-bbbb-cccc-dddddddddddd\",\n expires_in_minutes: 60,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.CreateWidgetSession(ctx, didit.TravelRuleWidgetSessionCreate{\n\tWalletAddress: didit.String(\"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9\"),\n\tChain: didit.String(\"ETH\"),\n\tHolderName: didit.String(\"Jane Doe\"),\n\tVendorData: didit.String(\"user-042\"),\n\tTransactionID: didit.String(\"99999999-aaaa-bbbb-cccc-dddddddddddd\"),\n\tExpiresInMinutes: didit.Int(60),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleWidgetSessionCreate;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().createWidgetSession(TravelRuleWidgetSessionCreate.builder()\n .walletAddress(\"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9\")\n .chain(\"ETH\")\n .holderName(\"Jane Doe\")\n .vendorData(\"user-042\")\n .transactionId(\"99999999-aaaa-bbbb-cccc-dddddddddddd\")\n .expiresInMinutes(60L)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->createWidgetSession([\n 'wallet_address' => '0xd3b62acb76fb27a7f8961ec40fa11746b113aca9',\n 'chain' => 'ETH',\n 'holder_name' => 'Jane Doe',\n 'vendor_data' => 'user-042',\n 'transaction_id' => '99999999-aaaa-bbbb-cccc-dddddddddddd',\n 'expires_in_minutes' => 60,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.create_widget_session(\n wallet_address: \"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9\",\n chain: \"ETH\",\n holder_name: \"Jane Doe\",\n vendor_data: \"user-042\",\n transaction_id: \"99999999-aaaa-bbbb-cccc-dddddddddddd\",\n expires_in_minutes: 60\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.CreateWidgetSessionAsync(new TravelRuleWidgetSessionCreate\n{\n WalletAddress = \"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9\",\n Chain = \"ETH\",\n HolderName = \"Jane Doe\",\n VendorData = \"user-042\",\n TransactionId = \"99999999-aaaa-bbbb-cccc-dddddddddddd\",\n ExpiresInMinutes = 60,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "La sesión de widget emitida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetSessionResponse" } } } }, "400": { "description": "Cuerpo no válido: `callback_url` no es una URL http(s) absoluta, `expires_in_minutes` está fuera del rango de 5 a 10080, `transaction_id` no es un UUID o un campo supera su límite de longitud.", "content": { "application/json": { "examples": { "Invalid callback_url": { "value": { "callback_url": [ "callback_url must be an absolute http(s) URL." ] } } } } } }, "404": { "description": "`transaction_id` no corresponde a ninguna transferencia de Travel Rule en esta aplicación." } } } }, "/v3/travel-rule/widget/{token}/": { "get": { "summary": "Obtener el contexto del widget de propiedad de wallets", "description": "Endpoint público de lectura identificado por el token de sesión del widget; no requiere clave de API. Devuelve el contexto del widget junto con el estado de cada prueba, para que puedas consultarlo periódicamente y detectar cuándo se completa; completed_at deja de ser null en cuanto se verifica una prueba. Una prueba SATOSHI_TEST puede permanecer en status PENDING mientras su depósito se ve on-chain pero sin confirmar: un proceso en segundo plano la vuelve a comprobar automáticamente y la completa cuando el depósito se confirma, así que el cliente no tiene que hacer nada mientras espera. Cada prueba incluye los campos que necesita su método: deposit_address, expected_amount y su propio expires_at para SATOSHI_TEST; challenge para MESSAGE_SIGNING. Cuando la sesión está vinculada a una transferencia, es preferible usar el webhook travel_rule.status.updated en lugar de la consulta periódica.", "operationId": "getTravelRuleWidgetContext", "x-didit-sdk": { "resource": "travel_rule", "method": "retrieve_widget_context", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Token de sesión opaco devuelto cuando se generó la sesión del widget.", "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl https://verification.didit.me/v3/travel-rule/widget/{token}/" } ], "responses": { "200": { "description": "El contexto del widget y los estados de las pruebas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetContext" } } } }, "404": { "description": "Token desconocido." }, "410": { "description": "La sesión expiró sin completarse." } } } }, "/v3/travel-rule/widget/{token}/vasps/": { "get": { "summary": "Buscar VASP desde el widget de wallet", "description": "Endpoint público de lectura identificado por el token de sesión del widget; no requiere clave de API: el selector de VASP del widget del usuario final. Ofrece la misma búsqueda y los mismos filtros que GET /v3/travel-rule/vasps/ para la aplicación del widget, pero solo indica quién es cada VASP y si se puede contactar.", "operationId": "listTravelRuleWidgetVasps", "x-didit-sdk": { "resource": "travel_rule", "method": "list_widget_vasps", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Token de sesión opaco devuelto cuando se generó la sesión del widget.", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string", "maxLength": 255 }, "description": "Un fragmento de nombre o alias (sin distinguir mayúsculas de minúsculas), un LEI exacto o un dominio (example.com o una URL de ese dominio). Los miembros de la red Didit coinciden por su razón social, su LEI o el dominio de su correo electrónico de cumplimiento." }, { "name": "network", "in": "query", "schema": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA", "TRISA" ] }, "description": "Solo las entradas del directorio que el directorio de miembros de una red incluye actualmente." }, { "name": "jurisdiction", "in": "query", "schema": { "type": "string" }, "description": "Código de país ISO 3166 alfa-2 o alfa-3. Cualquier otro valor devuelve 400." }, { "name": "reachable", "in": "query", "schema": { "type": "boolean" }, "description": "true: solo los VASP a los que tu aplicación tiene una ruta disponible (incluidos los miembros de la red de Didit). false: solo las entradas del directorio a las que hoy no puede llegar." }, { "name": "kind", "in": "query", "schema": { "type": "string", "enum": [ "directory", "didit" ] }, "description": "Solo entradas del directorio, o solo miembros de la red de Didit." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl 'https://verification.didit.me/v3/travel-rule/widget/{token}/vasps/?search=counterparty'" } ], "responses": { "200": { "description": "Resultados paginados, ordenados por nombre.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/VaspDirectoryWidgetEntry" } } } } } } }, "400": { "description": "Un filtro no es válido: el cuerpo indica cada campo, por ejemplo, un código de red o de país desconocido.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "example": { "jurisdiction": [ "Use an ISO 3166 alpha-2 or alpha-3 country code." ], "network": [ "\"SWIFT\" is not a valid choice." ] } } } }, "404": { "description": "Token desconocido." }, "410": { "description": "La sesión expiró." } } }, "post": { "summary": "Elige el VASP de la contraparte en el widget de wallet", "description": "Endpoint público de escritura identificado por el token de sesión del widget; no requiere clave de API: el usuario final eligió el VASP de destino que el descubrimiento automático no pudo identificar. Solo lo acepta una transferencia saliente en COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE o NOT_ENOUGH_COUNTERPARTY_DATA. La transferencia se enruta a ese VASP y se vuelve a enviar; el descubrimiento automático nunca anula la elección.", "operationId": "selectTravelRuleWidgetVasp", "x-didit-sdk": { "resource": "travel_rule", "method": "select_widget_vasp", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Token de sesión opaco devuelto cuando se generó la sesión del widget.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "vasp" ], "properties": { "vasp": { "type": "string", "format": "uuid", "description": "El `id` de un VASP de `GET /v3/travel-rule/widget/{token}/vasps/`." } } }, "example": { "vasp": "9f1c2b34-5d6e-4f70-8a91-b2c3d4e5f607" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/widget/{token}/vasps/ \\\n -H 'Content-Type: application/json' \\\n -d '{\"vasp\": \"9f1c2b34-5d6e-4f70-8a91-b2c3d4e5f607\"}'" } ], "responses": { "200": { "description": "La selección se registró y la transferencia se está enviando de nuevo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "transfer_status": { "type": "string", "description": "El estado de la transferencia después de la selección." }, "counterparty_vasp": { "type": "string", "description": "El nombre del VASP que eligió el usuario final." } } }, "example": { "detail": "Counterparty VASP selected; the transfer is being resent.", "transfer_status": "AWAITING_COUNTERPARTY", "counterparty_vasp": "Northwind Exchange" } } } }, "400": { "description": "Falta `vasp` o ninguna entrada activa del directorio tiene ese id.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "example": { "vasp": [ "No directory entry has this id." ] } } } }, "404": { "description": "Token desconocido." }, "409": { "description": "La sesión del widget no está vinculada a una transferencia de Travel Rule, o la transferencia no es una transferencia saliente en un estado que acepte una contraparte." }, "410": { "description": "La sesión expiró." } } } }, "/v3/organization/{organization_id}/application/{application_id}/vendor-users/toggle-ongoing-monitoring/": { "patch": { "summary": "Activar o desactivar la monitorización AML continua para usuarios", "description": "Activa o desactiva la monitorización AML continua a nivel de usuario. Se mantiene exactamente un análisis AML monitorizado por usuario; a los usuarios sin ningún análisis AML (por ejemplo, usuarios importados) primero se les crea uno y se analizan, y se factura como un análisis AML normal. Establece estimate_only para previsualizar recuentos y costos sin escribir nada. Los lotes de 20 o menos se resuelven en línea (200, COMPLETED); los lotes más grandes devuelven 202 y se ejecutan de forma asíncrona.", "operationId": "toggle_vendor_users_ongoing_monitoring", "x-didit-sdk": { "resource": "users", "method": "set_ongoing_monitoring", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Users" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleRequest" }, "example": { "is_enabled": true, "didit_internal_id_list": [ "5b9a0000-0000-4000-8000-00000000f00d" ] } } } }, "responses": { "200": { "description": "Estimación (cuando se usa estimate_only) o el trabajo completado en lotes pequeños procesados en línea.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleResult" } } } }, "202": { "description": "Los lotes más grandes se procesan de forma asíncrona; consulta periódicamente el endpoint del trabajo con el job_id devuelto.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "403": { "description": "Falta el privilegio write:sessions, o el saldo es insuficiente para activarlo (la estimación se incluye en el cuerpo del error)." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.users.set_ongoing_monitoring(\n is_enabled=True,\n didit_internal_id_list=[\"5b9a0000-0000-4000-8000-00000000f00d\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.users.setOngoingMonitoring({\n is_enabled: true,\n didit_internal_id_list: [\"5b9a0000-0000-4000-8000-00000000f00d\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Users.SetOngoingMonitoring(ctx, didit.OngoingMonitoringToggleRequest{\n\tIsEnabled: true,\n\tDiditInternalIDList: didit.Some([]string{\"5b9a0000-0000-4000-8000-00000000f00d\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.OngoingMonitoringToggleRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.users().setOngoingMonitoring(OngoingMonitoringToggleRequest.builder()\n .isEnabled(true)\n .diditInternalIdList(List.of(\"5b9a0000-0000-4000-8000-00000000f00d\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->setOngoingMonitoring([\n 'is_enabled' => true,\n 'didit_internal_id_list' => ['5b9a0000-0000-4000-8000-00000000f00d'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.users.set_ongoing_monitoring(\n is_enabled: true,\n didit_internal_id_list: [\"5b9a0000-0000-4000-8000-00000000f00d\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Users.SetOngoingMonitoringAsync(new OngoingMonitoringToggleRequest\n{\n IsEnabled = true,\n DiditInternalIdList = new string[] { \"5b9a0000-0000-4000-8000-00000000f00d\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/vendor-users/toggle-ongoing-monitoring/{job_id}/": { "get": { "summary": "Obtener un trabajo de monitorización AML continua", "description": "Progreso y contadores por resultado de un trabajo de activación o desactivación de la monitorización. Consulta cada par de segundos mientras el estado sea PENDING o PROCESSING.", "operationId": "get_vendor_users_ongoing_monitoring_job", "x-didit-sdk": { "resource": "users", "method": "retrieve_ongoing_monitoring_job", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Users" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID del trabajo de monitorización que devuelve el endpoint de activación y desactivación." } ], "responses": { "200": { "description": "El trabajo.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "404": { "description": "Tarea desconocida para esta aplicación." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.users.retrieve_ongoing_monitoring_job(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.users.retrieveOngoingMonitoringJob(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Users.RetrieveOngoingMonitoringJob(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.users().retrieveOngoingMonitoringJob(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->retrieveOngoingMonitoringJob('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.users.retrieve_ongoing_monitoring_job(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Users.RetrieveOngoingMonitoringJobAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/vendor-businesses/toggle-ongoing-monitoring/": { "patch": { "summary": "Activar o desactivar la monitorización AML continua para empresas", "description": "Equivalente a nivel de empresa del interruptor de usuario: un análisis AML monitorizado por empresa, analizando primero las empresas que no tienen ningún análisis AML (entidad de tipo empresa). Mismo contrato de estimate_only, vía rápida en línea y trabajo asíncrono.", "operationId": "toggle_vendor_businesses_ongoing_monitoring", "x-didit-sdk": { "resource": "businesses", "method": "set_ongoing_monitoring", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Businesses" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleRequest" }, "example": { "is_enabled": true, "didit_internal_id_list": [ "b0000000-0000-4000-8000-0000000000b1" ] } } } }, "responses": { "200": { "description": "Estimación (cuando se usa estimate_only) o el trabajo completado en lotes pequeños procesados en línea.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleResult" } } } }, "202": { "description": "Los lotes más grandes se procesan de forma asíncrona; consulta periódicamente el endpoint del trabajo con el job_id devuelto.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "403": { "description": "Falta el privilegio write:sessions, o el saldo es insuficiente para activarlo (la estimación se incluye en el cuerpo del error)." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.businesses.set_ongoing_monitoring(\n is_enabled=True,\n didit_internal_id_list=[\"b0000000-0000-4000-8000-0000000000b1\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.businesses.setOngoingMonitoring({\n is_enabled: true,\n didit_internal_id_list: [\"b0000000-0000-4000-8000-0000000000b1\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.SetOngoingMonitoring(ctx, didit.OngoingMonitoringToggleRequest{\n\tIsEnabled: true,\n\tDiditInternalIDList: didit.Some([]string{\"b0000000-0000-4000-8000-0000000000b1\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.OngoingMonitoringToggleRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.businesses().setOngoingMonitoring(OngoingMonitoringToggleRequest.builder()\n .isEnabled(true)\n .diditInternalIdList(List.of(\"b0000000-0000-4000-8000-0000000000b1\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->setOngoingMonitoring([\n 'is_enabled' => true,\n 'didit_internal_id_list' => ['b0000000-0000-4000-8000-0000000000b1'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.businesses.set_ongoing_monitoring(\n is_enabled: true,\n didit_internal_id_list: [\"b0000000-0000-4000-8000-0000000000b1\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.SetOngoingMonitoringAsync(new OngoingMonitoringToggleRequest\n{\n IsEnabled = true,\n DiditInternalIdList = new string[] { \"b0000000-0000-4000-8000-0000000000b1\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/vendor-businesses/toggle-ongoing-monitoring/{job_id}/": { "get": { "summary": "Obtener un trabajo de monitorización AML continua", "description": "Progreso y contadores por resultado de un trabajo de activación o desactivación de la monitorización. Consulta cada par de segundos mientras el estado sea PENDING o PROCESSING.", "operationId": "get_vendor_businesses_ongoing_monitoring_job", "x-didit-sdk": { "resource": "businesses", "method": "retrieve_ongoing_monitoring_job", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Businesses" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID del trabajo de monitorización que devuelve el endpoint de activación y desactivación." } ], "responses": { "200": { "description": "El trabajo.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "404": { "description": "Tarea desconocida para esta aplicación." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.businesses.retrieve_ongoing_monitoring_job(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.businesses.retrieveOngoingMonitoringJob(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.RetrieveOngoingMonitoringJob(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.businesses().retrieveOngoingMonitoringJob(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->retrieveOngoingMonitoringJob('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.businesses.retrieve_ongoing_monitoring_job(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.RetrieveOngoingMonitoringJobAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/businesses/toggle-ongoing-monitoring/": { "patch": { "summary": "Activar o desactivar la monitorización AML continua para sesiones de empresas", "description": "Interruptor a nivel de sesión para verificaciones KYB, identificadas por número de sesión. A las sesiones sin un análisis AML se les crea uno y se adjunta a la propia sesión. Sigue el mismo contrato de estimate_only, ruta rápida en línea y trabajo asíncrono que los endpoints a nivel de usuario. Sustituye el comportamiento síncrono heredado, que omitía las sesiones sin un análisis AML.", "operationId": "toggle_business_sessions_ongoing_monitoring", "x-didit-sdk": { "resource": "businesses", "method": "set_session_ongoing_monitoring", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Businesses" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "is_enabled" ], "properties": { "is_enabled": { "type": "boolean", "description": "true para activar la monitorización, false para desactivarla." }, "estimate_only": { "type": "boolean", "default": false, "description": "Si es true, devuelve la estimación del costo y no realiza ninguna escritura." }, "update_all": { "type": "boolean", "default": false, "description": "Aplicar a todas las entidades de la aplicación (acotado por los parámetros filter_* cuando estén presentes)." }, "filter_search": { "type": "string" }, "filter_status": { "type": "array", "items": { "type": "string" } }, "filter_country": { "type": "string" }, "filter_date_from": { "type": "string", "format": "date" }, "filter_date_to": { "type": "string", "format": "date" }, "session_numbers": { "type": "array", "items": { "type": "string" }, "description": "Números de sesión de empresa que se van a alternar. Obligatorio salvo que update_all (o su alias heredado toggle_all) sea true." }, "toggle_all": { "type": "boolean", "default": false, "description": "Alias heredado de update_all." }, "filter_workflow_id": { "type": "string" } } }, "example": { "is_enabled": true, "session_numbers": [ "1001", "1002" ] } } } }, "responses": { "200": { "description": "Estimación (cuando se usa estimate_only) o el trabajo completado en lotes pequeños procesados en línea.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleResult" } } } }, "202": { "description": "Los lotes más grandes se procesan de forma asíncrona; consulta periódicamente el endpoint del trabajo con el job_id devuelto.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "403": { "description": "Falta el privilegio write:sessions, o el saldo es insuficiente para activarlo (la estimación se incluye en el cuerpo del error)." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.businesses.set_session_ongoing_monitoring(\n is_enabled=True,\n session_numbers=[\"1001\", \"1002\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.businesses.setSessionOngoingMonitoring({\n is_enabled: true,\n session_numbers: [\"1001\", \"1002\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.SetSessionOngoingMonitoring(ctx, didit.BusinessesSetSessionOngoingMonitoringParams{\n\tIsEnabled: true,\n\tSessionNumbers: didit.Some([]string{\"1001\", \"1002\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.BusinessesSetSessionOngoingMonitoringParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.businesses().setSessionOngoingMonitoring(BusinessesSetSessionOngoingMonitoringParams.builder()\n .isEnabled(true)\n .sessionNumbers(List.of(\"1001\", \"1002\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->setSessionOngoingMonitoring([\n 'is_enabled' => true,\n 'session_numbers' => ['1001', '1002'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.businesses.set_session_ongoing_monitoring(\n is_enabled: true,\n session_numbers: [\"1001\", \"1002\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.SetSessionOngoingMonitoringAsync(new BusinessesSetSessionOngoingMonitoringParams\n{\n IsEnabled = true,\n SessionNumbers = new string[] { \"1001\", \"1002\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/businesses/toggle-ongoing-monitoring/{job_id}/": { "get": { "summary": "Obtener un trabajo de monitorización AML continua", "description": "Progreso y contadores por resultado de un trabajo de activación o desactivación de la monitorización. Consulta cada par de segundos mientras el estado sea PENDING o PROCESSING.", "operationId": "get_business_sessions_ongoing_monitoring_job", "x-didit-sdk": { "resource": "businesses", "method": "retrieve_session_ongoing_monitoring_job", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Businesses" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID del trabajo de monitorización que devuelve el endpoint de activación y desactivación." } ], "responses": { "200": { "description": "El trabajo.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "404": { "description": "Tarea desconocida para esta aplicación." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.businesses.retrieve_session_ongoing_monitoring_job(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.businesses.retrieveSessionOngoingMonitoringJob(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.RetrieveSessionOngoingMonitoringJob(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.businesses().retrieveSessionOngoingMonitoringJob(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->retrieveSessionOngoingMonitoringJob('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.businesses.retrieve_session_ongoing_monitoring_job(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.RetrieveSessionOngoingMonitoringJobAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/": { "get": { "summary": "Listar casos", "description": "Lista los casos de la aplicación, del más reciente al más antiguo. Admite filtrado, búsqueda y ordenación; consulta los parámetros de consulta. Paginado con `limit`/`offset`.", "operationId": "list_cases", "x-didit-sdk": { "resource": "cases", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Tamaño de página. El valor predeterminado es 50." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Desplazamiento, empezando en cero, del primer registro." }, { "name": "status__in", "in": "query", "schema": { "type": "string" }, "description": "Estados que se incluirán, separados por comas, por ejemplo, OPEN,AWAITING_USER." }, { "name": "priority", "in": "query", "schema": { "type": "string" }, "description": "Prioridades que se incluirán, separadas por comas." }, { "name": "source__in", "in": "query", "schema": { "type": "string" }, "description": "Fuentes que se incluirán, separadas por comas." }, { "name": "blueprint", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Filtrar los casos de este blueprint." }, { "name": "assigned_to", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Filtrar los casos asignados a este usuario." }, { "name": "unassigned", "in": "query", "schema": { "type": "boolean" }, "description": "true para casos sin asignar, false para casos asignados." }, { "name": "tag", "in": "query", "schema": { "type": "string" }, "description": "Filtrar los casos que tienen exactamente esta etiqueta." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Busca coincidencias en el título, case_number, etiqueta, nombre/UUID/ID externo del sujeto, UUID de la sesión vinculada o UUID de la transacción vinculada." }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Límite inferior de la fecha de creación (inclusive)." }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Límite superior de la fecha de creación (inclusive)." }, { "name": "due_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Límite superior de due_at." }, { "name": "overdue", "in": "query", "schema": { "type": "boolean" }, "description": "true para devolver solo los casos abiertos/en espera del usuario que estén vencidos." }, { "name": "ordering", "in": "query", "schema": { "type": "string", "enum": [ "created_at", "-created_at", "due_at", "-due_at" ], "default": "-created_at" }, "description": "Orden de clasificación. Al ordenar por due_at, los valores nulos van al final." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/?status__in=OPEN,AWAITING_USER&ordering=-due_at' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.ListAutoPaging(ctx, didit.CasesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Lista paginada de casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de filas coincidentes. Exacto hasta 100, limitado a 100 a partir de ahí por rendimiento. Para detectar la última página, comprueba que `next` sea null." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta de la página siguiente, o null." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta de la página anterior, o null." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseListItem" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crear caso", "description": "Crea un caso vinculado exactamente a un sujeto (un usuario o una empresa), directamente o derivando el sujeto de un enlace a una sesión o transacción adjunta. El origen siempre es `MANUAL` para los casos creados por API.", "operationId": "create_case", "x-didit-sdk": { "resource": "cases", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "title" ], "properties": { "title": { "type": "string", "maxLength": 255 }, "blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID de CaseBlueprint. Omítelo para no usar ninguna plantilla." }, "priority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ], "default": "MEDIUM" }, "due_at": { "type": "string", "format": "date-time", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } }, "subject": { "type": "object", "description": "Obligatorio salvo que se proporcione links; el único sujeto del caso.", "properties": { "type": { "type": "string", "enum": [ "user", "business" ] }, "uuid": { "type": "string", "format": "uuid" } } }, "links": { "type": "array", "description": "Sesiones, sesiones de empresa o transacciones que se adjuntan al crear, p. ej. [{\"entity_type\": \"transaction\", \"entity_uuid\": \"...\"}]. Cuando se omite subject, el sujeto se deriva del propietario del primer vínculo.", "items": { "type": "object" } }, "assigned_to": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID del usuario al que se asigna de inmediato." }, "review_duplicates": { "type": "boolean", "default": false, "description": "Vuelve a comprobar las investigaciones existentes antes de crear el caso. Si es true, un sujeto con casos existentes requiere un separate_incident_reason no vacío. La consola siempre activa esta protección. Si lo omites, se mantiene el comportamiento actual de la API." }, "separate_incident_reason": { "type": "string", "maxLength": 1000 }, "source_context": { "$ref": "#/components/schemas/CaseDuplicateCaseFraudSourceContextRequest" } } }, "example": { "title": "Manual - Jane Doe", "blueprint": "b1de0000-0000-4000-8000-000000000002", "priority": "HIGH", "subject": { "type": "user", "uuid": "5b9a0000-0000-4000-8000-00000000f00d" }, "tags": [ "review" ] } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"title\": \"Manual - Jane Doe\", \"blueprint\": \"b1de0000-0000-4000-8000-000000000002\", \"priority\": \"HIGH\", \"subject\": {\"type\": \"user\", \"uuid\": \"5b9a0000-0000-4000-8000-00000000f00d\"}, \"tags\": [\"review\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.create(\n title=\"Manual - Jane Doe\",\n blueprint=\"b1de0000-0000-4000-8000-000000000002\",\n priority=\"HIGH\",\n tags=[\"review\"],\n subject={\n \"type\": \"user\",\n \"uuid\": \"5b9a0000-0000-4000-8000-00000000f00d\",\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.create({\n title: \"Manual - Jane Doe\",\n blueprint: \"b1de0000-0000-4000-8000-000000000002\",\n priority: \"HIGH\",\n tags: [\"review\"],\n subject: {\n type: \"user\",\n uuid: \"5b9a0000-0000-4000-8000-00000000f00d\",\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Create(ctx, didit.CasesCreateParams{\n\tTitle: \"Manual - Jane Doe\",\n\tBlueprint: didit.String(\"b1de0000-0000-4000-8000-000000000002\"),\n\tPriority: didit.Some(didit.CasesCreateParamsPriority(\"HIGH\")),\n\tTags: didit.Some([]string{\"review\"}),\n\tSubject: didit.Some(didit.CasesCreateParamsSubject{\n\t\tType: didit.Some(didit.CasesCreateParamsSubjectType(\"user\")),\n\t\tUUID: didit.String(\"5b9a0000-0000-4000-8000-00000000f00d\"),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CasesCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().create(CasesCreateParams.builder()\n .title(\"Manual - Jane Doe\")\n .blueprint(\"b1de0000-0000-4000-8000-000000000002\")\n .priority(CasesCreateParams.Priority.of(\"HIGH\"))\n .tags(List.of(\"review\"))\n .subject(CasesCreateParams.Subject.builder()\n .type(CasesCreateParams.Subject.Type.of(\"user\"))\n .uuid(\"5b9a0000-0000-4000-8000-00000000f00d\")\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->create([\n 'title' => 'Manual - Jane Doe',\n 'blueprint' => 'b1de0000-0000-4000-8000-000000000002',\n 'priority' => 'HIGH',\n 'tags' => ['review'],\n 'subject' => [\n 'type' => 'user',\n 'uuid' => '5b9a0000-0000-4000-8000-00000000f00d',\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.create(\n title: \"Manual - Jane Doe\",\n blueprint: \"b1de0000-0000-4000-8000-000000000002\",\n priority: \"HIGH\",\n tags: [\"review\"],\n subject: {\n type: \"user\",\n uuid: \"5b9a0000-0000-4000-8000-00000000f00d\",\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.CreateAsync(new CasesCreateParams\n{\n Title = \"Manual - Jane Doe\",\n Blueprint = \"b1de0000-0000-4000-8000-000000000002\",\n Priority = new CasesCreateParamsPriority(\"HIGH\"),\n Tags = new string[] { \"review\" },\n Subject = new CasesCreateParamsSubject\n {\n Type = new CasesCreateParamsSubjectType(\"user\"),\n Uuid = \"5b9a0000-0000-4000-8000-00000000f00d\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Caso creado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "400": { "description": "No se proporcionó ni subject ni links, o no se encontró el sujeto, el blueprint o la persona asignada.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "La revisión de duplicados está activada y se encontró un caso existente sin un motivo de incidente independiente. No se creó ningún caso." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/": { "get": { "summary": "Obtener un caso", "description": "Obtiene un caso con su sujeto, blueprint, notas, eventos, enlaces y lista de verificación.", "operationId": "get_case", "x-didit-sdk": { "resource": "cases", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.retrieve(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.retrieve(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Retrieve(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().retrieve(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->retrieve('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.retrieve(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RetrieveAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Detalle del caso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "404": { "description": "No se encontró el caso (o el recurso anidado) en esta aplicación.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualizar caso", "description": "Actualiza el título, la prioridad, la fecha de vencimiento, las etiquetas o el equipo de revisión responsable del caso. Envía solo los campos que quieras cambiar; los campos que omitas conservan su valor. `tags` reemplaza toda la lista de etiquetas. `team` acepta el uuid de un equipo de revisión activo de esta aplicación (consúltalos con `GET .../cases/teams/`), o null para quitar el equipo. Requiere una clave de API con acceso completo, o `write:cases` para un miembro de la consola: una clave con acceso restringido recibe un 403. Registra los eventos PRIORITY_CHANGED, DUE_DATE_CHANGED, TAG_ADDED, TAG_REMOVED y TEAM_CHANGED según corresponda; un cambio de título se guarda sin evento en la cronología. Devuelve el caso actualizado.", "operationId": "update_case", "x-didit-sdk": { "resource": "cases", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 255, "description": "Nuevo título del caso." }, "priority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "due_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Nueva fecha límite. Envía null para eliminarla." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "La lista completa de etiquetas. Sustituye a las etiquetas actuales." }, "team": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID del equipo de revisión al que pertenece el caso. Debe ser un equipo activo de esta aplicación. Envía null para quitar el equipo." } } }, "examples": { "Change priority and deadline": { "value": { "priority": "HIGH", "due_at": "2026-11-01T00:00:00Z" } }, "Move the case to a team": { "value": { "team": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "Clear the team": { "value": { "team": null } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"priority\": \"HIGH\", \"due_at\": \"2026-08-01T00:00:00Z\"}'" }, { "lang": "curl", "label": "curl (change team)", "source": "curl -X PATCH 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"team\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.update(\n \"c1a5e000-0000-4000-8000-000000000001\",\n priority=\"HIGH\",\n due_at=\"2026-11-01T00:00:00Z\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.update(\"c1a5e000-0000-4000-8000-000000000001\", {\n priority: \"HIGH\",\n due_at: \"2026-11-01T00:00:00Z\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Update(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesUpdateParams{\n\tPriority: didit.Some(didit.CasesUpdateParamsPriority(\"HIGH\")),\n\tDueAt: didit.Time(time.Date(2026, 11, 1, 0, 0, 0, 0, time.UTC)),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.OffsetDateTime;\nimport me.didit.Didit;\nimport me.didit.types.CasesUpdateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().update(\"c1a5e000-0000-4000-8000-000000000001\", CasesUpdateParams.builder()\n .priority(CasesUpdateParams.Priority.of(\"HIGH\"))\n .dueAt(OffsetDateTime.parse(\"2026-11-01T00:00:00Z\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->update('c1a5e000-0000-4000-8000-000000000001', [\n 'priority' => 'HIGH',\n 'due_at' => '2026-11-01T00:00:00Z',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.update(\n \"c1a5e000-0000-4000-8000-000000000001\",\n priority: \"HIGH\",\n due_at: \"2026-11-01T00:00:00Z\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.UpdateAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesUpdateParams\n{\n Priority = new CasesUpdateParamsPriority(\"HIGH\"),\n DueAt = DateTimeOffset.Parse(\"2026-11-01T00:00:00Z\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Caso actualizado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "400": { "description": "Un campo no superó la validación. El cuerpo está indexado por nombre de campo. `team` se rechaza cuando no es un equipo de revisión activo de esta aplicación.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "examples": { "Team not active in this application": { "value": { "team": [ "Choose an active team of this application." ] } }, "Invalid priority": { "value": { "priority": [ "\"URGENT\" is not a valid choice." ] } } } } } }, "403": { "description": "La clave de API pertenece a otra aplicación o es una clave con acceso restringido: los endpoints de Cases necesitan una clave de acceso completo. Un token de miembro de la consola necesita `write:cases`.", "content": { "application/json": { "examples": { "Restricted API Key": { "summary": "Clave de API con acceso restringido", "value": { "detail": "This API key has no access to this endpoint." } }, "Missing Privilege": { "summary": "Miembro de la consola sin write:cases, o una clave de otra aplicación", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No se encontró el caso en esta aplicación.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No Case matches the given query." } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Eliminar caso", "description": "Elimina un caso de forma permanente. Sus informes regulatorios en borrador se eliminan con él. Las verificaciones, personas, empresas y transacciones vinculadas no se eliminan. No existe ningún endpoint para restaurar un caso eliminado.\n\nSi el caso tiene un informe regulatorio finalizado, se rechaza toda la solicitud con `409` y no se elimina nada. El cuerpo usa `code: in_filed_report` e identifica cada informe con `uuid`, `report_number`, `report_type` y `case_uuid`. Elimina los informes y vuelve a enviar la solicitud.", "operationId": "delete_case", "x-didit-sdk": { "resource": "cases", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.cases.delete(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.cases.delete(\"c1a5e000-0000-4000-8000-000000000001\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nif err := client.Cases.Delete(ctx, \"c1a5e000-0000-4000-8000-000000000001\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.cases().delete(\"c1a5e000-0000-4000-8000-000000000001\");" }, { "lang": "php", "label": "PHP", "source": "cases->delete('c1a5e000-0000-4000-8000-000000000001');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.delete(\"c1a5e000-0000-4000-8000-000000000001\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Cases.DeleteAsync(\"c1a5e000-0000-4000-8000-000000000001\");" } ], "responses": { "204": { "description": "Caso eliminado." }, "403": { "description": "La clave no puede eliminar casos. Requiere una clave de acceso completo con `write:cases`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "404": { "description": "El caso no existe en esta aplicación o ya se eliminó.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "409": { "description": "El caso tiene un informe regulatorio finalizado. No se elimina nada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/assign/": { "post": { "summary": "Asignar o desasignar un caso", "description": "Asigna el caso a un usuario, o desasígnalo enviando assignee_user_id: null. assignee_email/assignee_name crean automáticamente un registro User cuando el asignado todavía no existe.", "operationId": "assign_case", "x-didit-sdk": { "resource": "cases", "method": "assign", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "assignee_user_id" ], "properties": { "assignee_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "null para desasignar." }, "assignee_email": { "type": "string", "format": "email", "nullable": true }, "assignee_name": { "type": "string", "nullable": true } } }, "example": { "assignee_user_id": "9a000000-0000-4000-8000-0000000000aa" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/assign/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"assignee_user_id\": \"9a000000-0000-4000-8000-0000000000aa\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.assign(\n \"c1a5e000-0000-4000-8000-000000000001\",\n assignee_user_id=\"9a000000-0000-4000-8000-0000000000aa\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.assign(\"c1a5e000-0000-4000-8000-000000000001\", {\n assignee_user_id: \"9a000000-0000-4000-8000-0000000000aa\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Assign(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesAssignParams{\n\tAssigneeUserID: didit.String(\"9a000000-0000-4000-8000-0000000000aa\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesAssignParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().assign(\"c1a5e000-0000-4000-8000-000000000001\", CasesAssignParams.builder()\n .assigneeUserId(\"9a000000-0000-4000-8000-0000000000aa\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->assign('c1a5e000-0000-4000-8000-000000000001', [\n 'assignee_user_id' => '9a000000-0000-4000-8000-0000000000aa',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.assign(\n \"c1a5e000-0000-4000-8000-000000000001\",\n assignee_user_id: \"9a000000-0000-4000-8000-0000000000aa\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.AssignAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesAssignParams\n{\n AssigneeUserId = \"9a000000-0000-4000-8000-0000000000aa\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Caso asignado o desasignado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/resolve/": { "post": { "summary": "Resolver caso", "description": "Resuelve el caso con una de cinco resoluciones: FALSE_POSITIVE (no se encontró ningún motivo de preocupación), VALID_THREAT (preocupación confirmada), INCONCLUSIVE, REQUIREMENTS_NOT_MET o REQUIREMENTS_SATISFIED. Se bloquea con 400 si la lista de verificación del blueprint no es opcional y quedan elementos incompletos, o si el blueprint exige una nota de resolución y no se proporciona ninguna. Cuando el blueprint del caso tiene un paso de verificador de cuatro ojos (four_eyes_checker_blueprint), la resolución queda en espera (case.pending_resolution) y el caso pasa al blueprint del verificador en lugar de resolverse de inmediato; otro responsable distinto debe llamar a approve o reject-approval. Envía una resolución de cuatro ojos como miembro de la consola: una resolución enviada con una clave de API no tiene autor registrado, por lo que approve y reject-approval devuelven 403 para cualquier llamante. En un blueprint de cuatro ojos puedes indicar con `checker` el miembro que debe aprobar: en ese caso, solo ese miembro puede aprobar o rechazar la resolución, y el campo `checker` de la respuesta lo identifica. Sin `checker`, la resolución espera en la cola del blueprint del verificador. Enviar `checker` para un blueprint sin paso de verificador devuelve 400.", "operationId": "resolve_case", "x-didit-sdk": { "resource": "cases", "method": "resolve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "resolution" ], "properties": { "resolution": { "type": "string", "enum": [ "FALSE_POSITIVE", "VALID_THREAT", "INCONCLUSIVE", "REQUIREMENTS_NOT_MET", "REQUIREMENTS_SATISFIED" ] }, "note": { "type": "string", "nullable": true, "description": "Obligatorio cuando el blueprint establece require_resolution_note." }, "checker": { "type": "string", "format": "uuid", "nullable": true, "description": "Solo para esquemas con principio de cuatro ojos. El uuid de usuario del miembro que debe aprobar esta resolución (el mismo id que `assigned_to.uuid` en un caso, o `members[].user_id` en un equipo de revisión). El miembro debe tener acceso a los casos de esta aplicación y no puede ser el responsable que envía la resolución. Omítelo o envía null para dejar la resolución a la cola de verificadores." } } }, "examples": { "Resolve": { "value": { "resolution": "FALSE_POSITIVE", "note": "Confirmed legitimate activity after reviewing documents." } }, "Four-eyes blueprint with a named checker": { "value": { "resolution": "VALID_THREAT", "note": "Document tampering confirmed.", "checker": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/resolve/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"resolution\": \"FALSE_POSITIVE\", \"note\": \"Confirmed legitimate activity after reviewing documents.\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.resolve(\n \"c1a5e000-0000-4000-8000-000000000001\",\n resolution=\"FALSE_POSITIVE\",\n note=\"Confirmed legitimate activity after reviewing documents.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.resolve(\"c1a5e000-0000-4000-8000-000000000001\", {\n resolution: \"FALSE_POSITIVE\",\n note: \"Confirmed legitimate activity after reviewing documents.\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Resolve(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesResolveParams{\n\tResolution: \"FALSE_POSITIVE\",\n\tNote: didit.String(\"Confirmed legitimate activity after reviewing documents.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesResolveParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().resolve(\"c1a5e000-0000-4000-8000-000000000001\", CasesResolveParams.builder()\n .resolution(CasesResolveParams.Resolution.of(\"FALSE_POSITIVE\"))\n .note(\"Confirmed legitimate activity after reviewing documents.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->resolve('c1a5e000-0000-4000-8000-000000000001', [\n 'resolution' => 'FALSE_POSITIVE',\n 'note' => 'Confirmed legitimate activity after reviewing documents.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.resolve(\n \"c1a5e000-0000-4000-8000-000000000001\",\n resolution: \"FALSE_POSITIVE\",\n note: \"Confirmed legitimate activity after reviewing documents.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ResolveAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesResolveParams\n{\n Resolution = \"FALSE_POSITIVE\",\n Note = \"Confirmed legitimate activity after reviewing documents.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Resuelto, o en espera de aprobación de cuatro ojos.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "400": { "description": "Se rechazó la resolución. Los errores que no corresponden a un campo llegan como una lista de cadenas: una checklist incompleta, falta una nota obligatoria, o un `checker` que no se pudo comprobar o que no es un revisor activo con acceso a casos de esta aplicación. Los errores de `checker` llegan con el campo como clave: el miembro indicado es el responsable que envía la resolución, o el blueprint del caso no tiene un paso de checker.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } ] }, "examples": { "Incomplete checklist": { "value": [ "Case has incomplete checklist items: Verify source of funds" ] }, "Resolution note required": { "value": [ "A resolution note is required to resolve this case." ] }, "Reviewer access could not be verified": { "value": [ "Reviewer access could not be verified. Try again." ] }, "Checker is not an active reviewer": { "value": [ "Choose an active reviewer with case access to this application." ] }, "Checker is the submitting officer": { "value": { "checker": [ "The officer who submitted the resolution cannot be its checker." ] } }, "Policy has no checker step": { "value": { "checker": [ "This review policy has no checker step, so the case resolves directly." ] } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/reopen/": { "post": { "summary": "Reabrir caso", "description": "Devuelve a abierto un caso en espera del usuario o resuelto, y borra resolution, resolution_notes, resolved_at y resolved_by_email.", "operationId": "reopen_case", "x-didit-sdk": { "resource": "cases", "method": "reopen", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/reopen/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.reopen(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.reopen(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Reopen(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().reopen(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->reopen('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.reopen(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ReopenAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Reabre el caso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/request-info/": { "post": { "summary": "Solicitar información (pendiente del usuario)", "description": "Pasa un caso abierto a awaiting_user mientras se recopila más información del usuario verificado. Falla con 400 si hay una resolución pendiente de aprobación por cuatro ojos.", "operationId": "request_case_info", "x-didit-sdk": { "resource": "cases", "method": "request_info", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/request-info/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.request_info(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requestInfo(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RequestInfo(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requestInfo(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requestInfo('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.request_info(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RequestInfoAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Solicitar información (pendiente del usuario).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/escalate/": { "post": { "summary": "Escalar caso", "description": "Mueve el caso al escalation_blueprint configurado en su blueprint. Requiere que el blueprint actual tenga escalation_enabled y un escalation_blueprint definido; de lo contrario, devuelve 400.", "operationId": "escalate_case", "x-didit-sdk": { "resource": "cases", "method": "escalate", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/escalate/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.escalate(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.escalate(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Escalate(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().escalate(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->escalate('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.escalate(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.EscalateAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Escalar caso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/transfer/": { "post": { "summary": "Transferir caso", "description": "Mueve el caso a otro blueprint activo de la misma aplicación. Requiere que el blueprint actual tenga transfer_enabled; de lo contrario, devuelve 400.", "operationId": "transfer_case", "x-didit-sdk": { "resource": "cases", "method": "transfer", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "target_blueprint" ], "properties": { "target_blueprint": { "type": "string", "format": "uuid" } } }, "example": { "target_blueprint": "b1de0000-0000-4000-8000-000000000002" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/transfer/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"target_blueprint\": \"b1de0000-0000-4000-8000-000000000002\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.transfer(\n \"c1a5e000-0000-4000-8000-000000000001\",\n target_blueprint=\"b1de0000-0000-4000-8000-000000000002\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.transfer(\"c1a5e000-0000-4000-8000-000000000001\", {\n target_blueprint: \"b1de0000-0000-4000-8000-000000000002\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Transfer(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesTransferParams{\n\tTargetBlueprint: \"b1de0000-0000-4000-8000-000000000002\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesTransferParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().transfer(\"c1a5e000-0000-4000-8000-000000000001\", CasesTransferParams.builder()\n .targetBlueprint(\"b1de0000-0000-4000-8000-000000000002\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->transfer('c1a5e000-0000-4000-8000-000000000001', [\n 'target_blueprint' => 'b1de0000-0000-4000-8000-000000000002',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.transfer(\n \"c1a5e000-0000-4000-8000-000000000001\",\n target_blueprint: \"b1de0000-0000-4000-8000-000000000002\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.TransferAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesTransferParams\n{\n TargetBlueprint = \"b1de0000-0000-4000-8000-000000000002\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Caso transferido.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/approve/": { "post": { "summary": "Aprobar la resolución preparada (cuatro ojos)", "description": "Aplica una resolución preparada por resolve en un blueprint de cuatro ojos. Quien llama debe ser un responsable distinto del que la envió; de lo contrario, se devuelve 403. Cuando la resolución designa a un verificador (el `checker` del caso), solo ese miembro puede aprobarla: cualquier otro llamante, incluida una clave de API, recibe 403.", "operationId": "approve_case_resolution", "x-didit-sdk": { "resource": "cases", "method": "approve_resolution", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/approve/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.approve_resolution(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.approveResolution(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.ApproveResolution(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().approveResolution(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->approveResolution('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.approve_resolution(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ApproveResolutionAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Resolución aplicada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "409": { "description": "El caso no tiene ninguna resolución pendiente de aprobación.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "403": { "description": "Quien hace la llamada no puede aprobar esta resolución: la envió él mismo, el caso no tiene un maker registrado o la resolución designa a otro checker. Una clave de API siempre recibe este 403 cuando se designa un checker.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Caller submitted the resolution": { "value": { "detail": "The officer who submitted the resolution cannot approve it." } }, "No recorded maker": { "value": { "detail": "Case has no recorded maker for this pending resolution; approve is not permitted." } }, "Caller is not the named checker": { "value": { "detail": "Only the named checker can approve this resolution." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/reject-approval/": { "post": { "summary": "Rechazar resolución preparada (principio de los cuatro ojos)", "description": "Rechaza una resolución preparada por resolve y devuelve el caso al blueprint de su autor. Quien llama debe ser un responsable distinto del que la envió; de lo contrario, se devuelve 403. Cuando la resolución designa un verificador (el `checker` del caso), solo ese miembro puede rechazarla: cualquier otro llamante, incluida una clave de API, recibe 403.", "operationId": "reject_case_resolution", "x-didit-sdk": { "resource": "cases", "method": "reject_resolution", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string", "nullable": true } } }, "example": { "notes": "Needs a clearer rationale before this can be approved." } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/reject-approval/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"notes\": \"Needs a clearer rationale before this can be approved.\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.reject_resolution(\n \"c1a5e000-0000-4000-8000-000000000001\",\n notes=\"Needs a clearer rationale before this can be approved.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.rejectResolution(\"c1a5e000-0000-4000-8000-000000000001\", {\n notes: \"Needs a clearer rationale before this can be approved.\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RejectResolution(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesRejectResolutionParams{\n\tNotes: didit.String(\"Needs a clearer rationale before this can be approved.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesRejectResolutionParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().rejectResolution(\"c1a5e000-0000-4000-8000-000000000001\", CasesRejectResolutionParams.builder()\n .notes(\"Needs a clearer rationale before this can be approved.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->rejectResolution('c1a5e000-0000-4000-8000-000000000001', [\n 'notes' => 'Needs a clearer rationale before this can be approved.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.reject_resolution(\n \"c1a5e000-0000-4000-8000-000000000001\",\n notes: \"Needs a clearer rationale before this can be approved.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RejectResolutionAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesRejectResolutionParams\n{\n Notes = \"Needs a clearer rationale before this can be approved.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Resolución rechazada; el caso vuelve al blueprint del creador.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "409": { "description": "El caso no tiene ninguna resolución pendiente de aprobación.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "403": { "description": "Quien hace la llamada no puede rechazar esta resolución: la envió él mismo, el caso no tiene un maker registrado o la resolución designa a otro checker. Una clave de API siempre recibe este 403 cuando se designa un checker.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Caller submitted the resolution": { "value": { "detail": "The officer who submitted the resolution cannot reject it." } }, "No recorded maker": { "value": { "detail": "Case has no recorded maker for this pending resolution; reject is not permitted." } }, "Caller is not the named checker": { "value": { "detail": "Only the named checker can reject this resolution." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/entity-actions/": { "post": { "operationId": "apply_case_entity_action", "x-didit-sdk": { "resource": "cases", "method": "apply_entity_action", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CaseActionCaseEntityActionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CaseActionCaseEntityActionRequest" }, "example": { "client_reference": "e1a00000-0000-4000-8000-000000000001", "action": "add_tags", "tags": [ "source-of-funds-reviewed" ] } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CaseActionCaseEntityActionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseActionCaseEntityActionResult" } } }, "description": "" }, "409": { "description": "La referencia pertenece a un payload de acción distinto." } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Aplica una acción explícita al sujeto del caso. Proporciona un client_reference único para obtener un recibo de la acción y hacer que los reintentos sean idempotentes. Reutilizar esa referencia con un payload distinto devuelve 409. Con una referencia, revisa receipt.status aunque el estado HTTP sea 200: FAILED significa que no se aplicó ninguna acción. Repetir una solicitud fallida no la vuelve a ejecutar salvo que retry sea true. Omitir client_reference mantiene la respuesta heredada.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.apply_entity_action(\n \"11111111-2222-3333-4444-555555555555\",\n client_reference=\"e1a00000-0000-4000-8000-000000000001\",\n action=\"add_tags\",\n tags=[\"source-of-funds-reviewed\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.applyEntityAction(\"11111111-2222-3333-4444-555555555555\", {\n client_reference: \"e1a00000-0000-4000-8000-000000000001\",\n action: \"add_tags\",\n tags: [\"source-of-funds-reviewed\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.ApplyEntityAction(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CaseActionCaseEntityActionRequest{\n\tClientReference: didit.String(\"e1a00000-0000-4000-8000-000000000001\"),\n\tAction: didit.CaseActionActionEnum(\"add_tags\"),\n\tTags: didit.Some([]string{\"source-of-funds-reviewed\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CaseActionActionEnum;\nimport me.didit.types.CaseActionCaseEntityActionRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().applyEntityAction(\"11111111-2222-3333-4444-555555555555\", CaseActionCaseEntityActionRequest.builder()\n .clientReference(\"e1a00000-0000-4000-8000-000000000001\")\n .action(CaseActionActionEnum.of(\"add_tags\"))\n .tags(List.of(\"source-of-funds-reviewed\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->applyEntityAction('11111111-2222-3333-4444-555555555555', [\n 'client_reference' => 'e1a00000-0000-4000-8000-000000000001',\n 'action' => 'add_tags',\n 'tags' => ['source-of-funds-reviewed'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.apply_entity_action(\n \"11111111-2222-3333-4444-555555555555\",\n client_reference: \"e1a00000-0000-4000-8000-000000000001\",\n action: \"add_tags\",\n tags: [\"source-of-funds-reviewed\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ApplyEntityActionAsync(\"11111111-2222-3333-4444-555555555555\", new CaseActionCaseEntityActionRequest\n{\n ClientReference = \"e1a00000-0000-4000-8000-000000000001\",\n Action = \"add_tags\",\n Tags = new string[] { \"source-of-funds-reviewed\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/print/": { "get": { "summary": "Imprimir caso (PDF)", "description": "Genera el caso completo (resumen, sujeto, estado de la lista de comprobación, notas, sesiones y transacciones adjuntas, eventos, lista de informes a la FIU) en PDF y devuelve una URL de descarga prefirmada.", "operationId": "print_case", "x-didit-sdk": { "resource": "cases", "method": "print", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/print/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.print(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.print(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Print(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().print(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->print('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.print(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.PrintAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "URL prefirmada del PDF.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/": { "get": { "operationId": "list_case_notes", "x-didit-sdk": { "resource": "cases.notes", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "name": "ordering", "required": false, "in": "query", "description": "Qué campo usar para ordenar los resultados.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Número de resultados que se devuelven por página.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "El índice inicial a partir del cual se devuelven los resultados.", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseCollaborationPaginatedCaseNoteList" } } }, "description": "" }, "403": { "description": "Quien hace la llamada no tiene el permiso de casos necesario." }, "404": { "description": "El caso o la nota no están disponibles para quien hace la llamada." } }, "tags": [ "Case Management" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.notes.list(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.notes.list(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.Notes.ListAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasesNotesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().notes().list(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->notes->list('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.notes.list(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.Notes.ListAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "operationId": "create_case_note", "x-didit-sdk": { "resource": "cases.notes", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CaseCollaborationCaseNoteCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CaseCollaborationCaseNoteCreateRequest" }, "example": { "comment": "Proof of address matches the ID document." } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CaseCollaborationCaseNoteCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseCollaborationCaseNote" } } }, "description": "" }, "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseCollaborationCaseNote" } } }, "description": "" }, "403": { "description": "Quien hace la llamada no tiene el permiso de casos necesario." }, "404": { "description": "El caso o la nota no están disponibles para quien hace la llamada." }, "409": { "description": "Esta referencia de cliente ya se usó para otra nota o para una nota que se ha eliminado." } }, "tags": [ "Case Management" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Añade una nota limitada al caso. Un client_reference opcional hace que un reintento sin cambios devuelva la misma nota sin duplicar la actividad ni las notificaciones. reply_to debe identificar una nota vigente de este caso. La respuesta incluye un extracto acotado de la nota principal, sin copiar ese extracto en la respuesta guardada.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.notes.create(\n \"11111111-2222-3333-4444-555555555555\",\n comment=\"Proof of address matches the ID document.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.notes.create(\"11111111-2222-3333-4444-555555555555\", {\n comment: \"Proof of address matches the ID document.\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Notes.Create(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CaseCollaborationCaseNoteCreateRequest{\n\tComment: \"Proof of address matches the ID document.\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CaseCollaborationCaseNoteCreateRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().notes().create(\"11111111-2222-3333-4444-555555555555\", CaseCollaborationCaseNoteCreateRequest.builder()\n .comment(\"Proof of address matches the ID document.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->notes->create('11111111-2222-3333-4444-555555555555', [\n 'comment' => 'Proof of address matches the ID document.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.notes.create(\n \"11111111-2222-3333-4444-555555555555\",\n comment: \"Proof of address matches the ID document.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Notes.CreateAsync(\"11111111-2222-3333-4444-555555555555\", new CaseCollaborationCaseNoteCreateRequest\n{\n Comment = \"Proof of address matches the ID document.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/{note_uuid}/": { "patch": { "operationId": "root_partial_update", "x-didit-sdk": { "resource": "cases.notes", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "note_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CaseCollaborationPatchedCaseNoteUpdateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CaseCollaborationPatchedCaseNoteUpdateRequest" }, "example": { "is_pinned": true } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CaseCollaborationPatchedCaseNoteUpdateRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseCollaborationCaseNote" } } }, "description": "" }, "403": { "description": "Quien hace la llamada no tiene el permiso de casos necesario." }, "404": { "description": "El caso o la nota no están disponibles para quien hace la llamada." } }, "tags": [ "Case Management" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Fija o desfija una nota existente. Las notas fijadas aparecen primero. Los cambios de fijación se registran en la actividad del caso y no modifican la evidencia ni las decisiones de origen.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.notes.update(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n is_pinned=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.notes.update(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n {\n is_pinned: true,\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Notes.Update(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\", didit.CaseCollaborationPatchedCaseNoteUpdateRequest{\n\tIsPinned: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CaseCollaborationPatchedCaseNoteUpdateRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().notes().update(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\", CaseCollaborationPatchedCaseNoteUpdateRequest.builder()\n .isPinned(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->notes->update('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555', [\n 'is_pinned' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.notes.update(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n is_pinned: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Notes.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\", new CaseCollaborationPatchedCaseNoteUpdateRequest\n{\n IsPinned = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "operationId": "delete_case_note", "x-didit-sdk": { "resource": "cases.notes", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "note_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "responses": { "204": { "description": "La nota se elimina de forma permanente. Las respuestas se conservan, sin el extracto de la nota principal eliminada. Los adjuntos se eliminan salvo que otra nota todavía los use." }, "403": { "description": "Quien hace la llamada no tiene el permiso de casos necesario." }, "404": { "description": "El caso o la nota no están disponibles para quien hace la llamada." } }, "tags": [ "Case Management" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.cases.notes.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.cases.notes.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nif err := client.Cases.Notes.Delete(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.cases().notes().delete(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "cases->notes->delete('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.notes.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Cases.Notes.DeleteAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/presign/": { "post": { "summary": "Subir archivo adjunto de nota", "description": "Sube un archivo (JPEG, PNG, WebP, PDF, texto plano o CSV; máximo 5 MB) para adjuntarlo a una nota. Devuelve el s3_key que debes pasar en el array attachments de la nota.", "operationId": "upload_case_note_attachment", "x-didit-sdk": { "resource": "cases.notes", "method": "create_attachment_upload", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/notes/presign/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'file=@evidence.pdf'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.notes.create_attachment_upload(\n \"c1a5e000-0000-4000-8000-000000000001\",\n file=open(\"document.pdf\", \"rb\"),\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.notes.createAttachmentUpload(\"c1a5e000-0000-4000-8000-000000000001\", {\n file: await fileFromPath(\"document.pdf\"),\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Notes.CreateAttachmentUpload(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesNotesCreateAttachmentUploadParams{\n\tFile: didit.FileFromPath(\"document.pdf\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.CasesNotesCreateAttachmentUploadParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().notes().createAttachmentUpload(\"c1a5e000-0000-4000-8000-000000000001\", CasesNotesCreateAttachmentUploadParams.builder()\n .file(Path.of(\"document.pdf\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->notes->createAttachmentUpload('c1a5e000-0000-4000-8000-000000000001', [\n 'file' => File::fromPath('document.pdf'),\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.notes.create_attachment_upload(\n \"c1a5e000-0000-4000-8000-000000000001\",\n file: Pathname(\"document.pdf\")\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Notes.CreateAttachmentUploadAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesNotesCreateAttachmentUploadParams\n{\n File = FileUpload.FromPath(\"document.pdf\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Archivo subido.", "content": { "application/json": { "schema": { "type": "object", "properties": { "s3_key": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "filename": { "type": "string" }, "file_size": { "type": "integer" } } } } } }, "400": { "description": "No hay archivo, el tipo de contenido no es compatible o el archivo supera los 5 MB.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "get": { "summary": "Obtener la URL del adjunto de una nota", "description": "Genera una nueva URL de descarga prefirmada para un archivo adjunto ya almacenado en una de las notas del caso.", "operationId": "get_case_note_attachment_url", "x-didit-sdk": { "resource": "cases.notes", "method": "retrieve_attachment_url", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." }, { "name": "s3_key", "in": "query", "schema": { "type": "string" }, "description": "El s3_key del adjunto, tal como lo devuelve la subida o aparece en la nota.", "required": true } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/notes/presign/?s3_key=case-notes/c1a5e000-0000-4000-8000-000000000001/evidence.pdf' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.notes.retrieve_attachment_url(\n \"c1a5e000-0000-4000-8000-000000000001\",\n s3_key=\"your-s3-key\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.notes.retrieveAttachmentUrl(\"c1a5e000-0000-4000-8000-000000000001\", {\n s3_key: \"your-s3-key\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Notes.RetrieveAttachmentURL(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesNotesRetrieveAttachmentURLParams{\n\tS3Key: \"your-s3-key\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesNotesRetrieveAttachmentUrlParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().notes().retrieveAttachmentUrl(\"c1a5e000-0000-4000-8000-000000000001\", CasesNotesRetrieveAttachmentUrlParams.builder()\n .s3Key(\"your-s3-key\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->notes->retrieveAttachmentUrl('c1a5e000-0000-4000-8000-000000000001', [\n 's3_key' => 'your-s3-key',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.notes.retrieve_attachment_url(\n \"c1a5e000-0000-4000-8000-000000000001\",\n s3_key: \"your-s3-key\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Notes.RetrieveAttachmentUrlAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesNotesRetrieveAttachmentUrlParams\n{\n S3Key = \"your-s3-key\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "URL prefirmada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "s3_key": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "filename": { "type": "string" } } } } } }, "404": { "description": "Falta s3_key o no pertenece a este caso.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/links/": { "get": { "summary": "Listar enlaces de un caso", "description": "Lista las sesiones, sesiones de empresa y transacciones vinculadas al caso.", "operationId": "list_case_links", "x-didit-sdk": { "resource": "cases.links", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/links/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.links.list(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.links.list(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Links.List(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().links().list(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->links->list('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.links.list(\"c1a5e000-0000-4000-8000-000000000001\").each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Links.ListAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Vínculos del caso.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseLink" } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Añadir un vínculo al caso", "description": "Adjunta una sesión, una sesión de empresa o una transacción al caso. Se rechaza con 400 si la entidad pertenece a un sujeto distinto del sujeto del caso.", "operationId": "create_case_link", "x-didit-sdk": { "resource": "cases.links", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "entity_type", "entity_uuid" ], "properties": { "entity_type": { "type": "string", "enum": [ "session", "business_session", "transaction" ] }, "entity_uuid": { "type": "string", "format": "uuid" } } }, "example": { "entity_type": "transaction", "entity_uuid": "77000000-0000-4000-8000-000000000077" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/links/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"entity_type\": \"transaction\", \"entity_uuid\": \"77000000-0000-4000-8000-000000000077\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.links.create(\n \"c1a5e000-0000-4000-8000-000000000001\",\n entity_type=\"transaction\",\n entity_uuid=\"77000000-0000-4000-8000-000000000077\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.links.create(\"c1a5e000-0000-4000-8000-000000000001\", {\n entity_type: \"transaction\",\n entity_uuid: \"77000000-0000-4000-8000-000000000077\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Links.Create(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesLinksCreateParams{\n\tEntityType: \"transaction\",\n\tEntityUUID: \"77000000-0000-4000-8000-000000000077\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesLinksCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().links().create(\"c1a5e000-0000-4000-8000-000000000001\", CasesLinksCreateParams.builder()\n .entityType(CasesLinksCreateParams.EntityType.of(\"transaction\"))\n .entityUuid(\"77000000-0000-4000-8000-000000000077\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->links->create('c1a5e000-0000-4000-8000-000000000001', [\n 'entity_type' => 'transaction',\n 'entity_uuid' => '77000000-0000-4000-8000-000000000077',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.links.create(\n \"c1a5e000-0000-4000-8000-000000000001\",\n entity_type: \"transaction\",\n entity_uuid: \"77000000-0000-4000-8000-000000000077\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Links.CreateAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesLinksCreateParams\n{\n EntityType = \"transaction\",\n EntityUuid = \"77000000-0000-4000-8000-000000000077\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Enlace creado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseLink" } } } }, "400": { "description": "La entidad pertenece a un perfil distinto del sujeto del caso.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/links/{link_uuid}/": { "delete": { "summary": "Eliminar el vínculo de un caso", "description": "Desvincula del caso una sesión, una sesión de empresa o una transacción vinculada.", "operationId": "delete_case_link", "x-didit-sdk": { "resource": "cases.links", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." }, { "name": "link_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "11000000-0000-4000-8000-000000000004" }, "description": "UUID del enlace." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/links/11000000-0000-4000-8000-000000000004/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.cases.links.delete(\n \"c1a5e000-0000-4000-8000-000000000001\",\n \"11000000-0000-4000-8000-000000000004\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.cases.links.delete(\n \"c1a5e000-0000-4000-8000-000000000001\",\n \"11000000-0000-4000-8000-000000000004\",\n);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nif err := client.Cases.Links.Delete(ctx, \"c1a5e000-0000-4000-8000-000000000001\", \"11000000-0000-4000-8000-000000000004\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.cases().links().delete(\"c1a5e000-0000-4000-8000-000000000001\", \"11000000-0000-4000-8000-000000000004\");" }, { "lang": "php", "label": "PHP", "source": "cases->links->delete('c1a5e000-0000-4000-8000-000000000001', '11000000-0000-4000-8000-000000000004');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.links.delete(\n \"c1a5e000-0000-4000-8000-000000000001\",\n \"11000000-0000-4000-8000-000000000004\"\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Cases.Links.DeleteAsync(\"c1a5e000-0000-4000-8000-000000000001\", \"11000000-0000-4000-8000-000000000004\");" } ], "responses": { "204": { "description": "Enlace eliminado." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/events/": { "get": { "summary": "Listar eventos de un caso", "description": "Cronología de auditoría de solo lectura del caso (creación, cambios de estado, asignación, resolución, escalado, transferencias, cambios de etiqueta/prioridad/fecha límite, acciones sobre entidades y más).", "operationId": "list_case_events", "x-didit-sdk": { "resource": "cases", "method": "list_events", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Tamaño de página." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Desplazamiento, empezando en cero." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/events/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.list_events(\n \"c1a5e000-0000-4000-8000-000000000001\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.listEvents(\"c1a5e000-0000-4000-8000-000000000001\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.ListEventsAutoPaging(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesListEventsParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().listEvents(\"c1a5e000-0000-4000-8000-000000000001\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->listEvents('c1a5e000-0000-4000-8000-000000000001') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.list_events(\"c1a5e000-0000-4000-8000-000000000001\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.ListEventsAsync(\"c1a5e000-0000-4000-8000-000000000001\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Eventos paginados, del más reciente al más antiguo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de filas coincidentes. Exacto hasta 100, limitado a 100 a partir de ahí por rendimiento. Para detectar la última página, comprueba que `next` sea null." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta de la página siguiente, o null." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta de la página anterior, o null." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseEvent" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/checklist/": { "get": { "summary": "Listar la checklist de un caso", "description": "Lista, en orden, los elementos de la lista de comprobación del caso, copiados de content_config.checklist.items de la plantilla en el momento de su creación.", "operationId": "list_case_checklist", "x-didit-sdk": { "resource": "cases.checklist", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/checklist/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.checklist.list(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.checklist.list(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Checklist.List(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().checklist().list(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->checklist->list('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.checklist.list(\"c1a5e000-0000-4000-8000-000000000001\").each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Checklist.ListAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Elementos de la lista de comprobación.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseChecklistItem" } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/checklist/{item_uuid}/": { "patch": { "summary": "Marcar o desmarcar un elemento de la lista de comprobación", "description": "Marca un elemento de la lista de comprobación como completado o pendiente. La resolución se bloquea mientras haya algún elemento pendiente, salvo que la plantilla marque la lista de comprobación como opcional.", "operationId": "toggle_case_checklist_item", "x-didit-sdk": { "resource": "cases.checklist", "method": "toggle_item", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." }, { "name": "item_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c4ec0000-0000-4000-8000-000000000005" }, "description": "UUID del elemento de la lista de comprobación." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "is_completed" ], "properties": { "is_completed": { "type": "boolean" } } }, "example": { "is_completed": true } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/checklist/c4ec0000-0000-4000-8000-000000000005/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"is_completed\": true}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.checklist.toggle_item(\n \"c1a5e000-0000-4000-8000-000000000001\",\n \"c4ec0000-0000-4000-8000-000000000005\",\n is_completed=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.checklist.toggleItem(\n \"c1a5e000-0000-4000-8000-000000000001\",\n \"c4ec0000-0000-4000-8000-000000000005\",\n {\n is_completed: true,\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Checklist.ToggleItem(ctx, \"c1a5e000-0000-4000-8000-000000000001\", \"c4ec0000-0000-4000-8000-000000000005\", didit.CasesChecklistToggleItemParams{\n\tIsCompleted: true,\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesChecklistToggleItemParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().checklist().toggleItem(\"c1a5e000-0000-4000-8000-000000000001\", \"c4ec0000-0000-4000-8000-000000000005\", CasesChecklistToggleItemParams.builder()\n .isCompleted(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->checklist->toggleItem('c1a5e000-0000-4000-8000-000000000001', 'c4ec0000-0000-4000-8000-000000000005', [\n 'is_completed' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.checklist.toggle_item(\n \"c1a5e000-0000-4000-8000-000000000001\",\n \"c4ec0000-0000-4000-8000-000000000005\",\n is_completed: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Checklist.ToggleItemAsync(\"c1a5e000-0000-4000-8000-000000000001\", \"c4ec0000-0000-4000-8000-000000000005\", new CasesChecklistToggleItemParams\n{\n IsCompleted = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Elemento de la lista de comprobación actualizado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseChecklistItem" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/aml/": { "get": { "summary": "Listar coincidencias AML de un caso", "description": "Lista las coincidencias del análisis AML del sujeto del caso. Tienen la misma estructura que las coincidencias que devuelve POST /v3/aml/.", "operationId": "list_case_aml_hits", "x-didit-sdk": { "resource": "cases", "method": "list_aml_hits", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/aml/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.list_aml_hits(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.listAmlHits(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.ListAMLHits(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().listAmlHits(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->listAmlHits('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.list_aml_hits(\"c1a5e000-0000-4000-8000-000000000001\").each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ListAmlHitsAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Coincidencias AML.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AMLScreening" } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/statistics/": { "get": { "summary": "Analítica de casos", "description": "Analítica agregada de casos para el intervalo de fechas (por defecto, los últimos 30 días; máximo 731 días). Los gráficos, las tablas, los totales, los eventos de asignación y los recuentos actuales de las colas usan los mismos filtros limitados a la aplicación. Los filtros usan los valores actuales de los casos. Las fechas se aplican a cada evento de métrica, por lo que los casos más antiguos asignados o resueltos durante el periodo siguen incluidos. La profundidad de las colas no depende del intervalo de fechas. Los filtros no válidos devuelven 400; una plantilla (blueprint) o un asignado desconocidos devuelven un resultado vacío.", "operationId": "get_case_analytics", "x-didit-sdk": { "resource": "cases", "method": "retrieve_statistics", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Inicio del rango (inclusive). El valor predeterminado es hace 30 días." }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Fin del rango (inclusive). El valor predeterminado es hoy." }, { "name": "blueprint", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Filtrar por el UUID del blueprint actual." }, { "name": "assigned_to", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Filtrar por el UUID del usuario revisor asignado actualmente." }, { "name": "priority", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "description": "Filtra por la prioridad actual del caso." }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "MANUAL", "AML_SCREENING", "TRANSACTION_RULE", "WORKFLOW_BUILDER" ] }, "description": "Filtra por origen de creación del caso." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ] }, "description": "Filtra por el estado actual del caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/statistics/?date_from=2026-06-01&date_to=2026-06-30' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.retrieve_statistics()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.retrieveStatistics();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RetrieveStatistics(ctx, didit.CasesRetrieveStatisticsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().retrieveStatistics();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->retrieveStatistics();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.retrieve_statistics\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RetrieveStatisticsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Payload de analítica.", "content": { "application/json": { "schema": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "created": { "type": "integer" }, "reviewed": { "type": "integer" } } } }, "tables": { "type": "object", "properties": { "officer": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Valor de la dimensión: correo electrónico del responsable, \"blueprint_name:uuid\", fuente o estado. \"unassigned\"/\"none\" para las dimensiones ausentes." }, "created": { "type": "integer" }, "assigned": { "type": "integer" }, "resolved": { "type": "integer" }, "threat_rate": { "type": "number", "format": "float" }, "false_positive_rate": { "type": "number", "format": "float" }, "unresolved": { "type": "integer" }, "reassignment_rate": { "type": "number", "format": "float" }, "escalation_rate": { "type": "number", "format": "float" }, "avg_assign_hours": { "type": "number", "format": "float" }, "avg_resolve_hours": { "type": "number", "format": "float" }, "avg_handling_hours": { "type": "number", "format": "float" } } } }, "blueprint": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Valor de la dimensión: correo electrónico del responsable, \"blueprint_name:uuid\", fuente o estado. \"unassigned\"/\"none\" para las dimensiones ausentes." }, "created": { "type": "integer" }, "assigned": { "type": "integer" }, "resolved": { "type": "integer" }, "threat_rate": { "type": "number", "format": "float" }, "false_positive_rate": { "type": "number", "format": "float" }, "unresolved": { "type": "integer" }, "reassignment_rate": { "type": "number", "format": "float" }, "escalation_rate": { "type": "number", "format": "float" }, "avg_assign_hours": { "type": "number", "format": "float" }, "avg_resolve_hours": { "type": "number", "format": "float" }, "avg_handling_hours": { "type": "number", "format": "float" } } } }, "source": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Valor de la dimensión: correo electrónico del responsable, \"blueprint_name:uuid\", fuente o estado. \"unassigned\"/\"none\" para las dimensiones ausentes." }, "created": { "type": "integer" }, "assigned": { "type": "integer" }, "resolved": { "type": "integer" }, "threat_rate": { "type": "number", "format": "float" }, "false_positive_rate": { "type": "number", "format": "float" }, "unresolved": { "type": "integer" }, "reassignment_rate": { "type": "number", "format": "float" }, "escalation_rate": { "type": "number", "format": "float" }, "avg_assign_hours": { "type": "number", "format": "float" }, "avg_resolve_hours": { "type": "number", "format": "float" }, "avg_handling_hours": { "type": "number", "format": "float" } } } }, "status": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Valor de la dimensión: correo electrónico del responsable, \"blueprint_name:uuid\", fuente o estado. \"unassigned\"/\"none\" para las dimensiones ausentes." }, "created": { "type": "integer" }, "assigned": { "type": "integer" }, "resolved": { "type": "integer" }, "threat_rate": { "type": "number", "format": "float" }, "false_positive_rate": { "type": "number", "format": "float" }, "unresolved": { "type": "integer" }, "reassignment_rate": { "type": "number", "format": "float" }, "escalation_rate": { "type": "number", "format": "float" }, "avg_assign_hours": { "type": "number", "format": "float" }, "avg_resolve_hours": { "type": "number", "format": "float" }, "avg_handling_hours": { "type": "number", "format": "float" } } } } } }, "totals": { "type": "object", "properties": { "created": { "type": "integer" }, "assigned": { "type": "integer" }, "resolved": { "type": "integer" }, "threat_rate": { "type": "number", "format": "float" }, "false_positive_rate": { "type": "number", "format": "float" }, "unresolved": { "type": "integer" }, "reassignment_rate": { "type": "number", "format": "float" }, "escalation_rate": { "type": "number", "format": "float" }, "avg_assign_hours": { "type": "number", "format": "float" }, "avg_resolve_hours": { "type": "number", "format": "float" }, "avg_handling_hours": { "type": "number", "format": "float" } } }, "queue": { "type": "object", "description": "Instantánea en tiempo real, no limitada al rango de fechas.", "properties": { "open": { "type": "integer" }, "overdue": { "type": "integer" } } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/bulk/status/": { "post": { "summary": "Actualizar en bloque el estado de casos", "description": "Aplica la misma transición de estado a varios casos en una sola llamada: OPEN los reabre, AWAITING_USER solicita información y RESOLVED los resuelve (se requiere una resolución). Cada caso se evalúa de forma independiente; los fallos de control (checklist incompleta, falta una nota obligatoria) se informan por caso sin abortar el lote.", "operationId": "bulk_update_case_status", "x-didit-sdk": { "resource": "cases", "method": "bulk_update_status", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "case_uuids", "status" ], "properties": { "case_uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1 }, "status": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ] }, "resolution": { "type": "string", "enum": [ "FALSE_POSITIVE", "VALID_THREAT", "INCONCLUSIVE", "REQUIREMENTS_NOT_MET", "REQUIREMENTS_SATISFIED" ], "description": "Obligatorio cuando status es RESOLVED." }, "note": { "type": "string", "nullable": true } } }, "example": { "case_uuids": [ "c1a5e000-0000-4000-8000-000000000001" ], "status": "RESOLVED", "resolution": "FALSE_POSITIVE" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/bulk/status/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"case_uuids\": [\"c1a5e000-0000-4000-8000-000000000001\"], \"status\": \"RESOLVED\", \"resolution\": \"FALSE_POSITIVE\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.bulk_update_status(\n case_uuids=[\"c1a5e000-0000-4000-8000-000000000001\"],\n status=\"RESOLVED\",\n resolution=\"FALSE_POSITIVE\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.bulkUpdateStatus({\n case_uuids: [\"c1a5e000-0000-4000-8000-000000000001\"],\n status: \"RESOLVED\",\n resolution: \"FALSE_POSITIVE\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.BulkUpdateStatus(ctx, didit.CasesBulkUpdateStatusParams{\n\tCaseUUIDs: []string{\"c1a5e000-0000-4000-8000-000000000001\"},\n\tStatus: \"RESOLVED\",\n\tResolution: didit.Some(didit.CasesBulkUpdateStatusParamsResolution(\"FALSE_POSITIVE\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CasesBulkUpdateStatusParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().bulkUpdateStatus(CasesBulkUpdateStatusParams.builder()\n .caseUuids(List.of(\"c1a5e000-0000-4000-8000-000000000001\"))\n .status(CasesBulkUpdateStatusParams.Status.of(\"RESOLVED\"))\n .resolution(CasesBulkUpdateStatusParams.Resolution.of(\"FALSE_POSITIVE\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->bulkUpdateStatus([\n 'case_uuids' => ['c1a5e000-0000-4000-8000-000000000001'],\n 'status' => 'RESOLVED',\n 'resolution' => 'FALSE_POSITIVE',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.bulk_update_status(\n case_uuids: [\"c1a5e000-0000-4000-8000-000000000001\"],\n status: \"RESOLVED\",\n resolution: \"FALSE_POSITIVE\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.BulkUpdateStatusAsync(new CasesBulkUpdateStatusParams\n{\n CaseUuids = new string[] { \"c1a5e000-0000-4000-8000-000000000001\" },\n Status = \"RESOLVED\",\n Resolution = new CasesBulkUpdateStatusParamsResolution(\"FALSE_POSITIVE\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Resultados por caso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBulkUpdateResult" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/bulk/assign/": { "post": { "summary": "Asignar casos en bloque", "description": "Asigna (o desasigna, con assignee_user_id: null) varios casos a la vez. Todos los casos deben compartir el mismo blueprint. Las discrepancias se informan por caso sin interrumpir el lote.", "operationId": "bulk_assign_cases", "x-didit-sdk": { "resource": "cases", "method": "bulk_assign", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "case_uuids", "assignee_user_id" ], "properties": { "case_uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1 }, "assignee_user_id": { "type": "string", "format": "uuid", "nullable": true }, "assignee_email": { "type": "string", "format": "email", "nullable": true }, "assignee_name": { "type": "string", "nullable": true } } }, "example": { "case_uuids": [ "c1a5e000-0000-4000-8000-000000000001" ], "assignee_user_id": "9a000000-0000-4000-8000-0000000000aa" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/bulk/assign/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"case_uuids\": [\"c1a5e000-0000-4000-8000-000000000001\"], \"assignee_user_id\": \"9a000000-0000-4000-8000-0000000000aa\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.bulk_assign(\n case_uuids=[\"c1a5e000-0000-4000-8000-000000000001\"],\n assignee_user_id=\"9a000000-0000-4000-8000-0000000000aa\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.bulkAssign({\n case_uuids: [\"c1a5e000-0000-4000-8000-000000000001\"],\n assignee_user_id: \"9a000000-0000-4000-8000-0000000000aa\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.BulkAssign(ctx, didit.CasesBulkAssignParams{\n\tCaseUUIDs: []string{\"c1a5e000-0000-4000-8000-000000000001\"},\n\tAssigneeUserID: didit.String(\"9a000000-0000-4000-8000-0000000000aa\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CasesBulkAssignParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().bulkAssign(CasesBulkAssignParams.builder()\n .caseUuids(List.of(\"c1a5e000-0000-4000-8000-000000000001\"))\n .assigneeUserId(\"9a000000-0000-4000-8000-0000000000aa\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->bulkAssign([\n 'case_uuids' => ['c1a5e000-0000-4000-8000-000000000001'],\n 'assignee_user_id' => '9a000000-0000-4000-8000-0000000000aa',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.bulk_assign(\n case_uuids: [\"c1a5e000-0000-4000-8000-000000000001\"],\n assignee_user_id: \"9a000000-0000-4000-8000-0000000000aa\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.BulkAssignAsync(new CasesBulkAssignParams\n{\n CaseUuids = new string[] { \"c1a5e000-0000-4000-8000-000000000001\" },\n AssigneeUserId = \"9a000000-0000-4000-8000-0000000000aa\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Resultados por caso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBulkUpdateResult" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/": { "get": { "summary": "Listar blueprints", "description": "Lista los blueprints de casos de la aplicación.", "operationId": "list_case_blueprints", "x-didit-sdk": { "resource": "cases.blueprints", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Tamaño de página." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Desplazamiento, empezando en cero." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.blueprints.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.blueprints.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.Blueprints.ListAutoPaging(ctx, didit.CasesBlueprintsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().blueprints().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.blueprints.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.Blueprints.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Lista paginada de blueprints.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de filas coincidentes, limitado a 100 por rendimiento." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseBlueprintListItem" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crear blueprint", "description": "Crea un modelo de caso: la configuración general (asignación, escalado, transferencia, emparejamiento de doble revisión) más content_config, las seis secciones que definen la página del caso. Establece publish=false para crear un borrador sin publicar; Publicar crea su primera versión activa. Descartar un borrador que nunca se ha publicado lo elimina.", "operationId": "create_case_blueprint", "x-didit-sdk": { "resource": "cases.blueprints", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "assignee_pool" ], "properties": { "name": { "type": "string", "maxLength": 24, "description": "Máximo 24 caracteres, por ejemplo \"Investigación AML\"." }, "description": { "type": "string", "nullable": true }, "assignee_pool": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "description": "Lista de UUID de usuario. Los arrays vacíos se rechazan con \"Pick at least one assignee\"." }, "assignment_method": { "type": "string", "enum": [ "MANUAL", "AUTOMATIC" ], "default": "MANUAL" }, "max_active_cases": { "type": "integer", "nullable": true, "minimum": 1, "description": "Umbral del modo automático: \"menos de N casos asignados de este blueprint\"." }, "escalation_enabled": { "type": "boolean", "default": false }, "escalation_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID del blueprint de destino. No se valida al guardar, pero la acción de escalado falla con 400 hasta que se configuran tanto escalation_enabled como escalation_blueprint." }, "transfer_enabled": { "type": "boolean", "default": false }, "four_eyes_checker_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "Configurar esto activa la revisión de cuatro ojos: las resoluciones de este blueprint quedan en espera en la cola del blueprint verificador." }, "require_resolution_note": { "type": "boolean", "default": false }, "content_config": { "$ref": "#/components/schemas/CaseContentConfig" }, "is_active": { "type": "boolean", "default": true }, "default_deadline_hours": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 8760, "description": "Plazo predeterminado para los casos recién abiertos. Los plazos de los casos existentes no cambian." }, "publish": { "type": "boolean", "writeOnly": true, "default": true, "description": "Establécelo en false para guardar un borrador nunca publicado. El registro permanece inactivo en la versión 0 hasta que el borrador se publique explícitamente. Si se omite este campo, se mantiene la creación inmediata para las integraciones existentes." } } }, "example": { "name": "AML investigation", "assignee_pool": [ "9a000000-0000-4000-8000-0000000000aa" ], "assignment_method": "AUTOMATIC", "max_active_cases": 15, "require_resolution_note": true, "content_config": { "aml_control": { "enabled": true, "financial": true, "identity": false } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"name\": \"AML investigation\", \"assignee_pool\": [\"9a000000-0000-4000-8000-0000000000aa\"], \"assignment_method\": \"AUTOMATIC\", \"max_active_cases\": 15, \"require_resolution_note\": true, \"content_config\": {\"aml_control\": {\"enabled\": true, \"financial\": true, \"identity\": false}}}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.create(\n name=\"AML investigation\",\n assignee_pool=[\"9a000000-0000-4000-8000-0000000000aa\"],\n assignment_method=\"AUTOMATIC\",\n max_active_cases=15,\n require_resolution_note=True,\n content_config={\n \"aml_control\": {\n \"enabled\": True,\n \"financial\": True,\n \"identity\": False,\n },\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.create({\n name: \"AML investigation\",\n assignee_pool: [\"9a000000-0000-4000-8000-0000000000aa\"],\n assignment_method: \"AUTOMATIC\",\n max_active_cases: 15,\n require_resolution_note: true,\n content_config: {\n aml_control: {\n enabled: true,\n financial: true,\n identity: false,\n },\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.Create(ctx, didit.CasesBlueprintsCreateParams{\n\tName: \"AML investigation\",\n\tAssigneePool: []string{\"9a000000-0000-4000-8000-0000000000aa\"},\n\tAssignmentMethod: didit.Some(didit.CasesBlueprintsCreateParamsAssignmentMethod(\"AUTOMATIC\")),\n\tMaxActiveCases: didit.Int(15),\n\tRequireResolutionNote: didit.Bool(true),\n\tContentConfig: didit.Some(didit.CaseContentConfigParam{\n\t\tAMLControl: didit.Some(didit.CaseContentConfigParamAMLControl{\n\t\t\tEnabled: didit.Bool(true),\n\t\t\tFinancial: didit.Bool(true),\n\t\t\tIdentity: didit.Bool(false),\n\t\t}),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CaseContentConfig;\nimport me.didit.types.CasesBlueprintsCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().create(CasesBlueprintsCreateParams.builder()\n .name(\"AML investigation\")\n .assigneePool(List.of(\"9a000000-0000-4000-8000-0000000000aa\"))\n .assignmentMethod(CasesBlueprintsCreateParams.AssignmentMethod.of(\"AUTOMATIC\"))\n .maxActiveCases(15L)\n .requireResolutionNote(true)\n .contentConfig(CaseContentConfig.builder()\n .amlControl(CaseContentConfig.AmlControl.builder()\n .enabled(true)\n .financial(true)\n .identity(false)\n .build())\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->create([\n 'name' => 'AML investigation',\n 'assignee_pool' => ['9a000000-0000-4000-8000-0000000000aa'],\n 'assignment_method' => 'AUTOMATIC',\n 'max_active_cases' => 15,\n 'require_resolution_note' => true,\n 'content_config' => [\n 'aml_control' => [\n 'enabled' => true,\n 'financial' => true,\n 'identity' => false,\n ],\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.create(\n name: \"AML investigation\",\n assignee_pool: [\"9a000000-0000-4000-8000-0000000000aa\"],\n assignment_method: \"AUTOMATIC\",\n max_active_cases: 15,\n require_resolution_note: true,\n content_config: {\n aml_control: {\n enabled: true,\n financial: true,\n identity: false,\n },\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.CreateAsync(new CasesBlueprintsCreateParams\n{\n Name = \"AML investigation\",\n AssigneePool = new string[] { \"9a000000-0000-4000-8000-0000000000aa\" },\n AssignmentMethod = new CasesBlueprintsCreateParamsAssignmentMethod(\"AUTOMATIC\"),\n MaxActiveCases = 15,\n RequireResolutionNote = true,\n ContentConfig = new CaseContentConfig\n {\n AmlControl = new CaseContentConfigAmlControl\n {\n Enabled = true,\n Financial = true,\n Identity = false,\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Blueprint creado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintDetail" } } } }, "400": { "description": "Nombre de más de 24 caracteres, assignee_pool vacío o una plantilla referenciada (escalado/verificador) que no se encuentra.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/": { "get": { "summary": "Obtener un blueprint", "description": "Obtiene un blueprint, incluidas sus fuentes de creación conectadas (configuración AML, reglas de transacciones, nodos del flujo) y qué blueprints escalan a él.", "operationId": "get_case_blueprint", "x-didit-sdk": { "resource": "cases.blueprints", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "blueprint_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "b1de0000-0000-4000-8000-000000000002" }, "description": "UUID del blueprint." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/b1de0000-0000-4000-8000-000000000002/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.retrieve(\n \"b1de0000-0000-4000-8000-000000000002\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.retrieve(\"b1de0000-0000-4000-8000-000000000002\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.Retrieve(ctx, \"b1de0000-0000-4000-8000-000000000002\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().retrieve(\"b1de0000-0000-4000-8000-000000000002\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->retrieve('b1de0000-0000-4000-8000-000000000002');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.retrieve(\"b1de0000-0000-4000-8000-000000000002\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.RetrieveAsync(\"b1de0000-0000-4000-8000-000000000002\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Detalle del blueprint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualizar blueprint", "description": "Actualiza parcialmente la configuración general o el content_config de un blueprint.", "operationId": "update_case_blueprint", "x-didit-sdk": { "resource": "cases.blueprints", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "blueprint_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "b1de0000-0000-4000-8000-000000000002" }, "description": "UUID del blueprint." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 24, "description": "Máximo 24 caracteres, por ejemplo \"Investigación AML\"." }, "description": { "type": "string", "nullable": true }, "assignee_pool": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "description": "Lista de UUID de usuario. Los arrays vacíos se rechazan con \"Pick at least one assignee\"." }, "assignment_method": { "type": "string", "enum": [ "MANUAL", "AUTOMATIC" ] }, "max_active_cases": { "type": "integer", "nullable": true, "minimum": 1, "description": "Umbral del modo automático: \"menos de N casos asignados de este blueprint\"." }, "escalation_enabled": { "type": "boolean" }, "escalation_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID del blueprint de destino. No se valida al guardar, pero la acción de escalado falla con 400 hasta que se configuran tanto escalation_enabled como escalation_blueprint." }, "transfer_enabled": { "type": "boolean" }, "four_eyes_checker_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "Configurar esto activa la revisión de cuatro ojos: las resoluciones de este blueprint quedan en espera en la cola del blueprint verificador." }, "require_resolution_note": { "type": "boolean" }, "content_config": { "$ref": "#/components/schemas/CaseContentConfig" }, "is_active": { "type": "boolean" }, "default_deadline_hours": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 8760, "description": "Plazo predeterminado para los casos recién abiertos. Los plazos de los casos existentes no cambian." }, "expected_version": { "type": "integer", "minimum": 1, "description": "La versión que abrió el editor. Una versión obsoleta devuelve 409 sin cambiar la política de revisión." } } }, "example": { "transfer_enabled": true } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/b1de0000-0000-4000-8000-000000000002/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"transfer_enabled\": true}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.update(\n \"b1de0000-0000-4000-8000-000000000002\",\n transfer_enabled=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.update(\"b1de0000-0000-4000-8000-000000000002\", {\n transfer_enabled: true,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.Update(ctx, \"b1de0000-0000-4000-8000-000000000002\", didit.CasesBlueprintsUpdateParams{\n\tTransferEnabled: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesBlueprintsUpdateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().update(\"b1de0000-0000-4000-8000-000000000002\", CasesBlueprintsUpdateParams.builder()\n .transferEnabled(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->update('b1de0000-0000-4000-8000-000000000002', [\n 'transfer_enabled' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.update(\n \"b1de0000-0000-4000-8000-000000000002\",\n transfer_enabled: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.UpdateAsync(\"b1de0000-0000-4000-8000-000000000002\", new CasesBlueprintsUpdateParams\n{\n TransferEnabled = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Blueprint actualizado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintDetail" } } } }, "409": { "description": "La política de revisión cambió desde expected_version. Revisa la última versión antes de reintentar." } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Eliminar blueprint", "description": "Elimina un blueprint. La eliminación siempre se completa y no afecta a los casos del blueprint: los casos existentes conservan su referencia al blueprint y su configuración se les sigue aplicando. Un blueprint eliminado ya no aparece en los listados de blueprints y ya no se puede elegir como destino de una transferencia; si se elimina un blueprint maker mientras una resolución está pendiente de aprobación por el principio de los cuatro ojos, una resolución rechazada deja el caso en el blueprint checker.", "operationId": "delete_case_blueprint", "x-didit-sdk": { "resource": "cases.blueprints", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "blueprint_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "b1de0000-0000-4000-8000-000000000002" }, "description": "UUID del blueprint." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/b1de0000-0000-4000-8000-000000000002/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.cases.blueprints.delete(\n \"b1de0000-0000-4000-8000-000000000002\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.cases.blueprints.delete(\"b1de0000-0000-4000-8000-000000000002\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nif err := client.Cases.Blueprints.Delete(ctx, \"b1de0000-0000-4000-8000-000000000002\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.cases().blueprints().delete(\"b1de0000-0000-4000-8000-000000000002\");" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->delete('b1de0000-0000-4000-8000-000000000002');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.blueprints.delete(\"b1de0000-0000-4000-8000-000000000002\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Cases.Blueprints.DeleteAsync(\"b1de0000-0000-4000-8000-000000000002\");" } ], "responses": { "204": { "description": "Blueprint eliminado." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/presets/": { "get": { "summary": "Listar presets de blueprints", "description": "Lista los cuatro presets integrados (Screening hit, AML investigation, Suspicious activity, KYC review) con su content_config e indica si cada uno ya está instalado en esta aplicación.", "operationId": "list_case_blueprint_presets", "x-didit-sdk": { "resource": "cases.blueprints", "method": "list_presets", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/presets/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.list_presets()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.listPresets();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.ListPresets(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().listPresets();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->listPresets();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.list_presets\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.ListPresetsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Catálogo de ajustes predefinidos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "preset_key": { "type": "string", "enum": [ "screening_hit", "aml_investigation", "suspicious_activity", "kyc" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "content_config": { "$ref": "#/components/schemas/CaseContentConfig" }, "installed": { "type": "boolean" } } } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/presets/install/": { "post": { "summary": "Instalar presets de plantilla", "description": "Copia uno o más presets en la aplicación como plantillas base editables. Es idempotente por preset_key; omite preset_keys para instalar todos los presets que aún no estén instalados.", "operationId": "install_case_blueprint_presets", "x-didit-sdk": { "resource": "cases.blueprints", "method": "install_presets", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "preset_keys": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Subconjunto de screening_hit, aml_investigation, suspicious_activity, kyc. Omítelo para instalarlos todos." } } }, "example": { "preset_keys": [ "aml_investigation", "kyc" ] } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/presets/install/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"preset_keys\": [\"aml_investigation\", \"kyc\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.install_presets(\n preset_keys=[\"aml_investigation\", \"kyc\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.installPresets({\n preset_keys: [\"aml_investigation\", \"kyc\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.InstallPresets(ctx, didit.CasesBlueprintsInstallPresetsParams{\n\tPresetKeys: didit.Some([]string{\"aml_investigation\", \"kyc\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CasesBlueprintsInstallPresetsParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().installPresets(CasesBlueprintsInstallPresetsParams.builder()\n .presetKeys(List.of(\"aml_investigation\", \"kyc\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->installPresets([\n 'preset_keys' => ['aml_investigation', 'kyc'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.install_presets(preset_keys: [\"aml_investigation\", \"kyc\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.InstallPresetsAsync(new CasesBlueprintsInstallPresetsParams\n{\n PresetKeys = new string[] { \"aml_investigation\", \"kyc\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Uno o más presets instalados.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintPresetInstallResult" } } } }, "200": { "description": "No hay preajustes nuevos para instalar (todos los preajustes solicitados ya existen).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintPresetInstallResult" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/report-templates/": { "get": { "summary": "Listar plantillas de informe", "description": "Lista las plantillas de informes FIU de la aplicación.", "operationId": "list_report_templates", "x-didit-sdk": { "resource": "report_templates", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Report Templates" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Tamaño de página." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Desplazamiento, empezando en cero." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/report-templates/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.report_templates.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.reportTemplates.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.ReportTemplates.ListAutoPaging(ctx, didit.ReportTemplatesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.reportTemplates().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "reportTemplates->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.report_templates.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.ReportTemplates.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Plantillas paginadas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de filas coincidentes, limitado a 100 por rendimiento." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTemplateDetail" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crear plantilla de informe", "description": "Crea una plantilla de encabezado goAML reutilizable por jurisdicción y por tipo de informe. Se rechaza con 400 si falta en field_config alguno de los campos obligatorios a nivel de plantilla (rentity_id, submission_code, currency_code_local); una plantilla no válida no se puede guardar ni usar para crear un informe. Los campos de encabezado propios de cada presentación (action, submission_date, transactions) se exigen, en cambio, al validar o finalizar el informe.", "operationId": "create_report_template", "x-didit-sdk": { "resource": "report_templates", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Report Templates" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "jurisdiction", "report_type" ], "properties": { "name": { "type": "string" }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Código de país ISO 3166-1 alfa-2, convertido a mayúsculas al guardar." }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "field_config": { "type": "object", "description": "Valores predeterminados reutilizables del encabezado de goAML. Campos obligatorios a nivel de plantilla: rentity_id, submission_code y currency_code_local (3 letras). Opcionales: enabled_fields (qué bloques opcionales del informe incluir), además de los valores predeterminados de reporting_person, location, reason y action. Los campos del encabezado de cada declaración (action, submission_date, transactions, jurisdiction) se exigen cuando el informe se valida o se finaliza, no en la plantilla." } } }, "example": { "name": "US SAR default", "jurisdiction": "US", "report_type": "SAR", "field_config": { "rentity_id": "FIU-US-00123", "submission_code": "E", "currency_code_local": "USD" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/report-templates/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"name\": \"US SAR default\", \"jurisdiction\": \"US\", \"report_type\": \"SAR\", \"field_config\": {\"rentity_id\": \"FIU-US-00123\", \"submission_code\": \"E\", \"currency_code_local\": \"USD\"}}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.report_templates.create(\n name=\"US SAR default\",\n jurisdiction=\"US\",\n report_type=\"SAR\",\n field_config={\"rentity_id\": \"FIU-US-00123\", \"submission_code\": \"E\", \"currency_code_local\": \"USD\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.reportTemplates.create({\n name: \"US SAR default\",\n jurisdiction: \"US\",\n report_type: \"SAR\",\n field_config: { rentity_id: \"FIU-US-00123\", submission_code: \"E\", currency_code_local: \"USD\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.ReportTemplates.Create(ctx, didit.ReportTemplatesCreateParams{\n\tName: \"US SAR default\",\n\tJurisdiction: \"US\",\n\tReportType: \"SAR\",\n\tFieldConfig: didit.Some(map[string]any{\"rentity_id\": \"FIU-US-00123\", \"submission_code\": \"E\", \"currency_code_local\": \"USD\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.ReportTemplatesCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.reportTemplates().create(ReportTemplatesCreateParams.builder()\n .name(\"US SAR default\")\n .jurisdiction(\"US\")\n .reportType(ReportTemplatesCreateParams.ReportType.of(\"SAR\"))\n .fieldConfig(Map.of(\"rentity_id\", \"FIU-US-00123\", \"submission_code\", \"E\", \"currency_code_local\", \"USD\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "reportTemplates->create([\n 'name' => 'US SAR default',\n 'jurisdiction' => 'US',\n 'report_type' => 'SAR',\n 'field_config' => ['rentity_id' => 'FIU-US-00123', 'submission_code' => 'E', 'currency_code_local' => 'USD'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.report_templates.create(\n name: \"US SAR default\",\n jurisdiction: \"US\",\n report_type: \"SAR\",\n field_config: { rentity_id: \"FIU-US-00123\", submission_code: \"E\", currency_code_local: \"USD\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.ReportTemplates.CreateAsync(new ReportTemplatesCreateParams\n{\n Name = \"US SAR default\",\n Jurisdiction = \"US\",\n ReportType = \"SAR\",\n FieldConfig = new Dictionary { [\"rentity_id\"] = \"FIU-US-00123\", [\"submission_code\"] = \"E\", [\"currency_code_local\"] = \"USD\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Plantilla creada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplateDetail" } } } }, "400": { "description": "Jurisdicción no reconocida, o field_config no supera la validación de campos obligatorios.", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/report-templates/{template_uuid}/": { "get": { "summary": "Obtener plantilla de informe", "description": "Obtiene una plantilla de informe.", "operationId": "get_report_template", "x-didit-sdk": { "resource": "report_templates", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Report Templates" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "template_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "7ec00000-0000-4000-8000-000000000006" }, "description": "UUID de la plantilla de informe." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/report-templates/7ec00000-0000-4000-8000-000000000006/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.report_templates.retrieve(\n \"7ec00000-0000-4000-8000-000000000006\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.reportTemplates.retrieve(\"7ec00000-0000-4000-8000-000000000006\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.ReportTemplates.Retrieve(ctx, \"7ec00000-0000-4000-8000-000000000006\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.reportTemplates().retrieve(\"7ec00000-0000-4000-8000-000000000006\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "reportTemplates->retrieve('7ec00000-0000-4000-8000-000000000006');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.report_templates.retrieve(\"7ec00000-0000-4000-8000-000000000006\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.ReportTemplates.RetrieveAsync(\"7ec00000-0000-4000-8000-000000000006\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Detalle de la plantilla.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplateDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualizar plantilla de informe", "description": "Actualiza parcialmente una plantilla de informe. Al guardar, vuelve a validar los campos obligatorios de goAML.", "operationId": "update_report_template", "x-didit-sdk": { "resource": "report_templates", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Report Templates" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "template_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "7ec00000-0000-4000-8000-000000000006" }, "description": "UUID de la plantilla de informe." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Código de país ISO 3166-1 alfa-2, convertido a mayúsculas al guardar." }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "field_config": { "type": "object", "description": "Valores predeterminados reutilizables del encabezado de goAML. Campos obligatorios a nivel de plantilla: rentity_id, submission_code y currency_code_local (3 letras). Opcionales: enabled_fields (qué bloques opcionales del informe incluir), además de los valores predeterminados de reporting_person, location, reason y action. Los campos del encabezado de cada declaración (action, submission_date, transactions, jurisdiction) se exigen cuando el informe se valida o se finaliza, no en la plantilla." } } }, "example": { "field_config": { "rentity_id": "FIU-US-00124" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/report-templates/7ec00000-0000-4000-8000-000000000006/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"field_config\": {\"rentity_id\": \"FIU-US-00124\"}}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.report_templates.update(\n \"7ec00000-0000-4000-8000-000000000006\",\n field_config={\"rentity_id\": \"FIU-US-00124\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.reportTemplates.update(\"7ec00000-0000-4000-8000-000000000006\", {\n field_config: { rentity_id: \"FIU-US-00124\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.ReportTemplates.Update(ctx, \"7ec00000-0000-4000-8000-000000000006\", didit.ReportTemplatesUpdateParams{\n\tFieldConfig: didit.Some(map[string]any{\"rentity_id\": \"FIU-US-00124\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.ReportTemplatesUpdateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.reportTemplates().update(\"7ec00000-0000-4000-8000-000000000006\", ReportTemplatesUpdateParams.builder()\n .fieldConfig(Map.of(\"rentity_id\", \"FIU-US-00124\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "reportTemplates->update('7ec00000-0000-4000-8000-000000000006', [\n 'field_config' => ['rentity_id' => 'FIU-US-00124'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.report_templates.update(\n \"7ec00000-0000-4000-8000-000000000006\",\n field_config: { rentity_id: \"FIU-US-00124\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.ReportTemplates.UpdateAsync(\"7ec00000-0000-4000-8000-000000000006\", new ReportTemplatesUpdateParams\n{\n FieldConfig = new Dictionary { [\"rentity_id\"] = \"FIU-US-00124\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Plantilla actualizada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplateDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Eliminar plantilla de informe", "description": "Elimina una plantilla de informe. Los informes ya creados a partir de ella no se ven afectados.", "operationId": "delete_report_template", "x-didit-sdk": { "resource": "report_templates", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Report Templates" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "template_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "7ec00000-0000-4000-8000-000000000006" }, "description": "UUID de la plantilla de informe." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/report-templates/7ec00000-0000-4000-8000-000000000006/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.report_templates.delete(\n \"7ec00000-0000-4000-8000-000000000006\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.reportTemplates.delete(\"7ec00000-0000-4000-8000-000000000006\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nif err := client.ReportTemplates.Delete(ctx, \"7ec00000-0000-4000-8000-000000000006\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.reportTemplates().delete(\"7ec00000-0000-4000-8000-000000000006\");" }, { "lang": "php", "label": "PHP", "source": "reportTemplates->delete('7ec00000-0000-4000-8000-000000000006');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.report_templates.delete(\"7ec00000-0000-4000-8000-000000000006\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.ReportTemplates.DeleteAsync(\"7ec00000-0000-4000-8000-000000000006\");" } ], "responses": { "204": { "description": "Plantilla eliminada." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/": { "get": { "summary": "Listar informes de un caso", "description": "Lista los informes FIU generados para el caso.", "operationId": "list_case_regulatory_reports", "x-didit-sdk": { "resource": "cases.regulatory_reports", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Tamaño de página." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Desplazamiento, empezando en cero." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/regulatory-reports/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.regulatory_reports.list(\n \"c1a5e000-0000-4000-8000-000000000001\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.regulatoryReports.list(\"c1a5e000-0000-4000-8000-000000000001\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.RegulatoryReports.ListAutoPaging(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesRegulatoryReportsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().regulatoryReports().list(\"c1a5e000-0000-4000-8000-000000000001\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->regulatoryReports->list('c1a5e000-0000-4000-8000-000000000001') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.regulatory_reports.list(\"c1a5e000-0000-4000-8000-000000000001\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.RegulatoryReports.ListAsync(\"c1a5e000-0000-4000-8000-000000000001\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Informes paginados del caso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportList" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crear informe a partir de un caso", "description": "Crea un borrador de informe FIU para el caso: con estado DRAFT y rellenado automáticamente a partir de la plantilla opcional más el sujeto del caso, las transacciones vinculadas y la narrativa. Valídalo y luego finalízalo para generar el XML de goAML y el PDF.", "operationId": "create_case_regulatory_report", "x-didit-sdk": { "resource": "cases.regulatory_reports", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del caso." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ], "description": "Obligatorio salvo que se indique una plantilla; en ese caso se usa el report_type de la plantilla." }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Obligatorio salvo que se indique una plantilla." }, "template": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID de la plantilla de informe; su field_config inicializa el borrador antes de combinar los datos derivados del caso." }, "transactions": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true, "description": "Transacciones que se adjuntan; de forma predeterminada, las transacciones vinculadas al caso." }, "rentity_id": { "type": "string", "nullable": true }, "rentity_branch": { "type": "string", "nullable": true }, "submission_code": { "type": "string", "enum": [ "E", "M" ], "default": "E" }, "entity_reference": { "type": "string", "nullable": true }, "fiu_ref_number": { "type": "string", "nullable": true }, "currency_code_local": { "type": "string", "minLength": 3, "maxLength": 3, "nullable": true }, "submission_date": { "type": "string", "format": "date-time", "nullable": true }, "reporting_person": { "type": "object" }, "location": { "type": "object" }, "reason": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "activity": { "type": "string", "nullable": true }, "narrative": { "type": "object", "properties": { "who": { "type": "string" }, "what": { "type": "string" }, "when": { "type": "string" }, "where": { "type": "string" }, "why": { "type": "string" }, "how": { "type": "string" } } }, "report_indicators": { "type": "array", "items": { "type": "string" } }, "included_fields": { "type": "array", "items": { "type": "string" } } } }, "example": { "template": "7ec00000-0000-4000-8000-000000000006" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/regulatory-reports/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"template\": \"7ec00000-0000-4000-8000-000000000006\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.regulatory_reports.create(\n \"c1a5e000-0000-4000-8000-000000000001\",\n template=\"7ec00000-0000-4000-8000-000000000006\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.regulatoryReports.create(\"c1a5e000-0000-4000-8000-000000000001\", {\n template: \"7ec00000-0000-4000-8000-000000000006\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RegulatoryReports.Create(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesRegulatoryReportsCreateParams{\n\tTemplate: didit.String(\"7ec00000-0000-4000-8000-000000000006\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesRegulatoryReportsCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().regulatoryReports().create(\"c1a5e000-0000-4000-8000-000000000001\", CasesRegulatoryReportsCreateParams.builder()\n .template(\"7ec00000-0000-4000-8000-000000000006\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->regulatoryReports->create('c1a5e000-0000-4000-8000-000000000001', [\n 'template' => '7ec00000-0000-4000-8000-000000000006',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.regulatory_reports.create(\n \"c1a5e000-0000-4000-8000-000000000001\",\n template: \"7ec00000-0000-4000-8000-000000000006\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RegulatoryReports.CreateAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesRegulatoryReportsCreateParams\n{\n Template = \"7ec00000-0000-4000-8000-000000000006\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Borrador de informe creado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "400": { "description": "No se encontró la plantilla referenciada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/": { "get": { "summary": "Listar informes", "description": "Lista de informes FIU de toda la aplicación, con filtro opcional por status, report_type o case.", "operationId": "list_regulatory_reports", "x-didit-sdk": { "resource": "regulatory_reports", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Tamaño de página." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Desplazamiento, empezando en cero." }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "DRAFT", "VALIDATED", "FINALIZED" ] }, "description": "Filtrar por estado." }, { "name": "report_type", "in": "query", "schema": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "description": "Filtra por tipo de informe." }, { "name": "case", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Filtrar los informes de este caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.regulatory_reports.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.regulatoryReports.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.RegulatoryReports.ListAutoPaging(ctx, didit.RegulatoryReportsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.regulatoryReports().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.regulatory_reports.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.RegulatoryReports.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Informes paginados de toda la aplicación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportList" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crear informe independiente", "description": "Crea un borrador de informe FIU desde la página independiente de Informes: tanto el caso como la plantilla son obligatorios (a diferencia de la creación dentro de un caso, que puede omitir la plantilla).", "operationId": "create_standalone_regulatory_report", "x-didit-sdk": { "resource": "regulatory_reports", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "case", "template" ], "properties": { "case": { "type": "string", "format": "uuid" }, "template": { "type": "string", "format": "uuid" }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ], "description": "Obligatorio salvo que se indique una plantilla; en ese caso se usa el report_type de la plantilla." }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Obligatorio salvo que se indique una plantilla." }, "transactions": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true, "description": "Transacciones que se adjuntan; de forma predeterminada, las transacciones vinculadas al caso." }, "rentity_id": { "type": "string", "nullable": true }, "rentity_branch": { "type": "string", "nullable": true }, "submission_code": { "type": "string", "enum": [ "E", "M" ], "default": "E" }, "entity_reference": { "type": "string", "nullable": true }, "fiu_ref_number": { "type": "string", "nullable": true }, "currency_code_local": { "type": "string", "minLength": 3, "maxLength": 3, "nullable": true }, "submission_date": { "type": "string", "format": "date-time", "nullable": true }, "reporting_person": { "type": "object" }, "location": { "type": "object" }, "reason": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "activity": { "type": "string", "nullable": true }, "narrative": { "type": "object", "properties": { "who": { "type": "string" }, "what": { "type": "string" }, "when": { "type": "string" }, "where": { "type": "string" }, "why": { "type": "string" }, "how": { "type": "string" } } }, "report_indicators": { "type": "array", "items": { "type": "string" } }, "included_fields": { "type": "array", "items": { "type": "string" } } } }, "example": { "case": "c1a5e000-0000-4000-8000-000000000001", "template": "7ec00000-0000-4000-8000-000000000006" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"case\": \"c1a5e000-0000-4000-8000-000000000001\", \"template\": \"7ec00000-0000-4000-8000-000000000006\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.regulatory_reports.create(\n case=\"c1a5e000-0000-4000-8000-000000000001\",\n template=\"7ec00000-0000-4000-8000-000000000006\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.regulatoryReports.create({\n case: \"c1a5e000-0000-4000-8000-000000000001\",\n template: \"7ec00000-0000-4000-8000-000000000006\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.RegulatoryReports.Create(ctx, didit.RegulatoryReportsCreateParams{\n\tCase: \"c1a5e000-0000-4000-8000-000000000001\",\n\tTemplate: \"7ec00000-0000-4000-8000-000000000006\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.RegulatoryReportsCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.regulatoryReports().create(RegulatoryReportsCreateParams.builder()\n .case_(\"c1a5e000-0000-4000-8000-000000000001\")\n .template(\"7ec00000-0000-4000-8000-000000000006\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->create([\n 'case' => 'c1a5e000-0000-4000-8000-000000000001',\n 'template' => '7ec00000-0000-4000-8000-000000000006',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.regulatory_reports.create(\n case: \"c1a5e000-0000-4000-8000-000000000001\",\n template: \"7ec00000-0000-4000-8000-000000000006\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.RegulatoryReports.CreateAsync(new RegulatoryReportsCreateParams\n{\n Case = \"c1a5e000-0000-4000-8000-000000000001\",\n Template = \"7ec00000-0000-4000-8000-000000000006\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Borrador de informe creado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "400": { "description": "No se encontró la plantilla referenciada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/": { "get": { "summary": "Obtener informe", "description": "Obtiene un informe regulatorio.", "operationId": "get_regulatory_report", "x-didit-sdk": { "resource": "regulatory_reports", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID del informe." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.regulatory_reports.retrieve(\n \"5ec00000-0000-4000-8000-000000000007\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.regulatoryReports.retrieve(\"5ec00000-0000-4000-8000-000000000007\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.RegulatoryReports.Retrieve(ctx, \"5ec00000-0000-4000-8000-000000000007\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.regulatoryReports().retrieve(\"5ec00000-0000-4000-8000-000000000007\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->retrieve('5ec00000-0000-4000-8000-000000000007');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.regulatory_reports.retrieve(\"5ec00000-0000-4000-8000-000000000007\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.RegulatoryReports.RetrieveAsync(\"5ec00000-0000-4000-8000-000000000007\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Detalle del informe.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualizar informe", "description": "Edita los campos de un informe en borrador o validado. Los informes finalizados no se pueden editar (409).", "operationId": "update_regulatory_report", "x-didit-sdk": { "resource": "regulatory_reports", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID del informe." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2 }, "rentity_id": { "type": "string", "nullable": true }, "rentity_branch": { "type": "string", "nullable": true }, "submission_code": { "type": "string", "enum": [ "E", "M" ], "default": "E" }, "entity_reference": { "type": "string", "nullable": true }, "fiu_ref_number": { "type": "string", "nullable": true }, "currency_code_local": { "type": "string", "minLength": 3, "maxLength": 3, "nullable": true }, "submission_date": { "type": "string", "format": "date-time", "nullable": true }, "reporting_person": { "type": "object" }, "location": { "type": "object" }, "reason": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "activity": { "type": "string", "nullable": true }, "narrative": { "type": "object", "properties": { "who": { "type": "string" }, "what": { "type": "string" }, "when": { "type": "string" }, "where": { "type": "string" }, "why": { "type": "string" }, "how": { "type": "string" } } }, "report_indicators": { "type": "array", "items": { "type": "string" } }, "included_fields": { "type": "array", "items": { "type": "string" } } } }, "example": { "rentity_id": "FIU-US-00123", "currency_code_local": "USD" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"rentity_id\": \"FIU-US-00123\", \"currency_code_local\": \"USD\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.regulatory_reports.update(\n \"5ec00000-0000-4000-8000-000000000007\",\n rentity_id=\"FIU-US-00123\",\n currency_code_local=\"USD\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.regulatoryReports.update(\"5ec00000-0000-4000-8000-000000000007\", {\n rentity_id: \"FIU-US-00123\",\n currency_code_local: \"USD\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.RegulatoryReports.Update(ctx, \"5ec00000-0000-4000-8000-000000000007\", didit.RegulatoryReportsUpdateParams{\n\tRentityID: didit.String(\"FIU-US-00123\"),\n\tCurrencyCodeLocal: didit.String(\"USD\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.RegulatoryReportsUpdateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.regulatoryReports().update(\"5ec00000-0000-4000-8000-000000000007\", RegulatoryReportsUpdateParams.builder()\n .rentityId(\"FIU-US-00123\")\n .currencyCodeLocal(\"USD\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->update('5ec00000-0000-4000-8000-000000000007', [\n 'rentity_id' => 'FIU-US-00123',\n 'currency_code_local' => 'USD',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.regulatory_reports.update(\n \"5ec00000-0000-4000-8000-000000000007\",\n rentity_id: \"FIU-US-00123\",\n currency_code_local: \"USD\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.RegulatoryReports.UpdateAsync(\"5ec00000-0000-4000-8000-000000000007\", new RegulatoryReportsUpdateParams\n{\n RentityId = \"FIU-US-00123\",\n CurrencyCodeLocal = \"USD\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Informe actualizado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "409": { "description": "El informe ya está finalizado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Eliminar informe", "description": "Elimina un informe regulatorio de forma permanente. Se borran el informe, su narrativa y motivos copiados, sus vínculos con transacciones y sus archivos XML de goAML y PDF generados, incluidas todas las versiones almacenadas de esos archivos. El informe desaparece de los listados y las URL de descarga dejan de funcionar. Los demás registros, incluidos el caso, las transacciones, las personas y las empresas, no se eliminan. No se puede deshacer.\n\nUn informe en borrador o validado se puede eliminar sin cuerpo de solicitud. Para eliminar un informe finalizado se requiere `confirm_delete: true` en el cuerpo de la solicitud. Si el informe no existe, la solicitud devuelve `404`; si se envía un informe finalizado sin confirmación, devuelve `400` y no se elimina nada.", "operationId": "delete_regulatory_report", "x-didit-sdk": { "resource": "regulatory_reports", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID del informe." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl (draft report)", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "curl", "label": "curl (finalized report)", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"confirm_delete\": true}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.regulatory_reports.delete(\n \"5ec00000-0000-4000-8000-000000000007\",\n confirm_delete=True,\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.regulatoryReports.delete(\"5ec00000-0000-4000-8000-000000000007\", {\n confirm_delete: true,\n});" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.RegulatoryReportsDeleteParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.regulatoryReports().delete(\"5ec00000-0000-4000-8000-000000000007\", RegulatoryReportsDeleteParams.builder()\n .confirmDelete(true)\n .build());" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->delete('5ec00000-0000-4000-8000-000000000007', [\n 'confirm_delete' => true,\n]);" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.regulatory_reports.delete(\n \"5ec00000-0000-4000-8000-000000000007\",\n confirm_delete: true\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.RegulatoryReports.DeleteAsync(\"5ec00000-0000-4000-8000-000000000007\", new RegulatoryReportsDeleteParams\n{\n ConfirmDelete = true,\n});" } ], "responses": { "204": { "description": "Informe eliminado, incluidos sus archivos generados." }, "400": { "description": "Se envió un informe finalizado sin `confirm_delete: true`. No se elimina nada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "confirm_delete": { "type": "array", "items": { "type": "string" } } } }, "example": { "confirm_delete": [ "This field is required to delete a finalized report." ] } } } }, "403": { "description": "La clave de API no puede eliminar informes. El endpoint requiere `write:cases`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "404": { "description": "No se encontró el informe en esta aplicación.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "409": { "description": "El informe ya se está eliminando. Repite la solicitud para terminar de borrar sus archivos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string" } } }, "example": { "detail": "This report is being deleted. Retry deleting it to finish erasing its files.", "code": "report_deletion_pending" } } } }, "503": { "description": "No se pudieron borrar los archivos del informe en este momento. El informe sigue existiendo. Repite la solicitud.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string" } } }, "example": { "detail": "The report files could not be erased. Please retry deleting the report.", "code": "report_storage_unavailable" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": false, "description": "Obligatorio solo para un informe finalizado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "confirm_delete": { "type": "boolean", "description": "Establécelo en true para confirmar que un informe finalizado y sus archivos generados se eliminan de forma permanente." } }, "example": { "confirm_delete": true } }, "example": { "confirm_delete": true } } } } } }, "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/validate/": { "post": { "summary": "Validar informe", "description": "Comprueba el informe con los campos obligatorios del encabezado de goAML (ID de la entidad informante, código de envío, moneda local, acción tomada, fecha de envío), además de al menos una transacción adjunta y una jurisdicción de 2 letras, sin generar ningún archivo. También almacena el resultado en el informe: se actualizan validation_errors y validated_at, y el estado de un informe no finalizado pasa a VALIDATED (sin errores) o vuelve a DRAFT (con errores).", "operationId": "validate_regulatory_report", "x-didit-sdk": { "resource": "regulatory_reports", "method": "validate", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID del informe." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/validate/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.regulatory_reports.validate(\n \"5ec00000-0000-4000-8000-000000000007\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.regulatoryReports.validate(\"5ec00000-0000-4000-8000-000000000007\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.RegulatoryReports.Validate(ctx, \"5ec00000-0000-4000-8000-000000000007\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.regulatoryReports().validate(\"5ec00000-0000-4000-8000-000000000007\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->validate('5ec00000-0000-4000-8000-000000000007');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.regulatory_reports.validate(\"5ec00000-0000-4000-8000-000000000007\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.RegulatoryReports.ValidateAsync(\"5ec00000-0000-4000-8000-000000000007\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Resultado de la validación.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "DRAFT", "VALIDATED", "FINALIZED" ] }, "is_valid": { "type": "boolean" }, "errors": { "type": "array", "description": "Vacío cuando es válido.", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/finalize/": { "post": { "summary": "Finalizar informe", "description": "Vuelve a validar y, después, genera el XML y el PDF de goAML y sube ambos a S3. En los informes SAR/STR/TFR, también pasa las alertas de transacciones del caso de Pending SAR a SAR filed.", "operationId": "finalize_regulatory_report", "x-didit-sdk": { "resource": "regulatory_reports", "method": "finalize", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID del informe." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/finalize/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.regulatory_reports.finalize(\n \"5ec00000-0000-4000-8000-000000000007\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.regulatoryReports.finalize(\"5ec00000-0000-4000-8000-000000000007\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.RegulatoryReports.Finalize(ctx, \"5ec00000-0000-4000-8000-000000000007\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.regulatoryReports().finalize_(\"5ec00000-0000-4000-8000-000000000007\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->finalize('5ec00000-0000-4000-8000-000000000007');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.regulatory_reports.finalize(\"5ec00000-0000-4000-8000-000000000007\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.RegulatoryReports.FinalizeAsync(\"5ec00000-0000-4000-8000-000000000007\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Informe finalizado; xml_s3_key y pdf_s3_key están definidos.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "400": { "description": "El informe no ha superado la validación.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "409": { "description": "El informe no está en un estado que permita finalizarlo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/download-url/": { "get": { "summary": "Obtener la URL de descarga del informe", "description": "Genera una URL prefirmada para el XML de goAML o el PDF de un informe finalizado.", "operationId": "get_regulatory_report_download_url", "x-didit-sdk": { "resource": "regulatory_reports", "method": "retrieve_download_url", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID del informe." }, { "name": "file", "in": "query", "schema": { "type": "string", "enum": [ "pdf", "xml" ], "default": "pdf" }, "description": "Qué archivo descargar." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/download-url/?file=xml' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.regulatory_reports.retrieve_download_url(\n \"5ec00000-0000-4000-8000-000000000007\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.regulatoryReports.retrieveDownloadUrl(\"5ec00000-0000-4000-8000-000000000007\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.RegulatoryReports.RetrieveDownloadURL(ctx, \"5ec00000-0000-4000-8000-000000000007\", didit.RegulatoryReportsRetrieveDownloadURLParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.regulatoryReports().retrieveDownloadUrl(\"5ec00000-0000-4000-8000-000000000007\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->retrieveDownloadUrl('5ec00000-0000-4000-8000-000000000007');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.regulatory_reports.retrieve_download_url(\"5ec00000-0000-4000-8000-000000000007\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.RegulatoryReports.RetrieveDownloadUrlAsync(\"5ec00000-0000-4000-8000-000000000007\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "URL de descarga prefirmada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "download_url": { "type": "string", "format": "uri" }, "file": { "type": "string", "enum": [ "pdf", "xml" ] } } } } } }, "409": { "description": "El informe aún no está finalizado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "status": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/transactions/rules/": { "get": { "summary": "Listar reglas", "description": "Lista las reglas de monitorización de transacciones de la aplicación: tus reglas personalizadas más los presets de la biblioteca que hayas instalado. Filtra por origen, categoría, modo, paquete o búsqueda de texto libre; ordena con `ordering` (run_count, approved_pct, reviewed_pct, declined_pct, latest_triggered_at, title, created_at, source, cada uno con un prefijo `-` opcional).", "operationId": "listTransactionRules", "x-didit-sdk": { "resource": "transactions.rules", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PRESET", "CUSTOM" ] }, "description": "PRESET o CUSTOM" }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filtra por categoría de regla" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "TEST" ] }, "description": "ACTIVE, DISABLED o TEST" }, { "name": "bundle", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filtrar configuraciones predefinidas por paquete" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Coincidencia sin distinguir mayúsculas y minúsculas con el título y la descripción" }, { "name": "ordering", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Campos de ordenación separados por comas; por defecto, source,-run_count" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tamaño de página" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Desplazamiento de página" } ], "responses": { "200": { "description": "Reglas paginadas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleDetail" } } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/rules/?source=CUSTOM&ordering=-run_count' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.transactions.rules.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.transactions.rules.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Transactions.Rules.ListAutoPaging(ctx, didit.TransactionsRulesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.transactions().rules().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.rules.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Transactions.Rules.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "summary": "Crear regla", "description": "Crea una regla CUSTOM de monitorización de transacciones. Los títulos son únicos por aplicación (un duplicado devuelve 400). Una acción `change_status` cuyo destino sea `AWAITING_USER` debe incluir `workflow_id`. Las reglas creadas en modo ACTIVE se aplican de inmediato a las nuevas transacciones; el procedimiento recomendado es crearlas en modo TEST, hacer un backtest y, después, cambiar el modo a ACTIVE.", "operationId": "createTransactionRule", "x-didit-sdk": { "resource": "transactions.rules", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleCreateRequest" }, "example": { "title": "Structuring - inbound (custom)", "description": "20+ inbound EUR transfers, all under 10,000 EUR, 30 days", "category": "finance", "mode": "TEST", "evaluation_mode": "ALL", "scope": { "transaction_types": [ "finance" ], "directions": [ "INBOUND" ] }, "conditions": [ { "field": "currency", "operator": "eq", "value": "EUR" }, { "field": "amount", "operator": "lt", "value": 10000 } ], "aggregation": [ { "metric": "count", "operator": "gte", "value": 20, "window": "30d", "filters": { "direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR" } }, { "metric": "max", "field": "amount", "operator": "lt", "value": 10000, "window": "30d", "filters": { "direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR" } } ], "actions": [ { "type": "add_score", "value": 35 } ] } } } }, "responses": { "201": { "description": "La regla creada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleDetail" } } } }, "400": { "description": "Error de validación: título duplicado, operador o métrica desconocidos, ventana mal formada, dirección de alcance no válida o AWAITING_USER sin workflow_id.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "title": [ "A rule with this name already exists." ] } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/transactions/rules/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"title\": \"Structuring - inbound (custom)\", \"description\": \"20+ inbound EUR transfers, all under 10,000 EUR, 30 days\", \"category\": \"finance\", \"mode\": \"TEST\", \"evaluation_mode\": \"ALL\", \"scope\": {\"transaction_types\": [\"finance\"], \"directions\": [\"INBOUND\"]}, \"conditions\": [{\"field\": \"currency\", \"operator\": \"eq\", \"value\": \"EUR\"}, {\"field\": \"amount\", \"operator\": \"lt\", \"value\": 10000}], \"aggregation\": [{\"metric\": \"count\", \"operator\": \"gte\", \"value\": 20, \"window\": \"30d\", \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}}, {\"metric\": \"max\", \"field\": \"amount\", \"operator\": \"lt\", \"value\": 10000, \"window\": \"30d\", \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}}], \"actions\": [{\"type\": \"add_score\", \"value\": 35}]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.rules.create(\n title=\"Structuring - inbound (custom)\",\n description=\"20+ inbound EUR transfers, all under 10,000 EUR, 30 days\",\n category=\"finance\",\n mode=\"TEST\",\n evaluation_mode=\"ALL\",\n scope={\n \"transaction_types\": [\"finance\"],\n \"directions\": [\"INBOUND\"],\n },\n conditions=[{\n \"field\": \"currency\",\n \"operator\": \"eq\",\n \"value\": \"EUR\",\n }, {\n \"field\": \"amount\",\n \"operator\": \"lt\",\n \"value\": 10000,\n }],\n aggregation=[{\n \"metric\": \"count\",\n \"operator\": \"gte\",\n \"value\": 20.0,\n \"window\": \"30d\",\n \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"},\n }, {\n \"metric\": \"max\",\n \"field\": \"amount\",\n \"operator\": \"lt\",\n \"value\": 10000.0,\n \"window\": \"30d\",\n \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"},\n }],\n actions=[{\n \"type\": \"add_score\",\n \"value\": 35,\n }],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.rules.create({\n title: \"Structuring - inbound (custom)\",\n description: \"20+ inbound EUR transfers, all under 10,000 EUR, 30 days\",\n category: \"finance\",\n mode: \"TEST\",\n evaluation_mode: \"ALL\",\n scope: {\n transaction_types: [\"finance\"],\n directions: [\"INBOUND\"],\n },\n conditions: [{\n field: \"currency\",\n operator: \"eq\",\n value: \"EUR\",\n }, {\n field: \"amount\",\n operator: \"lt\",\n value: 10000,\n }],\n aggregation: [{\n metric: \"count\",\n operator: \"gte\",\n value: 20.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }, {\n metric: \"max\",\n field: \"amount\",\n operator: \"lt\",\n value: 10000.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }],\n actions: [{\n type: \"add_score\",\n value: 35,\n }],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.Create(ctx, didit.TransactionRuleCreateRequest{\n\tTitle: \"Structuring - inbound (custom)\",\n\tDescription: didit.String(\"20+ inbound EUR transfers, all under 10,000 EUR, 30 days\"),\n\tCategory: \"finance\",\n\tMode: \"TEST\",\n\tEvaluationMode: didit.Some(didit.TransactionRuleCreateRequestEvaluationMode(\"ALL\")),\n\tScope: didit.Some(didit.TransactionRuleScopeParam{\n\t\tTransactionTypes: didit.Some([]string{\"finance\"}),\n\t\tDirections: didit.Some([]didit.TransactionRuleScopeDirections{\"INBOUND\"}),\n\t}),\n\tConditions: didit.Some([]didit.TransactionRuleConditionParam{{\n\t\tField: \"currency\",\n\t\tOperator: \"eq\",\n\t\tValue: didit.Some[any](\"EUR\"),\n\t}, {\n\t\tField: \"amount\",\n\t\tOperator: \"lt\",\n\t\tValue: didit.Some[any](10000),\n\t}}),\n\tAggregation: didit.Some([]didit.TransactionRuleAggregationParam{{\n\t\tMetric: didit.Some(didit.TransactionRuleAggregationMetric(\"count\")),\n\t\tOperator: didit.Some(didit.TransactionRuleAggregationOperator(\"gte\")),\n\t\tValue: 20.0,\n\t\tWindow: didit.String(\"30d\"),\n\t\tFilters: didit.Some(map[string]any{\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}),\n\t}, {\n\t\tMetric: didit.Some(didit.TransactionRuleAggregationMetric(\"max\")),\n\t\tField: didit.String(\"amount\"),\n\t\tOperator: didit.Some(didit.TransactionRuleAggregationOperator(\"lt\")),\n\t\tValue: 10000.0,\n\t\tWindow: didit.String(\"30d\"),\n\t\tFilters: didit.Some(map[string]any{\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}),\n\t}}),\n\tActions: didit.Some([]didit.TransactionRuleActionParam{{\n\t\tType: \"add_score\",\n\t\tValue: didit.Some[any](35),\n\t}}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.TransactionRuleAction;\nimport me.didit.types.TransactionRuleActionAddScore;\nimport me.didit.types.TransactionRuleAggregation;\nimport me.didit.types.TransactionRuleCondition;\nimport me.didit.types.TransactionRuleCreateRequest;\nimport me.didit.types.TransactionRuleScope;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().rules().create(TransactionRuleCreateRequest.builder()\n .title(\"Structuring - inbound (custom)\")\n .description(\"20+ inbound EUR transfers, all under 10,000 EUR, 30 days\")\n .category(\"finance\")\n .mode(TransactionRuleCreateRequest.Mode.of(\"TEST\"))\n .evaluationMode(TransactionRuleCreateRequest.EvaluationMode.of(\"ALL\"))\n .scope(TransactionRuleScope.builder()\n .transactionTypes(List.of(\"finance\"))\n .directions(List.of(TransactionRuleScope.Directions.of(\"INBOUND\")))\n .build())\n .conditions(List.of(\n TransactionRuleCondition.builder()\n .field(\"currency\")\n .operator(TransactionRuleCondition.Operator.of(\"eq\"))\n .value(\"EUR\")\n .build(),\n TransactionRuleCondition.builder()\n .field(\"amount\")\n .operator(TransactionRuleCondition.Operator.of(\"lt\"))\n .value(10000)\n .build()))\n .aggregation(List.of(\n TransactionRuleAggregation.builder()\n .metric(TransactionRuleAggregation.Metric.of(\"count\"))\n .operator(TransactionRuleAggregation.Operator.of(\"gte\"))\n .value(20.0)\n .window(\"30d\")\n .filters(Map.of(\"direction\", \"INBOUND\", \"transaction_type\", \"finance\", \"subject_vendor_data\", \"__current__\", \"currency\", \"EUR\"))\n .build(),\n TransactionRuleAggregation.builder()\n .metric(TransactionRuleAggregation.Metric.of(\"max\"))\n .field(\"amount\")\n .operator(TransactionRuleAggregation.Operator.of(\"lt\"))\n .value(10000.0)\n .window(\"30d\")\n .filters(Map.of(\"direction\", \"INBOUND\", \"transaction_type\", \"finance\", \"subject_vendor_data\", \"__current__\", \"currency\", \"EUR\"))\n .build()))\n .actions(List.of(TransactionRuleAction.ofAddScore(TransactionRuleActionAddScore.builder()\n .type(TransactionRuleActionAddScore.Type.of(\"add_score\"))\n .value(35L)\n .build())))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->create([\n 'title' => 'Structuring - inbound (custom)',\n 'description' => '20+ inbound EUR transfers, all under 10,000 EUR, 30 days',\n 'category' => 'finance',\n 'mode' => 'TEST',\n 'evaluation_mode' => 'ALL',\n 'scope' => [\n 'transaction_types' => ['finance'],\n 'directions' => ['INBOUND'],\n ],\n 'conditions' => [[\n 'field' => 'currency',\n 'operator' => 'eq',\n 'value' => 'EUR',\n ], [\n 'field' => 'amount',\n 'operator' => 'lt',\n 'value' => 10000,\n ]],\n 'aggregation' => [[\n 'metric' => 'count',\n 'operator' => 'gte',\n 'value' => 20.0,\n 'window' => '30d',\n 'filters' => ['direction' => 'INBOUND', 'transaction_type' => 'finance', 'subject_vendor_data' => '__current__', 'currency' => 'EUR'],\n ], [\n 'metric' => 'max',\n 'field' => 'amount',\n 'operator' => 'lt',\n 'value' => 10000.0,\n 'window' => '30d',\n 'filters' => ['direction' => 'INBOUND', 'transaction_type' => 'finance', 'subject_vendor_data' => '__current__', 'currency' => 'EUR'],\n ]],\n 'actions' => [[\n 'type' => 'add_score',\n 'value' => 35,\n ]],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.rules.create(\n title: \"Structuring - inbound (custom)\",\n description: \"20+ inbound EUR transfers, all under 10,000 EUR, 30 days\",\n category: \"finance\",\n mode: \"TEST\",\n evaluation_mode: \"ALL\",\n scope: {\n transaction_types: [\"finance\"],\n directions: [\"INBOUND\"],\n },\n conditions: [{\n field: \"currency\",\n operator: \"eq\",\n value: \"EUR\",\n }, {\n field: \"amount\",\n operator: \"lt\",\n value: 10000,\n }],\n aggregation: [{\n metric: \"count\",\n operator: \"gte\",\n value: 20.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }, {\n metric: \"max\",\n field: \"amount\",\n operator: \"lt\",\n value: 10000.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }],\n actions: [{\n type: \"add_score\",\n value: 35,\n }]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Rules.CreateAsync(new TransactionRuleCreateRequest\n{\n Title = \"Structuring - inbound (custom)\",\n Description = \"20+ inbound EUR transfers, all under 10,000 EUR, 30 days\",\n Category = \"finance\",\n Mode = \"TEST\",\n EvaluationMode = new TransactionRuleCreateRequestEvaluationMode(\"ALL\"),\n Scope = new TransactionRuleScope\n {\n TransactionTypes = new string[] { \"finance\" },\n Directions = new TransactionRuleScopeDirections[] { \"INBOUND\" },\n },\n Conditions = new TransactionRuleCondition[]\n {\n new()\n {\n Field = \"currency\",\n Operator = \"eq\",\n Value = \"EUR\",\n },\n new()\n {\n Field = \"amount\",\n Operator = \"lt\",\n Value = 10000,\n },\n },\n Aggregation = new TransactionRuleAggregation[]\n {\n new()\n {\n Metric = new TransactionRuleAggregationMetric(\"count\"),\n Operator = new TransactionRuleAggregationOperator(\"gte\"),\n Value = 20.0,\n Window = \"30d\",\n Filters = new Dictionary { [\"direction\"] = \"INBOUND\", [\"transaction_type\"] = \"finance\", [\"subject_vendor_data\"] = \"__current__\", [\"currency\"] = \"EUR\" },\n },\n new()\n {\n Metric = new TransactionRuleAggregationMetric(\"max\"),\n Field = \"amount\",\n Operator = new TransactionRuleAggregationOperator(\"lt\"),\n Value = 10000.0,\n Window = \"30d\",\n Filters = new Dictionary { [\"direction\"] = \"INBOUND\", [\"transaction_type\"] = \"finance\", [\"subject_vendor_data\"] = \"__current__\", [\"currency\"] = \"EUR\" },\n },\n },\n Actions = new TransactionRuleAction[]\n {\n new()\n {\n Type = new TransactionRuleActionType(\"add_score\"),\n Value = 35,\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/transactions/rules/{rule_uuid}/": { "parameters": [ { "name": "rule_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "El uuid de la regla, obtenido al listarla o crearla." } ], "get": { "summary": "Obtener regla", "description": "Obtén una regla con su configuración completa y sus contadores de ejecución.", "operationId": "getTransactionRule", "x-didit-sdk": { "resource": "transactions.rules", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "La regla.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleDetail" } } } }, "404": { "description": "No existe esa regla en esta aplicación.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/rules/RULE_UUID/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.rules.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.rules.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().rules().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.rules.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Rules.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "patch": { "summary": "Actualizar regla", "description": "Actualiza parcialmente una regla. Las reglas personalizadas aceptan todos los campos de configuración. Las reglas de la biblioteca (PRESET) solo aceptan `mode`: úsalo para activar o desactivar un preset, o para pasarlo a TEST; cualquier otro campo devuelve 400. Una copia instalada de una regla de la biblioteca retenida está desactivada: establecer su `mode` en cualquier valor distinto de `DISABLED` responde 400 (\"This library rule cannot run yet: its conditions read data the rules engine cannot evaluate.\").", "operationId": "updateTransactionRule", "x-didit-sdk": { "resource": "transactions.rules", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleUpdateRequest" }, "example": { "mode": "ACTIVE" } } } }, "responses": { "200": { "description": "La regla actualizada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleDetail" } } } }, "400": { "description": "Error de validación: un campo que no es de modo en una regla de la biblioteca, o un modo distinto de DISABLED en una regla de la biblioteca retenida.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/transactions/rules/RULE_UUID/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"mode\": \"ACTIVE\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.rules.update(\n \"11111111-2222-3333-4444-555555555555\",\n mode=\"ACTIVE\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.rules.update(\"11111111-2222-3333-4444-555555555555\", {\n mode: \"ACTIVE\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TransactionRuleUpdateRequest{\n\tMode: didit.Some(didit.TransactionRuleUpdateRequestMode(\"ACTIVE\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TransactionRuleUpdateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().rules().update(\"11111111-2222-3333-4444-555555555555\", TransactionRuleUpdateRequest.builder()\n .mode(TransactionRuleUpdateRequest.Mode.of(\"ACTIVE\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->update('11111111-2222-3333-4444-555555555555', [\n 'mode' => 'ACTIVE',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.rules.update(\n \"11111111-2222-3333-4444-555555555555\",\n mode: \"ACTIVE\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Rules.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new TransactionRuleUpdateRequest\n{\n Mode = new TransactionRuleUpdateRequestMode(\"ACTIVE\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "summary": "Eliminar regla", "description": "Elimina una regla CUSTOM. La eliminación es inmediata y permanente: la regla deja de evaluarse para las nuevas transacciones y desaparece de los listados, mientras que las ejecuciones anteriores de la regla sobre transacciones ya evaluadas conservan sus resultados registrados. Las reglas de la biblioteca no se pueden eliminar: desinstálalas mediante el endpoint de instalación (siempre se pueden volver a instalar desde la biblioteca).", "operationId": "deleteTransactionRule", "x-didit-sdk": { "resource": "transactions.rules", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "204": { "description": "Eliminado." }, "400": { "description": "La regla es un preset de la biblioteca: desinstálala en su lugar.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "detail": "Library rules cannot be deleted. Uninstall them via the rules install endpoint instead." } } } }, "404": { "description": "No existe esa regla en esta aplicación.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/transactions/rules/RULE_UUID/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.transactions.rules.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.transactions.rules.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Transactions.Rules.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.transactions().rules().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.rules.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Transactions.Rules.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ] } }, "/v3/transactions/rules/backtest/": { "post": { "summary": "Configuración de la regla para el backtest", "description": "Evalúa una configuración de regla hipotética con tus transacciones recientes (de la más reciente a la más antigua, hasta el límite del backtest) sin crear ninguna regla ni modificar ninguna transacción. Úsalo antes de activar una regla para ver con qué frecuencia habría coincidido y a cuántos sujetos habría afectado.", "operationId": "backtestTransactionRules", "x-didit-sdk": { "resource": "transactions.rules", "method": "backtest", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleBacktestRequest" }, "example": { "conditions": [ { "field": "currency", "operator": "eq", "value": "EUR" }, { "field": "amount", "operator": "lt", "value": 10000 } ], "aggregation": [ { "metric": "count", "operator": "gte", "value": 20, "window": "30d", "filters": { "direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR" } }, { "metric": "max", "field": "amount", "operator": "lt", "value": 10000, "window": "30d", "filters": { "direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR" } } ], "evaluation_mode": "ALL", "scope": { "transaction_types": [ "finance" ], "directions": [ "INBOUND" ] }, "period_days": 90 } } } }, "responses": { "200": { "description": "Estadísticas del backtest.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleBacktestResult" }, "example": { "evaluated": 4820, "matched": 12, "affected_entities": 4, "period_days": 90 } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/transactions/rules/backtest/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"conditions\": [{\"field\": \"currency\", \"operator\": \"eq\", \"value\": \"EUR\"}, {\"field\": \"amount\", \"operator\": \"lt\", \"value\": 10000}], \"aggregation\": [{\"metric\": \"count\", \"operator\": \"gte\", \"value\": 20, \"window\": \"30d\", \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}}, {\"metric\": \"max\", \"field\": \"amount\", \"operator\": \"lt\", \"value\": 10000, \"window\": \"30d\", \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}}], \"evaluation_mode\": \"ALL\", \"scope\": {\"transaction_types\": [\"finance\"], \"directions\": [\"INBOUND\"]}, \"period_days\": 90}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.rules.backtest(\n conditions=[{\n \"field\": \"currency\",\n \"operator\": \"eq\",\n \"value\": \"EUR\",\n }, {\n \"field\": \"amount\",\n \"operator\": \"lt\",\n \"value\": 10000,\n }],\n aggregation=[{\n \"metric\": \"count\",\n \"operator\": \"gte\",\n \"value\": 20.0,\n \"window\": \"30d\",\n \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"},\n }, {\n \"metric\": \"max\",\n \"field\": \"amount\",\n \"operator\": \"lt\",\n \"value\": 10000.0,\n \"window\": \"30d\",\n \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"},\n }],\n evaluation_mode=\"ALL\",\n scope={\n \"transaction_types\": [\"finance\"],\n \"directions\": [\"INBOUND\"],\n },\n period_days=90,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.rules.backtest({\n conditions: [{\n field: \"currency\",\n operator: \"eq\",\n value: \"EUR\",\n }, {\n field: \"amount\",\n operator: \"lt\",\n value: 10000,\n }],\n aggregation: [{\n metric: \"count\",\n operator: \"gte\",\n value: 20.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }, {\n metric: \"max\",\n field: \"amount\",\n operator: \"lt\",\n value: 10000.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }],\n evaluation_mode: \"ALL\",\n scope: {\n transaction_types: [\"finance\"],\n directions: [\"INBOUND\"],\n },\n period_days: 90,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.Backtest(ctx, didit.TransactionRuleBacktestRequest{\n\tConditions: didit.Some([]didit.TransactionRuleConditionParam{{\n\t\tField: \"currency\",\n\t\tOperator: \"eq\",\n\t\tValue: didit.Some[any](\"EUR\"),\n\t}, {\n\t\tField: \"amount\",\n\t\tOperator: \"lt\",\n\t\tValue: didit.Some[any](10000),\n\t}}),\n\tAggregation: didit.Some([]didit.TransactionRuleAggregationParam{{\n\t\tMetric: didit.Some(didit.TransactionRuleAggregationMetric(\"count\")),\n\t\tOperator: didit.Some(didit.TransactionRuleAggregationOperator(\"gte\")),\n\t\tValue: 20.0,\n\t\tWindow: didit.String(\"30d\"),\n\t\tFilters: didit.Some(map[string]any{\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}),\n\t}, {\n\t\tMetric: didit.Some(didit.TransactionRuleAggregationMetric(\"max\")),\n\t\tField: didit.String(\"amount\"),\n\t\tOperator: didit.Some(didit.TransactionRuleAggregationOperator(\"lt\")),\n\t\tValue: 10000.0,\n\t\tWindow: didit.String(\"30d\"),\n\t\tFilters: didit.Some(map[string]any{\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}),\n\t}}),\n\tEvaluationMode: didit.Some(didit.TransactionRuleBacktestRequestEvaluationMode(\"ALL\")),\n\tScope: didit.Some(didit.TransactionRuleScopeParam{\n\t\tTransactionTypes: didit.Some([]string{\"finance\"}),\n\t\tDirections: didit.Some([]didit.TransactionRuleScopeDirections{\"INBOUND\"}),\n\t}),\n\tPeriodDays: didit.Int(90),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.TransactionRuleAggregation;\nimport me.didit.types.TransactionRuleBacktestRequest;\nimport me.didit.types.TransactionRuleCondition;\nimport me.didit.types.TransactionRuleScope;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().rules().backtest(TransactionRuleBacktestRequest.builder()\n .conditions(List.of(\n TransactionRuleCondition.builder()\n .field(\"currency\")\n .operator(TransactionRuleCondition.Operator.of(\"eq\"))\n .value(\"EUR\")\n .build(),\n TransactionRuleCondition.builder()\n .field(\"amount\")\n .operator(TransactionRuleCondition.Operator.of(\"lt\"))\n .value(10000)\n .build()))\n .aggregation(List.of(\n TransactionRuleAggregation.builder()\n .metric(TransactionRuleAggregation.Metric.of(\"count\"))\n .operator(TransactionRuleAggregation.Operator.of(\"gte\"))\n .value(20.0)\n .window(\"30d\")\n .filters(Map.of(\"direction\", \"INBOUND\", \"transaction_type\", \"finance\", \"subject_vendor_data\", \"__current__\", \"currency\", \"EUR\"))\n .build(),\n TransactionRuleAggregation.builder()\n .metric(TransactionRuleAggregation.Metric.of(\"max\"))\n .field(\"amount\")\n .operator(TransactionRuleAggregation.Operator.of(\"lt\"))\n .value(10000.0)\n .window(\"30d\")\n .filters(Map.of(\"direction\", \"INBOUND\", \"transaction_type\", \"finance\", \"subject_vendor_data\", \"__current__\", \"currency\", \"EUR\"))\n .build()))\n .evaluationMode(TransactionRuleBacktestRequest.EvaluationMode.of(\"ALL\"))\n .scope(TransactionRuleScope.builder()\n .transactionTypes(List.of(\"finance\"))\n .directions(List.of(TransactionRuleScope.Directions.of(\"INBOUND\")))\n .build())\n .periodDays(90L)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->backtest([\n 'conditions' => [[\n 'field' => 'currency',\n 'operator' => 'eq',\n 'value' => 'EUR',\n ], [\n 'field' => 'amount',\n 'operator' => 'lt',\n 'value' => 10000,\n ]],\n 'aggregation' => [[\n 'metric' => 'count',\n 'operator' => 'gte',\n 'value' => 20.0,\n 'window' => '30d',\n 'filters' => ['direction' => 'INBOUND', 'transaction_type' => 'finance', 'subject_vendor_data' => '__current__', 'currency' => 'EUR'],\n ], [\n 'metric' => 'max',\n 'field' => 'amount',\n 'operator' => 'lt',\n 'value' => 10000.0,\n 'window' => '30d',\n 'filters' => ['direction' => 'INBOUND', 'transaction_type' => 'finance', 'subject_vendor_data' => '__current__', 'currency' => 'EUR'],\n ]],\n 'evaluation_mode' => 'ALL',\n 'scope' => [\n 'transaction_types' => ['finance'],\n 'directions' => ['INBOUND'],\n ],\n 'period_days' => 90,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.rules.backtest(\n conditions: [{\n field: \"currency\",\n operator: \"eq\",\n value: \"EUR\",\n }, {\n field: \"amount\",\n operator: \"lt\",\n value: 10000,\n }],\n aggregation: [{\n metric: \"count\",\n operator: \"gte\",\n value: 20.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }, {\n metric: \"max\",\n field: \"amount\",\n operator: \"lt\",\n value: 10000.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }],\n evaluation_mode: \"ALL\",\n scope: {\n transaction_types: [\"finance\"],\n directions: [\"INBOUND\"],\n },\n period_days: 90\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Rules.BacktestAsync(new TransactionRuleBacktestRequest\n{\n Conditions = new TransactionRuleCondition[]\n {\n new()\n {\n Field = \"currency\",\n Operator = \"eq\",\n Value = \"EUR\",\n },\n new()\n {\n Field = \"amount\",\n Operator = \"lt\",\n Value = 10000,\n },\n },\n Aggregation = new TransactionRuleAggregation[]\n {\n new()\n {\n Metric = new TransactionRuleAggregationMetric(\"count\"),\n Operator = new TransactionRuleAggregationOperator(\"gte\"),\n Value = 20.0,\n Window = \"30d\",\n Filters = new Dictionary { [\"direction\"] = \"INBOUND\", [\"transaction_type\"] = \"finance\", [\"subject_vendor_data\"] = \"__current__\", [\"currency\"] = \"EUR\" },\n },\n new()\n {\n Metric = new TransactionRuleAggregationMetric(\"max\"),\n Field = \"amount\",\n Operator = new TransactionRuleAggregationOperator(\"lt\"),\n Value = 10000.0,\n Window = \"30d\",\n Filters = new Dictionary { [\"direction\"] = \"INBOUND\", [\"transaction_type\"] = \"finance\", [\"subject_vendor_data\"] = \"__current__\", [\"currency\"] = \"EUR\" },\n },\n },\n EvaluationMode = new TransactionRuleBacktestRequestEvaluationMode(\"ALL\"),\n Scope = new TransactionRuleScope\n {\n TransactionTypes = new string[] { \"finance\" },\n Directions = new TransactionRuleScopeDirections[] { \"INBOUND\" },\n },\n PeriodDays = 90,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/transactions/rules/library/": { "get": { "summary": "Listar la biblioteca de reglas", "description": "Explora la biblioteca completa de reglas predefinidas (150+ reglas), con la configuración completa de cada entrada y un indicador `is_installed` para esta aplicación. Filtra por paquete, por categoría o con una búsqueda de texto libre. Una regla de la biblioteca cuyas condiciones leen datos que el motor de reglas aún no puede evaluar queda retenida hasta que pueda ejecutarse. Las reglas retenidas no aparecen en la lista.", "operationId": "listTransactionRuleLibrary", "x-didit-sdk": { "resource": "transactions.rules", "method": "list_library", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "bundle", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filtra por paquete, p. ej., finance, aml_ctf, crypto_monitoring, travel_rule" }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filtra por categoría" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Coincidencia sin distinguir mayúsculas y minúsculas con el título y la descripción" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tamaño de página" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Desplazamiento de página" } ], "responses": { "200": { "description": "Entradas de la biblioteca paginadas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleLibraryEntry" } } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/rules/library/?bundle=finance' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.transactions.rules.list_library():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.transactions.rules.listLibrary()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Transactions.Rules.ListLibraryAutoPaging(ctx, didit.TransactionsRulesListLibraryParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.transactions().rules().listLibrary()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->listLibrary() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.rules.list_library.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Transactions.Rules.ListLibraryAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/transactions/rules/install/": { "post": { "summary": "Instalar reglas de la biblioteca", "description": "Instala uno o más presets en la aplicación, mediante `library_keys` o un `bundle` completo. Un preset instalado se activa de inmediato mientras la monitorización de transacciones está activada y, en caso contrario, queda deshabilitado; las claves ya instaladas se omiten. Una regla de la biblioteca cuyas condiciones leen datos que el motor de reglas todavía no puede evaluar se retiene hasta que pueda ejecutarse. Una solicitud que incluya una de ellas en `library_keys` responde con 400 y no instala nada (\"These library rules cannot run yet: their conditions read data the rules engine cannot evaluate.\" seguido de las claves), y una instalación mediante `bundle` la omite. Una regla retenida vuelve por sí sola en cuanto sus condiciones pueden evaluarse. Una entrada de `library_keys` que no está en la biblioteca se omite, no se rechaza.", "operationId": "installTransactionRuleLibrary", "x-didit-sdk": { "resource": "transactions.rules", "method": "install_library", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleInstallRequest" }, "example": { "library_keys": [ "structuring-inbound", "structuring-outbound" ] } } } }, "responses": { "200": { "description": "Qué se instaló.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleInstallResult" }, "example": { "installed_library_keys": [ "structuring-inbound", "structuring-outbound" ], "installed_count": 2 } } } }, "400": { "description": "No se proporcionó ni library_keys ni bundle, `library_keys` no es una lista o una entrada de `library_keys` está retenida. Una entrada desconocida se omite y la respuesta es 200 sin ella.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/transactions/rules/install/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"library_keys\": [\"structuring-inbound\", \"structuring-outbound\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.rules.install_library(\n library_keys=[\"structuring-inbound\", \"structuring-outbound\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.rules.installLibrary({\n library_keys: [\"structuring-inbound\", \"structuring-outbound\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.InstallLibrary(ctx, didit.TransactionRuleInstallRequest{\n\tLibraryKeys: didit.Some([]string{\"structuring-inbound\", \"structuring-outbound\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.TransactionRuleInstallRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().rules().installLibrary(TransactionRuleInstallRequest.builder()\n .libraryKeys(List.of(\"structuring-inbound\", \"structuring-outbound\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->installLibrary([\n 'library_keys' => ['structuring-inbound', 'structuring-outbound'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.rules.install_library(library_keys: [\"structuring-inbound\", \"structuring-outbound\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Rules.InstallLibraryAsync(new TransactionRuleInstallRequest\n{\n LibraryKeys = new string[] { \"structuring-inbound\", \"structuring-outbound\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "summary": "Desinstalar reglas de la biblioteca", "description": "Elimina de la aplicación los presets instalados, por `library_keys` o por un `bundle` completo. Los presets desinstalados dejan de evaluarse de inmediato y se pueden volver a instalar desde la biblioteca en cualquier momento.", "operationId": "uninstallTransactionRuleLibrary", "x-didit-sdk": { "resource": "transactions.rules", "method": "uninstall_library", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleInstallRequest" }, "example": { "bundle": "responsible_gaming" } } } }, "responses": { "200": { "description": "Cuántas configuraciones predefinidas se eliminaron.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleInstallResult" }, "example": { "uninstalled_count": 5 } } } }, "400": { "description": "No se proporcionó ni library_keys ni bundle.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/transactions/rules/install/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"bundle\": \"responsible_gaming\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.rules.uninstall_library(\n bundle=\"responsible_gaming\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.rules.uninstallLibrary({\n bundle: \"responsible_gaming\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.UninstallLibrary(ctx, didit.TransactionRuleInstallRequest{\n\tBundle: didit.String(\"responsible_gaming\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TransactionRuleInstallRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().rules().uninstallLibrary(TransactionRuleInstallRequest.builder()\n .bundle(\"responsible_gaming\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->uninstallLibrary([\n 'bundle' => 'responsible_gaming',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.rules.uninstall_library(bundle: \"responsible_gaming\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Rules.UninstallLibraryAsync(new TransactionRuleInstallRequest\n{\n Bundle = \"responsible_gaming\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/": { "get": { "summary": "Listar redes", "description": "Lista las redes de fraude detectadas en la organización de esta aplicación, ordenadas por defecto de mayor a menor riesgo. Por defecto se excluyen las redes descartadas; pasa status para incluirlas. Las aplicaciones de sandbox nunca tienen redes: la agrupación excluye por completo los datos de sandbox. Cada respuesta incluye el `sharing_mode` de la organización e indica si se le aplican señales entre organizaciones (`cross_org_available`, `cross_org_unavailable_reason`). `kpis` agrega las redes que coinciden con tus filtros y `counts` agrega todas las redes que la aplicación puede ver; pasa `summary=false` para omitir ambos cuando solo necesites la página. Requiere una clave de API con acceso completo, o `list:networks` para un miembro de la consola.", "operationId": "list_networks", "x-didit-sdk": { "resource": "networks", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "status", "in": "query", "schema": { "type": "string" }, "description": "Estados que se incluirán, separados por comas: active,in_review,resolved,dismissed. Si se omite, se excluyen los descartados." }, { "name": "scope", "in": "query", "schema": { "type": "string", "enum": [ "identity", "transactions" ] }, "description": "`transactions` conserva las redes cuyos miembros son todos partes de transacciones; `identity` conserva todas las demás redes. Omítelo para obtener ambas. También acota `counts.views` y `counts.facets`. Cualquier otro valor devuelve 400." }, { "name": "signal_type", "in": "query", "schema": { "type": "string" }, "description": "Tipos de señal separados por comas: ip_address,device,face,document_number,phone,email,address." }, { "name": "pattern_type", "in": "query", "schema": { "type": "string" }, "description": "Tipos de patrón separados por comas, por ejemplo, exact_same_device,same_email." }, { "name": "risk_band", "in": "query", "schema": { "type": "string" }, "description": "Bandas separadas por comas: low,medium,high." }, { "name": "min_size", "in": "query", "schema": { "type": "integer" }, "description": "Número mínimo de miembros." }, { "name": "max_size", "in": "query", "schema": { "type": "integer" }, "description": "Número máximo de miembros." }, { "name": "assignee", "in": "query", "schema": { "type": "string" }, "description": "Asignados separados por comas: `unassigned`, correos electrónicos de miembros (se comparan sin distinguir mayúsculas de minúsculas) o `me` para el miembro de la consola que hace la llamada. Una red coincide con cualquier valor. `me` requiere un token de miembro de la consola: con una clave de API se obtiene un 400 `{\"assignee\": [\"\\\"me\\\" needs a user token; an API key has no assignee identity.\"]}`." }, { "name": "priority", "in": "query", "schema": { "type": "string" }, "description": "Prioridades separadas por comas: `low`, `medium`, `high` o `none` para redes sin prioridad. Cualquier otro valor devuelve 400 `{\"priority\": \"Unknown priority: .\"}`." }, { "name": "risk_min", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 100 }, "description": "Puntuación de riesgo mínima, un número entero de 0 a 100. Un valor que no sea un número entero devuelve 400 `{\"risk_min\": \"Use a whole number from 0 to 100.\"}`." }, { "name": "has_case", "in": "query", "schema": { "type": "boolean" }, "description": "`true` conserva las redes para las que tu aplicación abrió un caso; `false`, las demás. Cualquier otro valor se ignora." }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Límite inferior de last_activity_at (fecha o fecha y hora ISO 8601)." }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Límite superior de first_activity_at (fecha o fecha y hora ISO 8601)." }, { "name": "q", "in": "query", "schema": { "type": "string" }, "description": "Búsqueda en texto libre por nombre de la red, nombres de los miembros, el network_id (N-0001) y tokens exactos de pattern_type." }, { "name": "ordering", "in": "query", "schema": { "type": "string" }, "description": "Uno de risk_score, -risk_score, last_activity_at, -last_activity_at, first_activity_at, -first_activity_at, network_number, -network_number. Valor predeterminado: -risk_score,-last_activity_at." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 100, "minimum": 1, "maximum": 500 }, "description": "Tamaño de página, de 1 a 500. El valor predeterminado es 100." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Desplazamiento, empezando en cero, del primer registro." }, { "name": "summary", "in": "query", "schema": { "type": "boolean", "default": true }, "description": "`false` devuelve solo la página y su `count`, sin `kpis` ni `counts`. El valor predeterminado es `true`. Cualquier valor distinto de `true` o `false` devuelve 400." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/?status=active,in_review&ordering=-risk_score' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.networks.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.networks.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Networks.ListAutoPaging(ctx, didit.NetworksListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.networks().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "networks->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.networks.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Networks.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Lista paginada de redes, con el modo de compartición de la organización y la disponibilidad entre organizaciones, además de `kpis` y `counts` salvo que `summary=false`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "integer", "nullable": true, "description": "Desplazamiento (offset) de la página siguiente, o null en la última página." }, "previous": { "type": "integer", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkListItem" } }, "kpis": { "type": "object", "description": "Cada clave es {value, delta} sobre los resultados que coinciden con los filtros actuales. Se omite cuando `summary=false`.", "properties": { "active": { "type": "object" }, "in_review": { "type": "object" }, "applicants_involved": { "type": "object" }, "detected_this_period": { "type": "object" }, "false_positive_rate": { "type": "object" } } }, "counts": { "$ref": "#/components/schemas/NetworkListCounts" }, "sharing_mode": { "type": "string", "enum": [ "off", "private", "global" ], "description": "El modo de uso compartido entre organizaciones de la organización. Solo `global` compara redes entre organizaciones; `private` y `off` las limitan al historial propio de la organización.", "example": "global" }, "cross_org_available": { "type": "boolean", "description": "Indica si las señales entre organizaciones se aplican a esta organización. Requieren tanto el plan Enterprise como el modo de compartición `global`.", "example": true }, "cross_org_unavailable_reason": { "type": "string", "enum": [ "plan", "sharing_mode" ], "nullable": true, "description": "Por qué no se aplican las señales entre organizaciones, comprobado en este orden. `plan`: el plan de la organización no incluye la red de fraude entre organizaciones (requiere el plan Enterprise), sea cual sea el modo de compartición. `sharing_mode`: el plan la incluye, pero el modo de compartición es `private` u `off`. Null cuando `cross_org_available` es `true`.", "example": null } }, "required": [ "count", "next", "previous", "results", "sharing_mode", "cross_org_available", "cross_org_unavailable_reason" ] } } } }, "400": { "description": "Valor de filtro, ordenación, paginación o `summary` no válido.", "content": { "application/json": { "examples": { "Invalid summary": { "summary": "Resumen no válido", "value": { "summary": [ "Must be \"true\" or \"false\"." ] } }, "Invalid scope": { "summary": "Alcance no válido", "value": { "scope": [ "Use identity or transactions." ] } }, "Unsupported ordering": { "summary": "Ordenación no admitida", "value": [ "Unsupported ordering." ] } } } } }, "401": { "description": "Credenciales ausentes o no válidas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente en errores con código, por ejemplo `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Credenciales ausentes o no válidas", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "La clave de API pertenece a otra aplicación o es una clave con acceso restringido: los endpoints de Networks necesitan una clave de acceso completo. Un token de miembro de la consola necesita `list:networks`. También se devuelve con `code: networks_not_entitled` cuando Networks no está habilitado para la organización.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente en errores con código, por ejemplo `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Redes no habilitadas", "value": { "detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled" } }, "Restricted API key": { "summary": "Clave de API restringida", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Sin permiso", "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/": { "get": { "summary": "Obtener una red", "description": "Obtén el detalle completo de una red: estadísticas, etiquetas de fraude y señales de riesgo, además del `sharing_mode` de la organización y la disponibilidad entre organizaciones, las `tags` de tu aplicación en la red, los `outcomes` de los miembros y las puntuaciones de patrones (`patterns`). Requiere una clave de API con acceso completo, o `read:networks` para un miembro de la consola.", "operationId": "get_network", "x-didit-sdk": { "resource": "networks", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID de la red." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/n3a5e000-0000-4000-8000-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.retrieve(\n \"n3a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.retrieve(\"n3a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.Retrieve(ctx, \"n3a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().retrieve(\"n3a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->retrieve('n3a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.retrieve(\"n3a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.RetrieveAsync(\"n3a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Detalle de la red.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkDetailResponse" }, "example": { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "network_id": "N-0042", "name": null, "status": "in_review", "risk": { "score": 82, "band": "high", "bar": 0.82 }, "pattern_types": [ "exact_same_device", "same_email" ], "signal_types": [ "device", "email" ], "member_counts": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signal_coverage": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } }, "first_activity_at": "2026-10-01T09:12:44Z", "last_activity_at": "2026-10-12T16:03:10Z", "stats": { "members": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signals": { "total": 2, "by_type": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } } } }, "fraud_tags": [], "risk_signals": { "residential_proxy_reuse": { "detected": false, "signal_count": 0, "max_subject_count": 0 }, "email_intelligence": { "enriched_signal_count": 1, "high_risk_count": 0, "social_profile_count": 0 }, "phone_intelligence": { "enriched_signal_count": 0, "high_risk_count": 0 } }, "reviewed_at": "2026-10-12T16:30:00Z", "reviewed_by": "reviewer@example.com", "review_reason": "Shared device across three new accounts.", "notes_count": 0, "sharing_mode": "global", "cross_org_available": true, "cross_org_unavailable_reason": null, "tags": [ { "uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "name": "SUSPICIOUS", "color": "#6366F1", "source": "custom", "added_by": null, "added_at": "2026-10-13T08:15:00Z" } ], "outcomes": { "approved": 1, "declined": 1, "in_review": 0, "total": 3 }, "patterns": [ { "type": "background", "score": 0.8125, "members": 3, "reason": null, "computed_at": "2026-10-13T08:00:00Z" } ] } } } }, "404": { "description": "Red no encontrada (o no visible para esta aplicación).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "401": { "description": "Credenciales ausentes o no válidas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente en errores con código, por ejemplo `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Credenciales ausentes o no válidas", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "La clave de API pertenece a otra aplicación o es una clave con acceso restringido: los endpoints de Networks necesitan una clave de acceso completo. Un token de miembro de la consola necesita `read:networks`. También se devuelve con `code: networks_not_entitled` cuando Networks no está habilitado para la organización.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente en errores con código, por ejemplo `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Redes no habilitadas", "value": { "detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled" } }, "Restricted API key": { "summary": "Clave de API restringida", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Sin permiso", "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/graph/": { "get": { "summary": "Obtener el grafo de la red", "description": "Obtén la red como un grafo formado por nodos de sujeto (usuarios del proveedor, empresas del proveedor, partes de transacciones) y nodos de señal (los valores compartidos de dispositivo/IP/rostro/documento/teléfono/correo electrónico/dirección que los vinculan), con aristas que representan pertenencias.", "operationId": "get_network_graph", "x-didit-sdk": { "resource": "networks", "method": "retrieve_graph", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID de la red." }, { "name": "depth", "in": "query", "schema": { "type": "string", "enum": [ "1", "2", "3", "all" ] }, "description": "Saltos desde el sujeto principal que se incluyen. De forma predeterminada, todos (sin límite)." }, { "name": "focus_kind", "in": "query", "schema": { "type": "string", "enum": [ "vendor_user", "vendor_business", "transaction_party" ] }, "description": "Tipo de sujeto en el que se centra el grafo. Debe indicarse junto con focus_id; si la profundidad está acotada y no se indica ninguno de los dos, se usa por defecto un miembro arbitrario." }, { "name": "focus_id", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "UUID del sujeto en el que se centra el grafo." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/n3a5e000-0000-4000-8000-000000000001/graph/?depth=2' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.retrieve_graph(\n \"n3a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.retrieveGraph(\"n3a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.RetrieveGraph(ctx, \"n3a5e000-0000-4000-8000-000000000001\", didit.NetworksRetrieveGraphParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().retrieveGraph(\"n3a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->retrieveGraph('n3a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.retrieve_graph(\"n3a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.RetrieveGraphAsync(\"n3a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Grafo de la red.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkGraph" } } } }, "404": { "description": "Red no encontrada (o no visible para esta aplicación).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/members/": { "get": { "summary": "Listar miembros de una red", "description": "Lista los sujetos (usuarios del cliente, empresas del cliente o partes de transacciones) que pertenecen a esta red.", "operationId": "list_network_members", "x-didit-sdk": { "resource": "networks", "method": "list_members", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID de la red." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/n3a5e000-0000-4000-8000-000000000001/members/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.list_members(\n \"n3a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.listMembers(\"n3a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.ListMembers(ctx, \"n3a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().listMembers(\"n3a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->listMembers('n3a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.list_members(\"n3a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.ListMembersAsync(\"n3a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Miembros de la red. Sin paginación.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkMember" } } } } } } }, "404": { "description": "Red no encontrada (o no visible para esta aplicación).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/signals/": { "get": { "summary": "Listar señales de una red", "description": "Lista las señales (valores compartidos de dispositivo, IP, rostro, número de documento, teléfono, correo electrónico o dirección) que vinculan a los miembros de esta red.", "operationId": "list_network_signals", "x-didit-sdk": { "resource": "networks", "method": "list_signals", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID de la red." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/n3a5e000-0000-4000-8000-000000000001/signals/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.list_signals(\n \"n3a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.listSignals(\"n3a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.ListSignals(ctx, \"n3a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().listSignals(\"n3a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->listSignals('n3a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.list_signals(\"n3a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.ListSignalsAsync(\"n3a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Señales de la red. Sin paginación.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkSignal" } } } } } } }, "404": { "description": "Red no encontrada (o no visible para esta aplicación).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/timeline/": { "get": { "summary": "Obtener la cronología de la red", "description": "Sin `contract`: los eventos propios de la red (detección, la última observación de cada señal y su revisión), del más antiguo al más reciente y sin paginar. Se ignoran `limit`, `cursor` y `event_type`. Con `contract=2`: la cronología tipada, del más reciente al más antiguo y paginada por cursor. Añade lo que hicieron las cuentas miembro (intentos de verificación, transacciones, inicios de sesión que publicas a través de la API de eventos y las reglas activas que hayan saltado) y los casos abiertos para la red. Los eventos `note_added` solo se devuelven a los miembros de la consola, nunca a una clave de API. Requiere una clave de API con acceso completo, o `read:networks` para un miembro de la consola.", "operationId": "get_network_timeline", "x-didit-sdk": { "resource": "networks", "method": "retrieve_timeline", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID de la red." }, { "name": "contract", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2" ] }, "description": "`2` devuelve la línea de tiempo tipada. Omítelo para obtener la línea de tiempo predeterminada. Cualquier otro valor devuelve 400." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 }, "description": "Solo para la cronología tipada. Eventos por página, de 1 a 500. El valor predeterminado es 100." }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Solo para la cronología tipada. El `next_cursor` de la página anterior. Un cursor no válido o vacío devuelve 400." }, { "name": "event_type", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "maxItems": 20, "items": { "type": "string", "enum": [ "network_detected", "signal_observed", "network_active", "network_in_review", "network_resolved", "network_dismissed", "verification_attempt", "transaction", "login", "rule_hit", "case_linked", "note_added" ] } }, "description": "Solo para la cronología tipada. Tipos de eventos que se conservan, repetidos o separados por comas, con un máximo de 20 valores. De forma predeterminada, todos los tipos." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/n3a5e000-0000-4000-8000-000000000001/timeline/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "curl", "label": "curl (typed timeline)", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/3fa85f64-5717-4562-b3fc-2c963f66afa6/timeline/?contract=2&limit=50&event_type=verification_attempt,login' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.retrieve_timeline(\n \"n3a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.retrieveTimeline(\"n3a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.RetrieveTimeline(ctx, \"n3a5e000-0000-4000-8000-000000000001\", didit.NetworksRetrieveTimelineParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().retrieveTimeline(\"n3a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->retrieveTimeline('n3a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.retrieve_timeline(\"n3a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.RetrieveTimelineAsync(\"n3a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Sin `contract`: `{results}`, del más antiguo al más reciente, sin paginar. Con `contract=2`: `{results, next_cursor}`, del más reciente al más antiguo.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/NetworkTimeline" }, { "$ref": "#/components/schemas/NetworkTimelinePage" } ] }, "examples": { "Default timeline": { "summary": "Sin contract", "value": { "results": [ { "event_type": "network_detected", "occurred_at": "2026-10-01T09:12:44Z", "label": "Network detected", "metadata": { "network_id": "N-0042" } }, { "event_type": "signal_observed", "occurred_at": "2026-10-12T16:03:10Z", "label": "device observed", "metadata": { "signal_type": "device", "subject_count": 3, "is_hub": false } }, { "event_type": "network_in_review", "occurred_at": "2026-10-12T16:30:00Z", "label": "Network in_review", "metadata": { "reason": "Shared device across three new accounts." } } ] } }, "Typed timeline": { "summary": "Con contract=2", "value": { "results": [ { "id": "monitoring_event:9b2f1c3e-4d5a-4b6c-8d7e-0f1a2b3c4d5e", "event_type": "login", "occurred_at": "2026-10-12T18:41:02Z", "ingested_at": "2026-10-12T18:41:03Z", "label": "Login", "metadata": {}, "account": { "node_id": "vendor_user:5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f", "node_type": "account", "uuid": "5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f", "vendor_data": "user-1042", "display_name": "Alex Example", "ownership": "owned", "route": { "kind": "user", "id": "5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f", "application_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } }, "source_ref": { "kind": "monitoring_event", "id": "9b2f1c3e-4d5a-4b6c-8d7e-0f1a2b3c4d5e", "ownership": "owned" }, "verification_attempt": null, "transaction": null, "login": { "action": "auth.login", "succeeded": true, "status": "APPROVED", "ip": { "address": "203.0.113.24", "country_code": "ES", "city": "Madrid", "connection_type": null, "is_vpn_or_tor": false, "is_data_center": false }, "device": { "fingerprint": "fp_0a1b2c3d", "label": "Chrome · Android" }, "is_first_login": false, "is_new_device": true }, "rule_hit": null, "case_linked": null, "note_added": null }, { "id": "session:1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "event_type": "verification_attempt", "occurred_at": "2026-10-12T16:03:10Z", "ingested_at": "2026-10-12T16:03:10Z", "label": "Verification attempt 2 of 2", "metadata": {}, "account": { "node_id": "vendor_user:5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f", "node_type": "account", "uuid": "5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f", "vendor_data": "user-1042", "display_name": "Alex Example", "ownership": "owned", "route": { "kind": "user", "id": "5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f", "application_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } }, "source_ref": { "kind": "session", "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "ownership": "owned", "route": { "kind": "session", "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "application_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } }, "verification_attempt": { "session_id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "session_number": 1287, "attempt": 2, "attempt_count": 2, "status": "Approved", "status_changed_at": "2026-10-12T16:05:41Z", "decline_reasons": [] }, "transaction": null, "login": null, "rule_hit": null, "case_linked": null, "note_added": null }, { "id": "signal_observed:8d7c6b5a-4e3f-4a2b-9c1d-0e9f8a7b6c5d", "event_type": "signal_observed", "occurred_at": "2026-10-12T16:03:10Z", "ingested_at": "2026-10-01T09:12:44Z", "label": "device observed", "metadata": { "signal_type": "device", "subject_count": 3, "is_hub": false }, "account": null, "source_ref": null, "verification_attempt": null, "transaction": null, "login": null, "rule_hit": null, "case_linked": null, "note_added": null } ], "next_cursor": "eyJ0IjoiMjAyNi0xMC0xMlQxNjowMzoxMCswMDowMCIsImMiOiIyMDI2LTEwLTAxVDA5OjEyOjQ0KzAwOjAwIiwiciI6MSwidSI6IjhkN2M2YjVhLTRlM2YtNGEyYi05YzFkLTBlOWY4YTdiNmM1ZCJ9" } } } } } }, "400": { "description": "Con `contract` presente: un valor no válido de `contract`, `limit`, `cursor` o `event_type`.", "content": { "application/json": { "examples": { "Unsupported contract": { "summary": "Contrato no admitido", "value": { "contract": [ "\"3\" is not a valid choice." ] } }, "Invalid cursor": { "summary": "Cursor no válido", "value": { "cursor": [ "This cursor is not valid. Reload the feed." ] } }, "Limit too large": { "summary": "Límite demasiado grande", "value": { "limit": [ "Ensure this value is less than or equal to 500." ] } }, "Unknown event type": { "summary": "Tipo de evento desconocido", "value": { "event_type": { "0": [ "\"logout\" is not a valid choice." ] } } } } } } }, "401": { "description": "Credenciales ausentes o no válidas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente en errores con código, por ejemplo `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Credenciales ausentes o no válidas", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "La clave de API pertenece a otra aplicación o es una clave con acceso restringido: los endpoints de Networks necesitan una clave de acceso completo. Un token de miembro de la consola necesita `read:networks`. También se devuelve con `code: networks_not_entitled` cuando Networks no está habilitado para la organización.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente en errores con código, por ejemplo `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Redes no habilitadas", "value": { "detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled" } }, "Restricted API key": { "summary": "Clave de API restringida", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Sin permiso", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Red no encontrada (o no visible para esta aplicación).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/map/": { "get": { "summary": "Obtener el mapa de la red", "description": "Puntos geográficos en los que convergen las direcciones o ubicaciones de los miembros de esta red, obtenidos de las sesiones, las sesiones de empresa y las transacciones que respaldan sus membresías.", "operationId": "get_network_map", "x-didit-sdk": { "resource": "networks", "method": "retrieve_map", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID de la red." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/n3a5e000-0000-4000-8000-000000000001/map/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.retrieve_map(\n \"n3a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.retrieveMap(\"n3a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.RetrieveMap(ctx, \"n3a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().retrieveMap(\"n3a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->retrieveMap('n3a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.retrieve_map(\"n3a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.RetrieveMapAsync(\"n3a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Mapa de la red.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkMap" } } } }, "404": { "description": "Red no encontrada (o no visible para esta aplicación).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/sessions/{session_id}/networks/": { "get": { "summary": "Listar redes de una sesión", "description": "Lista las redes a las que pertenece el usuario del proveedor de la sesión. Se resuelve a través del usuario vinculado mediante vendor_data a la sesión.", "operationId": "list_session_network_memberships", "x-didit-sdk": { "resource": "sessions", "method": "list_networks", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la sesión." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/sessions/aaaaaaaa-0000-4000-8000-000000000001/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.sessions.list_networks(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.sessions.listNetworks(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ListNetworks(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.sessions().listNetworks(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->listNetworks('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.sessions.list_networks(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ListNetworksAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Redes a las que pertenece esta entidad. Sin paginación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "No se encontró la entidad en esta aplicación, o no tiene un sujeto vinculado que consultar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/business-sessions/{business_session_id}/networks/": { "get": { "summary": "Listar redes de una sesión de empresa", "description": "Lista las redes a las que pertenece la empresa del proveedor de la sesión de empresa.", "operationId": "list_business_session_network_memberships", "x-didit-sdk": { "resource": "business_sessions", "method": "list_networks", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "business_session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la sesión de empresa." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/business-sessions/aaaaaaaa-0000-4000-8000-000000000002/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.business_sessions.list_networks(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.businessSessions.listNetworks(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.BusinessSessions.ListNetworks(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.businessSessions().listNetworks(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businessSessions->listNetworks('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.business_sessions.list_networks(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.BusinessSessions.ListNetworksAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Redes a las que pertenece esta entidad. Sin paginación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "No se encontró la entidad en esta aplicación, o no tiene un sujeto vinculado que consultar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/users/{vendor_user_uuid}/networks/": { "get": { "summary": "Listar redes de un usuario", "description": "Lista las redes a las que pertenece un usuario del proveedor.", "operationId": "list_user_network_memberships", "x-didit-sdk": { "resource": "users", "method": "list_networks", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "vendor_user_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de usuario del proveedor." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/users/aaaaaaaa-0000-4000-8000-000000000003/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.users.list_networks(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.users.listNetworks(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Users.ListNetworks(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.users().listNetworks(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->listNetworks('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.users.list_networks(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Users.ListNetworksAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Redes a las que pertenece esta entidad. Sin paginación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "No se encontró la entidad en esta aplicación, o no tiene un sujeto vinculado que consultar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/businesses/{vendor_business_uuid}/networks/": { "get": { "summary": "Listar redes de una empresa", "description": "Lista las redes a las que pertenece una empresa del proveedor.", "operationId": "list_business_network_memberships", "x-didit-sdk": { "resource": "businesses", "method": "list_networks", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "vendor_business_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de empresa del proveedor." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/businesses/aaaaaaaa-0000-4000-8000-000000000004/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.businesses.list_networks(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.businesses.listNetworks(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.ListNetworks(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.businesses().listNetworks(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->listNetworks('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.businesses.list_networks(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.ListNetworksAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Redes a las que pertenece esta entidad. Sin paginación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "No se encontró la entidad en esta aplicación, o no tiene un sujeto vinculado que consultar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/networks/": { "get": { "summary": "Listar redes de una transacción", "description": "Lista las redes a las que pertenece el sujeto de KYC/KYB asociado a la transacción (resuelto a través de la sesión o la sesión de empresa de la transacción).", "operationId": "list_transaction_network_memberships", "x-didit-sdk": { "resource": "transactions", "method": "list_networks", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "transaction_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la transacción." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/transactions/aaaaaaaa-0000-4000-8000-000000000005/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.transactions.list_networks(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.transactions.listNetworks(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.ListNetworks(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.transactions().listNetworks(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->listNetworks('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.transactions.list_networks(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.ListNetworksAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Redes a las que pertenece esta entidad. Sin paginación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "No se encontró la entidad en esta aplicación, o no tiene un sujeto vinculado que consultar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/parties/{transaction_party_uuid}/networks/": { "get": { "summary": "Listar redes de una parte de una transacción", "description": "Lista las redes a las que pertenece una parte de la transacción (remitente, beneficiario o contraparte), resueltas a través de la propia parte y no de la sesión asociada a la transacción.", "operationId": "list_transaction_party_network_memberships", "x-didit-sdk": { "resource": "transactions", "method": "list_party_networks", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "transaction_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la transacción." }, { "name": "transaction_party_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la parte de la transacción." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/transactions/aaaaaaaa-0000-4000-8000-000000000005/parties/bbbbbbbb-0000-4000-8000-000000000006/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.transactions.list_party_networks(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.transactions.listPartyNetworks(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.ListPartyNetworks(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.transactions().listPartyNetworks(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->listPartyNetworks('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.transactions.list_party_networks(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.ListPartyNetworksAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Redes a las que pertenece esta entidad. Sin paginación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "No se encontró la entidad en esta aplicación, o no tiene un sujeto vinculado que consultar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/biometric-templates/": { "get": { "summary": "Listar plantillas biométricas conservadas", "description": "Una aplicación que lo ha activado conserva una plantilla biométrica facial, gestionada por separado y sin imágenes, vinculada al usuario cuando se elimina una sesión (consulta `DELETE /v3/session/{sessionId}/delete/`). Las plantillas son datos biométricos con un `expires_at` finito; nunca contienen imágenes, datos de sesión ni campos de identidad, y se purgan al eliminar el usuario, con un borrado por privacidad, al expirar o mediante una purga explícita. Estos endpoints solo aceptan claves de API de la aplicación (`x-api-key`); los tokens de usuario de Business Console se rechazan con `403`.\n\nDevuelve una lista paginada de las plantillas que la aplicación conserva actualmente. Las plantillas purgadas no aparecen en la lista.", "operationId": "list_biometric_templates", "x-didit-sdk": { "resource": "biometric_templates", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Biometric Templates" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "query", "name": "vendor_data", "required": false, "description": "Coincidencia de subcadena, sin distinguir mayúsculas y minúsculas, en el `vendor_data` actual del usuario propietario.", "schema": { "type": "string" } }, { "in": "query", "name": "vendor_user_uuid", "required": false, "description": "Coincidencia exacta con el usuario propietario.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "status", "required": false, "description": "Estado del ciclo de vida. Las plantillas purgadas nunca se incluyen en la lista.", "schema": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed" ] } }, { "in": "query", "name": "source_type", "required": false, "description": "Cómo se creó la plantilla.", "schema": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ] } }, { "in": "query", "name": "retained_from", "required": false, "description": "Plantillas retenidas en este momento o después.", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "retained_to", "required": false, "description": "Plantillas retenidas en este momento o antes. No debe ser anterior a `retained_from` (`400`).", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "ordering", "required": false, "description": "Orden de clasificación.", "schema": { "type": "string", "enum": [ "retained_at", "-retained_at", "expires_at", "-expires_at" ], "default": "-retained_at" } }, { "in": "query", "name": "limit", "required": false, "description": "Tamaño de página.", "schema": { "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "description": "Desplazamiento de la paginación.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Plantillas paginadas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID de la plantilla. Se genera aleatoriamente; no se deriva de la sesión eliminada ni de su rostro." }, "vendor_user_uuid": { "type": "string", "format": "uuid", "description": "El usuario propietario." }, "vendor_data": { "type": "string", "nullable": true, "description": "El `vendor_data` actual del usuario, que se resuelve al leer la plantilla (nunca se copia)." }, "source_type": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ], "description": "Cómo se creó la plantilla: una eliminación de sesión (API o Console), el periodo automático de retención de datos de la aplicación o un backfill realizado por Didit siguiendo tus instrucciones." }, "provenance_reference": { "type": "string", "format": "uuid", "description": "Referencia opaca que vincula la plantilla con su registro de auditoría. No es el id de la sesión eliminada y no puede resolverse a él." }, "retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "La política de la aplicación en el momento de la retención." }, "retention_override": { "type": "boolean", "nullable": true, "description": "El valor de `retain_face_embeddings` enviado en la eliminación, o `null` cuando se aplicó la política." }, "retained_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time", "description": "Fecha y hora en que la plantilla expira y se purga automáticamente. Siempre está definido." }, "retained_by": { "type": "string", "nullable": true, "description": "Entidad que dio la instrucción: el id de la aplicación para las claves de API, el id del miembro de la Console para las acciones en la Console, o un identificador `service:` para la retención automática. Nunca es una dirección de correo electrónico." }, "retained_by_type": { "type": "string", "enum": [ "API_KEY", "CONSOLE_USER", "SYSTEM" ] }, "instruction_class": { "type": "string", "enum": [ "operational_session_delete", "privacy_erasure" ] }, "instruction_source": { "type": "string", "enum": [ "api", "console", "automatic_retention", "backfill", "privacy_erasure", "explicit_template_purge", "vendor_user_delete", "expiry", "reconciliation", "migration", "system" ] }, "instruction_id": { "type": "string", "description": "El `instruction_id` enviado en la eliminación, o un id generado por Didit." }, "held_out_of_use": { "type": "boolean", "description": "`true` solo mientras se aplica una retención legal. Una plantilla retenida queda excluida de toda búsqueda de coincidencias." }, "status": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed", "purged" ], "description": "Solo participan en la búsqueda de coincidencias las plantillas `active` que no están retenidas, no han superado `expires_at` y cuyo usuario sigue existiendo." }, "purged_at": { "type": "string", "format": "date-time", "nullable": true } } } } } }, "examples": { "One active template": { "value": { "count": 1, "next": null, "previous": null, "results": [ { "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f", "vendor_data": "user-42", "source_type": "session_delete", "provenance_reference": "6b1e8d2f-4a3c-4f9e-8c7d-1a2b3c4d5e6f", "retention_policy": "retain_until_user_deleted", "retention_override": null, "retained_at": "2026-08-28T10:15:42.318402Z", "expires_at": "2027-08-28T10:15:42.318402Z", "retained_by": "3c9e2b1f-7d4a-4e8b-9c1d-5f6a7b8c9d0e", "retained_by_type": "API_KEY", "instruction_class": "operational_session_delete", "instruction_source": "api", "instruction_id": "post-approval-cleanup-2026-08", "held_out_of_use": false, "status": "active", "purged_at": null } ] } } } } } }, "400": { "description": "Valor de filtro no válido, o `retained_to` anterior a `retained_from`. Errores de validación agrupados por campo.", "content": { "application/json": { "examples": { "Bad range": { "value": { "retained_to": [ "Must be on or after retained_from." ] } } } } } }, "403": { "description": "Token de usuario de la consola, o la clave de API no está permitida. Estos endpoints solo aceptan claves de API de aplicación.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/biometric-templates/?vendor_data=user-42&status=active' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.biometric_templates.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.biometricTemplates.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.BiometricTemplates.ListAutoPaging(ctx, didit.BiometricTemplatesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.biometricTemplates().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "biometricTemplates->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.biometric_templates.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.BiometricTemplates.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/biometric-templates/count/": { "get": { "summary": "Contar las plantillas biométricas conservadas", "description": "Una aplicación que lo haya activado conserva una plantilla biométrica facial gestionada por separado y sin imágenes, vinculada al usuario, cuando se elimina una sesión (consulta `DELETE /v3/session/{sessionId}/delete/`). Las plantillas son datos biométricos con un `expires_at` finito; nunca contienen imágenes, datos de la sesión ni campos de identidad, y se purgan al eliminar el usuario, por un borrado por privacidad, al expirar o mediante una purga explícita. Estos endpoints solo aceptan claves de API de aplicación (`x-api-key`); los tokens de usuario de Business Console se rechazan con `403`.\n\nDevuelve el número de plantillas que coinciden con los mismos filtros que el endpoint de listado. Úsalo para comprobar a qué afectaría una purga masiva filtrada con `delete_all: true`.", "operationId": "count_biometric_templates", "x-didit-sdk": { "resource": "biometric_templates", "method": "count", "auth": "api_key", "server": true }, "tags": [ "Biometric Templates" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "query", "name": "vendor_data", "required": false, "description": "Coincidencia de subcadena, sin distinguir mayúsculas y minúsculas, en el `vendor_data` actual del usuario propietario.", "schema": { "type": "string" } }, { "in": "query", "name": "vendor_user_uuid", "required": false, "description": "Coincidencia exacta con el usuario propietario.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "status", "required": false, "description": "Estado del ciclo de vida. Las plantillas purgadas nunca se incluyen en la lista.", "schema": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed" ] } }, { "in": "query", "name": "source_type", "required": false, "description": "Cómo se creó la plantilla.", "schema": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ] } }, { "in": "query", "name": "retained_from", "required": false, "description": "Plantillas retenidas en este momento o después.", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "retained_to", "required": false, "description": "Plantillas retenidas en este momento o antes. No debe ser anterior a `retained_from` (`400`).", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Recuento.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0 } } }, "examples": { "Count": { "value": { "count": 128 } } } } } }, "400": { "description": "Valor de filtro no válido, o `retained_to` anterior a `retained_from`. Errores de validación agrupados por campo.", "content": { "application/json": { "examples": { "Bad range": { "value": { "retained_to": [ "Must be on or after retained_from." ] } } } } } }, "403": { "description": "Token de usuario de la consola, o la clave de API no está permitida. Estos endpoints solo aceptan claves de API de aplicación.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/biometric-templates/count/?status=active' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.biometric_templates.count()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.biometricTemplates.count();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.BiometricTemplates.Count(ctx, didit.BiometricTemplatesCountParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.biometricTemplates().count();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "biometricTemplates->count();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.biometric_templates.count\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.BiometricTemplates.CountAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/biometric-templates/{template_uuid}/": { "get": { "summary": "Obtener una plantilla biométrica conservada", "description": "Una aplicación que lo ha activado conserva una plantilla biométrica facial, gestionada por separado y sin imágenes, vinculada al usuario cuando se elimina una sesión (consulta `DELETE /v3/session/{sessionId}/delete/`). Las plantillas son datos biométricos con un `expires_at` finito; nunca contienen imágenes, datos de sesión ni campos de identidad, y se purgan al eliminar el usuario, con un borrado por privacidad, al expirar o mediante una purga explícita. Estos endpoints solo aceptan claves de API de la aplicación (`x-api-key`); los tokens de usuario de Business Console se rechazan con `403`.\n\nDevuelve una plantilla. La respuesta nunca incluye una imagen, un vector, el id de la sesión eliminada ni datos de identidad.", "operationId": "get_biometric_template", "x-didit-sdk": { "resource": "biometric_templates", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Biometric Templates" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "template_uuid", "required": true, "description": "ID de la plantilla, tal como lo devuelven `biometric_template_uuid` en los endpoints de eliminación de sesiones, `biometric_template_id` en una coincidencia de Búsqueda facial o el endpoint de listado.", "schema": { "type": "string", "format": "uuid", "example": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b" } } ], "responses": { "200": { "description": "La plantilla.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID de la plantilla. Se genera aleatoriamente; no se deriva de la sesión eliminada ni de su rostro." }, "vendor_user_uuid": { "type": "string", "format": "uuid", "description": "El usuario propietario." }, "vendor_data": { "type": "string", "nullable": true, "description": "El `vendor_data` actual del usuario, que se resuelve al leer la plantilla (nunca se copia)." }, "source_type": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ], "description": "Cómo se creó la plantilla: una eliminación de sesión (API o Console), el periodo automático de retención de datos de la aplicación o un backfill realizado por Didit siguiendo tus instrucciones." }, "provenance_reference": { "type": "string", "format": "uuid", "description": "Referencia opaca que vincula la plantilla con su registro de auditoría. No es el id de la sesión eliminada y no puede resolverse a él." }, "retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "La política de la aplicación en el momento de la retención." }, "retention_override": { "type": "boolean", "nullable": true, "description": "El valor de `retain_face_embeddings` enviado en la eliminación, o `null` cuando se aplicó la política." }, "retained_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time", "description": "Fecha y hora en que la plantilla expira y se purga automáticamente. Siempre está definido." }, "retained_by": { "type": "string", "nullable": true, "description": "Entidad que dio la instrucción: el id de la aplicación para las claves de API, el id del miembro de la Console para las acciones en la Console, o un identificador `service:` para la retención automática. Nunca es una dirección de correo electrónico." }, "retained_by_type": { "type": "string", "enum": [ "API_KEY", "CONSOLE_USER", "SYSTEM" ] }, "instruction_class": { "type": "string", "enum": [ "operational_session_delete", "privacy_erasure" ] }, "instruction_source": { "type": "string", "enum": [ "api", "console", "automatic_retention", "backfill", "privacy_erasure", "explicit_template_purge", "vendor_user_delete", "expiry", "reconciliation", "migration", "system" ] }, "instruction_id": { "type": "string", "description": "El `instruction_id` enviado en la eliminación, o un id generado por Didit." }, "held_out_of_use": { "type": "boolean", "description": "`true` solo mientras se aplica una retención legal. Una plantilla retenida queda excluida de toda búsqueda de coincidencias." }, "status": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed", "purged" ], "description": "Solo participan en la búsqueda de coincidencias las plantillas `active` que no están retenidas, no han superado `expires_at` y cuyo usuario sigue existiendo." }, "purged_at": { "type": "string", "format": "date-time", "nullable": true } } }, "examples": { "Active template": { "value": { "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f", "vendor_data": "user-42", "source_type": "session_delete", "provenance_reference": "6b1e8d2f-4a3c-4f9e-8c7d-1a2b3c4d5e6f", "retention_policy": "retain_until_user_deleted", "retention_override": null, "retained_at": "2026-08-28T10:15:42.318402Z", "expires_at": "2027-08-28T10:15:42.318402Z", "retained_by": "3c9e2b1f-7d4a-4e8b-9c1d-5f6a7b8c9d0e", "retained_by_type": "API_KEY", "instruction_class": "operational_session_delete", "instruction_source": "api", "instruction_id": "post-approval-cleanup-2026-08", "held_out_of_use": false, "status": "active", "purged_at": null } } } } } }, "403": { "description": "Token de usuario de la consola, o la clave de API no está permitida. Estos endpoints solo aceptan claves de API de aplicación.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Plantilla desconocida, una plantilla de otra aplicación o (en `GET`) una plantilla purgada.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Biometric template not found." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/biometric-templates/9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.biometric_templates.retrieve(\n \"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.biometricTemplates.retrieve(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.BiometricTemplates.Retrieve(ctx, \"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.biometricTemplates().retrieve(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "biometricTemplates->retrieve('9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.biometric_templates.retrieve(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.BiometricTemplates.RetrieveAsync(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "summary": "Purgar una plantilla biométrica conservada", "description": "Una aplicación que lo ha activado conserva una plantilla biométrica facial, gestionada por separado y sin imágenes, vinculada al usuario cuando se elimina una sesión (consulta `DELETE /v3/session/{sessionId}/delete/`). Las plantillas son datos biométricos con un `expires_at` finito; nunca contienen imágenes, datos de sesión ni campos de identidad, y se purgan al eliminar el usuario, con un borrado por privacidad, al expirar o mediante una purga explícita. Estos endpoints solo aceptan claves de API de la aplicación (`x-api-key`); los tokens de usuario de Business Console se rechazan con `403`.\n\nPurga una plantilla: se retira de todo tipo de coincidencia y se elimina la plantilla almacenada. Es irreversible y queda anotado en el registro de auditoría junto con la identidad que realiza la acción.\n\n**Semántica de reintento:** Didit elimina primero la plantilla almacenada y solo después marca la plantilla como purgada. Si un almacén biométrico no está disponible, la llamada devuelve `503`, la plantilla pasa a `status: purge_failed` y ya queda excluida de la coincidencia; repite la misma llamada para terminar. Repetir la purga de una plantilla ya purgada devuelve `already_purged`.\n\nLas plantillas también se purgan con `POST /v3/users/delete/` para el usuario propietario, con cualquier eliminación de las sesiones de ese usuario con `deletion_instruction: privacy_erasure` y automáticamente en `expires_at`.", "operationId": "purge_biometric_template", "x-didit-sdk": { "resource": "biometric_templates", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Biometric Templates" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "template_uuid", "required": true, "description": "ID de la plantilla, tal como lo devuelven `biometric_template_uuid` en los endpoints de eliminación de sesiones, `biometric_template_id` en una coincidencia de Búsqueda facial o el endpoint de listado.", "schema": { "type": "string", "format": "uuid", "example": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b" } } ], "responses": { "200": { "description": "Resultado de la purga.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "outcome": { "type": "string", "enum": [ "purged", "already_purged" ] } } }, "examples": { "Purged": { "value": { "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "outcome": "purged" } }, "Already purged": { "value": { "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "outcome": "already_purged" } } } } } }, "403": { "description": "Token de usuario de la consola, o la clave de API no está permitida. Estos endpoints solo aceptan claves de API de aplicación.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Plantilla desconocida, una plantilla de otra aplicación o (en `GET`) una plantilla purgada.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Biometric template not found." } } } } } }, "503": { "description": "Un almacén biométrico no estaba disponible al conservar o purgar una plantilla biométrica. No se elimina nada; repite la misma solicitud. Los reintentos son idempotentes y convergen en una única plantilla.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Retryable": { "value": { "detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE https://verification.didit.me/v3/biometric-templates/9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.biometric_templates.delete(\n \"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.biometricTemplates.delete(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.BiometricTemplates.Delete(ctx, \"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.biometricTemplates().delete(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "biometricTemplates->delete('9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.biometric_templates.delete(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.BiometricTemplates.DeleteAsync(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/biometric-templates/delete/": { "post": { "summary": "Purgar en bloque las plantillas biométricas conservadas", "description": "Una aplicación que lo ha activado conserva una plantilla biométrica facial, gestionada por separado y sin imágenes, vinculada al usuario cuando se elimina una sesión (consulta `DELETE /v3/session/{sessionId}/delete/`). Las plantillas son datos biométricos con un `expires_at` finito; nunca contienen imágenes, datos de sesión ni campos de identidad, y se purgan al eliminar el usuario, con un borrado por privacidad, al expirar o mediante una purga explícita. Estos endpoints solo aceptan claves de API de la aplicación (`x-api-key`); los tokens de usuario de Business Console se rechazan con `403`.\n\nPurga muchas plantillas en una sola llamada, mediante una lista explícita de ids o con `delete_all: true`, opcionalmente acotado con los mismos filtros que el endpoint de listado. Las plantillas se purgan una a una y cada resultado indica `purged` o `already_purged`. Si un almacén biométrico no está disponible, la llamada devuelve `503` en la primera plantilla que falla: las plantillas purgadas antes dentro de la solicitud siguen purgadas, la que falla pasa a `purge_failed` (ya excluida de la coincidencia) y repetir la solicitud completa el trabajo.\n\n**`delete_all: true` sin filtros purga todas las plantillas biométricas de la aplicación y no se puede deshacer.** Ejecuta primero el endpoint de recuento con los mismos filtros.", "operationId": "bulk_purge_biometric_templates", "x-didit-sdk": { "resource": "biometric_templates", "method": "batch_delete", "auth": "api_key", "server": true }, "tags": [ "Biometric Templates" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "template_uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "description": "Plantillas que se purgarán. Obligatorio salvo que `delete_all` sea `true`. Los ID ya purgados se indican como `already_purged`." }, "delete_all": { "type": "boolean", "default": false, "description": "Si es `true`, purga todas las plantillas que coinciden con los filtros siguientes (todas las plantillas de la aplicación si no se indica ningún filtro). Se ignora `template_uuids`. Es irreversible." }, "vendor_data": { "type": "string", "description": "Solo con `delete_all`: coincidencia de subcadena, sin distinguir mayúsculas y minúsculas, en el `vendor_data` del usuario propietario." }, "vendor_user_uuid": { "type": "string", "format": "uuid", "description": "Solo con `delete_all`: coincidencia exacta con el usuario propietario." }, "status": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed" ], "description": "Solo con `delete_all`." }, "source_type": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ], "description": "Solo con `delete_all`." }, "retained_from": { "type": "string", "format": "date-time", "description": "Solo con `delete_all`." }, "retained_to": { "type": "string", "format": "date-time", "description": "Solo con `delete_all`. No debe ser anterior a `retained_from`." } } }, "examples": { "By id": { "value": { "template_uuids": [ "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d" ] } }, "Every template of one User": { "value": { "delete_all": true, "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f" } }, "Every template in the application": { "value": { "delete_all": true } } } } } }, "responses": { "200": { "description": "Resultados de la purga por plantilla.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "outcome": { "type": "string", "enum": [ "purged", "already_purged" ] } } } } } }, "examples": { "Mixed": { "value": { "results": [ { "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "outcome": "purged" }, { "uuid": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "outcome": "already_purged" } ] } } } } } }, "400": { "description": "Error de validación: no se purga nada.", "content": { "application/json": { "examples": { "Missing selector": { "value": { "template_uuids": [ "This field is required unless delete_all is true." ] } }, "Bad range": { "value": { "retained_to": [ "Must be on or after retained_from." ] } } } } } }, "403": { "description": "Token de usuario de la consola, o la clave de API no está permitida. Estos endpoints solo aceptan claves de API de aplicación.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "503": { "description": "Un almacén biométrico no estaba disponible al conservar o purgar una plantilla biométrica. No se elimina nada; repite la misma solicitud. Los reintentos son idempotentes y convergen en una única plantilla.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Retryable": { "value": { "detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/biometric-templates/delete/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"delete_all\": true, \"vendor_user_uuid\": \"2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.biometric_templates.batch_delete(\n template_uuids=[\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\", \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.biometricTemplates.batchDelete({\n template_uuids: [\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\", \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.BiometricTemplates.BatchDelete(ctx, didit.BiometricTemplatesBatchDeleteParams{\n\tTemplateUUIDs: didit.Some([]string{\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\", \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.BiometricTemplatesBatchDeleteParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.biometricTemplates().batchDelete(BiometricTemplatesBatchDeleteParams.builder()\n .templateUuids(List.of(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\", \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "biometricTemplates->batchDelete([\n 'template_uuids' => ['9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b', '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.biometric_templates.batch_delete(template_uuids: [\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\", \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.BiometricTemplates.BatchDeleteAsync(new BiometricTemplatesBatchDeleteParams\n{\n TemplateUuids = new string[] { \"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\", \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/kyb/shareholders/": { "post": { "summary": "Empresa del registro KYB con accionistas (independiente)", "operationId": "post_v3_kyb_shareholders", "x-didit-sdk": { "resource": "kyb", "method": "list_shareholders", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [], "description": "Obtén el perfil Lite **junto con los accionistas directos** (personas físicas y personas jurídicas, con sus rangos de participación) de un candidato devuelto por `POST /v3/kyb/search/`.\n\n**Relación con la búsqueda.** Pasa el `kyb_response_id` del candidato tal como lo devolvió una búsqueda de la misma aplicación. Busca en el nivel que quieres comprar (`tier` en `POST /v3/kyb/search/`), porque la búsqueda se ejecuta en la cadena de registros que sirve ese nivel, y una búsqueda Lite sin resultados no demuestra que el registro no tenga la empresa. Cuando los datos de propiedad del país están en otro registro, Didit vuelve a localizar allí la empresa por su número de registro, sin coste adicional.\n\n**Facturación.** Se factura al precio del nivel Shareholders del país; consulta [precios de registros KYB](/es/getting-started/kyb-registry-pricing). Cuando el registro no tiene ningún dato de accionistas de la empresa (o el país no ofrece ningún dato de propiedad), se entrega y se factura el perfil Lite en su lugar: consulta `registry_tier_delivered` y `registry_ownership_status`. El saldo se comprueba contra el precio del nivel Shareholders antes de cualquier llamada al registro (`403` si no es suficiente).\n\n**Disponibilidad.** Solo en v3. Cada llamada crea una sesión de empresa (su id es el `request_id`).\n\n**Informes pendientes.** Cuando un informe todavía se está preparando, o la sección de propiedad aún no se ha obtenido del registro, el endpoint devuelve 202 Accepted, kyb_registry.fetch_status=pending, kyb_registry.registry_ownership_status=pending y registry_tier_delivered=null. Conserva request_id y consulta GET /v3/session/{request_id}/decision/ hasta que registry_checks[0].company.fetch_status se resuelva. Didit completa el informe automáticamente y cobra el nivel entregado cuando está listo. No repitas la compra mientras esté pendiente: cada nuevo POST crea una solicitud independiente.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KYBRegistryCandidateRequest" }, "example": { "kyb_response_id": "69aeeb95febb0f1704042259", "vendor_data": "company-1234" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/kyb/shareholders/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"kyb_response_id\": \"69aeeb95febb0f1704042259\",\n \"vendor_data\": \"company-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.kyb.list_shareholders(\n kyb_response_id=\"69aeeb95febb0f1704042259\",\n vendor_data=\"company-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.kyb.listShareholders({\n kyb_response_id: \"69aeeb95febb0f1704042259\",\n vendor_data: \"company-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.KYB.ListShareholders(ctx, didit.KYBRegistryCandidateRequest{\n\tKYBResponseID: \"69aeeb95febb0f1704042259\",\n\tVendorData: didit.String(\"company-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.KYBRegistryCandidateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.kyb().listShareholders(KYBRegistryCandidateRequest.builder()\n .kybResponseId(\"69aeeb95febb0f1704042259\")\n .vendorData(\"company-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "kyb->listShareholders([\n 'kyb_response_id' => '69aeeb95febb0f1704042259',\n 'vendor_data' => 'company-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.kyb.list_shareholders(\n kyb_response_id: \"69aeeb95febb0f1704042259\",\n vendor_data: \"company-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Kyb.ListShareholdersAsync(new KYBRegistryCandidateRequest\n{\n KybResponseId = \"69aeeb95febb0f1704042259\",\n VendorData = \"company-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Informe de empresa devuelto y facturado en el nivel entregado. Los informes de propiedad que aún se están preparando pueden devolver 202; conserva request_id para recuperar su decisión guardada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sesión de empresa creada para esta consulta. El registro almacenado (visible en la consola) se sigue actualizando si el registro de empresas responde después de la respuesta." }, "registry_tier_requested": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "El nivel que vende este endpoint: `basic` (Lite) para países seleccionados, `shareholders`, `ubo`." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "El nivel realmente entregado y facturado. Es inferior al solicitado cuando los registros del país no contienen datos de propiedad o cuando el registro no tiene ningún registro de propiedad para esta empresa.", "nullable": true }, "kyb_registry": { "type": "object", "description": "Perfil completo de la empresa en el registro.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID de Didit de este registro de empresa." }, "node_id": { "type": "string", "example": "feature_kyb_registry" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review" ], "description": "Evaluación de Didit de la comprobación en el registro (p. ej., `In Review` cuando la empresa no está activa en el registro o no se pudieron derivar los datos de propiedad)." }, "registry_status": { "type": "string", "nullable": true, "enum": [ "active", "dissolved", "deregistered", "see full details", "authorised", "appointed representative", "unauthorised", "inactive", "no longer authorised", "closed", "struck off", null ], "description": "Estado normalizado de la empresa según lo informa el registro." }, "data_resolved": { "type": "boolean", "description": "`true` una vez que el registro de empresas devolvió el perfil completo. `false` cuando el registro de empresas seguía procesando tras el sondeo: los datos almacenados se completan automáticamente cuando el registro de empresas lo resuelve." }, "company_name": { "type": "string", "example": "Tesco PLC" }, "registration_number": { "type": "string", "nullable": true, "example": "00445790" }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2.", "example": "GB" }, "region": { "type": "string", "nullable": true, "description": "Código de subdivisión cuando el registro es regional (p. ej., `CA` para `US-CA`); vacío en caso contrario." }, "company_type": { "type": "string", "nullable": true, "example": "Public Limited Company" }, "incorporation_date": { "type": "string", "format": "date", "nullable": true, "example": "1947-11-27" }, "registered_address": { "type": "string", "nullable": true, "example": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA" }, "tax_number": { "type": "string", "nullable": true, "example": "GB412 8925 93" }, "risk_level": { "type": "string", "nullable": true, "description": "Nivel de riesgo según el registro, cuando está disponible." }, "verification_status": { "type": "string", "nullable": true, "description": "Estado de verificación en el registro, cuando está disponible." }, "is_from_registry": { "type": "boolean", "description": "Siempre `true` en este endpoint: el perfil se obtuvo de un registro oficial." }, "fetch_status": { "type": "string", "enum": [ "pending", "resolved" ], "description": "Ciclo de vida de la consulta al registro. Se refleja en `data_resolved`." }, "alternative_names": { "type": "string", "nullable": true, "description": "Nombres alternativos, comerciales, anteriores o en el idioma original de la empresa, como texto, cuando se informan." }, "nature_of_business": { "type": "string", "nullable": true, "description": "Descripción de la actividad o código de clasificación, cuando se informa." }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Importe decimal como cadena, cuando se informa." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Código ISO 4217, cuando se informa." }, "website": { "type": "string", "nullable": true, "example": "https://www.tesco.com/" }, "email": { "type": "string", "nullable": true, "example": "customer.service@tesco.co.uk" }, "phone": { "type": "string", "nullable": true, "example": "03301231688" }, "legal_entity_identifier": { "type": "string", "nullable": true, "description": "LEI, cuando se informa." }, "location_of_registration": { "type": "string", "nullable": true, "description": "Registro o jurisdicción en la que está inscrita la empresa, cuando se indica." }, "vat_number": { "type": "string", "nullable": true, "description": "Número de IVA de la UE, cuando se recopila durante el paso de registro alojado o se edita después. En el momento de la selección normalmente todavía no está definido: la validación del IVA y de la identificación fiscal se ejecuta cuando el usuario final envía el paso de registro en el flujo alojado." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Resultado de validar el número de IVA o, si no lo hay, el `tax_number`, al enviar al registro. `valid` / `invalid`: lo decide el registro oficial del país (VIES de la UE, Noruega, Suiza, Brasil, Colombia, Costa Rica, Ecuador, Paraguay; Polonia también mediante su registro nacional de IVA). `format_valid` / `invalid_format`: lo deciden las reglas de formato y dígito de control del país cuando no se puede consultar ningún registro. `could_not_validate`: el registro no estaba disponible. `not_applicable`: no hay número, el país no tiene registro ni reglas, o es una sesión de sandbox." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "El número que se comprobó, tal como lo conoce la fuente (por ejemplo, el número de IVA derivado de un SIREN francés o de un RSIN neerlandés). `null` cuando no se realizó ninguna comprobación." }, "vat_validation_source": { "type": "string", "nullable": true, "enum": [ "eu_vies", "pl_vat_white_list", "no_brreg", "ch_uid_register", "br_receita_federal", "co_rues", "cr_hacienda", "ec_sri", "py_dnit", "format_rules", null ], "description": "La fuente que determinó `vat_validation_status`: un registro oficial o `format_rules`. `null` cuando no se ejecutó ninguna comprobación." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Nombre registrado en la fuente que validó el número, cuando la fuente lo revela. Solo se informa cuando el estado es `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Dirección registrada en la fuente que validó el número, cuando esta la facilita. Solo se establece cuando el estado es `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de tiempo de la comprobación. `null` cuando no se ejecutó ninguna comprobación." }, "financial_summary": { "type": "object", "nullable": true, "description": "Detalles de acciones y capital según el registro (moneda, total de acciones, clases de acciones), cuando están disponibles." }, "officers": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "example": "MELISSA BETHELL" }, "designation": { "type": "string", "nullable": true, "description": "Designación del registro sin procesar (p. ej., `Director`, `Secretary`)." }, "role": { "type": "string", "description": "Rol normalizado derivado del cargo. Conjunto completo del modelo de 17 valores; el análisis del registro en este endpoint suele devolver director, non_executive_director, secretary, chairman o company_officer.", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "company_officer", "settlor", "protector", "investor", "other" ] }, "nationality": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "description": "`false` cuando el registro marca el nombramiento como dimitido." }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending", null ], "description": "Estado de una sesión KYC asociada, cuando se inició una para este directivo. `null` en caso contrario." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "URL de verificación de la sesión de KYC asociada, si existe." }, "first_name": { "type": "string", "nullable": true, "description": "Nombre de pila cuando el registro lo indica explícitamente; no se deduce del nombre completo." }, "last_name": { "type": "string", "nullable": true, "description": "Apellido, cuando el registro lo indica explícitamente." }, "address": { "type": "string", "nullable": true, "description": "Dirección del directivo según el registro." }, "appointment_date": { "type": "string", "nullable": true, "description": "Fecha en que se nombró al cargo.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Fecha en que terminó el nombramiento, cuando se informa.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Fecha de nacimiento completa según el registro. Es null cuando solo se conoce el año o el mes de nacimiento.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Año de nacimiento según el registro, incluso cuando la fecha completa no está disponible." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Mes de nacimiento según el registro. Null cuando solo se conoce el año." } } }, "description": "Directores, secretarios y otros administradores extraídos del registro." }, "beneficial_owners": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Si el propietario es una persona física o una persona jurídica." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles normalizados (por ejemplo, `ubo`, `shareholder`)." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Límite inferior de la franja de propiedad informada por el registro (por ejemplo, `25%`)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Límite superior del rango de propiedad informado por el registro." }, "is_active": { "type": "boolean" }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending", null ] }, "kyc_session_url": { "type": "string", "nullable": true }, "effective_ownership_percent": { "type": "number", "nullable": true, "description": "Porcentaje de propiedad analizado (límite máximo, con el límite mínimo como alternativa)." }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "country_of_birth": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "designation": { "type": "string", "nullable": true }, "voting_min_shares": { "type": "string", "nullable": true }, "voting_max_shares": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "nullable": true, "description": "Fecha de nacimiento completa, cuando se informa.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Fecha de nombramiento, cuando se informa.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } }, "description": "Beneficiarios finales / personas con control significativo extraídos del registro. Puede estar vacío cuando el registro no expone la propiedad." }, "addresses": { "type": "array", "nullable": true, "description": "Todas las direcciones que indica el registro, con una única forma canónica. Es null si no indica ninguna.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "Las actividades en las que el registro clasifica a la empresa, con una única forma canónica. Es null cuando no indica ninguna.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Fechas de presentación ante el registro, cuando están disponibles. Las declaraciones anuales y las juntas generales usan last_annual_return_date y last_agm_date; son distintas de las cuentas financieras." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "description": "Siempre `null` en este endpoint (lo usa el flujo de KYB alojado cuando los usuarios finales editan los datos del registro)." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Siempre `null` en este endpoint." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Se establece cuando un revisor de la consola edita el registro más adelante." }, "is_editable": { "type": "boolean", "description": "Si los datos procedentes del registro aún se pueden editar en el flujo alojado o en la consola." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "Igual que `registry_tier_delivered` del nivel superior.", "nullable": true }, "registry_ownership_status": { "type": "string", "nullable": true, "enum": [ "not_requested", "delivered", "not_held", "unavailable", "pending", null ], "description": "`delivered` cuando se recibieron los datos de propiedad, `not_held` cuando el registro de propiedad respondió y no incluye esta empresa (consulta `registry_data.ownership_error`), `unavailable` cuando se solicitó un nivel con propiedad pero el registro no tenía datos de esta empresa o no se pudo consultar (consulta `registry_data.ownership_error`), `pending` cuando la sección de propiedad aún no se ha obtenido del registro y Didit todavía la está completando, `not_requested` en el nivel Lite." }, "ownership": { "$ref": "#/components/schemas/KYBRegistryOwnership" }, "registry_tier": { "type": "string", "nullable": true, "description": "El nivel de registro que solicitó el flujo: `basic`, `shareholders` o `ubo`. También en `ownership.tier_requested`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "El monitor de registro más reciente de la empresa, o `null` si no existe ninguno.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "unavailable_reason": { "type": "string", "nullable": true }, "enrolled_at": { "type": "string", "format": "date-time", "nullable": true }, "cancelled_at": { "type": "string", "format": "date-time", "nullable": true }, "last_bill_date": { "type": "string", "format": "date", "nullable": true }, "next_bill_date": { "type": "string", "format": "date", "nullable": true }, "last_event_at": { "type": "string", "format": "date-time", "nullable": true }, "events_count": { "type": "integer" }, "watched_fields": { "description": "Los campos de la empresa que vigila el monitor." } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste." }, "metadata": { "type": "object", "nullable": true, "description": "Devuelve el `metadata` que enviaste." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved company": { "summary": "Perfil completo del registro (lista de cargos truncada por brevedad)", "value": { "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e", "kyb_registry": { "uuid": "f1e2d3c4-b5a6-4789-9c0d-1e2f3a4b5c6d", "node_id": "feature_kyb_registry", "status": "In Review", "registry_status": "active", "data_resolved": true, "company_name": "Tesco PLC", "registration_number": "00445790", "country_code": "GB", "region": "", "company_type": "Public Limited Company", "incorporation_date": "1947-11-27", "registered_address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA", "tax_number": "GB412 8925 93", "risk_level": "low risk", "verification_status": "verified", "is_from_registry": true, "fetch_status": "resolved", "alternative_names": "TESCO STORES (HOLDINGS) PUBLIC LIMITED COMPANY", "nature_of_business": null, "registered_capital": null, "registered_capital_amount": null, "registered_capital_currency": null, "website": "https://www.tesco.com/", "email": "customer.service@tesco.co.uk", "phone": "03301231688", "legal_entity_identifier": null, "location_of_registration": null, "financial_summary": { "currency": "Pound (£)", "total_number_of_shares": "8174378721", "meta_detail": { "Class_Of_Share": "Ordinary" } }, "officers": [ { "uuid": "a1b2c3d4-e5f6-4789-9a0b-1c2d3e4f5a6b", "name": "CHRISTOPHER JON TAYLOR", "designation": "Secretary", "role": "secretary", "nationality": null, "is_active": true, "kyc_status": null, "kyc_session_url": null }, { "uuid": "b2c3d4e5-f6a7-4890-8b1c-2d3e4f5a6b7c", "name": "MELISSA BETHELL", "designation": "Director", "role": "director", "nationality": "British", "is_active": true, "kyc_status": null, "kyc_session_url": null } ], "beneficial_owners": [], "addresses": [ { "address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA", "type": "legal_entity_registry_address", "description": "registered office address" } ], "industries": null, "accounts": { "last_account": "26 February 2025", "next_account": "26 February 2026", "due_by_date": "26 August 2026" }, "registry_data": {}, "user_provided_data": null, "confirmed_by_user_at": null, "last_console_edit_at": null, "is_editable": true }, "vendor_data": "company-1234", "metadata": null, "created_at": "2026-06-11T10:45:00.000000+00:00" } } } } } }, "400": { "description": "Error de validación. Los problemas a nivel de campo usan el envoltorio estándar de DRF.", "content": { "application/json": { "examples": { "Missing kyb_response_id": { "summary": "`kyb_response_id` es obligatorio", "value": { "kyb_response_id": [ "This field is required." ] } }, "save_api_request=false rejected": { "summary": "Las selecciones siempre se guardan", "value": { "save_api_request": [ "KYB registry select must be saved so billing and retrieval can be tracked." ] } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key` y también cuando el saldo de la organización que realiza la llamada no la cubre; una clave incorrecta, revocada o expirada devuelve `401`. Si falta la clave, se devuelve `403` con `{\"detail\": ...}`; una clave incorrecta, revocada o expirada devuelve `401`. La falta de créditos devuelve `403` con `{\"error\": ...}` antes de que se realice cualquier análisis o llamada a un proveedor.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de la organización no cubre la llamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "202": { "description": "Informe aceptado y todavía en proceso. Cuando un informe aún se está preparando, el endpoint devuelve 202 Accepted, kyb_registry.fetch_status=pending y registry_tier_delivered=null. Guarda request_id y consulta GET /v3/session/{request_id}/decision/ hasta que registry_checks[0].company.fetch_status se resuelva. Didit completa el informe automáticamente y cobra el nivel entregado en cuanto está listo. No repitas la compra mientras esté pendiente; cada nuevo POST crea una solicitud independiente.", "content": { "application/json": { "schema": { "$ref": "#/paths/~1v3~1kyb~1shareholders~1/post/responses/200/content/application~1json/schema" }, "examples": { "Pending (registry still resolving)": { "summary": "El informe de propiedad aún se está procesando; recupera la decisión guardada", "value": { "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e", "kyb_registry": { "uuid": "7c0a4f7e-2b1d-4f6a-9c3e-8d5b2a1f0e9d", "node_id": "feature_kyb_registry", "status": "Not Finished", "registry_status": null, "data_resolved": false, "company_name": "Example Holdings Limited", "registration_number": "12345678", "country_code": "HK", "region": null, "company_type": null, "incorporation_date": null, "registered_address": null, "tax_number": null, "risk_level": null, "verification_status": null, "is_from_registry": true, "fetch_status": "pending", "alternative_names": null, "nature_of_business": null, "registered_capital": null, "registered_capital_amount": null, "registered_capital_currency": null, "website": null, "email": null, "phone": null, "legal_entity_identifier": null, "location_of_registration": null, "financial_summary": {}, "officers": [], "beneficial_owners": [], "addresses": null, "industries": null, "accounts": null, "registry_data": {}, "user_provided_data": null, "confirmed_by_user_at": null, "last_console_edit_at": null, "is_editable": true, "registry_tier_delivered": null, "registry_ownership_status": "pending" }, "vendor_data": "company-1234", "metadata": null, "created_at": "2026-06-11T10:45:00.000000+00:00", "registry_tier_delivered": null, "registry_tier_requested": "shareholders" } } } } } } } } }, "/v3/kyb/ubo/": { "post": { "summary": "Empresa del registro KYB con beneficiarios finales (independiente)", "operationId": "post_v3_kyb_ubo", "x-didit-sdk": { "resource": "kyb", "method": "list_ubos", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [], "description": "Obtén el perfil Lite, los accionistas directos **y los beneficiarios finales últimos** determinados a través de la cadena de propiedad (`registry_data.ubo_resolution` contiene la cadena de matrices corporativas) de un candidato devuelto por `POST /v3/kyb/search/`.\n\n**Relación con la búsqueda.** Pasa el `kyb_response_id` del candidato tal como lo devolvió una búsqueda de la misma aplicación. Busca en el nivel que quieres comprar (`tier` en `POST /v3/kyb/search/`), porque la búsqueda se ejecuta en la cadena de registros que sirve ese nivel, y una búsqueda Lite sin resultados no demuestra que el registro no tenga la empresa. Cuando los datos de propiedad del país están en otro registro, Didit vuelve a localizar allí la empresa por su número de registro, sin coste adicional.\n\n**Facturación.** Se factura al precio del nivel UBO del país; consulta [precios de registros KYB](/es/getting-started/kyb-registry-pricing). El nivel entregado es el más alto que el país y el registro pueden ofrecer: Shareholders cuando el informe resuelto no identifica a ninguna persona física como beneficiario final, y Lite cuando no existe ningún dato de propiedad; `registry_tier_delivered` indica lo que se facturó. El saldo se comprueba contra el precio del nivel UBO antes de cualquier llamada al registro (`403` si no es suficiente).\n\n**Disponibilidad.** Solo en v3. Cada llamada crea una sesión de empresa (su id es el `request_id`).\n\n**Informes pendientes.** Cuando un informe todavía se está preparando, o la sección de propiedad aún no se ha obtenido del registro, el endpoint devuelve 202 Accepted, kyb_registry.fetch_status=pending, kyb_registry.registry_ownership_status=pending y registry_tier_delivered=null. Conserva request_id y consulta GET /v3/session/{request_id}/decision/ hasta que registry_checks[0].company.fetch_status se resuelva. Didit completa el informe automáticamente y cobra el nivel entregado cuando está listo. No repitas la compra mientras esté pendiente: cada nuevo POST crea una solicitud independiente.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KYBRegistryCandidateRequest" }, "example": { "kyb_response_id": "69aeeb95febb0f1704042259", "vendor_data": "company-1234" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/kyb/ubo/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"kyb_response_id\": \"69aeeb95febb0f1704042259\",\n \"vendor_data\": \"company-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.kyb.list_ubos(\n kyb_response_id=\"69aeeb95febb0f1704042259\",\n vendor_data=\"company-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.kyb.listUbos({\n kyb_response_id: \"69aeeb95febb0f1704042259\",\n vendor_data: \"company-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.KYB.ListUBOs(ctx, didit.KYBRegistryCandidateRequest{\n\tKYBResponseID: \"69aeeb95febb0f1704042259\",\n\tVendorData: didit.String(\"company-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.KYBRegistryCandidateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.kyb().listUbos(KYBRegistryCandidateRequest.builder()\n .kybResponseId(\"69aeeb95febb0f1704042259\")\n .vendorData(\"company-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "kyb->listUbos([\n 'kyb_response_id' => '69aeeb95febb0f1704042259',\n 'vendor_data' => 'company-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.kyb.list_ubos(\n kyb_response_id: \"69aeeb95febb0f1704042259\",\n vendor_data: \"company-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Kyb.ListUbosAsync(new KYBRegistryCandidateRequest\n{\n KybResponseId = \"69aeeb95febb0f1704042259\",\n VendorData = \"company-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Informe de empresa devuelto y facturado en el nivel entregado. Los informes de propiedad que aún se están preparando pueden devolver 202; conserva request_id para recuperar su decisión guardada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sesión de empresa creada para esta consulta. El registro almacenado (visible en la consola) se sigue actualizando si el registro de empresas responde después de la respuesta." }, "registry_tier_requested": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "El nivel que vende este endpoint: `basic` (Lite) para países seleccionados, `shareholders`, `ubo`." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "El nivel realmente entregado y facturado. Es inferior al solicitado cuando los registros del país no contienen datos de propiedad, cuando el registro no tiene ningún registro de propiedad para esta empresa o cuando el informe resuelto de una solicitud `ubo` no nombra a ninguna persona física como beneficiario final.", "nullable": true }, "kyb_registry": { "type": "object", "description": "Perfil completo de la empresa en el registro.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID de Didit de este registro de empresa." }, "node_id": { "type": "string", "example": "feature_kyb_registry" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review" ], "description": "Evaluación de Didit de la comprobación en el registro (p. ej., `In Review` cuando la empresa no está activa en el registro o no se pudieron derivar los datos de propiedad)." }, "registry_status": { "type": "string", "nullable": true, "enum": [ "active", "dissolved", "deregistered", "see full details", "authorised", "appointed representative", "unauthorised", "inactive", "no longer authorised", "closed", "struck off", null ], "description": "Estado normalizado de la empresa según lo informa el registro." }, "data_resolved": { "type": "boolean", "description": "`true` una vez que el registro de empresas devolvió el perfil completo. `false` cuando el registro de empresas seguía procesando tras el sondeo: los datos almacenados se completan automáticamente cuando el registro de empresas lo resuelve." }, "company_name": { "type": "string", "example": "Tesco PLC" }, "registration_number": { "type": "string", "nullable": true, "example": "00445790" }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2.", "example": "GB" }, "region": { "type": "string", "nullable": true, "description": "Código de subdivisión cuando el registro es regional (p. ej., `CA` para `US-CA`); vacío en caso contrario." }, "company_type": { "type": "string", "nullable": true, "example": "Public Limited Company" }, "incorporation_date": { "type": "string", "format": "date", "nullable": true, "example": "1947-11-27" }, "registered_address": { "type": "string", "nullable": true, "example": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA" }, "tax_number": { "type": "string", "nullable": true, "example": "GB412 8925 93" }, "risk_level": { "type": "string", "nullable": true, "description": "Nivel de riesgo según el registro, cuando está disponible." }, "verification_status": { "type": "string", "nullable": true, "description": "Estado de verificación en el registro, cuando está disponible." }, "is_from_registry": { "type": "boolean", "description": "Siempre `true` en este endpoint: el perfil se obtuvo de un registro oficial." }, "fetch_status": { "type": "string", "enum": [ "pending", "resolved" ], "description": "Ciclo de vida de la consulta al registro. Se refleja en `data_resolved`." }, "alternative_names": { "type": "string", "nullable": true, "description": "Nombres alternativos, comerciales, anteriores o en el idioma original de la empresa, como texto, cuando se informan." }, "nature_of_business": { "type": "string", "nullable": true, "description": "Descripción de la actividad o código de clasificación, cuando se informa." }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Importe decimal como cadena, cuando se informa." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Código ISO 4217, cuando se informa." }, "website": { "type": "string", "nullable": true, "example": "https://www.tesco.com/" }, "email": { "type": "string", "nullable": true, "example": "customer.service@tesco.co.uk" }, "phone": { "type": "string", "nullable": true, "example": "03301231688" }, "legal_entity_identifier": { "type": "string", "nullable": true, "description": "LEI, cuando se informa." }, "location_of_registration": { "type": "string", "nullable": true, "description": "Registro o jurisdicción en la que está inscrita la empresa, cuando se indica." }, "vat_number": { "type": "string", "nullable": true, "description": "Número de IVA de la UE, cuando se recopila durante el paso de registro alojado o se edita después. En el momento de la selección normalmente todavía no está definido: la validación del IVA y de la identificación fiscal se ejecuta cuando el usuario final envía el paso de registro en el flujo alojado." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Resultado de validar el número de IVA o, si no lo hay, el `tax_number`, al enviar al registro. `valid` / `invalid`: lo decide el registro oficial del país (VIES de la UE, Noruega, Suiza, Brasil, Colombia, Costa Rica, Ecuador, Paraguay; Polonia también mediante su registro nacional de IVA). `format_valid` / `invalid_format`: lo deciden las reglas de formato y dígito de control del país cuando no se puede consultar ningún registro. `could_not_validate`: el registro no estaba disponible. `not_applicable`: no hay número, el país no tiene registro ni reglas, o es una sesión de sandbox." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "El número que se comprobó, tal como lo conoce la fuente (por ejemplo, el número de IVA derivado de un SIREN francés o de un RSIN neerlandés). `null` cuando no se realizó ninguna comprobación." }, "vat_validation_source": { "type": "string", "nullable": true, "enum": [ "eu_vies", "pl_vat_white_list", "no_brreg", "ch_uid_register", "br_receita_federal", "co_rues", "cr_hacienda", "ec_sri", "py_dnit", "format_rules", null ], "description": "La fuente que determinó `vat_validation_status`: un registro oficial o `format_rules`. `null` cuando no se ejecutó ninguna comprobación." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Nombre registrado en la fuente que validó el número, cuando la fuente lo revela. Solo se informa cuando el estado es `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Dirección registrada en la fuente que validó el número, cuando esta la facilita. Solo se establece cuando el estado es `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de tiempo de la comprobación. `null` cuando no se ejecutó ninguna comprobación." }, "financial_summary": { "type": "object", "nullable": true, "description": "Detalles de acciones y capital según el registro (moneda, total de acciones, clases de acciones), cuando están disponibles." }, "officers": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "example": "MELISSA BETHELL" }, "designation": { "type": "string", "nullable": true, "description": "Designación del registro sin procesar (p. ej., `Director`, `Secretary`)." }, "role": { "type": "string", "description": "Rol normalizado derivado del cargo. Conjunto completo del modelo de 17 valores; el análisis del registro en este endpoint suele devolver director, non_executive_director, secretary, chairman o company_officer.", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "company_officer", "settlor", "protector", "investor", "other" ] }, "nationality": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "description": "`false` cuando el registro marca el nombramiento como dimitido." }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending", null ], "description": "Estado de una sesión KYC asociada, cuando se inició una para este directivo. `null` en caso contrario." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "URL de verificación de la sesión de KYC asociada, si existe." }, "first_name": { "type": "string", "nullable": true, "description": "Nombre de pila cuando el registro lo indica explícitamente; no se deduce del nombre completo." }, "last_name": { "type": "string", "nullable": true, "description": "Apellido, cuando el registro lo indica explícitamente." }, "address": { "type": "string", "nullable": true, "description": "Dirección del directivo según el registro." }, "appointment_date": { "type": "string", "nullable": true, "description": "Fecha en que se nombró al cargo.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Fecha en que terminó el nombramiento, cuando se informa.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Fecha de nacimiento completa según el registro. Es null cuando solo se conoce el año o el mes de nacimiento.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Año de nacimiento según el registro, incluso cuando la fecha completa no está disponible." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Mes de nacimiento según el registro. Null cuando solo se conoce el año." } } }, "description": "Directores, secretarios y otros administradores extraídos del registro." }, "beneficial_owners": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Si el propietario es una persona física o una persona jurídica." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles normalizados (por ejemplo, `ubo`, `shareholder`)." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Límite inferior de la franja de propiedad informada por el registro (por ejemplo, `25%`)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Límite superior del rango de propiedad informado por el registro." }, "is_active": { "type": "boolean" }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending", null ] }, "kyc_session_url": { "type": "string", "nullable": true }, "effective_ownership_percent": { "type": "number", "nullable": true, "description": "Porcentaje de propiedad analizado (límite máximo, con el límite mínimo como alternativa)." }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "country_of_birth": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "designation": { "type": "string", "nullable": true }, "voting_min_shares": { "type": "string", "nullable": true }, "voting_max_shares": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "nullable": true, "description": "Fecha de nacimiento completa, cuando se informa.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Fecha de nombramiento, cuando se informa.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } }, "description": "Beneficiarios finales / personas con control significativo extraídos del registro. Puede estar vacío cuando el registro no expone la propiedad." }, "addresses": { "type": "array", "nullable": true, "description": "Todas las direcciones que indica el registro, con una única forma canónica. Es null si no indica ninguna.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "Las actividades en las que el registro clasifica a la empresa, con una única forma canónica. Es null cuando no indica ninguna.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Fechas de presentación ante el registro, cuando están disponibles. Las declaraciones anuales y las juntas generales usan last_annual_return_date y last_agm_date; son distintas de las cuentas financieras." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "description": "Siempre `null` en este endpoint (lo usa el flujo de KYB alojado cuando los usuarios finales editan los datos del registro)." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Siempre `null` en este endpoint." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Se establece cuando un revisor de la consola edita el registro más adelante." }, "is_editable": { "type": "boolean", "description": "Si los datos procedentes del registro aún se pueden editar en el flujo alojado o en la consola." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "Igual que `registry_tier_delivered` del nivel superior.", "nullable": true }, "registry_ownership_status": { "type": "string", "nullable": true, "enum": [ "not_requested", "delivered", "not_held", "unavailable", "pending", null ], "description": "`delivered` cuando se recibieron los datos de propiedad, `not_held` cuando el registro de propiedad respondió y no incluye esta empresa (consulta `registry_data.ownership_error`), `unavailable` cuando se solicitó un nivel con propiedad pero el registro no tenía datos de esta empresa o no se pudo consultar (consulta `registry_data.ownership_error`), `pending` cuando la sección de propiedad aún no se ha obtenido del registro y Didit todavía la está completando, `not_requested` en el nivel Lite." }, "ownership": { "$ref": "#/components/schemas/KYBRegistryOwnership" }, "registry_tier": { "type": "string", "nullable": true, "description": "El nivel de registro que solicitó el flujo: `basic`, `shareholders` o `ubo`. También en `ownership.tier_requested`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "El monitor de registro más reciente de la empresa, o `null` si no existe ninguno.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "unavailable_reason": { "type": "string", "nullable": true }, "enrolled_at": { "type": "string", "format": "date-time", "nullable": true }, "cancelled_at": { "type": "string", "format": "date-time", "nullable": true }, "last_bill_date": { "type": "string", "format": "date", "nullable": true }, "next_bill_date": { "type": "string", "format": "date", "nullable": true }, "last_event_at": { "type": "string", "format": "date-time", "nullable": true }, "events_count": { "type": "integer" }, "watched_fields": { "description": "Los campos de la empresa que vigila el monitor." } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste." }, "metadata": { "type": "object", "nullable": true, "description": "Devuelve el `metadata` que enviaste." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved company": { "summary": "Perfil completo del registro (lista de cargos truncada por brevedad)", "value": { "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e", "kyb_registry": { "uuid": "f1e2d3c4-b5a6-4789-9c0d-1e2f3a4b5c6d", "node_id": "feature_kyb_registry", "status": "In Review", "registry_status": "active", "data_resolved": true, "company_name": "Tesco PLC", "registration_number": "00445790", "country_code": "GB", "region": "", "company_type": "Public Limited Company", "incorporation_date": "1947-11-27", "registered_address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA", "tax_number": "GB412 8925 93", "risk_level": "low risk", "verification_status": "verified", "is_from_registry": true, "fetch_status": "resolved", "alternative_names": "TESCO STORES (HOLDINGS) PUBLIC LIMITED COMPANY", "nature_of_business": null, "registered_capital": null, "registered_capital_amount": null, "registered_capital_currency": null, "website": "https://www.tesco.com/", "email": "customer.service@tesco.co.uk", "phone": "03301231688", "legal_entity_identifier": null, "location_of_registration": null, "financial_summary": { "currency": "Pound (£)", "total_number_of_shares": "8174378721", "meta_detail": { "Class_Of_Share": "Ordinary" } }, "officers": [ { "uuid": "a1b2c3d4-e5f6-4789-9a0b-1c2d3e4f5a6b", "name": "CHRISTOPHER JON TAYLOR", "designation": "Secretary", "role": "secretary", "nationality": null, "is_active": true, "kyc_status": null, "kyc_session_url": null }, { "uuid": "b2c3d4e5-f6a7-4890-8b1c-2d3e4f5a6b7c", "name": "MELISSA BETHELL", "designation": "Director", "role": "director", "nationality": "British", "is_active": true, "kyc_status": null, "kyc_session_url": null } ], "beneficial_owners": [], "addresses": [ { "address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA", "type": "legal_entity_registry_address", "description": "registered office address" } ], "industries": null, "accounts": { "last_account": "26 February 2025", "next_account": "26 February 2026", "due_by_date": "26 August 2026" }, "registry_data": { "ubo_resolution": { "parent_chain": [], "subsidiaries": [], "unresolved": [] } }, "user_provided_data": null, "confirmed_by_user_at": null, "last_console_edit_at": null, "is_editable": true }, "vendor_data": "company-1234", "metadata": null, "created_at": "2026-06-11T10:45:00.000000+00:00" } } } } } }, "400": { "description": "Error de validación. Los problemas a nivel de campo usan el envoltorio estándar de DRF.", "content": { "application/json": { "examples": { "Missing kyb_response_id": { "summary": "`kyb_response_id` es obligatorio", "value": { "kyb_response_id": [ "This field is required." ] } }, "save_api_request=false rejected": { "summary": "Las selecciones siempre se guardan", "value": { "save_api_request": [ "KYB registry select must be saved so billing and retrieval can be tracked." ] } } } } } }, "403": { "description": "Permiso denegado. Se devuelve cuando falta el encabezado `x-api-key` y también cuando el saldo de la organización que realiza la llamada no la cubre; una clave incorrecta, revocada o expirada devuelve `401`. Si falta la clave, se devuelve `403` con `{\"detail\": ...}`; una clave incorrecta, revocada o expirada devuelve `401`. La falta de créditos devuelve `403` con `{\"error\": ...}` antes de que se realice cualquier análisis o llamada a un proveedor.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de la organización no cubre la llamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Límite de solicitudes superado. Todos los endpoints POST/PATCH/DELETE comparten un presupuesto de 300 solicitudes de escritura por minuto por clave de API. La respuesta incluye los encabezados `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` y `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Más de 300 solicitudes de escritura en el minuto actual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "202": { "description": "Informe aceptado y todavía en proceso. Cuando un informe aún se está preparando, el endpoint devuelve 202 Accepted, kyb_registry.fetch_status=pending y registry_tier_delivered=null. Guarda request_id y consulta GET /v3/session/{request_id}/decision/ hasta que registry_checks[0].company.fetch_status se resuelva. Didit completa el informe automáticamente y cobra el nivel entregado en cuanto está listo. No repitas la compra mientras esté pendiente; cada nuevo POST crea una solicitud independiente.", "content": { "application/json": { "schema": { "$ref": "#/paths/~1v3~1kyb~1ubo~1/post/responses/200/content/application~1json/schema" }, "examples": { "Pending (registry still resolving)": { "summary": "El informe de propiedad aún se está procesando; recupera la decisión guardada", "value": { "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e", "kyb_registry": { "uuid": "7c0a4f7e-2b1d-4f6a-9c3e-8d5b2a1f0e9d", "node_id": "feature_kyb_registry", "status": "Not Finished", "registry_status": null, "data_resolved": false, "company_name": "Example Holdings Limited", "registration_number": "12345678", "country_code": "HK", "region": null, "company_type": null, "incorporation_date": null, "registered_address": null, "tax_number": null, "risk_level": null, "verification_status": null, "is_from_registry": true, "fetch_status": "pending", "alternative_names": null, "nature_of_business": null, "registered_capital": null, "registered_capital_amount": null, "registered_capital_currency": null, "website": null, "email": null, "phone": null, "legal_entity_identifier": null, "location_of_registration": null, "financial_summary": {}, "officers": [], "beneficial_owners": [], "addresses": null, "industries": null, "accounts": null, "registry_data": {}, "user_provided_data": null, "confirmed_by_user_at": null, "last_console_edit_at": null, "is_editable": true, "registry_tier_delivered": null, "registry_ownership_status": "pending" }, "vendor_data": "company-1234", "metadata": null, "created_at": "2026-06-11T10:45:00.000000+00:00", "registry_tier_delivered": null, "registry_tier_requested": "ubo" } } } } } } } } }, "/v3/id-verification/wallets/": { "get": { "operationId": "list_wallets", "x-didit-sdk": { "resource": "id_wallets", "method": "list", "auth": "api_key", "server": true }, "description": "Todas las wallets de Digital ID con su endpoint de inicio, sus países, sus campos obligatorios y si esta aplicación puede iniciarlas ahora en este entorno. Que una wallet aparezca en la lista no significa que esté activa.", "summary": "Listar wallets de Digital ID", "tags": [ "Digital ID wallets" ], "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletCatalogResponse" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiClientCredentialsForbiddenErrorMessage" } } }, "description": "Faltan las credenciales (x-api-key o Authorization: Bearer)." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request GET \\\n --url https://verification.didit.me/v3/id-verification/wallets/ \\\n --header 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.list()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.list();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.List(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().list();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->list();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.list\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.ListAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/id-verification/wallets/verifications/{request_id}/": { "get": { "operationId": "get_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "retrieve_verification", "auth": "api_key", "server": true }, "description": "Estado y resultado de una verificación de wallet: la identidad normalizada y los atributos propios de la wallet una vez verificada, el código de error una vez rechazada y la siguiente acción mientras está pendiente. Una verificación que supera expires_at se decide como timeout.", "summary": "Obtener una verificación de wallet", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "El request_id que devolvió el endpoint de inicio.", "required": true } ], "tags": [ "Digital ID wallets" ], "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "ftn", "name": "Finnish Trust Network", "issuing_authority": "Finnish banks and mobile operators (FTN)" }, "country": "FIN", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiClientCredentialsForbiddenErrorMessage" } } }, "description": "Faltan las credenciales (x-api-key o Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error not_found: ninguna verificación de wallet de esta aplicación tiene este request_id." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request GET \\\n --url https://verification.didit.me/v3/id-verification/wallets/verifications/REQUEST_ID/ \\\n --header 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.retrieve_verification(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.retrieveVerification(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.RetrieveVerification(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().retrieveVerification(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->retrieveVerification('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.retrieve_verification(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.RetrieveVerificationAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/id-verification/wallets/verifications/{request_id}/poll/": { "post": { "operationId": "poll_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "poll_verification", "auth": "api_key", "server": true }, "description": "Smart-ID y Mobile-ID: pregunta al proveedor si el usuario confirmó, rechazó o dejó que la solicitud caducara, y verifica la identidad firmada cuando confirmó. Las wallets con redirección se completan a través del navegador del usuario, por lo que para ellas esto solo vuelve a leer la verificación. Responde con la verificación tal como queda después.", "summary": "Consultar el estado de una verificación de wallet", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "El request_id que devolvió el endpoint de inicio.", "required": true } ], "tags": [ "Digital ID wallets" ], "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "smart_id", "name": "Smart-ID", "issuing_authority": "SK ID Solutions" }, "country": "EST", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "in_app", "simulated": true, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "confirm_in_app", "verification_code": "1234", "poll_interval_seconds": 2 }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiClientCredentialsForbiddenErrorMessage" } } }, "description": "Faltan las credenciales (x-api-key o Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error not_found: ninguna verificación de wallet de esta aplicación tiene este request_id." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/verifications/REQUEST_ID/poll/ \\\n --header 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.poll_verification(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.pollVerification(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.PollVerification(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().pollVerification(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->pollVerification('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.poll_verification(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.PollVerificationAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/id-verification/wallets/verifications/{request_id}/cancel/": { "post": { "operationId": "cancel_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "cancel_verification", "auth": "api_key", "server": true }, "description": "Retira una verificación pendiente: se rechaza como cancelada y nunca se factura. Una verificación ya decidida se devuelve sin cambios. Smart-ID y Mobile-ID: una cancelación que llega mientras un sondeo está comprobando el inicio de sesión espera unos segundos a ese sondeo y luego la rechaza, o la devuelve como verificada si el usuario ya había confirmado. Una verificación que el usuario está completando en este momento no se puede cancelar (409 verification_in_progress con Retry-After): vuelve a intentarlo tras ese número de segundos para leer su resultado.", "summary": "Cancelar una verificación de wallet", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "El request_id que devolvió el endpoint de inicio.", "required": true } ], "tags": [ "Digital ID wallets" ], "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "ftn", "name": "Finnish Trust Network", "issuing_authority": "Finnish banks and mobile operators (FTN)" }, "country": "FIN", "status": "Declined", "outcome": "cancelled", "error": "cancelled_by_customer", "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": null, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiClientCredentialsForbiddenErrorMessage" } } }, "description": "Faltan las credenciales (x-api-key o Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error not_found: ninguna verificación de wallet de esta aplicación tiene este request_id." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error verification_in_progress: el usuario está completando este inicio de sesión en este momento. El encabezado Retry-After indica cuándo reintentar; el reintento devuelve la verificación ya decidida." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/verifications/REQUEST_ID/cancel/ \\\n --header 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.cancel_verification(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.cancelVerification(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.CancelVerification(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().cancelVerification(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->cancelVerification('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.cancel_verification(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.CancelVerificationAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/id-verification/wallets/mitid/": { "post": { "operationId": "start_mitid_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_mitid", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con MitID (Danish Agency for Digital Government; DNK) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con MitID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMitidWalletVerificationStartRequest" }, "example": { "country": "DNK", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMitidWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMitidWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "mitid", "name": "MitID", "issuing_authority": "Danish Agency for Digital Government" }, "country": "DNK", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/mitid/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"DNK\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_mitid(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"DNK\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startMitid({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"DNK\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartMitid(ctx, didit.IDWalletsStartMitidParams{\n\tBody: didit.DigitalIDWalletAPIMitidWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIMitidWalletVerificationStartCountryEnum(\"DNK\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiMitidWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiMitidWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startMitid(DigitalIdWalletApiMitidWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiMitidWalletVerificationStartCountryEnum.of(\"DNK\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startMitid([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'DNK',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_mitid(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"DNK\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartMitidAsync(new DigitalIdWalletApiMitidWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiMitidWalletVerificationStartCountryEnum(\"DNK\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "mitid" } }, "/v3/id-verification/wallets/bankid-se/": { "post": { "operationId": "start_bankid_se_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_bankid_se", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con BankID (SWE) (Finansiell ID-Teknik / consorcio bancario; SWE) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con BankID (SWE)", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidSeWalletVerificationStartRequest" }, "example": { "country": "SWE", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidSeWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidSeWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "bankid_se", "name": "BankID", "issuing_authority": "Finansiell ID-Teknik / bank consortium" }, "country": "SWE", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/bankid-se/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"SWE\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_bankid_se(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"SWE\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startBankidSe({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"SWE\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartBankidSe(ctx, didit.IDWalletsStartBankidSeParams{\n\tBody: didit.DigitalIDWalletAPIBankidSeWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountryEe9enum(\"SWE\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiBankidSeWalletVerificationStartRequest;\nimport me.didit.types.DigitalIdWalletApiCountryEe9Enum;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startBankidSe(DigitalIdWalletApiBankidSeWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountryEe9Enum.of(\"SWE\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startBankidSe([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'SWE',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_bankid_se(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"SWE\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartBankidSeAsync(new DigitalIdWalletApiBankidSeWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountryEe9Enum(\"SWE\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "bankid_se" } }, "/v3/id-verification/wallets/bankid-no/": { "post": { "operationId": "start_bankid_no_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_bankid_no", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con BankID (NOR) (BankID BankAxept AS; NOR) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con BankID (NOR)", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidNoWalletVerificationStartRequest" }, "example": { "country": "NOR", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidNoWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidNoWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "bankid_no", "name": "BankID", "issuing_authority": "BankID BankAxept AS" }, "country": "NOR", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/bankid-no/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"NOR\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_bankid_no(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"NOR\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startBankidNo({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NOR\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartBankidNo(ctx, didit.IDWalletsStartBankidNoParams{\n\tBody: didit.DigitalIDWalletAPIBankidNoWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountryAfcEnum(\"NOR\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiBankidNoWalletVerificationStartRequest;\nimport me.didit.types.DigitalIdWalletApiCountryAfcEnum;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startBankidNo(DigitalIdWalletApiBankidNoWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountryAfcEnum.of(\"NOR\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startBankidNo([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'NOR',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_bankid_no(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NOR\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartBankidNoAsync(new DigitalIdWalletApiBankidNoWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountryAfcEnum(\"NOR\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "bankid_no" } }, "/v3/id-verification/wallets/vipps/": { "post": { "operationId": "start_vipps_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_vipps", "auth": "api_key", "server": true }, "description": "Inicia el acceso con Vipps (Vipps MobilePay / BankID NO; NOR) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con Vipps", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiVippsWalletVerificationStartRequest" }, "example": { "country": "NOR", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiVippsWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiVippsWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "vipps", "name": "Vipps", "issuing_authority": "Vipps MobilePay / BankID NO" }, "country": "NOR", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/vipps/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"NOR\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_vipps(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"NOR\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startVipps({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NOR\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartVipps(ctx, didit.IDWalletsStartVippsParams{\n\tBody: didit.DigitalIDWalletAPIVippsWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountryAfcEnum(\"NOR\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiCountryAfcEnum;\nimport me.didit.types.DigitalIdWalletApiVippsWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startVipps(DigitalIdWalletApiVippsWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountryAfcEnum.of(\"NOR\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startVipps([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'NOR',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_vipps(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NOR\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartVippsAsync(new DigitalIdWalletApiVippsWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountryAfcEnum(\"NOR\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "vipps" } }, "/v3/id-verification/wallets/buypass/": { "post": { "operationId": "start_buypass_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_buypass", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con Buypass ID (Buypass AS; NOR) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes redirigir el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o a través del webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con Buypass ID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBuypassWalletVerificationStartRequest" }, "example": { "country": "NOR", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBuypassWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBuypassWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "buypass", "name": "Buypass ID", "issuing_authority": "Buypass AS" }, "country": "NOR", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/buypass/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"NOR\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_buypass(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"NOR\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startBuypass({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NOR\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartBuypass(ctx, didit.IDWalletsStartBuypassParams{\n\tBody: didit.DigitalIDWalletAPIBuypassWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountryAfcEnum(\"NOR\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiBuypassWalletVerificationStartRequest;\nimport me.didit.types.DigitalIdWalletApiCountryAfcEnum;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startBuypass(DigitalIdWalletApiBuypassWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountryAfcEnum.of(\"NOR\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startBuypass([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'NOR',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_buypass(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NOR\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartBuypassAsync(new DigitalIdWalletApiBuypassWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountryAfcEnum(\"NOR\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "buypass" } }, "/v3/id-verification/wallets/itsme/": { "post": { "operationId": "start_itsme_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_itsme", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con itsme (Belgian Mobile ID; BEL, LUX, NLD) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando la identidad queda verificada. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Lee el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar la verificación con itsme", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiItsmeWalletVerificationStartRequest" }, "example": { "country": "BEL", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiItsmeWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiItsmeWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "itsme", "name": "itsme", "issuing_authority": "Belgian Mobile ID" }, "country": "BEL", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/itsme/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"BEL\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_itsme(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"BEL\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startItsme({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"BEL\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartItsme(ctx, didit.IDWalletsStartItsmeParams{\n\tBody: didit.DigitalIDWalletAPIItsmeWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.DigitalIDWalletAPIItsmeWalletVerificationStartCountryEnum(\"BEL\"),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiItsmeWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiItsmeWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startItsme(DigitalIdWalletApiItsmeWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiItsmeWalletVerificationStartCountryEnum.of(\"BEL\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startItsme([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'BEL',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_itsme(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"BEL\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartItsmeAsync(new DigitalIdWalletApiItsmeWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = \"BEL\",\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "itsme" } }, "/v3/id-verification/wallets/idin/": { "post": { "operationId": "start_idin_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_idin", "auth": "api_key", "server": true }, "description": "Inicia el acceso con iDIN (Dutch banks (Currence iDIN); NLD) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar la verificación con iDIN", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiIdinWalletVerificationStartRequest" }, "example": { "country": "NLD", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiIdinWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiIdinWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "idin", "name": "iDIN", "issuing_authority": "Dutch banks (Currence iDIN)" }, "country": "NLD", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/idin/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"NLD\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_idin(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"NLD\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startIdin({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NLD\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartIdin(ctx, didit.IDWalletsStartIdinParams{\n\tBody: didit.DigitalIDWalletAPIIdinWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIIdinWalletVerificationStartCountryEnum(\"NLD\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiIdinWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiIdinWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startIdin(DigitalIdWalletApiIdinWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiIdinWalletVerificationStartCountryEnum.of(\"NLD\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startIdin([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'NLD',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_idin(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NLD\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartIdinAsync(new DigitalIdWalletApiIdinWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiIdinWalletVerificationStartCountryEnum(\"NLD\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "idin" } }, "/v3/id-verification/wallets/ftn/": { "post": { "operationId": "start_ftn_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_ftn", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con Finnish Trust Network (bancos y operadores móviles finlandeses (FTN); FIN) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes redirigir el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o a través del webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con Finnish Trust Network", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFtnWalletVerificationStartRequest" }, "example": { "country": "FIN", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFtnWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFtnWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "ftn", "name": "Finnish Trust Network", "issuing_authority": "Finnish banks and mobile operators (FTN)" }, "country": "FIN", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/ftn/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"FIN\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_ftn(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"FIN\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startFtn({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"FIN\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartFtn(ctx, didit.IDWalletsStartFtnParams{\n\tBody: didit.DigitalIDWalletAPIFtnWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIFtnWalletVerificationStartCountryEnum(\"FIN\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiFtnWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiFtnWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startFtn(DigitalIdWalletApiFtnWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiFtnWalletVerificationStartCountryEnum.of(\"FIN\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startFtn([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'FIN',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_ftn(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"FIN\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartFtnAsync(new DigitalIdWalletApiFtnWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiFtnWalletVerificationStartCountryEnum(\"FIN\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "ftn" } }, "/v3/id-verification/wallets/personalausweis/": { "post": { "operationId": "start_personalausweis_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_personalausweis", "auth": "api_key", "server": true }, "description": "Inicia el acceso con Personalausweis (Bundesministerium des Innern (eID); DEU) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con Personalausweis", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiPersonalausweisWalletVerificationStartRequest" }, "example": { "country": "DEU", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiPersonalausweisWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiPersonalausweisWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "personalausweis", "name": "Personalausweis", "issuing_authority": "Bundesministerium des Innern (eID)" }, "country": "DEU", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/personalausweis/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"DEU\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_personalausweis(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"DEU\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startPersonalausweis({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"DEU\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartPersonalausweis(ctx, didit.IDWalletsStartPersonalausweisParams{\n\tBody: didit.DigitalIDWalletAPIPersonalausweisWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIPersonalausweisWalletVerificationStartCountryEnum(\"DEU\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiPersonalausweisWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiPersonalausweisWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startPersonalausweis(DigitalIdWalletApiPersonalausweisWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiPersonalausweisWalletVerificationStartCountryEnum.of(\"DEU\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startPersonalausweis([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'DEU',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_personalausweis(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"DEU\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartPersonalausweisAsync(new DigitalIdWalletApiPersonalausweisWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiPersonalausweisWalletVerificationStartCountryEnum(\"DEU\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "personalausweis" } }, "/v3/id-verification/wallets/frejaid/": { "post": { "operationId": "start_frejaid_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_frejaid", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con Freja eID (Freja eID Group; SWE) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con Freja eID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFrejaidWalletVerificationStartRequest" }, "example": { "country": "SWE", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFrejaidWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFrejaidWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "frejaid", "name": "Freja eID", "issuing_authority": "Freja eID Group" }, "country": "SWE", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/frejaid/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"SWE\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_frejaid(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"SWE\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startFrejaid({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"SWE\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartFrejaid(ctx, didit.IDWalletsStartFrejaidParams{\n\tBody: didit.DigitalIDWalletAPIFrejaidWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountryEe9enum(\"SWE\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiCountryEe9Enum;\nimport me.didit.types.DigitalIdWalletApiFrejaidWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startFrejaid(DigitalIdWalletApiFrejaidWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountryEe9Enum.of(\"SWE\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startFrejaid([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'SWE',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_frejaid(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"SWE\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartFrejaidAsync(new DigitalIdWalletApiFrejaidWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountryEe9Enum(\"SWE\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "frejaid" } }, "/v3/id-verification/wallets/uae-pass/": { "post": { "operationId": "start_uae_pass_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_uae_pass", "auth": "api_key", "server": true }, "description": "Inicia el acceso con UAE PASS (UAE Digital Government Authority; ARE) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con UAE PASS", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiUaePassWalletVerificationStartRequest" }, "example": { "country": "ARE", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiUaePassWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiUaePassWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "uae_pass", "name": "UAE PASS", "issuing_authority": "UAE Digital Government Authority" }, "country": "ARE", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/uae-pass/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"ARE\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_uae_pass(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"ARE\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startUaePass({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"ARE\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartUaePass(ctx, didit.IDWalletsStartUaePassParams{\n\tBody: didit.DigitalIDWalletAPIUaePassWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIUaePassWalletVerificationStartCountryEnum(\"ARE\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiUaePassWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startUaePass(DigitalIdWalletApiUaePassWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum.of(\"ARE\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startUaePass([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'ARE',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_uae_pass(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"ARE\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartUaePassAsync(new DigitalIdWalletApiUaePassWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum(\"ARE\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "uae_pass" } }, "/v3/id-verification/wallets/govbr/": { "post": { "operationId": "start_govbr_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_govbr", "auth": "api_key", "server": true }, "description": "Inicia el acceso con gov.br (Governo Federal do Brasil; BRA) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar la verificación con gov.br", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGovbrWalletVerificationStartRequest" }, "example": { "country": "BRA", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGovbrWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGovbrWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "govbr", "name": "gov.br", "issuing_authority": "Governo Federal do Brasil" }, "country": "BRA", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/govbr/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"BRA\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_govbr(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"BRA\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startGovbr({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"BRA\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartGovbr(ctx, didit.IDWalletsStartGovbrParams{\n\tBody: didit.DigitalIDWalletAPIGovbrWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIGovbrWalletVerificationStartCountryEnum(\"BRA\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiGovbrWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiGovbrWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startGovbr(DigitalIdWalletApiGovbrWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiGovbrWalletVerificationStartCountryEnum.of(\"BRA\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startGovbr([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'BRA',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_govbr(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"BRA\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartGovbrAsync(new DigitalIdWalletApiGovbrWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiGovbrWalletVerificationStartCountryEnum(\"BRA\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "govbr" } }, "/v3/id-verification/wallets/oneid/": { "post": { "operationId": "start_oneid_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_oneid", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con OneID (OneID (identidad verificada por bancos del Reino Unido); GBR) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con OneID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiOneidWalletVerificationStartRequest" }, "example": { "country": "GBR", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiOneidWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiOneidWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "oneid", "name": "OneID", "issuing_authority": "OneID (UK bank-verified identity)" }, "country": "GBR", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/oneid/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"GBR\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_oneid(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"GBR\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startOneid({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"GBR\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartOneid(ctx, didit.IDWalletsStartOneidParams{\n\tBody: didit.DigitalIDWalletAPIOneidWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountry520enum(\"GBR\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiCountry520Enum;\nimport me.didit.types.DigitalIdWalletApiOneidWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startOneid(DigitalIdWalletApiOneidWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountry520Enum.of(\"GBR\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startOneid([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'GBR',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_oneid(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"GBR\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartOneidAsync(new DigitalIdWalletApiOneidWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountry520Enum(\"GBR\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "oneid" } }, "/v3/id-verification/wallets/govuk-wallet/": { "post": { "operationId": "start_govuk_wallet_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_govuk_wallet", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con GOV.UK Wallet (UK Government Digital Service; GBR) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con GOV.UK Wallet", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGovukWalletWalletVerificationStartRequest" }, "example": { "country": "GBR", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGovukWalletWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGovukWalletWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "govuk_wallet", "name": "GOV.UK Wallet", "issuing_authority": "UK Government Digital Service" }, "country": "GBR", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/govuk-wallet/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"GBR\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_govuk_wallet(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"GBR\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startGovukWallet({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"GBR\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartGovukWallet(ctx, didit.IDWalletsStartGovukWalletParams{\n\tBody: didit.DigitalIDWalletAPIGovukWalletWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountry520enum(\"GBR\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiCountry520Enum;\nimport me.didit.types.DigitalIdWalletApiGovukWalletWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startGovukWallet(DigitalIdWalletApiGovukWalletWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountry520Enum.of(\"GBR\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startGovukWallet([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'GBR',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_govuk_wallet(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"GBR\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartGovukWalletAsync(new DigitalIdWalletApiGovukWalletWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountry520Enum(\"GBR\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "govuk_wallet" } }, "/v3/id-verification/wallets/smart-id/": { "post": { "operationId": "start_smart_id_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_smart_id", "auth": "api_key", "server": true }, "description": "Inicia el acceso con Smart-ID (SK ID Solutions; EST, LVA, LTU, BEL) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=confirm_in_app con el código de comparación que debes mostrar al usuario; el usuario lo confirma e introduce su PIN en la app (nunca recopiles el PIN). Consulta POST /v3/id-verification/wallets/verifications/{request_id}/poll/ cada poll_interval_seconds, o confía en el webhook: Didit también consulta el estado en segundo plano. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con Smart-ID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiSmartIdWalletVerificationStartRequest" }, "example": { "country": "EST", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "personal_code": "00000000000" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiSmartIdWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiSmartIdWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "smart_id", "name": "Smart-ID", "issuing_authority": "SK ID Solutions" }, "country": "EST", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "in_app", "simulated": true, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "confirm_in_app", "verification_code": "1234", "poll_interval_seconds": 2 }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/smart-id/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"EST\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"personal_code\": \"00000000000\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_smart_id(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"EST\",\n personal_code=\"00000000000\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startSmartId({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"EST\",\n personal_code: \"00000000000\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartSmartID(ctx, didit.IDWalletsStartSmartIDParams{\n\tBody: didit.DigitalIDWalletAPISmartIDWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.DigitalIDWalletAPISmartIDWalletVerificationStartCountryEnum(\"EST\"),\n\t\tPersonalCode: \"00000000000\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiSmartIdWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiSmartIdWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startSmartId(DigitalIdWalletApiSmartIdWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiSmartIdWalletVerificationStartCountryEnum.of(\"EST\"))\n .personalCode(\"00000000000\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startSmartId([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'EST',\n 'personal_code' => '00000000000',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_smart_id(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"EST\",\n personal_code: \"00000000000\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartSmartIdAsync(new DigitalIdWalletApiSmartIdWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = \"EST\",\n PersonalCode = \"00000000000\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "smart_id" } }, "/v3/id-verification/wallets/mobile-id/": { "post": { "operationId": "start_mobile_id_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_mobile_id", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con Mobile-ID (SK ID Solutions con los operadores móviles nacionales; EST, LTU) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=confirm_in_app con el código de comparación que debes mostrar al usuario; el usuario lo confirma e introduce su PIN en la app (nunca recopiles el PIN). Consulta POST /v3/id-verification/wallets/verifications/{request_id}/poll/ cada poll_interval_seconds o confía en el webhook: Didit también consulta el estado en segundo plano. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con Mobile-ID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMobileIdWalletVerificationStartRequest" }, "example": { "country": "EST", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "personal_code": "00000000000", "phone_number": "+37200000000" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMobileIdWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMobileIdWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "mobile_id", "name": "Mobile-ID", "issuing_authority": "SK ID Solutions with the national mobile operators" }, "country": "EST", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "in_app", "simulated": true, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "confirm_in_app", "verification_code": "1234", "poll_interval_seconds": 2 }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/mobile-id/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"EST\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"personal_code\": \"00000000000\",\n \"phone_number\": \"+37200000000\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_mobile_id(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"EST\",\n personal_code=\"00000000000\",\n phone_number=\"+37200000000\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startMobileId({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"EST\",\n personal_code: \"00000000000\",\n phone_number: \"+37200000000\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartMobileID(ctx, didit.IDWalletsStartMobileIDParams{\n\tBody: didit.DigitalIDWalletAPIMobileIDWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.DigitalIDWalletAPIMobileIDWalletVerificationStartCountryEnum(\"EST\"),\n\t\tPersonalCode: \"00000000000\",\n\t\tPhoneNumber: \"+37200000000\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiMobileIdWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiMobileIdWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startMobileId(DigitalIdWalletApiMobileIdWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiMobileIdWalletVerificationStartCountryEnum.of(\"EST\"))\n .personalCode(\"00000000000\")\n .phoneNumber(\"+37200000000\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startMobileId([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'EST',\n 'personal_code' => '00000000000',\n 'phone_number' => '+37200000000',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_mobile_id(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"EST\",\n personal_code: \"00000000000\",\n phone_number: \"+37200000000\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartMobileIdAsync(new DigitalIdWalletApiMobileIdWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = \"EST\",\n PersonalCode = \"00000000000\",\n PhoneNumber = \"+37200000000\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "mobile_id" } }, "/v3/id-verification/wallets/idcard-ee/": { "post": { "operationId": "start_idcard_ee_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_idcard_ee", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con Estonian ID-card (Police and Border Guard Board (Estonia); EST) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes redirigir el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o a través del webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con la tarjeta de identidad estonia", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiIdcardEeWalletVerificationStartRequest" }, "example": { "country": "EST", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiIdcardEeWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiIdcardEeWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "idcard_ee", "name": "Estonian ID-card", "issuing_authority": "Police and Border Guard Board (Estonia)" }, "country": "EST", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/idcard-ee/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"EST\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_idcard_ee(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"EST\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startIdcardEe({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"EST\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartIdcardEe(ctx, didit.IDWalletsStartIdcardEeParams{\n\tBody: didit.DigitalIDWalletAPIIdcardEeWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIIdcardEeWalletVerificationStartCountryEnum(\"EST\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiIdcardEeWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startIdcardEe(DigitalIdWalletApiIdcardEeWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum.of(\"EST\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startIdcardEe([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'EST',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_idcard_ee(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"EST\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartIdcardEeAsync(new DigitalIdWalletApiIdcardEeWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum(\"EST\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "idcard_ee" } }, "/v3/id-verification/wallets/eparaksts-mobile/": { "post": { "operationId": "start_eparaksts_mobile_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_eparaksts_mobile", "auth": "api_key", "server": true }, "description": "Inicia el acceso con eParaksts mobile (LVRTC (Latvian State Radio and Television Centre); LVA) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar la verificación móvil con eParaksts", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest" }, "example": { "country": "LVA", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "eparaksts_mobile", "name": "eParaksts mobile", "issuing_authority": "LVRTC (Latvian State Radio and Television Centre)" }, "country": "LVA", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/eparaksts-mobile/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"LVA\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_eparaksts_mobile(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"LVA\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startEparakstsMobile({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"LVA\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartEparakstsMobile(ctx, didit.IDWalletsStartEparakstsMobileParams{\n\tBody: didit.DigitalIDWalletAPIEparakstsMobileWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIEparakstsMobileWalletVerificationStartCountryEnum(\"LVA\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiEparakstsMobileWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startEparakstsMobile(DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiEparakstsMobileWalletVerificationStartCountryEnum.of(\"LVA\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startEparakstsMobile([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'LVA',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_eparaksts_mobile(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"LVA\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartEparakstsMobileAsync(new DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiEparakstsMobileWalletVerificationStartCountryEnum(\"LVA\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "eparaksts_mobile" } }, "/v3/id-verification/wallets/bankid-cz/": { "post": { "operationId": "start_bankid_cz_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_bankid_cz", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con Bank iD (Bankovní identita, a.s.; CZE) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con Bank iD", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidCzWalletVerificationStartRequest" }, "example": { "country": "CZE", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidCzWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidCzWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "bankid_cz", "name": "Bank iD", "issuing_authority": "Bankovní identita, a.s." }, "country": "CZE", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/bankid-cz/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"CZE\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_bankid_cz(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"CZE\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startBankidCz({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"CZE\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartBankidCz(ctx, didit.IDWalletsStartBankidCzParams{\n\tBody: didit.DigitalIDWalletAPIBankidCzWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountryE2dEnum(\"CZE\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiBankidCzWalletVerificationStartRequest;\nimport me.didit.types.DigitalIdWalletApiCountryE2dEnum;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startBankidCz(DigitalIdWalletApiBankidCzWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountryE2dEnum.of(\"CZE\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startBankidCz([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'CZE',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_bankid_cz(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"CZE\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartBankidCzAsync(new DigitalIdWalletApiBankidCzWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountryE2dEnum(\"CZE\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "bankid_cz" } }, "/v3/id-verification/wallets/mojeid/": { "post": { "operationId": "start_mojeid_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_mojeid", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con MojeID (CZ.NIC; CZE) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con MojeID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMojeidWalletVerificationStartRequest" }, "example": { "country": "CZE", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMojeidWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMojeidWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "mojeid", "name": "MojeID", "issuing_authority": "CZ.NIC" }, "country": "CZE", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/mojeid/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"CZE\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_mojeid(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"CZE\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startMojeid({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"CZE\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartMojeid(ctx, didit.IDWalletsStartMojeidParams{\n\tBody: didit.DigitalIDWalletAPIMojeidWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountryE2dEnum(\"CZE\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiCountryE2dEnum;\nimport me.didit.types.DigitalIdWalletApiMojeidWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startMojeid(DigitalIdWalletApiMojeidWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountryE2dEnum.of(\"CZE\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startMojeid([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'CZE',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_mojeid(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"CZE\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartMojeidAsync(new DigitalIdWalletApiMojeidWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountryE2dEnum(\"CZE\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "mojeid" } }, "/v3/id-verification/wallets/diia/": { "post": { "operationId": "start_diia_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_diia", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con Diia (Ministry of Digital Transformation of Ukraine; UKR) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes redirigir el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o a través del webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con Diia", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiDiiaWalletVerificationStartRequest" }, "example": { "country": "UKR", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiDiiaWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiDiiaWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "diia", "name": "Diia", "issuing_authority": "Ministry of Digital Transformation of Ukraine" }, "country": "UKR", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/diia/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"UKR\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_diia(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"UKR\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startDiia({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"UKR\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartDiia(ctx, didit.IDWalletsStartDiiaParams{\n\tBody: didit.DigitalIDWalletAPIDiiaWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIDiiaWalletVerificationStartCountryEnum(\"UKR\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiDiiaWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiDiiaWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startDiia(DigitalIdWalletApiDiiaWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiDiiaWalletVerificationStartCountryEnum.of(\"UKR\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startDiia([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'UKR',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_diia(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"UKR\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartDiiaAsync(new DigitalIdWalletApiDiiaWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiDiiaWalletVerificationStartCountryEnum(\"UKR\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "diia" } }, "/v3/id-verification/wallets/franceconnect/": { "post": { "operationId": "start_franceconnect_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_franceconnect", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con FranceConnect (DINUM (Estado francés); FRA) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes redirigir el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o a través del webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con FranceConnect", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFranceconnectWalletVerificationStartRequest" }, "example": { "country": "FRA", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFranceconnectWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFranceconnectWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "franceconnect", "name": "FranceConnect", "issuing_authority": "DINUM (French state)" }, "country": "FRA", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/franceconnect/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"FRA\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_franceconnect(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"FRA\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startFranceconnect({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"FRA\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartFranceconnect(ctx, didit.IDWalletsStartFranceconnectParams{\n\tBody: didit.DigitalIDWalletAPIFranceconnectWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIFranceconnectWalletVerificationStartCountryEnum(\"FRA\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiFranceconnectWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiFranceconnectWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startFranceconnect(DigitalIdWalletApiFranceconnectWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiFranceconnectWalletVerificationStartCountryEnum.of(\"FRA\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startFranceconnect([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'FRA',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_franceconnect(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"FRA\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartFranceconnectAsync(new DigitalIdWalletApiFranceconnectWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiFranceconnectWalletVerificationStartCountryEnum(\"FRA\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "franceconnect" } }, "/v3/id-verification/wallets/audkenni/": { "post": { "operationId": "start_audkenni_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_audkenni", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con Auðkenni (Auðkenni (identificación electrónica islandesa); ISL) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes enviar el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o desde el webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con Auðkenni", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiAudkenniWalletVerificationStartRequest" }, "example": { "country": "ISL", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiAudkenniWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiAudkenniWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "audkenni", "name": "Auðkenni", "issuing_authority": "Auðkenni (Icelandic electronic ID)" }, "country": "ISL", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/audkenni/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"ISL\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_audkenni(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"ISL\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startAudkenni({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"ISL\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartAudkenni(ctx, didit.IDWalletsStartAudkenniParams{\n\tBody: didit.DigitalIDWalletAPIAudkenniWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIAudkenniWalletVerificationStartCountryEnum(\"ISL\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiAudkenniWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiAudkenniWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startAudkenni(DigitalIdWalletApiAudkenniWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiAudkenniWalletVerificationStartCountryEnum.of(\"ISL\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startAudkenni([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'ISL',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_audkenni(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"ISL\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartAudkenniAsync(new DigitalIdWalletApiAudkenniWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiAudkenniWalletVerificationStartCountryEnum(\"ISL\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "audkenni" } }, "/v3/id-verification/wallets/connectid/": { "post": { "operationId": "start_connectid_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_connectid", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con ConnectID (Australian Payments Plus; AUS) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes redirigir el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o a través del webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con ConnectID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiConnectidWalletVerificationStartRequest" }, "example": { "country": "AUS", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiConnectidWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiConnectidWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "connectid", "name": "ConnectID", "issuing_authority": "Australian Payments Plus" }, "country": "AUS", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/connectid/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"AUS\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_connectid(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"AUS\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startConnectid({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"AUS\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartConnectid(ctx, didit.IDWalletsStartConnectidParams{\n\tBody: didit.DigitalIDWalletAPIConnectidWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIConnectidWalletVerificationStartCountryEnum(\"AUS\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiConnectidWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiConnectidWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startConnectid(DigitalIdWalletApiConnectidWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiConnectidWalletVerificationStartCountryEnum.of(\"AUS\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startConnectid([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'AUS',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_connectid(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"AUS\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartConnectidAsync(new DigitalIdWalletApiConnectidWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiConnectidWalletVerificationStartCountryEnum(\"AUS\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "connectid" } }, "/v3/id-verification/wallets/eudi/": { "post": { "operationId": "start_eudi_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_eudi", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con EUDI Wallet (el propio Estado miembro del usuario; el emisor varía según el país; AUT, BEL, BGR, HRV, CYP, CZE, DNK, EST, FIN, FRA, DEU, GRC, HUN, IRL, ITA, LVA, LTU, LUX, MLT, NLD, POL, PRT, ROU, SVK, SVN, ESP, SWE, ISL, LIE, NOR) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=redirect con la URL a la que debes redirigir el navegador del usuario; el usuario vuelve a return_url con request_id y result añadidos. Consulta el resultado con GET /v3/id-verification/wallets/verifications/{request_id}/ o a través del webhook, nunca desde la URL. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con EUDI Wallet", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiEudiWalletVerificationStartRequest" }, "example": { "country": "AUT", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiEudiWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiEudiWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "eudi", "name": "EUDI Wallet", "issuing_authority": "The user's own member state; the issuer differs per country" }, "country": "AUT", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/eudi/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"AUT\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_eudi(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"AUT\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startEudi({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"AUT\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartEudi(ctx, didit.IDWalletsStartEudiParams{\n\tBody: didit.DigitalIDWalletAPIEudiWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.DigitalIDWalletAPIEudiWalletVerificationStartCountryEnum(\"AUT\"),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\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;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiEudiWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiEudiWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startEudi(DigitalIdWalletApiEudiWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiEudiWalletVerificationStartCountryEnum.of(\"AUT\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startEudi([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'AUT',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_eudi(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"AUT\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartEudiAsync(new DigitalIdWalletApiEudiWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = \"AUT\",\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "eudi" } }, "/v3/organization/{organization_id}/application/{application_id}/cases/teams/": { "get": { "summary": "Listar equipos de revisión", "description": "Requiere `list:cases` para la aplicación solicitada.", "operationId": "list_case_teams", "x-didit-sdk": { "resource": "cases.teams", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 1000000, "default": 0 } } ], "responses": { "200": { "description": "Éxito", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseReviewTeam" } }, "count": { "type": "integer", "description": "Número de coincidencias, limitado a 100. Sigue next para continuar más allá del límite." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true } } } } } }, "400": { "description": "Entrada no válida." }, "403": { "description": "Permiso insuficiente." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.teams.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.teams.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.Teams.ListAutoPaging(ctx, didit.CasesTeamsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().teams().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->teams->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.teams.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.Teams.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "summary": "Crear equipo de revisión", "description": "Requiere `write:cases` para la aplicación solicitada.", "operationId": "create_case_teams", "x-didit-sdk": { "resource": "cases.teams", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "responses": { "201": { "description": "Éxito", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeam" } } } }, "400": { "description": "Entrada no válida." }, "403": { "description": "Permiso insuficiente." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeamCreate" }, "example": { "name": "AML analysts", "members": [ { "user_id": "9a000000-0000-4000-8000-0000000000aa", "capacity": 10 } ] } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.teams.create(\n name=\"AML analysts\",\n members=[{\n \"user_id\": \"9a000000-0000-4000-8000-0000000000aa\",\n \"capacity\": 10,\n }],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.teams.create({\n name: \"AML analysts\",\n members: [{\n user_id: \"9a000000-0000-4000-8000-0000000000aa\",\n capacity: 10,\n }],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Teams.Create(ctx, didit.CaseReviewTeamCreate{\n\tName: \"AML analysts\",\n\tMembers: []didit.CaseReviewTeamMemberParam{{\n\t\tUserID: \"9a000000-0000-4000-8000-0000000000aa\",\n\t\tCapacity: didit.Int(10),\n\t}},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CaseReviewTeamCreate;\nimport me.didit.types.CaseReviewTeamMember;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().teams().create(CaseReviewTeamCreate.builder()\n .name(\"AML analysts\")\n .members(List.of(CaseReviewTeamMember.builder()\n .userId(\"9a000000-0000-4000-8000-0000000000aa\")\n .capacity(10L)\n .build()))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->teams->create([\n 'name' => 'AML analysts',\n 'members' => [[\n 'user_id' => '9a000000-0000-4000-8000-0000000000aa',\n 'capacity' => 10,\n ]],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.teams.create(\n name: \"AML analysts\",\n members: [{\n user_id: \"9a000000-0000-4000-8000-0000000000aa\",\n capacity: 10,\n }]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Teams.CreateAsync(new CaseReviewTeamCreate\n{\n Name = \"AML analysts\",\n Members = new CaseReviewTeamMember[]\n {\n new()\n {\n UserId = \"9a000000-0000-4000-8000-0000000000aa\",\n Capacity = 10,\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/fraud/checks/{check_id}/": { "get": { "operationId": "root_retrieve", "x-didit-sdk": { "resource": "fraud_checks", "method": "retrieve", "auth": "api_key", "server": true }, "description": "Obtiene una comprobación creada previamente por su `check_id`.", "summary": "Obtener una comprobación de fraude", "parameters": [ { "in": "path", "name": "check_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudCheckResponse" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudClientCredentialsErrorMessage" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudClientCredentialsForbiddenErrorMessage" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Fraud Check" ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.fraud_checks.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.fraudChecks.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.FraudChecks.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.fraudChecks().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "fraudChecks->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.fraud_checks.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.FraudChecks.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/": { "get": { "operationId": "organization_application_cases_requests_list", "x-didit-sdk": { "resource": "cases.requests", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "name": "ordering", "required": false, "in": "query", "description": "Qué campo usar para ordenar los resultados.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Número de resultados que se devuelven por página.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "El índice inicial a partir del cual se devuelven los resultados.", "schema": { "type": "integer" } } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingPaginatedCaseRequestList" } } }, "description": "" }, "404": { "description": "La solicitud o el caso no están disponibles para quien hace la llamada." }, "403": { "description": "Quien hace la llamada no tiene el permiso de casos necesario." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.requests.list(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.requests.list(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.Requests.ListAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasesRequestsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().requests().list(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->requests->list('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.requests.list(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.Requests.ListAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "operationId": "organization_application_cases_requests_create", "x-didit-sdk": { "resource": "cases.requests", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestConfirmRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestConfirmRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestConfirmRequest" } } }, "required": true }, "responses": { "404": { "description": "La solicitud o el caso no están disponibles para quien hace la llamada." }, "403": { "description": "Quien hace la llamada no tiene el permiso de casos necesario." }, "400": { "description": "Entradas no válidas, finalidad no admitida, contacto verificado no disponible o una respuesta inmutable ya existente." }, "409": { "description": "La vista previa cambió o expiró. Genera de nuevo la vista previa antes de confirmar." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequest" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Confirma la vista previa firmada exacta en un plazo de 15 minutos. Solo se aceptan plantillas fijas y un contacto verificado por OTP que pertenezca al sujeto del caso. El ID de la solicitud hace que los reintentos sean idempotentes. La entrega se pone en cola; SENT, SIMULATED y UNKNOWN son resultados distintos. Una solicitud que requiere acción pone el caso en Awaiting user. Una actualización de revisión no modifica su estado.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.requests.create(\n \"11111111-2222-3333-4444-555555555555\",\n contact_id=\"11111111-2222-3333-4444-555555555555\",\n purpose=\"identity_document\",\n request_id=\"11111111-2222-3333-4444-555555555555\",\n expires_at=\"2026-01-15T10:00:00Z\",\n preview_token=\"your-preview-token\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requests.create(\"11111111-2222-3333-4444-555555555555\", {\n contact_id: \"11111111-2222-3333-4444-555555555555\",\n purpose: \"identity_document\",\n request_id: \"11111111-2222-3333-4444-555555555555\",\n expires_at: \"2026-01-15T10:00:00Z\",\n preview_token: \"your-preview-token\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Requests.Create(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CustomerMessagingCaseRequestConfirmRequest{\n\tContactID: \"11111111-2222-3333-4444-555555555555\",\n\tPurpose: didit.CustomerMessagingPurposeEnum(\"identity_document\"),\n\tRequestID: \"11111111-2222-3333-4444-555555555555\",\n\tExpiresAt: time.Date(2026, 1, 15, 10, 0, 0, 0, time.UTC),\n\tPreviewToken: \"your-preview-token\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.OffsetDateTime;\nimport me.didit.Didit;\nimport me.didit.types.CustomerMessagingCaseRequestConfirmRequest;\nimport me.didit.types.CustomerMessagingPurposeEnum;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requests().create(\"11111111-2222-3333-4444-555555555555\", CustomerMessagingCaseRequestConfirmRequest.builder()\n .contactId(\"11111111-2222-3333-4444-555555555555\")\n .purpose(CustomerMessagingPurposeEnum.of(\"identity_document\"))\n .requestId(\"11111111-2222-3333-4444-555555555555\")\n .expiresAt(OffsetDateTime.parse(\"2026-01-15T10:00:00Z\"))\n .previewToken(\"your-preview-token\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requests->create('11111111-2222-3333-4444-555555555555', [\n 'contact_id' => '11111111-2222-3333-4444-555555555555',\n 'purpose' => 'identity_document',\n 'request_id' => '11111111-2222-3333-4444-555555555555',\n 'expires_at' => '2026-01-15T10:00:00Z',\n 'preview_token' => 'your-preview-token',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.requests.create(\n \"11111111-2222-3333-4444-555555555555\",\n contact_id: \"11111111-2222-3333-4444-555555555555\",\n purpose: \"identity_document\",\n request_id: \"11111111-2222-3333-4444-555555555555\",\n expires_at: \"2026-01-15T10:00:00Z\",\n preview_token: \"your-preview-token\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Requests.CreateAsync(\"11111111-2222-3333-4444-555555555555\", new CustomerMessagingCaseRequestConfirmRequest\n{\n ContactId = \"11111111-2222-3333-4444-555555555555\",\n Purpose = \"identity_document\",\n RequestId = \"11111111-2222-3333-4444-555555555555\",\n ExpiresAt = DateTimeOffset.Parse(\"2026-01-15T10:00:00Z\"),\n PreviewToken = \"your-preview-token\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/fraud/checks/": { "post": { "operationId": "create_fraud_check", "x-didit-sdk": { "resource": "fraud_checks", "method": "create", "auth": "api_key", "server": true }, "description": "Envía uno o varios identificadores tipados y recibe en una sola respuesta la normalización, un enriquecimiento actualizado, la validación con fuentes oficiales cuando el país y el tipo de identificador están cubiertos, dimensiones de riesgo independientes y una recomendación.\n\nEstos perfiles admiten comprobaciones de identificadores. La vinculación de identidad basada en selfie (`biometric_identity`) requiere la versión de perfil `2026-09-14.2` y un CPF brasileño; solo se ejecuta con el consentimiento del usuario y cuando tu organización tiene derecho a ella. Las versiones anteriores la notifican como `not_available_in_profile_version`. Los módulos que no pueden ejecutarse se notifican como omitidos con un motivo determinista; una fuente que no pudo responder nunca se notifica como una discrepancia de identidad.", "summary": "Ejecutar una comprobación de fraude", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" }, "example": { "client_reference": "review-attempt-001", "subject": { "identifiers": [ { "type": "email", "value": "applicant@example.com" } ], "attributes": { "first_name": "Alex", "last_name": "Example" } }, "checks": { "include": [ "networks_same_org", "networks_cross_org", "email_risk" ] } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudCheckResponse" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudClientCredentialsErrorMessage" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudClientCredentialsForbiddenErrorMessage" } } }, "description": "" }, "409": { "description": "Conflicto, devuelto sin cargo: el `client_reference` ya se usó con un cuerpo de solicitud diferente; todavía hay en curso una comprobación con el mismo `client_reference` (vuelve a intentarlo tras `Retry-After` segundos con la misma referencia); o la verificación en la que se registra esta comprobación se eliminó antes de que la comprobación terminara.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] }, "examples": { "different_body": { "summary": "Referencia reutilizada con un cuerpo distinto", "value": { "error": "client_reference has already been used with a different request body." } }, "still_running": { "summary": "Todavía se está ejecutando una comprobación con esta referencia", "value": { "error": "A check with this client_reference is already running. Retry with the same reference later." } }, "verification_deleted": { "summary": "La verificación se eliminó antes de que se completara la comprobación", "value": { "error": "This verification was deleted before the check completed." } } } } }, "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar; se envía cuando una comprobación con el mismo `client_reference` aún está en curso.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Fraud Check" ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.fraud_checks.create(\n client_reference=\"review-attempt-001\",\n subject={\n \"identifiers\": [{\n \"type\": \"email\",\n \"value\": \"applicant@example.com\",\n }],\n \"attributes\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Example\",\n },\n },\n checks={\n \"include\": [\"networks_same_org\", \"networks_cross_org\", \"email_risk\"],\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.fraudChecks.create({\n client_reference: \"review-attempt-001\",\n subject: {\n identifiers: [{\n type: \"email\",\n value: \"applicant@example.com\",\n }],\n attributes: {\n first_name: \"Alex\",\n last_name: \"Example\",\n },\n },\n checks: {\n include: [\"networks_same_org\", \"networks_cross_org\", \"email_risk\"],\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.FraudChecks.Create(ctx, didit.FraudCheckRequestRequest{\n\tClientReference: didit.String(\"review-attempt-001\"),\n\tSubject: didit.FraudCheckSubjectRequest{\n\t\tIdentifiers: []didit.FraudCheckIdentifierRequest{{\n\t\t\tType: didit.FraudTypeEnum(\"email\"),\n\t\t\tValue: \"applicant@example.com\",\n\t\t}},\n\t\tAttributes: didit.Some(didit.FraudCheckAttributesRequest{\n\t\t\tFirstName: didit.String(\"Alex\"),\n\t\t\tLastName: didit.String(\"Example\"),\n\t\t}),\n\t},\n\tChecks: didit.Some(didit.FraudCheckModuleSelectionRequest{\n\t\tInclude: didit.Some([]didit.FraudExcludeEnum{didit.FraudExcludeEnum(\"networks_same_org\"), didit.FraudExcludeEnum(\"networks_cross_org\"), didit.FraudExcludeEnum(\"email_risk\")}),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.FraudCheckAttributesRequest;\nimport me.didit.types.FraudCheckIdentifierRequest;\nimport me.didit.types.FraudCheckModuleSelectionRequest;\nimport me.didit.types.FraudCheckRequestRequest;\nimport me.didit.types.FraudCheckSubjectRequest;\nimport me.didit.types.FraudExcludeEnum;\nimport me.didit.types.FraudTypeEnum;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.fraudChecks().create(FraudCheckRequestRequest.builder()\n .clientReference(\"review-attempt-001\")\n .subject(FraudCheckSubjectRequest.builder()\n .identifiers(List.of(FraudCheckIdentifierRequest.builder()\n .type(FraudTypeEnum.of(\"email\"))\n .value(\"applicant@example.com\")\n .build()))\n .attributes(FraudCheckAttributesRequest.builder()\n .firstName(\"Alex\")\n .lastName(\"Example\")\n .build())\n .build())\n .checks(FraudCheckModuleSelectionRequest.builder()\n .include(List.of(FraudExcludeEnum.of(\"networks_same_org\"), FraudExcludeEnum.of(\"networks_cross_org\"), FraudExcludeEnum.of(\"email_risk\")))\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "fraudChecks->create([\n 'client_reference' => 'review-attempt-001',\n 'subject' => [\n 'identifiers' => [[\n 'type' => 'email',\n 'value' => 'applicant@example.com',\n ]],\n 'attributes' => [\n 'first_name' => 'Alex',\n 'last_name' => 'Example',\n ],\n ],\n 'checks' => [\n 'include' => ['networks_same_org', 'networks_cross_org', 'email_risk'],\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.fraud_checks.create(\n client_reference: \"review-attempt-001\",\n subject: {\n identifiers: [{\n type: \"email\",\n value: \"applicant@example.com\",\n }],\n attributes: {\n first_name: \"Alex\",\n last_name: \"Example\",\n },\n },\n checks: {\n include: [\"networks_same_org\", \"networks_cross_org\", \"email_risk\"],\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.FraudChecks.CreateAsync(new FraudCheckRequestRequest\n{\n ClientReference = \"review-attempt-001\",\n Subject = new()\n {\n Identifiers = new FraudCheckIdentifierRequest[]\n {\n new()\n {\n Type = \"email\",\n Value = \"applicant@example.com\",\n },\n },\n Attributes = new FraudCheckAttributesRequest\n {\n FirstName = \"Alex\",\n LastName = \"Example\",\n },\n },\n Checks = new FraudCheckModuleSelectionRequest\n {\n Include = new FraudExcludeEnum[] { \"networks_same_org\", \"networks_cross_org\", \"email_risk\" },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/{request_uuid}/cancel/": { "post": { "operationId": "organization_application_cases_requests_cancel_create", "x-didit-sdk": { "resource": "cases.requests", "method": "cancel", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "request_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequest" } } }, "description": "" }, "404": { "description": "La solicitud o el caso no están disponibles para quien hace la llamada." }, "403": { "description": "Quien hace la llamada no tiene el permiso de casos necesario." }, "400": { "description": "Entradas no válidas, finalidad no admitida, contacto verificado no disponible o una respuesta inmutable ya existente." }, "409": { "description": "La vista previa cambió o expiró. Genera de nuevo la vista previa antes de confirmar." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.requests.cancel(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requests.cancel(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Requests.Cancel(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requests().cancel(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requests->cancel('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.requests.cancel(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Requests.CancelAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/options/": { "get": { "operationId": "organization_application_cases_requests_options_retrieve", "x-didit-sdk": { "resource": "cases.requests", "method": "retrieve_options", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestOptions" } } }, "description": "" }, "404": { "description": "La solicitud o el caso no están disponibles para quien hace la llamada." }, "403": { "description": "Quien hace la llamada no tiene el permiso de casos necesario." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.requests.retrieve_options(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requests.retrieveOptions(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Requests.RetrieveOptions(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requests().retrieveOptions(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requests->retrieveOptions('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.requests.retrieve_options(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Requests.RetrieveOptionsAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/{request_uuid}/attachment/": { "get": { "operationId": "organization_application_cases_requests_attachment_retrieve", "x-didit-sdk": { "resource": "cases.requests", "method": "retrieve_attachment", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "request_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "image/jpeg": { "schema": { "type": "string", "format": "binary" } } }, "description": "" }, "404": { "description": "La solicitud o el caso no están disponibles para quien hace la llamada." }, "403": { "description": "Quien hace la llamada no tiene el permiso de casos necesario." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\ncontent = client.cases.requests.retrieve_attachment(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nwith open(\"download.png\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst content = await didit.cases.requests.retrieveAttachment(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nawait writeFile(\"download.png\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresp, err := client.Cases.Requests.RetrieveAttachment(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.png\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.cases().requests().retrieveAttachment(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\n .writeTo(Path.of(\"download.png\"));" }, { "lang": "php", "label": "PHP", "source": "cases->requests->retrieveAttachment('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');\n$content->saveTo('download.png');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ncontent = didit.cases.requests.retrieve_attachment(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nFile.binwrite(\"download.png\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar content = await client.Cases.Requests.RetrieveAttachmentAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nawait content.SaveToAsync(\"download.png\");" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/history/": { "get": { "operationId": "list_case_routing_rule_history", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "list_history", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "record_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "name": "ordering", "required": false, "in": "query", "description": "Qué campo usar para ordenar los resultados.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Número de resultados que se devuelven por página.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "El índice inicial a partir del cual se devuelven los resultados.", "schema": { "type": "integer" } } ], "tags": [ "Case Assignment" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPaginatedPolicyRevisionList" } } }, "description": "" }, "403": { "description": "Se requiere acceso a casos." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.routing_rules.list_history(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.routingRules.listHistory(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.RoutingRules.ListHistoryAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasesRoutingRulesListHistoryParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().routingRules().listHistory(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->listHistory('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.routing_rules.list_history(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.RoutingRules.ListHistoryAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/session/{sessionId}/resubmission-preview/": { "post": { "summary": "Vista previa de un correo electrónico de reenvío", "description": "Genera el correo electrónico que acompañaría a un reenvío de KYC o KYB sin modificar la sesión, restablecer comprobaciones, ampliar su caducidad, ejecutar comprobaciones ni enviar correos. Requiere el privilegio `write:sessions` (una clave de API con alcance limitado necesita acceso de escritura a decisiones) y una sesión en estado `Approved`, `Declined`, `In Review`, `Kyc Expired` o `Abandoned`. El servidor valida los pasos seleccionados del flujo de verificación (workflow) y genera su plantilla fija traducida con el remitente verificado y la imagen de marca blanca que correspondan. La solicitud no puede definir un asunto, un cuerpo de mensaje ni una URL de acción.\n\n`email_address` es opcional. Sin él, el correo se envía a la dirección de la propia persona: la que verificó en un paso de verificación de correo electrónico del flujo o, en su defecto, la indicada en `contact_details` al crear la sesión. Una dirección que pases tiene prioridad (`recipient_source: request`). Si no se conoce ninguna dirección y no pasas ninguna, `recipient` y `preview_token` son cadenas vacías y no se puede enviar ningún correo.\n\nLa respuesta incluye el destinatario y su origen, el remitente, el asunto, el HTML, el idioma, los pasos resueltos, si al confirmar se envía el correo (`will_be_sent`, `not_sent_reason`) y un `preview_token` firmado. `requires_user_action` es `false` cuando todos los pasos seleccionados se ejecutan sin la persona: en ese caso, el reenvío finaliza por sí solo y no se envía ningún correo (`not_sent_reason: no_user_action`).\n\nEsta vista previa no reserva el estado de la sesión ni autoriza la entrega. Después de revisarla, llama a [Actualizar estado de la sesión](/es/sessions-api/update-status) con `new_status: Resubmitted`, los mismos `nodes_to_resubmit` y `email_language` que previsualizaste, `send_email: true`, `email_address` con el valor de `recipient` y `email_preview_token` con el valor de `preview_token`. El comprobante expira a los 15 minutos. Cuando se proporciona un comprobante, cualquier cambio en las entradas, el contenido del mensaje, el remitente o el estado de la sesión devuelve `409` antes de cualquier modificación o envío. Las integraciones existentes pueden omitir el comprobante. Vuelve a generar la vista previa después de un conflicto. Trata la respuesta como contenido de verificación sensible; las respuestas usan `Cache-Control: no-store`. Muestra el HTML en un marco aislado (sandbox), nunca directamente en el DOM de tu aplicación.", "operationId": "post_v3_session_resubmission_preview", "x-didit-sdk": { "resource": "sessions", "method": "preview_resubmission", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sesión de verificación que se va a actualizar. Acepta ID de sesión tanto de usuario (KYC) como de empresa (KYB): el servicio resuelve el ID en ambos tipos de sesión.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nodes_to_resubmit": { "type": "array", "description": "Pasos que se previsualizan, con la misma validación, selección y orden del flujo que un reenvío. Omítelo para seleccionar automáticamente los intentos registrados que necesitan reenvío.", "items": { "type": "object", "required": [ "node_id", "feature" ], "properties": { "node_id": { "type": "string", "description": "Identificador del nodo tal como aparece en la definición del flujo de la sesión (por ejemplo, `feature_ocr`, `feature_liveness`).", "example": "feature_ocr" }, "feature": { "type": "string", "description": "Tipo de función del nodo. El servidor normaliza los alias `ID_VERIFICATION`, `POA`, `PHONE` y `EMAIL` a `OCR`, `PROOF_OF_ADDRESS`, `PHONE_VERIFICATION` y `EMAIL_VERIFICATION`. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` y `KYB` superan la validación del esquema, pero siempre se rechazan con el `400` de regla de negocio que se muestra en los ejemplos.", "enum": [ "OCR", "OCR_BACK", "NFC", "AML", "FACE", "LIVENESS", "FACE_MATCH", "IP_ANALYSIS", "AGE_ESTIMATION", "PROOF_OF_ADDRESS", "PHONE_VERIFICATION", "EMAIL_VERIFICATION", "FACE_SEARCH", "DATABASE_VALIDATION", "QUESTIONNAIRE", "DOCUMENT_AI", "KYB_DOCUMENTS", "ID_VERIFICATION", "POA", "PHONE", "EMAIL", "KYB_REGISTRY", "KYB_KEY_PEOPLE", "KYB", "GEOLOCATION" ], "example": "OCR" } } } }, "email_address": { "type": "string", "format": "email", "description": "Opcional. Envía el correo electrónico a esta dirección en lugar de a la de la propia persona. Sin él, el destinatario es la dirección que la persona verificó en el flujo o, si no, la indicada en `contact_details`. Esta llamada no envía ningún correo electrónico.", "example": "user@example.com" }, "email_language": { "type": "string", "description": "Idioma del correo electrónico de notificación. El esquema acepta cualquier cadena; los códigos no admitidos pasan a inglés (`en`) sin avisar.", "default": "en", "example": "en" } } }, "examples": { "Person's Own Address": { "summary": "Vista previa de un reenvío de prueba de domicilio para la dirección de la propia persona", "value": { "nodes_to_resubmit": [ { "node_id": "feature_poa_1", "feature": "POA" } ], "email_language": "en" } }, "Named Recipient": { "summary": "Vista previa del correo electrónico para una dirección que indiques", "value": { "nodes_to_resubmit": [ { "node_id": "feature_ocr", "feature": "OCR" } ], "email_address": "person@example.com", "email_language": "en" } } } } } }, "responses": { "200": { "description": "Solo vista previa. La sesión no cambia y no se envía ningún correo electrónico.", "content": { "application/json": { "schema": { "type": "object", "required": [ "recipient", "recipient_source", "sender", "sender_name", "sender_email", "sender_kind", "subject", "html", "text", "language", "will_be_sent", "not_sent_reason", "preview_token", "nodes_to_resubmit", "requires_user_action" ], "properties": { "recipient": { "type": "string", "description": "La dirección a la que va el correo electrónico. Es una cadena vacía cuando no se conoce ninguna dirección de la persona: en ese caso no se puede enviar ningún correo y `preview_token` también está vacío. Pásala como `email_address` al confirmar.", "example": "person@example.com" }, "recipient_source": { "type": "string", "enum": [ "email_verification", "contact_details", "request", "" ], "description": "De dónde procede `recipient`. `request`: el `email_address` que enviaste. `email_verification`: la dirección que la persona verificó en un paso de verificación de correo electrónico del flujo. `contact_details`: la dirección indicada en `contact_details` al crear la sesión. Una cadena vacía cuando no hay dirección.", "example": "email_verification" }, "sender": { "type": "string", "description": "El encabezado `From` con el que se envía el correo electrónico.", "example": "Example App " }, "sender_name": { "type": "string", "description": "La parte del nombre visible de `sender`.", "example": "Example App" }, "sender_email": { "type": "string", "format": "email", "description": "La parte de dirección de `sender`.", "example": "no-reply@mail.example.com" }, "sender_kind": { "type": "string", "enum": [ "customer", "didit" ], "description": "`customer`: el correo electrónico se envía desde el dominio de remitente verificado de tu aplicación (marca blanca). `didit`: se envía desde el remitente propio de Didit.", "example": "customer" }, "subject": { "type": "string", "description": "La línea de asunto exactamente como se envía.", "example": "Action Required: Complete your verification in Example App" }, "html": { "type": "string", "description": "El HTML del correo electrónico exactamente como se envía, con su logotipo incrustado como data URL. Renderízalo en un frame aislado (sandbox), nunca directamente en el DOM de tu aplicación.", "example": "..." }, "text": { "type": "string", "description": "El texto del correo electrónico en texto plano, tal como lo conserva el hilo de Mensajes de la persona, para una vista previa compacta (el HTML sigue siendo el correo electrónico que recibe la persona).", "example": "Almost there\n\nSome steps need to be completed again.\nHere’s what to fix:\n\nhttps://verify.didit.me/session/abc123" }, "language": { "type": "string", "description": "El idioma en el que está escrito el correo. Inglés (`en`) cuando el `email_language` que pediste no está disponible.", "example": "en" }, "will_be_sent": { "type": "boolean", "description": "Indica si confirmar el cambio con `send_email: true` envía este correo electrónico. `false` cuando `not_sent_reason` está definido.", "example": true }, "not_sent_reason": { "type": "string", "nullable": true, "enum": [ "no_user_action", "no_recipient", "sandbox", null ], "description": "Por qué la confirmación no enviaría ningún correo electrónico, o `null` cuando se enviará. `no_user_action`: todos los pasos seleccionados se ejecutan sin la persona, así que el reenvío termina por sí solo y no se envía ningún correo. `no_recipient`: no se conoce ninguna dirección de la persona y no indicaste ninguna. `sandbox`: una sesión de sandbox cuyo destinatario no ha aceptado la entrega de correos en sandbox, así que el envío solo se simula.", "example": null }, "nodes_to_resubmit": { "type": "array", "items": { "type": "object", "required": [ "node_id", "feature" ], "properties": { "node_id": { "type": "string", "description": "Identificador del nodo tal como aparece en la definición del flujo de la sesión (por ejemplo, `feature_ocr`, `feature_liveness`).", "example": "feature_ocr" }, "feature": { "type": "string", "description": "Tipo de función del nodo. El servidor normaliza los alias `ID_VERIFICATION`, `POA`, `PHONE` y `EMAIL` a `OCR`, `PROOF_OF_ADDRESS`, `PHONE_VERIFICATION` y `EMAIL_VERIFICATION`. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` y `KYB` superan la validación del esquema, pero siempre se rechazan con el `400` de regla de negocio que se muestra en los ejemplos.", "enum": [ "OCR", "OCR_BACK", "NFC", "AML", "FACE", "LIVENESS", "FACE_MATCH", "IP_ANALYSIS", "AGE_ESTIMATION", "PROOF_OF_ADDRESS", "PHONE_VERIFICATION", "EMAIL_VERIFICATION", "FACE_SEARCH", "DATABASE_VALIDATION", "QUESTIONNAIRE", "DOCUMENT_AI", "KYB_DOCUMENTS", "ID_VERIFICATION", "POA", "PHONE", "EMAIL", "KYB_REGISTRY", "KYB_KEY_PEOPLE", "KYB", "GEOLOCATION" ], "example": "OCR" } } } }, "requires_user_action": { "type": "boolean", "description": "Indica si al menos una de las comprobaciones seleccionadas requiere interacción del usuario. No predice el resultado final del flujo de verificación (workflow)." }, "preview_token": { "type": "string", "description": "Recibo firmado para este correo electrónico exacto, válido durante 15 minutos. Pásalo como `email_preview_token` a [Actualizar el estado de la sesión](/es/sessions-api/update-status). Una cadena vacía cuando no hay destinatario.", "example": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } } }, "examples": { "Will Be Sent": { "summary": "Destinatario predeterminado: la dirección verificada en el flujo", "value": { "recipient": "person@example.com", "recipient_source": "email_verification", "sender": "Example App ", "sender_name": "Example App", "sender_email": "no-reply@mail.example.com", "sender_kind": "customer", "subject": "Action Required: Complete your verification in Example App", "html": "...", "language": "en", "will_be_sent": true, "not_sent_reason": null, "nodes_to_resubmit": [ { "node_id": "feature_poa_1", "feature": "PROOF_OF_ADDRESS" } ], "requires_user_action": true, "preview_token": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } }, "No User Action": { "summary": "Solo se seleccionan pasos de backend, por lo que no se envía ningún correo electrónico", "value": { "recipient": "person@example.com", "recipient_source": "contact_details", "sender": "Example App ", "sender_name": "Example App", "sender_email": "no-reply@mail.example.com", "sender_kind": "customer", "subject": "Action Required: Complete your verification in Example App", "html": "...", "language": "en", "will_be_sent": false, "not_sent_reason": "no_user_action", "nodes_to_resubmit": [ { "node_id": "feature_aml", "feature": "AML" } ], "requires_user_action": false, "preview_token": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } } } } }, "headers": { "Cache-Control": { "description": "Siempre `no-store`: la vista previa contiene contenido de verificación y no debe almacenarse en caché.", "schema": { "type": "string", "example": "no-store" } } } }, "400": { "description": "La sesión no está en un estado que este endpoint acepte, ya está en `Resubmitted`, los pasos seleccionados no se pueden volver a enviar o un campo no es válido.", "content": { "application/json": { "examples": { "Wrong Current Status": { "summary": "La sesión no está en un estado que este endpoint acepte", "value": { "detail": "Only sessions with status Approved, Declined, In Review, Kyc Expired, Abandoned, Resubmitted can be updated. Current status: In Progress" } }, "Already Resubmitted": { "summary": "La sesión ya está en Resubmitted", "value": [ "The new status is the same as the current status." ] }, "Nothing To Resubmit": { "summary": "La selección automática no encontró ningún paso que requiera un nuevo envío", "value": { "nodes_to_resubmit": "No features found that need resubmission. All features are already approved." } }, "Invalid Email": { "summary": "email_address no es una dirección de correo electrónico", "value": { "email_address": [ "Enter a valid email address." ] } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Clave de API con alcance limitado con la fecha de caducidad vencida", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Faltan las credenciales, quien llama no tiene el privilegio `write:sessions`, una clave de API con alcance limitado no tiene el acceso que necesita este endpoint, o el `session_id` pertenece a otra aplicación.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente o no válido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "El autor de la llamada no tiene write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Clave de API con alcance limitado sin este acceso", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "No existe ninguna sesión KYC o KYB con este `session_id`.", "content": { "application/json": { "examples": { "Not Found": { "summary": "session_id desconocido", "value": { "detail": "Not found." } } } } } }, "429": { "description": "Los pasos que se van a reenviar son todos solo de backend (AML, DATABASE_VALIDATION, IP_ANALYSIS) y la sesión ya se reenvió para pasos solo de backend en los últimos 30 segundos, por lo que Update Session Status rechazaría el reenvío. Reintenta después del intervalo indicado en `Retry-After`.", "content": { "application/json": { "examples": { "Backend-only resubmit throttled": { "value": { "detail": "This session was already resubmitted for backend-only features within the last 30 seconds; repeating it cannot change the outcome. Wait before resubmitting again." } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.preview_resubmission(\n \"11111111-2222-3333-4444-555555555555\",\n nodes_to_resubmit=[{\n \"node_id\": \"feature_poa_1\",\n \"feature\": \"POA\",\n }],\n email_language=\"en\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.previewResubmission(\"11111111-2222-3333-4444-555555555555\", {\n nodes_to_resubmit: [{\n node_id: \"feature_poa_1\",\n feature: \"POA\",\n }],\n email_language: \"en\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.PreviewResubmission(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsPreviewResubmissionParams{\n\tNodesToResubmit: didit.Some([]didit.SessionsPreviewResubmissionParamsNodesToResubmit{{\n\t\tNodeID: \"feature_poa_1\",\n\t\tFeature: \"POA\",\n\t}}),\n\tEmailLanguage: didit.String(\"en\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.SessionsPreviewResubmissionParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().previewResubmission(\"11111111-2222-3333-4444-555555555555\", SessionsPreviewResubmissionParams.builder()\n .nodesToResubmit(List.of(SessionsPreviewResubmissionParams.NodesToResubmit.builder()\n .nodeId(\"feature_poa_1\")\n .feature(SessionsPreviewResubmissionParams.NodesToResubmit.Feature.of(\"POA\"))\n .build()))\n .emailLanguage(\"en\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->previewResubmission('11111111-2222-3333-4444-555555555555', [\n 'nodes_to_resubmit' => [[\n 'node_id' => 'feature_poa_1',\n 'feature' => 'POA',\n ]],\n 'email_language' => 'en',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.preview_resubmission(\n \"11111111-2222-3333-4444-555555555555\",\n nodes_to_resubmit: [{\n node_id: \"feature_poa_1\",\n feature: \"POA\",\n }],\n email_language: \"en\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.PreviewResubmissionAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsPreviewResubmissionParams\n{\n NodesToResubmit = new SessionsPreviewResubmissionParamsNodesToResubmit[]\n {\n new()\n {\n NodeId = \"feature_poa_1\",\n Feature = \"POA\",\n },\n },\n EmailLanguage = \"en\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/": { "get": { "summary": "Obtener regla de enrutamiento", "description": "Requiere `read:cases` para la aplicación solicitada.", "operationId": "retrieve_case_routing_rules", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Éxito", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRule" } } } }, "400": { "description": "Entrada no válida." }, "403": { "description": "Permiso insuficiente." }, "404": { "description": "No se encontró el registro en esta aplicación." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "patch": { "summary": "Actualizar regla de enrutamiento", "description": "Requiere `write:cases` para la aplicación solicitada.", "operationId": "update_case_routing_rules", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Éxito", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRule" } } } }, "400": { "description": "Entrada no válida." }, "403": { "description": "Permiso insuficiente." }, "404": { "description": "No se encontró el registro en esta aplicación." }, "409": { "description": "La regla de enrutamiento cambió desde expected_version. Revisa la última regla antes de reintentar." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRuleUpdate" } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.update(\n \"11111111-2222-3333-4444-555555555555\",\n name=\"your-name\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.update(\"11111111-2222-3333-4444-555555555555\", {\n name: \"your-name\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CaseRoutingRuleUpdate{\n\tName: didit.String(\"your-name\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CaseRoutingRuleUpdate;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().update(\"11111111-2222-3333-4444-555555555555\", CaseRoutingRuleUpdate.builder()\n .name(\"your-name\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->update('11111111-2222-3333-4444-555555555555', [\n 'name' => 'your-name',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.update(\n \"11111111-2222-3333-4444-555555555555\",\n name: \"your-name\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new CaseRoutingRuleUpdate\n{\n Name = \"your-name\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/case-requests/{request_uuid}/": { "get": { "operationId": "case_requests_retrieve", "x-didit-sdk": { "resource": "case_requests", "method": "retrieve", "auth": "device_token", "server": false }, "parameters": [ { "in": "path", "name": "request_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestPublic" } } }, "description": "" }, "404": { "description": "La solicitud o el caso no están disponibles para quien hace la llamada." } }, "security": [ { "CaseRequestToken": [] } ], "description": "Accede a una solicitud de cliente con su token específico de la solicitud. No se devuelven hallazgos privados del caso, datos de identidad originales ni la dirección del destinatario. Las solicitudes que requieren acción expiran a los siete días. La cancelación o la resolución del caso invalida el enlace. Las respuestas son inmutables y se conservan como evidencia para la evaluación del revisor; nunca aprueban ni actualizan una verificación de origen." }, "post": { "operationId": "case_requests_create", "x-didit-sdk": { "resource": "case_requests", "method": "respond", "auth": "device_token", "server": false }, "parameters": [ { "in": "path", "name": "request_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseCustomerResponseRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseCustomerResponseRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseCustomerResponseResult" } } }, "description": "" }, "404": { "description": "La solicitud o el caso no están disponibles para quien hace la llamada." }, "400": { "description": "Entradas no válidas, finalidad no admitida, contacto verificado no disponible o una respuesta inmutable ya existente." }, "409": { "description": "La vista previa cambió o expiró. Genera de nuevo la vista previa antes de confirmar." } }, "security": [ { "CaseRequestToken": [] } ], "description": "Accede a una solicitud de cliente con su token específico de la solicitud. No se devuelven hallazgos privados del caso, datos de identidad originales ni la dirección del destinatario. Las solicitudes que requieren acción expiran a los siete días. La cancelación o la resolución del caso invalida el enlace. Las respuestas son inmutables y se conservan como evidencia para la evaluación del revisor; nunca aprueban ni actualizan una verificación de origen." } }, "/v3/fraud/checks/plan/": { "post": { "operationId": "plan_create", "x-didit-sdk": { "resource": "fraud_checks", "method": "plan", "auth": "api_key", "server": true }, "description": "Valida las comprobaciones seleccionadas y estima su precio sin ejecutarlas, sin crear una sesión y sin facturar.", "summary": "Planificar una comprobación de fraude", "tags": [ "Fraud Check" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" }, "example": { "client_reference": "review-attempt-001", "subject": { "identifiers": [ { "type": "email", "value": "applicant@example.com" } ], "attributes": { "first_name": "Alex", "last_name": "Example" } }, "checks": { "include": [ "networks_same_org", "networks_cross_org", "email_risk" ] } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudCheckPlan" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudBadRequestErrorMessage" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.fraud_checks.plan(\n client_reference=\"review-attempt-001\",\n subject={\n \"identifiers\": [{\n \"type\": \"email\",\n \"value\": \"applicant@example.com\",\n }],\n \"attributes\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Example\",\n },\n },\n checks={\n \"include\": [\"networks_same_org\", \"networks_cross_org\", \"email_risk\"],\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.fraudChecks.plan({\n client_reference: \"review-attempt-001\",\n subject: {\n identifiers: [{\n type: \"email\",\n value: \"applicant@example.com\",\n }],\n attributes: {\n first_name: \"Alex\",\n last_name: \"Example\",\n },\n },\n checks: {\n include: [\"networks_same_org\", \"networks_cross_org\", \"email_risk\"],\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.FraudChecks.Plan(ctx, didit.FraudCheckRequestRequest{\n\tClientReference: didit.String(\"review-attempt-001\"),\n\tSubject: didit.FraudCheckSubjectRequest{\n\t\tIdentifiers: []didit.FraudCheckIdentifierRequest{{\n\t\t\tType: didit.FraudTypeEnum(\"email\"),\n\t\t\tValue: \"applicant@example.com\",\n\t\t}},\n\t\tAttributes: didit.Some(didit.FraudCheckAttributesRequest{\n\t\t\tFirstName: didit.String(\"Alex\"),\n\t\t\tLastName: didit.String(\"Example\"),\n\t\t}),\n\t},\n\tChecks: didit.Some(didit.FraudCheckModuleSelectionRequest{\n\t\tInclude: didit.Some([]didit.FraudExcludeEnum{didit.FraudExcludeEnum(\"networks_same_org\"), didit.FraudExcludeEnum(\"networks_cross_org\"), didit.FraudExcludeEnum(\"email_risk\")}),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.FraudCheckAttributesRequest;\nimport me.didit.types.FraudCheckIdentifierRequest;\nimport me.didit.types.FraudCheckModuleSelectionRequest;\nimport me.didit.types.FraudCheckRequestRequest;\nimport me.didit.types.FraudCheckSubjectRequest;\nimport me.didit.types.FraudExcludeEnum;\nimport me.didit.types.FraudTypeEnum;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.fraudChecks().plan(FraudCheckRequestRequest.builder()\n .clientReference(\"review-attempt-001\")\n .subject(FraudCheckSubjectRequest.builder()\n .identifiers(List.of(FraudCheckIdentifierRequest.builder()\n .type(FraudTypeEnum.of(\"email\"))\n .value(\"applicant@example.com\")\n .build()))\n .attributes(FraudCheckAttributesRequest.builder()\n .firstName(\"Alex\")\n .lastName(\"Example\")\n .build())\n .build())\n .checks(FraudCheckModuleSelectionRequest.builder()\n .include(List.of(FraudExcludeEnum.of(\"networks_same_org\"), FraudExcludeEnum.of(\"networks_cross_org\"), FraudExcludeEnum.of(\"email_risk\")))\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "fraudChecks->plan([\n 'client_reference' => 'review-attempt-001',\n 'subject' => [\n 'identifiers' => [[\n 'type' => 'email',\n 'value' => 'applicant@example.com',\n ]],\n 'attributes' => [\n 'first_name' => 'Alex',\n 'last_name' => 'Example',\n ],\n ],\n 'checks' => [\n 'include' => ['networks_same_org', 'networks_cross_org', 'email_risk'],\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.fraud_checks.plan(\n client_reference: \"review-attempt-001\",\n subject: {\n identifiers: [{\n type: \"email\",\n value: \"applicant@example.com\",\n }],\n attributes: {\n first_name: \"Alex\",\n last_name: \"Example\",\n },\n },\n checks: {\n include: [\"networks_same_org\", \"networks_cross_org\", \"email_risk\"],\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.FraudChecks.PlanAsync(new FraudCheckRequestRequest\n{\n ClientReference = \"review-attempt-001\",\n Subject = new()\n {\n Identifiers = new FraudCheckIdentifierRequest[]\n {\n new()\n {\n Type = \"email\",\n Value = \"applicant@example.com\",\n },\n },\n Attributes = new FraudCheckAttributesRequest\n {\n FirstName = \"Alex\",\n LastName = \"Example\",\n },\n },\n Checks = new FraudCheckModuleSelectionRequest\n {\n Include = new FraudExcludeEnum[] { \"networks_same_org\", \"networks_cross_org\", \"email_risk\" },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/": { "get": { "summary": "Listar reglas de enrutamiento", "description": "Requiere `list:cases` para la aplicación solicitada.", "operationId": "list_case_routing_rules", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 1000000, "default": 0 } } ], "responses": { "200": { "description": "Éxito", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseRoutingRule" } }, "count": { "type": "integer", "description": "Número de coincidencias, limitado a 100. Sigue next para continuar más allá del límite." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true } } } } } }, "400": { "description": "Entrada no válida." }, "403": { "description": "Permiso insuficiente." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.routing_rules.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.routingRules.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.RoutingRules.ListAutoPaging(ctx, didit.CasesRoutingRulesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().routingRules().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.routing_rules.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.RoutingRules.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "summary": "Crear regla de enrutamiento", "description": "Requiere `write:cases` para la aplicación solicitada. Establece publish=false para crear un borrador sin publicar; al publicarlo se crea su primera versión activa. Descartar un borrador que nunca se ha publicado lo elimina.", "operationId": "create_case_routing_rules", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "responses": { "201": { "description": "Éxito", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRule" } } } }, "400": { "description": "Entrada no válida." }, "403": { "description": "Permiso insuficiente." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRuleCreate" }, "example": { "name": "AML screening alerts", "conditions": [ { "field": "source", "operator": "equals", "value": "AML_SCREENING" } ], "blueprint": "b1de0000-0000-4000-8000-000000000002" } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.create(\n name=\"AML screening alerts\",\n conditions=[{\n \"field\": \"source\",\n \"operator\": \"equals\",\n \"value\": \"AML_SCREENING\",\n }],\n blueprint=\"b1de0000-0000-4000-8000-000000000002\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.create({\n name: \"AML screening alerts\",\n conditions: [{\n field: \"source\",\n operator: \"equals\",\n value: \"AML_SCREENING\",\n }],\n blueprint: \"b1de0000-0000-4000-8000-000000000002\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.Create(ctx, didit.CaseRoutingRuleCreate{\n\tName: \"AML screening alerts\",\n\tConditions: []didit.CaseRoutingConditionParam{{\n\t\tField: \"source\",\n\t\tOperator: \"equals\",\n\t\tValue: \"AML_SCREENING\",\n\t}},\n\tBlueprint: \"b1de0000-0000-4000-8000-000000000002\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CaseRoutingCondition;\nimport me.didit.types.CaseRoutingRuleCreate;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().create(CaseRoutingRuleCreate.builder()\n .name(\"AML screening alerts\")\n .conditions(List.of(CaseRoutingCondition.builder()\n .field(CaseRoutingCondition.Field.of(\"source\"))\n .operator(CaseRoutingCondition.Operator.of(\"equals\"))\n .value(CaseRoutingCondition.Value.ofString(\"AML_SCREENING\"))\n .build()))\n .blueprint(\"b1de0000-0000-4000-8000-000000000002\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->create([\n 'name' => 'AML screening alerts',\n 'conditions' => [[\n 'field' => 'source',\n 'operator' => 'equals',\n 'value' => 'AML_SCREENING',\n ]],\n 'blueprint' => 'b1de0000-0000-4000-8000-000000000002',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.create(\n name: \"AML screening alerts\",\n conditions: [{\n field: \"source\",\n operator: \"equals\",\n value: \"AML_SCREENING\",\n }],\n blueprint: \"b1de0000-0000-4000-8000-000000000002\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.CreateAsync(new CaseRoutingRuleCreate\n{\n Name = \"AML screening alerts\",\n Conditions = new CaseRoutingCondition[]\n {\n new()\n {\n Field = \"source\",\n Operator = \"equals\",\n Value = \"AML_SCREENING\",\n },\n },\n Blueprint = \"b1de0000-0000-4000-8000-000000000002\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/publish/": { "post": { "operationId": "publish_case_routing_rule", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "publish", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "record_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Assignment" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftPreconditionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftPreconditionRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftPreconditionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationCaseRoutingRule" } } }, "description": "" }, "403": { "description": "Se requiere acceso a casos." }, "409": { "description": "La versión publicada o la revisión del borrador ha cambiado. Recarga antes de reintentar." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.publish(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version=0,\n expected_revision=\"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.publish(\"11111111-2222-3333-4444-555555555555\", {\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.Publish(ctx, \"11111111-2222-3333-4444-555555555555\", didit.RoutingPublicationPolicyDraftPreconditionRequest{\n\tExpectedVersion: 0,\n\tExpectedRevision: didit.String(\"11111111-2222-3333-4444-555555555555\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.RoutingPublicationPolicyDraftPreconditionRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().publish(\"11111111-2222-3333-4444-555555555555\", RoutingPublicationPolicyDraftPreconditionRequest.builder()\n .expectedVersion(0L)\n .expectedRevision(\"11111111-2222-3333-4444-555555555555\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->publish('11111111-2222-3333-4444-555555555555', [\n 'expected_version' => 0,\n 'expected_revision' => '11111111-2222-3333-4444-555555555555',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.publish(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.PublishAsync(\"11111111-2222-3333-4444-555555555555\", new RoutingPublicationPolicyDraftPreconditionRequest\n{\n ExpectedVersion = 0,\n ExpectedRevision = \"11111111-2222-3333-4444-555555555555\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/publish/": { "post": { "operationId": "publish_case_blueprint", "x-didit-sdk": { "resource": "cases.blueprints", "method": "publish", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "blueprint_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftPreconditionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftPreconditionRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftPreconditionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationCaseBlueprint" } } }, "description": "" }, "409": { "description": "Cambió la versión publicada o la revisión del borrador guardado. Vuelve a cargar antes de reintentar." }, "403": { "description": "Falta el permiso de caso requerido." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.publish(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version=0,\n expected_revision=\"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.publish(\"11111111-2222-3333-4444-555555555555\", {\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.Publish(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasePublicationPolicyDraftPreconditionRequest{\n\tExpectedVersion: 0,\n\tExpectedRevision: didit.String(\"11111111-2222-3333-4444-555555555555\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasePublicationPolicyDraftPreconditionRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().publish(\"11111111-2222-3333-4444-555555555555\", CasePublicationPolicyDraftPreconditionRequest.builder()\n .expectedVersion(0L)\n .expectedRevision(\"11111111-2222-3333-4444-555555555555\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->publish('11111111-2222-3333-4444-555555555555', [\n 'expected_version' => 0,\n 'expected_revision' => '11111111-2222-3333-4444-555555555555',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.publish(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.PublishAsync(\"11111111-2222-3333-4444-555555555555\", new CasePublicationPolicyDraftPreconditionRequest\n{\n ExpectedVersion = 0,\n ExpectedRevision = \"11111111-2222-3333-4444-555555555555\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/preview/": { "post": { "operationId": "organization_application_cases_requests_preview_create", "x-didit-sdk": { "resource": "cases.requests", "method": "preview", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestPreviewRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestPreviewRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestPreviewRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestPreviewResponse" } } }, "description": "" }, "404": { "description": "La solicitud o el caso no están disponibles para quien hace la llamada." }, "403": { "description": "Quien hace la llamada no tiene el permiso de casos necesario." }, "400": { "description": "Entradas no válidas, finalidad no admitida, contacto verificado no disponible o una respuesta inmutable ya existente." }, "409": { "description": "La vista previa cambió o expiró. Genera de nuevo la vista previa antes de confirmar." } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Genera el correo electrónico de producción sin enviarlo ni modificar el caso. Devuelve el destinatario, el remitente, el asunto y el cuerpo exactos, y un preview_token firmado. Envía los mismos contact_id, purpose, language, request_id, expires_at y preview_token para confirmar en un plazo de 15 minutos.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.requests.preview(\n \"11111111-2222-3333-4444-555555555555\",\n contact_id=\"11111111-2222-3333-4444-555555555555\",\n purpose=\"identity_document\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requests.preview(\"11111111-2222-3333-4444-555555555555\", {\n contact_id: \"11111111-2222-3333-4444-555555555555\",\n purpose: \"identity_document\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Requests.Preview(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CustomerMessagingCaseRequestPreviewRequest{\n\tContactID: \"11111111-2222-3333-4444-555555555555\",\n\tPurpose: didit.CustomerMessagingPurposeEnum(\"identity_document\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CustomerMessagingCaseRequestPreviewRequest;\nimport me.didit.types.CustomerMessagingPurposeEnum;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requests().preview(\"11111111-2222-3333-4444-555555555555\", CustomerMessagingCaseRequestPreviewRequest.builder()\n .contactId(\"11111111-2222-3333-4444-555555555555\")\n .purpose(CustomerMessagingPurposeEnum.of(\"identity_document\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requests->preview('11111111-2222-3333-4444-555555555555', [\n 'contact_id' => '11111111-2222-3333-4444-555555555555',\n 'purpose' => 'identity_document',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.requests.preview(\n \"11111111-2222-3333-4444-555555555555\",\n contact_id: \"11111111-2222-3333-4444-555555555555\",\n purpose: \"identity_document\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Requests.PreviewAsync(\"11111111-2222-3333-4444-555555555555\", new CustomerMessagingCaseRequestPreviewRequest\n{\n ContactId = \"11111111-2222-3333-4444-555555555555\",\n Purpose = \"identity_document\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/action-receipts/": { "get": { "operationId": "action_receipts_retrieve", "x-didit-sdk": { "resource": "cases", "method": "list_action_receipts", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "offset", "schema": { "type": "integer", "maximum": 1000000, "minimum": 0, "default": 0 } } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseActionCaseActionReceiptPage" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Lista los comprobantes de acciones sobre sujetos, del más reciente al más antiguo, con un máximo de 20 resultados por página. Usa next_offset para obtener la página siguiente. El texto de la nota introducida no se muestra en el historial.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.list_action_receipts(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.listActionReceipts(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.ListActionReceipts(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasesListActionReceiptsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().listActionReceipts(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->listActionReceipts('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.list_action_receipts(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ListActionReceiptsAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/notes/{note_uuid}/": { "delete": { "operationId": "delete_network_note", "x-didit-sdk": { "resource": "networks.notes", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "summary": "Eliminar tu nota de red", "description": "Requiere write:networks y ser el autor autenticado de la nota. La eliminación es irreversible. Los datos de la cuenta y de verificación conectados no se ven afectados.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la red." }, { "name": "note_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Token de acceso del usuario de la consola con el formato Bearer ." } ], "responses": { "204": { "description": "Nota eliminada." }, "401": { "description": "Se requiere autenticación." }, "403": { "description": "Falta el permiso o el acceso a Networks." }, "404": { "description": "La red o la nota no es visible para esta aplicación." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\nclient = Didit()\n\nclient.networks.notes.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n extra_headers={\"Authorization\": \"Bearer YOUR_CONSOLE_USER_TOKEN\"},\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nconst didit = new Didit({\n fetch: (url, init) => {\n const headers = new Headers(init?.headers);\n headers.set(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\");\n return fetch(url, { ...init, headers });\n },\n});\n\nawait didit.networks.notes.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nclient := didit.NewClient()\n\nif err := client.Networks.Notes.Delete(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\", didit.NetworksNotesDeleteParams{\n\tAuthorization: \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n}); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.core.RequestOptions;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nDidit client = new Didit();\n\nclient.networks().notes().delete(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\", RequestOptions.builder()\n .header(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\")\n .build());" }, { "lang": "php", "label": "PHP", "source": "networks->notes->delete('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555', [\n 'authorization' => 'Bearer YOUR_CONSOLE_USER_TOKEN',\n]);" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\ndidit = Didit::Client.new\n\ndidit.networks.notes.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n request_options: { extra_headers: { \"Authorization\" => \"Bearer YOUR_CONSOLE_USER_TOKEN\" } }\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nusing var client = new DiditClient();\n\nawait client.Networks.Notes.DeleteAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\", requestOptions: new RequestOptions\n{\n Headers = new Dictionary\n {\n [\"Authorization\"] = \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n },\n});" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/action-receipts/{receipt_uuid}/retry/": { "post": { "operationId": "action_receipts_retry_create", "x-didit-sdk": { "resource": "cases", "method": "retry_action_receipt", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "receipt_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseActionCaseActionReceipt" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Reintenta solo esta acción fallida sobre el sujeto con sus entradas guardadas. Se comprueba el permiso de escritura actual. Las acciones ya aplicadas devuelven su comprobante sin volver a ejecutarse. El cierre del caso es independiente.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.retry_action_receipt(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.retryActionReceipt(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RetryActionReceipt(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().retryActionReceipt(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->retryActionReceipt('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.retry_action_receipt(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RetryActionReceiptAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/draft/": { "get": { "operationId": "get_case_blueprint_draft", "x-didit-sdk": { "resource": "cases.blueprints", "method": "retrieve_draft", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "blueprint_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftResponse" } } }, "description": "" }, "403": { "description": "Falta el permiso de caso requerido." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.retrieve_draft(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.retrieveDraft(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.RetrieveDraft(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().retrieveDraft(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->retrieveDraft('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.retrieve_draft(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.RetrieveDraftAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "put": { "operationId": "save_case_blueprint_draft", "x-didit-sdk": { "resource": "cases.blueprints", "method": "save_draft", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "blueprint_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftWriteRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftWriteRequest" }, "example": { "expected_version": 1, "expected_revision": "4e5f0000-0000-4000-8000-000000000003", "changes": { "max_active_cases": 20 } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftWriteRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraft" } } }, "description": "" }, "409": { "description": "Cambió la versión publicada o la revisión del borrador guardado. Vuelve a cargar antes de reintentar." }, "403": { "description": "Falta el permiso de caso requerido." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.save_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version=1,\n expected_revision=\"4e5f0000-0000-4000-8000-000000000003\",\n changes={\"max_active_cases\": 20},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.saveDraft(\"11111111-2222-3333-4444-555555555555\", {\n expected_version: 1,\n expected_revision: \"4e5f0000-0000-4000-8000-000000000003\",\n changes: { max_active_cases: 20 },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.SaveDraft(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasePublicationPolicyDraftWriteRequest{\n\tExpectedVersion: 1,\n\tExpectedRevision: didit.String(\"4e5f0000-0000-4000-8000-000000000003\"),\n\tChanges: map[string]any{\"max_active_cases\": 20},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.CasePublicationPolicyDraftWriteRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().saveDraft(\"11111111-2222-3333-4444-555555555555\", CasePublicationPolicyDraftWriteRequest.builder()\n .expectedVersion(1L)\n .expectedRevision(\"4e5f0000-0000-4000-8000-000000000003\")\n .changes(Map.of(\"max_active_cases\", 20))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->saveDraft('11111111-2222-3333-4444-555555555555', [\n 'expected_version' => 1,\n 'expected_revision' => '4e5f0000-0000-4000-8000-000000000003',\n 'changes' => ['max_active_cases' => 20],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.save_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version: 1,\n expected_revision: \"4e5f0000-0000-4000-8000-000000000003\",\n changes: { max_active_cases: 20 }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.SaveDraftAsync(\"11111111-2222-3333-4444-555555555555\", new CasePublicationPolicyDraftWriteRequest\n{\n ExpectedVersion = 1,\n ExpectedRevision = \"4e5f0000-0000-4000-8000-000000000003\",\n Changes = new Dictionary { [\"max_active_cases\"] = 20 },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "operationId": "discard_case_blueprint_draft", "x-didit-sdk": { "resource": "cases.blueprints", "method": "discard_draft", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "blueprint_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "204": { "description": "Sin cuerpo de respuesta" }, "409": { "description": "Cambió la versión publicada o la revisión del borrador guardado. Vuelve a cargar antes de reintentar." }, "403": { "description": "Falta el permiso de caso requerido." } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftPreconditionRequest" } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.cases.blueprints.discard_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version=0,\n expected_revision=\"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.cases.blueprints.discardDraft(\"11111111-2222-3333-4444-555555555555\", {\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\",\n});" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nif err := client.Cases.Blueprints.DiscardDraft(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasePublicationPolicyDraftPreconditionRequest{\n\tExpectedVersion: 0,\n\tExpectedRevision: didit.String(\"11111111-2222-3333-4444-555555555555\"),\n}); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasePublicationPolicyDraftPreconditionRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.cases().blueprints().discardDraft(\"11111111-2222-3333-4444-555555555555\", CasePublicationPolicyDraftPreconditionRequest.builder()\n .expectedVersion(0L)\n .expectedRevision(\"11111111-2222-3333-4444-555555555555\")\n .build());" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->discardDraft('11111111-2222-3333-4444-555555555555', [\n 'expected_version' => 0,\n 'expected_revision' => '11111111-2222-3333-4444-555555555555',\n]);" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.blueprints.discard_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\"\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Cases.Blueprints.DiscardDraftAsync(\"11111111-2222-3333-4444-555555555555\", new CasePublicationPolicyDraftPreconditionRequest\n{\n ExpectedVersion = 0,\n ExpectedRevision = \"11111111-2222-3333-4444-555555555555\",\n});" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/teams/{record_uuid}/": { "get": { "summary": "Obtener equipo de revisión", "description": "Requiere `read:cases` para la aplicación solicitada.", "operationId": "retrieve_case_teams", "x-didit-sdk": { "resource": "cases.teams", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Éxito", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeam" } } } }, "400": { "description": "Entrada no válida." }, "403": { "description": "Permiso insuficiente." }, "404": { "description": "No se encontró el registro en esta aplicación." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.teams.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.teams.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Teams.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().teams().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->teams->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.teams.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Teams.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "patch": { "summary": "Actualizar equipo de revisión", "description": "Requiere `write:cases` para la aplicación solicitada.", "operationId": "update_case_teams", "x-didit-sdk": { "resource": "cases.teams", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Éxito", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeam" } } } }, "400": { "description": "Entrada no válida." }, "403": { "description": "Permiso insuficiente." }, "404": { "description": "No se encontró el registro en esta aplicación." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeamUpdate" } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.teams.update(\n \"11111111-2222-3333-4444-555555555555\",\n name=\"your-name\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.teams.update(\"11111111-2222-3333-4444-555555555555\", {\n name: \"your-name\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Teams.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CaseReviewTeamUpdate{\n\tName: didit.String(\"your-name\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CaseReviewTeamUpdate;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().teams().update(\"11111111-2222-3333-4444-555555555555\", CaseReviewTeamUpdate.builder()\n .name(\"your-name\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->teams->update('11111111-2222-3333-4444-555555555555', [\n 'name' => 'your-name',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.teams.update(\n \"11111111-2222-3333-4444-555555555555\",\n name: \"your-name\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Teams.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new CaseReviewTeamUpdate\n{\n Name = \"your-name\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/report/": { "get": { "operationId": "download_network_report", "x-didit-sdk": { "resource": "networks", "method": "download_report", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "summary": "Descargar un informe de evidencias de una red", "description": "Descarga un PDF de la red actual de la organización, con sus conexiones de cuentas observadas, las referencias de señales y el estado de revisión. Requiere read:networks. No se incluyen la inteligencia global ni las notas privadas de los analistas. Cada lista de cuentas y de señales tiene un máximo de 500 entradas, y el informe indica cuándo está incompleto. La solicitud no cambia el estado de la red. Los errores se devuelven en JSON.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la red." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Token de acceso del usuario de la consola con el formato Bearer ." } ], "responses": { "200": { "description": "Informe de evidencias de la red. Cache-Control: no-store.", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Se requiere autenticación." }, "403": { "description": "Falta el permiso o el acceso a Networks." }, "404": { "description": "La red o la nota no es visible para esta aplicación." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\nclient = Didit()\n\ncontent = client.networks.download_report(\n \"11111111-2222-3333-4444-555555555555\",\n extra_headers={\"Authorization\": \"Bearer YOUR_CONSOLE_USER_TOKEN\"},\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nconst didit = new Didit({\n fetch: (url, init) => {\n const headers = new Headers(init?.headers);\n headers.set(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\");\n return fetch(url, { ...init, headers });\n },\n});\n\nconst content = await didit.networks.downloadReport(\"11111111-2222-3333-4444-555555555555\");\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nclient := didit.NewClient()\n\nresp, err := client.Networks.DownloadReport(ctx, \"11111111-2222-3333-4444-555555555555\", didit.NetworksDownloadReportParams{\n\tAuthorization: \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.core.RequestOptions;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nDidit client = new Didit();\n\nclient.networks().downloadReport(\"11111111-2222-3333-4444-555555555555\", RequestOptions.builder()\n .header(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\")\n .build())\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "networks->downloadReport('11111111-2222-3333-4444-555555555555', [\n 'authorization' => 'Bearer YOUR_CONSOLE_USER_TOKEN',\n]);\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\ndidit = Didit::Client.new\n\ncontent = didit.networks.download_report(\n \"11111111-2222-3333-4444-555555555555\",\n request_options: { extra_headers: { \"Authorization\" => \"Bearer YOUR_CONSOLE_USER_TOKEN\" } }\n)\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nusing var client = new DiditClient();\n\nvar content = await client.Networks.DownloadReportAsync(\"11111111-2222-3333-4444-555555555555\", requestOptions: new RequestOptions\n{\n Headers = new Dictionary\n {\n [\"Authorization\"] = \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n },\n});\nawait content.SaveToAsync(\"download.pdf\");" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/notes/": { "get": { "operationId": "list_network_notes", "x-didit-sdk": { "resource": "networks.notes", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "summary": "Listar notas privadas de una red", "description": "Los usuarios de la consola con read:networks pueden leer las notas de una red visible para la aplicación. Las notas permanecen dentro de la organización y no se aportan a la inteligencia compartida. Las notas más recientes aparecen primero.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la red." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Token de acceso del usuario de la consola con el formato Bearer ." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 30 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 1000000, "default": 0 } } ], "responses": { "200": { "description": "Una página de notas. El recuento tiene un máximo de 100; usa next para continuar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkNote" } } } } } } }, "401": { "description": "Se requiere autenticación." }, "403": { "description": "Falta el permiso o el acceso a Networks." }, "404": { "description": "La red o la nota no es visible para esta aplicación." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\nclient = Didit()\n\nfor item in client.networks.notes.list(\n \"11111111-2222-3333-4444-555555555555\",\n extra_headers={\"Authorization\": \"Bearer YOUR_CONSOLE_USER_TOKEN\"},\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nconst didit = new Didit({\n fetch: (url, init) => {\n const headers = new Headers(init?.headers);\n headers.set(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\");\n return fetch(url, { ...init, headers });\n },\n});\n\nfor await (const item of didit.networks.notes.list(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nclient := didit.NewClient()\n\niter := client.Networks.Notes.ListAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.NetworksNotesListParams{\n\tAuthorization: \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.core.RequestOptions;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nDidit client = new Didit();\n\nfor (var item : client.networks().notes().list(\"11111111-2222-3333-4444-555555555555\", RequestOptions.builder()\n .header(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\")\n .build())) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "networks->notes->list('11111111-2222-3333-4444-555555555555', [\n 'authorization' => 'Bearer YOUR_CONSOLE_USER_TOKEN',\n]) as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\ndidit = Didit::Client.new\n\ndidit.networks.notes.list(\n \"11111111-2222-3333-4444-555555555555\",\n request_options: { extra_headers: { \"Authorization\" => \"Bearer YOUR_CONSOLE_USER_TOKEN\" } }\n).auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Networks.Notes.ListAsync(\"11111111-2222-3333-4444-555555555555\", requestOptions: new RequestOptions\n{\n Headers = new Dictionary\n {\n [\"Authorization\"] = \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n },\n}))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "operationId": "create_network_note", "x-didit-sdk": { "resource": "networks.notes", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "summary": "Añadir una nota privada a la red", "description": "Requiere un usuario de la consola con write:networks. El autor se asigna a partir del usuario autenticado. Proporciona un client_reference UUID aleatorio nuevo para cada nota; tras una respuesta incierta, reintenta con el mismo cuerpo y la misma referencia para evitar duplicados. Reutilizar una referencia con otro cuerpo, autor o red devuelve 409. Cuando las redes se fusionan, las notas pasan a la investigación que se conserva.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la red." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Token de acceso del usuario de la consola con el formato Bearer ." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "comment", "client_reference" ], "properties": { "comment": { "type": "string", "minLength": 1, "maxLength": 10000 }, "client_reference": { "type": "string", "format": "uuid" } } } } } }, "responses": { "201": { "description": "Nota privada guardada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkNote" } } } }, "200": { "description": "Nota privada guardada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkNote" } } } }, "400": { "description": "Nota no válida o vacía." }, "409": { "description": "La referencia ya se usó para otra nota." }, "401": { "description": "Se requiere autenticación." }, "403": { "description": "Falta el permiso o el acceso a Networks." }, "404": { "description": "La red o la nota no es visible para esta aplicación." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\nclient = Didit()\n\nresult = client.networks.notes.create(\n \"11111111-2222-3333-4444-555555555555\",\n comment=\"your-comment\",\n client_reference=\"11111111-2222-3333-4444-555555555555\",\n extra_headers={\"Authorization\": \"Bearer YOUR_CONSOLE_USER_TOKEN\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nconst didit = new Didit({\n fetch: (url, init) => {\n const headers = new Headers(init?.headers);\n headers.set(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\");\n return fetch(url, { ...init, headers });\n },\n});\n\nconst result = await didit.networks.notes.create(\"11111111-2222-3333-4444-555555555555\", {\n comment: \"your-comment\",\n client_reference: \"11111111-2222-3333-4444-555555555555\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nclient := didit.NewClient()\n\nresult, err := client.Networks.Notes.Create(ctx, \"11111111-2222-3333-4444-555555555555\", didit.NetworksNotesCreateParams{\n\tComment: \"your-comment\",\n\tClientReference: \"11111111-2222-3333-4444-555555555555\",\n\tAuthorization: \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.core.RequestOptions;\nimport me.didit.types.NetworksNotesCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nDidit client = new Didit();\n\nvar result = client.networks().notes().create(\"11111111-2222-3333-4444-555555555555\", NetworksNotesCreateParams.builder()\n .comment(\"your-comment\")\n .clientReference(\"11111111-2222-3333-4444-555555555555\")\n .build(), RequestOptions.builder()\n .header(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->notes->create('11111111-2222-3333-4444-555555555555', [\n 'comment' => 'your-comment',\n 'client_reference' => '11111111-2222-3333-4444-555555555555',\n 'authorization' => 'Bearer YOUR_CONSOLE_USER_TOKEN',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\ndidit = Didit::Client.new\n\nresult = didit.networks.notes.create(\n \"11111111-2222-3333-4444-555555555555\",\n comment: \"your-comment\",\n client_reference: \"11111111-2222-3333-4444-555555555555\",\n request_options: { extra_headers: { \"Authorization\" => \"Bearer YOUR_CONSOLE_USER_TOKEN\" } }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.Notes.CreateAsync(\"11111111-2222-3333-4444-555555555555\", new NetworksNotesCreateParams\n{\n Comment = \"your-comment\",\n ClientReference = \"11111111-2222-3333-4444-555555555555\",\n}, requestOptions: new RequestOptions\n{\n Headers = new Dictionary\n {\n [\"Authorization\"] = \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/draft/": { "get": { "operationId": "get_case_routing_rule_draft", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "retrieve_draft", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "record_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Assignment" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftResponse" } } }, "description": "" }, "403": { "description": "Se requiere acceso a casos." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.retrieve_draft(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.retrieveDraft(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.RetrieveDraft(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().retrieveDraft(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->retrieveDraft('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.retrieve_draft(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.RetrieveDraftAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "put": { "operationId": "save_case_routing_rule_draft", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "save_draft", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "record_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Assignment" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftWriteRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftWriteRequest" }, "example": { "expected_version": 1, "expected_revision": "4e5f0000-0000-4000-8000-000000000003", "changes": { "priority": 10 } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftWriteRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraft" } } }, "description": "" }, "403": { "description": "Se requiere acceso a casos." }, "409": { "description": "La versión publicada o la revisión del borrador ha cambiado. Recarga antes de reintentar." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.save_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version=1,\n expected_revision=\"4e5f0000-0000-4000-8000-000000000003\",\n changes={\"priority\": 10},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.saveDraft(\"11111111-2222-3333-4444-555555555555\", {\n expected_version: 1,\n expected_revision: \"4e5f0000-0000-4000-8000-000000000003\",\n changes: { priority: 10 },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.SaveDraft(ctx, \"11111111-2222-3333-4444-555555555555\", didit.RoutingPublicationPolicyDraftWriteRequest{\n\tExpectedVersion: 1,\n\tExpectedRevision: didit.String(\"4e5f0000-0000-4000-8000-000000000003\"),\n\tChanges: map[string]any{\"priority\": 10},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.RoutingPublicationPolicyDraftWriteRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().saveDraft(\"11111111-2222-3333-4444-555555555555\", RoutingPublicationPolicyDraftWriteRequest.builder()\n .expectedVersion(1L)\n .expectedRevision(\"4e5f0000-0000-4000-8000-000000000003\")\n .changes(Map.of(\"priority\", 10))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->saveDraft('11111111-2222-3333-4444-555555555555', [\n 'expected_version' => 1,\n 'expected_revision' => '4e5f0000-0000-4000-8000-000000000003',\n 'changes' => ['priority' => 10],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.save_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version: 1,\n expected_revision: \"4e5f0000-0000-4000-8000-000000000003\",\n changes: { priority: 10 }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.SaveDraftAsync(\"11111111-2222-3333-4444-555555555555\", new RoutingPublicationPolicyDraftWriteRequest\n{\n ExpectedVersion = 1,\n ExpectedRevision = \"4e5f0000-0000-4000-8000-000000000003\",\n Changes = new Dictionary { [\"priority\"] = 10 },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "operationId": "discard_case_routing_rule_draft", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "discard_draft", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "record_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Assignment" ], "responses": { "204": { "description": "Sin cuerpo de respuesta" }, "403": { "description": "Se requiere acceso a casos." }, "409": { "description": "La versión publicada o la revisión del borrador ha cambiado. Recarga antes de reintentar." } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftPreconditionRequest" } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.cases.routing_rules.discard_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version=0,\n expected_revision=\"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.cases.routingRules.discardDraft(\"11111111-2222-3333-4444-555555555555\", {\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\",\n});" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nif err := client.Cases.RoutingRules.DiscardDraft(ctx, \"11111111-2222-3333-4444-555555555555\", didit.RoutingPublicationPolicyDraftPreconditionRequest{\n\tExpectedVersion: 0,\n\tExpectedRevision: didit.String(\"11111111-2222-3333-4444-555555555555\"),\n}); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.RoutingPublicationPolicyDraftPreconditionRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.cases().routingRules().discardDraft(\"11111111-2222-3333-4444-555555555555\", RoutingPublicationPolicyDraftPreconditionRequest.builder()\n .expectedVersion(0L)\n .expectedRevision(\"11111111-2222-3333-4444-555555555555\")\n .build());" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->discardDraft('11111111-2222-3333-4444-555555555555', [\n 'expected_version' => 0,\n 'expected_revision' => '11111111-2222-3333-4444-555555555555',\n]);" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.routing_rules.discard_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\"\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Cases.RoutingRules.DiscardDraftAsync(\"11111111-2222-3333-4444-555555555555\", new RoutingPublicationPolicyDraftPreconditionRequest\n{\n ExpectedVersion = 0,\n ExpectedRevision = \"11111111-2222-3333-4444-555555555555\",\n});" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/duplicates/": { "post": { "operationId": "duplicates_create", "x-didit-sdk": { "resource": "cases", "method": "find_duplicates", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CaseDuplicateCaseDuplicateQueryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CaseDuplicateCaseDuplicateQueryRequest" }, "example": { "subject": { "type": "user", "uuid": "5b9a0000-0000-4000-8000-00000000f00d" } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CaseDuplicateCaseDuplicateQueryRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDuplicateCaseDuplicatePage" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Revisa los casos existentes de un sujeto o de un registro de origen propio antes de crear un caso manualmente. Se devuelven tanto las investigaciones abiertas como las resueltas. Cada página contiene como máximo 20 casos; usa next_offset para solicitar otra página.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.find_duplicates(\n subject={\n \"type\": \"user\",\n \"uuid\": \"5b9a0000-0000-4000-8000-00000000f00d\",\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.findDuplicates({\n subject: {\n type: \"user\",\n uuid: \"5b9a0000-0000-4000-8000-00000000f00d\",\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.FindDuplicates(ctx, didit.CaseDuplicateCaseDuplicateQueryRequest{\n\tSubject: didit.Some(didit.CaseDuplicateCaseSubjectInputRequest{\n\t\tType: didit.CaseDuplicateTypeEnum(\"user\"),\n\t\tUUID: \"5b9a0000-0000-4000-8000-00000000f00d\",\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CaseDuplicateCaseDuplicateQueryRequest;\nimport me.didit.types.CaseDuplicateCaseSubjectInputRequest;\nimport me.didit.types.CaseDuplicateTypeEnum;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().findDuplicates(CaseDuplicateCaseDuplicateQueryRequest.builder()\n .subject(CaseDuplicateCaseSubjectInputRequest.builder()\n .type(CaseDuplicateTypeEnum.of(\"user\"))\n .uuid(\"5b9a0000-0000-4000-8000-00000000f00d\")\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->findDuplicates([\n 'subject' => [\n 'type' => 'user',\n 'uuid' => '5b9a0000-0000-4000-8000-00000000f00d',\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.find_duplicates(\n subject: {\n type: \"user\",\n uuid: \"5b9a0000-0000-4000-8000-00000000f00d\",\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.FindDuplicatesAsync(new CaseDuplicateCaseDuplicateQueryRequest\n{\n Subject = new CaseDuplicateCaseSubjectInputRequest\n {\n Type = \"user\",\n Uuid = \"5b9a0000-0000-4000-8000-00000000f00d\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/preview/": { "post": { "summary": "Enrutamiento de casos de prueba", "description": "Requiere `read:cases` para la aplicación solicitada. Evalúa las reglas actuales o un borrador proporcionado frente al acceso, la disponibilidad, las habilidades y la capacidad actuales de los revisores. No guarda el borrador ni reserva capacidad de los revisores.", "operationId": "preview_case_routing", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "preview", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "responses": { "200": { "description": "Éxito", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingPreview" } } } }, "400": { "description": "Entrada no válida." }, "403": { "description": "Permiso insuficiente." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingPreviewRequest" } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.preview(\n source=\"MANUAL\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.preview({\n source: \"MANUAL\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.Preview(ctx, didit.CaseRoutingPreviewRequest{\n\tSource: \"MANUAL\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CaseRoutingPreviewRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().preview(CaseRoutingPreviewRequest.builder()\n .source(CaseRoutingPreviewRequest.Source.of(\"MANUAL\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->preview([\n 'source' => 'MANUAL',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.preview(source: \"MANUAL\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.PreviewAsync(new CaseRoutingPreviewRequest\n{\n Source = \"MANUAL\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/reviewers/": { "get": { "summary": "Listar revisores de casos elegibles", "description": "Requiere `list:cases` para la aplicación solicitada.", "operationId": "list_case_reviewers", "x-didit-sdk": { "resource": "cases", "method": "list_reviewers", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "responses": { "200": { "description": "Éxito", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" } } } } } } } } }, "400": { "description": "Entrada no válida." }, "403": { "description": "Permiso insuficiente." }, "503": { "description": "No se pudo verificar el acceso del revisor. Vuelve a intentarlo más tarde." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.list_reviewers()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.listReviewers();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.ListReviewers(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().listReviewers();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->listReviewers();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.list_reviewers\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ListReviewersAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/history/": { "get": { "operationId": "list_case_blueprint_history", "x-didit-sdk": { "resource": "cases.blueprints", "method": "list_history", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "blueprint_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "name": "ordering", "required": false, "in": "query", "description": "Qué campo usar para ordenar los resultados.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Número de resultados que se devuelven por página.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "El índice inicial a partir del cual se devuelven los resultados.", "schema": { "type": "integer" } } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationPaginatedPolicyRevisionList" } } }, "description": "" }, "403": { "description": "Falta el permiso de caso requerido." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.blueprints.list_history(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.blueprints.listHistory(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.Blueprints.ListHistoryAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasesBlueprintsListHistoryParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().blueprints().listHistory(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->listHistory('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.blueprints.list_history(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.Blueprints.ListHistoryAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/session/{sessionId}/signatures/{nodeId}/documents/{documentId}/file/": { "get": { "summary": "Descargar un documento firmado", "description": "Descarga el PDF firmado de un documento de un paso de Firma electrónica. Usa la ruta `signed_file` de `signatures[].documents[]` en la decisión. El PDF contiene el documento que se mostró al firmante con los valores de sus campos estampados y la página de evidencias (salvo que `signature_evidence_page` esté desactivado). Un PDF avanzado (AES) también incluye la firma PAdES con su marca de tiempo; un PDF simple no tiene firma digital, sello ni marca de tiempo. Didit comprueba el archivo con `sha256_signed` antes de devolverlo.\n\nFunciona con sesiones de Verificación de usuarios (KYC) y de Verificación de empresas (KYB). Requiere `read:sessions`; tu clave de API sirve. Consulta el [informe de Firma electrónica](/es/core-technology/electronic-signature/report-electronic-signature#descargar-los-documentos-firmados).", "operationId": "get_v3_session_signature_document_file", "x-didit-sdk": { "resource": "sessions.signatures", "method": "download_document", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "La sesión de verificación de usuarios (KYC) o de verificación de empresas (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "El paso de Firma electrónica: `node_id` del elemento en `signatures[]`.", "schema": { "type": "string", "example": "feature_signature" } }, { "name": "documentId", "in": "path", "required": true, "description": "`id` del documento en `signatures[].documents[]`.", "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "El PDF firmado.", "headers": { "Content-Disposition": { "description": "Adjunto con el nombre del archivo.", "schema": { "type": "string", "example": "attachment; filename=\"agreement-signed.pdf\"" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Faltan las credenciales, o la credencial no puede leer esta sesión. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "You do not have permission to perform this action." } } } }, "404": { "description": "Ningún documento firmado coincide: la sesión, el paso o el documento no existe, se eliminó o todavía no está firmado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Not signed yet": { "summary": "El firmante no ha firmado", "value": { "code": "signature_not_signed", "detail": "signature_not_signed" } }, "Unknown document": { "summary": "No existe ese documento en este paso", "value": { "code": "signature_not_found", "detail": "signature_not_found" } } } } } }, "409": { "description": "El archivo almacenado ya no coincide con su SHA-256 registrado. No se devuelve nada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Changed file": { "summary": "El archivo almacenado no coincide con su hash", "value": { "code": "signature_document_changed", "detail": "signature_document_changed" } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.sessions.signatures.download_document(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.sessions.signatures.downloadDocument(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Sessions.Signatures.DownloadDocument(ctx, \"11111111-2222-3333-4444-555555555555\", \"feature_signature\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.sessions().signatures().downloadDocument(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\", \"11111111-2222-3333-4444-555555555555\")\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "sessions->signatures->downloadDocument('11111111-2222-3333-4444-555555555555', 'feature_signature', '11111111-2222-3333-4444-555555555555');\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.sessions.signatures.download_document(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Sessions.Signatures.DownloadDocumentAsync(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\", \"11111111-2222-3333-4444-555555555555\");\nawait content.SaveToAsync(\"download.pdf\");" } ] } }, "/v3/session/{sessionId}/signatures/{nodeId}/evidence/": { "get": { "summary": "Descargar las evidencias de la firma", "description": "Descarga el PDF de evidencias de un firmante: el nivel y el formato, el firmante, la dirección IP, cada documento con su SHA-256 original y los valores de sus campos, y el SHA-256 de cada archivo firmado, además, en una firma avanzada (AES), la sesión de identidad verificada, la confirmación del código, el certificado y la marca de tiempo. Usa la ruta `evidence_file` del elemento del firmante en `signatures[]`.\n\nPasa siempre `signature_id` cuando un paso de Verificación de empresas tenga varios firmantes: sin él, la ruta elige a uno de los firmantes del paso. Requiere `read:sessions`; tu clave de API sirve.", "operationId": "get_v3_session_signature_evidence", "x-didit-sdk": { "resource": "sessions.signatures", "method": "download_evidence", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "La sesión de verificación de usuarios (KYC) o de verificación de empresas (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "El paso de Firma electrónica: `node_id` del elemento en `signatures[]`.", "schema": { "type": "string", "example": "feature_signature" } }, { "name": "signature_id", "in": "query", "required": false, "description": "`id` del elemento del firmante en `signatures[]`.", "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "El PDF de evidencia.", "headers": { "Content-Disposition": { "description": "Adjunto con el nombre del archivo.", "schema": { "type": "string", "example": "attachment; filename=\"signature-evidence.pdf\"" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Faltan las credenciales, o la credencial no puede leer esta sesión. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "You do not have permission to perform this action." } } } }, "404": { "description": "No hay evidencia que coincida: la sesión, el paso o el firmante no existe, se eliminó o no ha firmado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Not signed yet": { "summary": "El firmante no ha firmado", "value": { "code": "signature_not_signed", "detail": "signature_not_signed" } }, "Unknown signer": { "summary": "No existe esa firma en este paso", "value": { "code": "signature_not_found", "detail": "signature_not_found" } } } } } }, "409": { "description": "El archivo almacenado ya no coincide con su SHA-256 registrado. No se devuelve nada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Changed file": { "summary": "El archivo almacenado no coincide con su hash", "value": { "code": "signature_document_changed", "detail": "signature_document_changed" } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.sessions.signatures.download_evidence(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.sessions.signatures.downloadEvidence(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n);\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Sessions.Signatures.DownloadEvidence(ctx, \"11111111-2222-3333-4444-555555555555\", \"feature_signature\", didit.SessionsSignaturesDownloadEvidenceParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.sessions().signatures().downloadEvidence(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\")\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "sessions->signatures->downloadEvidence('11111111-2222-3333-4444-555555555555', 'feature_signature');\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.sessions.signatures.download_evidence(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\"\n)\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Sessions.Signatures.DownloadEvidenceAsync(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\");\nawait content.SaveToAsync(\"download.pdf\");" } ] } }, "/v3/session/{sessionId}/signatures/{nodeId}/fields/{fieldId}/image/": { "get": { "summary": "Descargar una imagen de firma", "description": "Descarga en PNG la firma o las iniciales que un firmante aplicó a un campo. Usa el `image_url` del campo en `signatures[].documents[].fields[]`. Requiere `read:sessions`; tu clave de API sirve.", "operationId": "get_v3_session_signature_field_image", "x-didit-sdk": { "resource": "sessions.signatures", "method": "download_field_image", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "La sesión de verificación de usuarios (KYC) o de verificación de empresas (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "El paso de Firma electrónica: `node_id` del elemento en `signatures[]`.", "schema": { "type": "string", "example": "feature_signature" } }, { "name": "fieldId", "in": "path", "required": true, "description": "El campo en la copia de este firmante, como en el `image_url` del campo.", "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "La imagen.", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "La imagen almacenada ya no coincide con su SHA-256 registrado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "example": { "code": "signature_document_changed", "detail": "signature_document_changed" } } } }, "403": { "description": "Faltan las credenciales, o la credencial no puede leer esta sesión. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "You do not have permission to perform this action." } } } }, "404": { "description": "No hay ninguna imagen que coincida: la sesión, el paso o el campo no existe, se eliminó o no tiene una firma o iniciales aplicadas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Unknown field": { "summary": "No existe ese campo", "value": { "code": "signature_field_not_found", "detail": "signature_field_not_found" } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.sessions.signatures.download_field_image(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nwith open(\"download.png\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.sessions.signatures.downloadFieldImage(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nawait writeFile(\"download.png\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Sessions.Signatures.DownloadFieldImage(ctx, \"11111111-2222-3333-4444-555555555555\", \"feature_signature\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.png\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.sessions().signatures().downloadFieldImage(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\", \"11111111-2222-3333-4444-555555555555\")\n .writeTo(Path.of(\"download.png\"));" }, { "lang": "php", "label": "PHP", "source": "sessions->signatures->downloadFieldImage('11111111-2222-3333-4444-555555555555', 'feature_signature', '11111111-2222-3333-4444-555555555555');\n$content->saveTo('download.png');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.sessions.signatures.download_field_image(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nFile.binwrite(\"download.png\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Sessions.Signatures.DownloadFieldImageAsync(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\", \"11111111-2222-3333-4444-555555555555\");\nawait content.SaveToAsync(\"download.png\");" } ] } }, "/v3/session/{sessionId}/signatures/{nodeId}/validate/": { "post": { "summary": "Volver a validar las firmas", "description": "Vuelve a comprobar los documentos firmados de un paso de Firma electrónica. Didit vuelve a leer cada PDF firmado, comprueba su SHA-256 y, en una firma avanzada (AES), valida la firma PAdES, el certificado, los datos de revocación y el sello de tiempo (una firma simple no tiene firma digital, así que solo se comprueba la integridad del archivo); después guarda el resultado en el `validation` de cada firmante y devuelve los elementos actualizados. No se vuelve a firmar nada. Envía `signature_id` para comprobar un solo firmante; sin él, se comprueban todos los firmantes del paso, y la llamada falla si alguno de ellos no ha firmado.\n\nRequiere `write:sessions`; tu clave de API sirve. En la consola es el botón **Validate again**.", "operationId": "post_v3_session_signature_validate", "x-didit-sdk": { "resource": "sessions.signatures", "method": "validate", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "La sesión de verificación de usuarios (KYC) o de verificación de empresas (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "El paso de Firma electrónica: `node_id` del elemento en `signatures[]`.", "schema": { "type": "string", "example": "feature_signature" } } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "signature_id": { "type": "string", "format": "uuid", "description": "`id` del elemento de un firmante en `signatures[]`." } } }, "example": { "signature_id": "0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10" } } } }, "responses": { "200": { "description": "Los firmantes comprobados, con su `validation` actualizado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "signatures": { "type": "array", "items": { "$ref": "#/components/schemas/SignatureResult" } } } } } } }, "400": { "description": "Un PDF firmado almacenado ya no coincide con el SHA-256 registrado cuando se firmó.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Document changed": { "summary": "Un archivo firmado ya no coincide con su hash", "value": { "code": "signature_document_changed", "detail": "signature_document_changed" } } } } } }, "403": { "description": "Faltan las credenciales, o la credencial no puede leer esta sesión. Si falta la clave, se devuelve `403`; si la clave es incorrecta, está revocada o ha expirado, se devuelve `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "You do not have permission to perform this action." } } } }, "404": { "description": "Ninguna firma coincide: la sesión, el paso o el firmante no existe o se eliminó.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Unknown signer": { "summary": "No existe esa firma en este paso", "value": { "code": "signature_not_found", "detail": "signature_not_found" } } } } } }, "409": { "description": "Un firmante del paso no ha firmado, por lo que no hay nada que validar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Not signed": { "summary": "Un firmante aún no ha firmado", "value": { "code": "signature_not_signed", "detail": "signature_not_signed" } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.signatures.validate(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n signature_id=\"0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.signatures.validate(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n {\n signature_id: \"0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10\",\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Signatures.Validate(ctx, \"11111111-2222-3333-4444-555555555555\", \"feature_signature\", didit.SessionsSignaturesValidateParams{\n\tSignatureID: didit.String(\"0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsSignaturesValidateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().signatures().validate(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\", SessionsSignaturesValidateParams.builder()\n .signatureId(\"0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->signatures->validate('11111111-2222-3333-4444-555555555555', 'feature_signature', [\n 'signature_id' => '0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.signatures.validate(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n signature_id: \"0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Signatures.ValidateAsync(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\", new SessionsSignaturesValidateParams\n{\n SignatureId = \"0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/document-ai/{sessionId}/documents/{documentUuid}/": { "patch": { "summary": "Actualizar un documento de Document AI", "description": "Corrige los campos que Document AI extrajo de un documento subido, establece su estado de revisión, o ambas cosas, en una sesión KYC o KYB. `extracted_data` debe ser un objeto JSON y se combina clave por clave: una clave que envías reemplaza el valor guardado (una clave enviada como `null` se guarda como `null`) y las claves que omites conservan sus valores. El estado del documento alimenta el resultado de Document AI de su nodo del flujo en la decisión de la sesión; el estado de la propia sesión no se recalcula. Cada llamada exitosa, incluso una que no cambia nada, envía un [webhook](https://docs.didit.me/es/integration/webhooks) `data.updated` con el disparador `manual_review`. Una clave de API con alcance limitado necesita `decisions: write`; consulta [Document AI](https://docs.didit.me/es/core-technology/document-ai/overview).", "operationId": "patch_v3_document_ai_document", "x-didit-sdk": { "resource": "sessions", "method": "update_document_ai_data", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de verificación (el `session_id` que devuelve `POST /v3/session/`). Acepta ID de sesión tanto de Verificación de usuarios (KYC) como de Verificación de empresas (KYB): el servidor resuelve el ID en ambos tipos de sesión. Debe ser un UUID con formato válido; un valor mal formado no coincide con la ruta y devuelve un `404` en HTML.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "documentUuid", "in": "path", "required": true, "description": "UUID del documento de Document AI (`document_ai_documents[].items[].uuid` en `GET /v3/session/{sessionId}/decision/`). Debe pertenecer a la sesión indicada en la ruta.", "schema": { "type": "string", "format": "uuid", "example": "44444444-5555-6666-7777-888888888888" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "extracted_data": { "type": "object", "additionalProperties": true, "description": "Claves de campo (las claves que configuraste para el documento) y sus valores corregidos. Debe ser un objeto JSON; se combina clave por clave con los datos almacenados. Omítelo en lugar de enviar `null`, que devuelve `400`.", "example": { "invoice_number": "INV-2026-0042" } }, "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Not Finished" ], "description": "Nuevo estado de revisión del documento.", "example": "Approved" } } }, "example": { "extracted_data": { "invoice_number": "INV-2026-0042" }, "status": "Approved" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/document-ai/11111111-2222-3333-4444-555555555555/documents/44444444-5555-6666-7777-888888888888/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"extracted_data\": {\"invoice_number\": \"INV-2026-0042\"}, \"status\": \"Approved\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_document_ai_data(\n \"11111111-2222-3333-4444-555555555555\",\n \"44444444-5555-6666-7777-888888888888\",\n extracted_data={\"invoice_number\": \"INV-2026-0042\"},\n status=\"Approved\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateDocumentAiData(\n \"11111111-2222-3333-4444-555555555555\",\n \"44444444-5555-6666-7777-888888888888\",\n {\n extracted_data: { invoice_number: \"INV-2026-0042\" },\n status: \"Approved\",\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateDocumentAiData(ctx, \"11111111-2222-3333-4444-555555555555\", \"44444444-5555-6666-7777-888888888888\", didit.SessionsUpdateDocumentAiDataParams{\n\tExtractedData: didit.Some(map[string]any{\"invoice_number\": \"INV-2026-0042\"}),\n\tStatus: didit.Some(didit.SessionsUpdateDocumentAiDataParamsStatus(\"Approved\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsUpdateDocumentAiDataParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateDocumentAiData(\"11111111-2222-3333-4444-555555555555\", \"44444444-5555-6666-7777-888888888888\", SessionsUpdateDocumentAiDataParams.builder()\n .extractedData(Map.of(\"invoice_number\", \"INV-2026-0042\"))\n .status(SessionsUpdateDocumentAiDataParams.Status.of(\"Approved\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateDocumentAiData('11111111-2222-3333-4444-555555555555', '44444444-5555-6666-7777-888888888888', [\n 'extracted_data' => ['invoice_number' => 'INV-2026-0042'],\n 'status' => 'Approved',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_document_ai_data(\n \"11111111-2222-3333-4444-555555555555\",\n \"44444444-5555-6666-7777-888888888888\",\n extracted_data: { invoice_number: \"INV-2026-0042\" },\n status: \"Approved\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateDocumentAiDataAsync(\"11111111-2222-3333-4444-555555555555\", \"44444444-5555-6666-7777-888888888888\", new SessionsUpdateDocumentAiDataParams\n{\n ExtractedData = new Dictionary { [\"invoice_number\"] = \"INV-2026-0042\" },\n Status = new SessionsUpdateDocumentAiDataParamsStatus(\"Approved\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Documento actualizado. Devuelve el documento después de la combinación.", "content": { "application/json": { "schema": { "type": "object", "required": [ "uuid", "document_key", "original_filename", "file_url", "status", "extracted_data" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador del documento." }, "document_key": { "type": "string", "description": "El documento configurado al que corresponde esta carga." }, "original_filename": { "type": "string", "nullable": true, "description": "Nombre de archivo con el que se subió el documento." }, "file_url": { "type": "string", "nullable": true, "description": "Ruta de almacenamiento del archivo subido. No es un enlace de descarga: lee el `file_url` prefirmado de la decisión de la sesión para descargar el archivo." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estado de revisión del documento." }, "extracted_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Todos los campos extraídos tras la combinación, indexados por clave de campo." } } }, "example": { "uuid": "44444444-5555-6666-7777-888888888888", "document_key": "invoice", "original_filename": "invoice-2026-09.pdf", "file_url": "document_ai/11111111-2222-3333-4444-555555555555-66666666-7777-8888-9999-000000000000.pdf", "status": "Approved", "extracted_data": { "invoice_number": "INV-2026-0042", "total_amount": 1250.0, "issue_date": "2026-09-01" } } } } }, "400": { "description": "Error de validación, comprobado antes de buscar el documento: `status` no es uno de los valores permitidos, o `extracted_data` se envía como `null`.", "content": { "application/json": { "examples": { "Invalid status": { "summary": "status no está en el enum", "value": { "status": [ "\"Rejected\" is not a valid choice." ] } }, "Null extracted_data": { "summary": "extracted_data es null", "value": { "extracted_data": [ "This field may not be null." ] } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Este es el único caso que devuelve `401`: una clave ausente, no válida o revocada devuelve `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "summary": "La fecha de caducidad de la clave ya pasó", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallo de autenticación o autorización. Si falta la clave, se devuelve `403`, al igual que con una clave de otra aplicación, una clave con alcance limitado sin el permiso que necesita este endpoint y una solicitud desde fuera de la lista de IP permitidas de la clave; una clave incorrecta, revocada o expirada devuelve `401`. Distínguelos por `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la validación", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clave válida que pertenece a una aplicación distinta de la de la sesión", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clave con alcance limitado le falta decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Solicitud desde fuera de la lista de IP permitidas de la clave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión no existe, se ha eliminado o está fuera de los límites de una clave con alcance restringido, o no le pertenece ningún documento actual con este UUID. La búsqueda de la sesión se ejecuta antes de comprobar la credencial, por lo que un `sessionId` desconocido devuelve `404` incluso sin una clave válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Unknown session": { "summary": "No existe ninguna sesión con este ID, o se eliminó", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "La sesión está fuera de los límites de una clave con alcance restringido (también se devuelve para una sesión eliminada hace unos instantes)", "value": { "detail": "Session not found." } }, "Unknown document": { "summary": "documentUuid no pertenece a la sesión", "value": { "detail": "Document AI document not found." } } } } } }, "429": { "description": "Límite de solicitudes superado: 300 solicitudes de escritura (POST, PATCH, DELETE) por minuto por clave de API. Espera los segundos indicados en `Retry-After` antes de reintentar; los encabezados `X-RateLimit-*` muestran el presupuesto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Rate limited": { "summary": "Presupuesto del minuto actual agotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/aml/dataset-freshness/": { "get": { "summary": "Obtener el estado de actualización del conjunto de datos AML", "description": "Indica lo actualizados que están los conjuntos de datos en los que se basa el Análisis AML, por familia de fuentes (`sanctions`, `pep`, `warnings`, `adverse_media`), como evidencia de auditoría para la [Monitorización AML continua](https://docs.didit.me/es/core-technology/aml-screening/continuous-monitoring-aml-screening#demostrar-que-la-monitorización-se-ejecutó). La respuesta abarca toda la plataforma: no hay ninguna sesión en la ruta ni datos de clientes en el cuerpo, y la respuesta es la misma para todas las aplicaciones.\n\nSiempre devuelve `200` para una clave aceptada. Comprueba primero `availability`: cuando no es `available`, `dataset_freshness` es `null`. Las fechas nunca se estiman: una familia cuyos conjuntos de datos no informaron ninguna fecha no aparece en `sources`, y una familia en la que solo algunos conjuntos de datos informaron una tiene `oldest_updated_at: null`. Las lecturas se toman mientras se ejecuta la monitorización continua, no en cada llamada; `captured_at` indica cuándo.\n\nUna clave de API con alcance limitado necesita `sessions: read`; una clave limitada a algunos flujos o a sesiones aprobadas no puede llamar a este endpoint. No se cobra nada.", "operationId": "get_aml_dataset_freshness", "x-didit-sdk": { "resource": "aml", "method": "retrieve_dataset_freshness", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "parameters": [], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/aml/dataset-freshness/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.aml.retrieve_dataset_freshness()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.aml.retrieveDatasetFreshness();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.AML.RetrieveDatasetFreshness(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.aml().retrieveDatasetFreshness();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "aml->retrieveDatasetFreshness();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.aml.retrieve_dataset_freshness\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Aml.RetrieveDatasetFreshnessAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La lectura más reciente de actualización del conjunto de datos, o `null` con el motivo.", "content": { "application/json": { "schema": { "type": "object", "required": [ "dataset_freshness", "availability" ], "properties": { "dataset_freshness": { "allOf": [ { "$ref": "#/components/schemas/AMLDatasetFreshness" } ], "nullable": true, "description": "La lectura más reciente, o `null` cuando `availability` no es `available`." }, "availability": { "type": "string", "enum": [ "available", "not_configured", "not_yet_collected" ], "description": "`available` cuando existe una lectura; `not_configured` cuando no se recopilan las fechas de los conjuntos de datos en este entorno; `not_yet_collected` cuando la recopilación está configurada, pero aún no existe ninguna lectura." } } }, "examples": { "Available": { "value": { "dataset_freshness": { "captured_at": "2026-10-17T06:00:12.345678+00:00", "provider": "aml_data_source", "catalog_version": "20261017054500-abc", "sources": { "sanctions": { "last_updated_at": "2026-10-17T04:10:00+00:00", "oldest_updated_at": "2026-10-15T22:30:00+00:00", "dataset_count": 48, "dated_dataset_count": 48 }, "pep": { "last_updated_at": "2026-10-16T23:05:00+00:00", "oldest_updated_at": null, "dataset_count": 12, "dated_dataset_count": 11 } } }, "availability": "available" } }, "Not collected yet": { "value": { "dataset_freshness": null, "availability": "not_yet_collected" } } } } } }, "401": { "description": "La clave de API ha expirado. Solo puede expirar una clave creada con fecha de caducidad; a partir de esa fecha, toda solicitud que la use responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Si falta la clave, se recibe el mensaje genérico; una clave incorrecta, revocada o expirada recibe `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without sessions read": { "value": { "detail": "This API key has no read access to sessions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Más de 600 solicitudes GET por minuto con esta clave de API. Espera el número de segundos indicado en `Retry-After` y vuelve a intentarlo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos hasta que se reinicia la ventana actual de un minuto.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas por minuto en este presupuesto.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Tiempo Unix en que se restablece la ventana.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/lists/": { "get": { "summary": "Listar listas", "description": "Devuelve las listas de la aplicación, de más reciente a más antigua: las listas del sistema que Didit crea (una lista de bloqueo por cada tipo de entrada, la lista personalizada **High Risk Countries** y cualquier lista de permitidos del sistema) y las listas de permitidos y listas personalizadas que creaste. Filtra con `list_type` y `entry_type`; las listas eliminadas nunca aparecen. Los resultados se paginan con `limit` y `offset`. Una clave de API con alcance limitado necesita `workflows: read`. Consulta [Listas](https://docs.didit.me/es/management-api/lists/overview) para saber qué hace cada tipo de lista.", "operationId": "list_lists", "x-didit-sdk": { "resource": "lists", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_type", "in": "query", "required": false, "description": "Solo listas de este tipo.", "schema": { "type": "string", "enum": [ "blocklist", "allowlist", "custom" ] } }, { "name": "entry_type", "in": "query", "required": false, "description": "Solo listas de este tipo de entrada.", "schema": { "type": "string", "enum": [ "face", "document", "phone", "email", "ip_address", "device_fingerprint", "wallet_address", "bank_account", "country", "user", "business", "key" ] } }, { "name": "ordering", "in": "query", "required": false, "description": "Orden de clasificación: `-created_at` (lo más reciente primero, el valor predeterminado) o `created_at` (lo más antiguo primero).", "schema": { "type": "string", "enum": [ "-created_at", "created_at" ], "default": "-created_at" } }, { "name": "limit", "in": "query", "required": false, "description": "Tamaño de página. El valor predeterminado es 50. Un valor superior a 1000000 devuelve `400`; cero, un valor negativo o un valor no numérico hacen que se use 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 } }, { "name": "offset", "in": "query", "required": false, "description": "Índice, empezando en cero, del primer elemento que se devuelve. Es preferible seguir `next`. Un valor superior a 1000000 devuelve `400`; un valor negativo o no numérico se toma como 0.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/lists/?list_type=blocklist' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.lists.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.lists.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Lists.ListAutoPaging(ctx, didit.ListsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.lists().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "lists->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.lists.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Lists.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Una página de listas.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Número total de listas que coinciden con los filtros." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la página siguiente, o `null` en la última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la página anterior, o `null` en la primera página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ComplianceList" } } } }, "examples": { "Lists": { "value": { "count": 2, "next": null, "previous": null, "results": [ { "uuid": "22222222-3333-4444-5555-666666666666", "name": "Trusted office IPs", "description": "Office egress ranges", "list_type": "allowlist", "entry_type": "ip_address", "is_system": false, "entry_count": 3, "last_entry_added_at": "2026-10-02T08:15:27.501334Z", "created_at": "2026-09-30T13:20:45.889120Z", "updated_at": "2026-09-30T13:20:45.889120Z" }, { "uuid": "11111111-2222-3333-4444-555555555555", "name": "Face Blocklist", "description": "Blocked biometric faces. When a face matching an entry in this list is detected during liveness verification, the session will be automatically declined.", "list_type": "blocklist", "entry_type": "face", "is_system": true, "entry_count": 12, "last_entry_added_at": "2026-10-09T16:42:03.118204Z", "created_at": "2026-01-14T10:02:11.402917Z", "updated_at": "2026-01-14T10:02:11.402917Z" } ] } } } } } }, "400": { "description": "Un parámetro de consulta no es válido.", "content": { "application/json": { "examples": { "Unknown list type": { "value": { "list_type": [ "\"denylist\" is not a valid choice." ] } }, "Unsupported ordering": { "value": { "ordering": [ "\"name\" is not a valid choice." ] } }, "Limit too large": { "value": [ "limit must not exceed 1000000." ] } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Los demás fallos de autenticación devuelven `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta el encabezado `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), o una clave de API con alcance limitado no tiene `workflows: read` o se usa desde una dirección IP que no está en su lista de permitidas.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no read access to workflows." } } } } } }, "429": { "description": "Se superó el límite de lectura compartido de 600 solicitudes por minuto por clave de API. Respeta `Retry-After` antes de reintentar.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crear una lista", "description": "Crea una lista de permitidos o una lista personalizada en la aplicación a la que pertenece la clave de API. No se pueden crear listas de bloqueo: Didit aprovisiona una lista de bloqueo del sistema por cada tipo de entrada, y tú añades elementos a ella con [Crear una entrada de lista](https://docs.didit.me/es/management-api/lists/create-entry). `entry_type` no puede cambiar después de la creación y determina cómo se validan y comparan los valores de las entradas. Las entradas de una lista de permitidos marcan como de confianza los elementos coincidentes. Por ejemplo, una lista de permitidos de rostros omite la acción de rostro duplicado. Estas entradas nunca anulan una coincidencia con una lista de bloqueo. Haz referencia a cualquier lista desde una condición de regla de flujo o de transacción con `value_type: \"list\"`. Una clave de API con alcance limitado necesita `workflows: write`.", "operationId": "create_list", "x-didit-sdk": { "resource": "lists", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "list_type", "entry_type" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Nombre de la lista. Debe ser distinto del nombre de cualquier otra lista de la aplicación, incluidas las listas del sistema." }, "description": { "type": "string", "default": "", "description": "Descripción opcional en texto libre." }, "list_type": { "type": "string", "enum": [ "allowlist", "custom" ], "description": "`allowlist` o `custom`. `blocklist` se rechaza con `400`." }, "entry_type": { "type": "string", "enum": [ "face", "document", "phone", "email", "ip_address", "device_fingerprint", "wallet_address", "bank_account", "country", "user", "business", "key" ], "description": "Qué contiene la lista: `face`, `document` (número de documento), `phone`, `email`, `ip_address` (dirección IP o rango CIDR), `device_fingerprint`, `wallet_address`, `bank_account`, `country` (ISO 3166-1 alfa-3), `user` o `business` (tu `vendor_data`), o `key` (cualquier cadena). Determina cómo se validan y comparan los valores de las entradas. No se puede cambiar después." } } }, "examples": { "IP allowlist": { "value": { "name": "Trusted office IPs", "description": "Office egress ranges", "list_type": "allowlist", "entry_type": "ip_address" } }, "Custom country list": { "value": { "name": "Enhanced due diligence countries", "list_type": "custom", "entry_type": "country" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/lists/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"name\": \"Trusted office IPs\",\n \"description\": \"Office egress ranges\",\n \"list_type\": \"allowlist\",\n \"entry_type\": \"ip_address\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.lists.create(\n name=\"Trusted office IPs\",\n description=\"Office egress ranges\",\n list_type=\"allowlist\",\n entry_type=\"ip_address\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.lists.create({\n name: \"Trusted office IPs\",\n description: \"Office egress ranges\",\n list_type: \"allowlist\",\n entry_type: \"ip_address\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Create(ctx, didit.ListsCreateParams{\n\tName: \"Trusted office IPs\",\n\tDescription: didit.String(\"Office egress ranges\"),\n\tListType: \"allowlist\",\n\tEntryType: \"ip_address\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.ListsCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.lists().create(ListsCreateParams.builder()\n .name(\"Trusted office IPs\")\n .description(\"Office egress ranges\")\n .listType(ListsCreateParams.ListType.of(\"allowlist\"))\n .entryType(ListsCreateParams.EntryType.of(\"ip_address\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "lists->create([\n 'name' => 'Trusted office IPs',\n 'description' => 'Office egress ranges',\n 'list_type' => 'allowlist',\n 'entry_type' => 'ip_address',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.lists.create(\n name: \"Trusted office IPs\",\n description: \"Office egress ranges\",\n list_type: \"allowlist\",\n entry_type: \"ip_address\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Lists.CreateAsync(new ListsCreateParams\n{\n Name = \"Trusted office IPs\",\n Description = \"Office egress ranges\",\n ListType = \"allowlist\",\n EntryType = \"ip_address\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "La lista se creó.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceList" }, "examples": { "New allowlist": { "value": { "uuid": "22222222-3333-4444-5555-666666666666", "name": "Trusted office IPs", "description": "Office egress ranges", "list_type": "allowlist", "entry_type": "ip_address", "is_system": false, "entry_count": 0, "last_entry_added_at": null, "created_at": "2026-10-12T09:15:44.031876Z", "updated_at": "2026-10-12T09:15:44.031876Z" } } } } } }, "400": { "description": "El cuerpo no es válido.", "content": { "application/json": { "examples": { "Blocklist refused": { "value": { "list_type": [ "Cannot create additional blocklist lists. System blocklists are auto-created for each application." ] } }, "Duplicate name": { "value": { "name": [ "A list with this name already exists for this application." ] } }, "Missing fields": { "value": { "name": [ "This field is required." ], "list_type": [ "This field is required." ], "entry_type": [ "This field is required." ] } }, "Unknown entry type": { "value": { "entry_type": [ "\"iban\" is not a valid choice." ] } }, "Name too long": { "value": { "name": [ "Ensure this field has no more than 255 characters." ] } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Los demás fallos de autenticación devuelven `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta el encabezado `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), o una clave de API con alcance limitado no tiene `workflows: write` o se usa desde una dirección IP que no está en su lista de permitidas.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/lists/{list_uuid}/": { "get": { "summary": "Obtener una lista", "description": "Devuelve una lista de la aplicación con su número de entradas y la fecha en que se añadió su entrada más reciente. Una lista de otra aplicación, o una que se eliminó, devuelve `404`. Esto devuelve solo la lista: lee sus valores con [Listar entradas de una lista](https://docs.didit.me/es/management-api/lists/list-entries). Una clave de API con alcance limitado necesita `workflows: read`.", "operationId": "get_list", "x-didit-sdk": { "resource": "lists", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID de la lista, tal como lo devuelven Listar listas o Crear una lista.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.lists.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.lists.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.lists().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "lists->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.lists.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Lists.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La lista.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceList" }, "examples": { "System face blocklist": { "value": { "uuid": "11111111-2222-3333-4444-555555555555", "name": "Face Blocklist", "description": "Blocked biometric faces. When a face matching an entry in this list is detected during liveness verification, the session will be automatically declined.", "list_type": "blocklist", "entry_type": "face", "is_system": true, "entry_count": 12, "last_entry_added_at": "2026-10-09T16:42:03.118204Z", "created_at": "2026-01-14T10:02:11.402917Z", "updated_at": "2026-01-14T10:02:11.402917Z" } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Los demás fallos de autenticación devuelven `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta el encabezado `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), o una clave de API con alcance limitado no tiene `workflows: read` o se usa desde una dirección IP que no está en su lista de permitidas.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no read access to workflows." } } } } } }, "404": { "description": "No existe ninguna lista con este UUID en la aplicación de la clave de API, o se eliminó.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No List matches the given query." } } } } } }, "429": { "description": "Se superó el límite de lectura compartido de 600 solicitudes por minuto por clave de API. Respeta `Retry-After` antes de reintentar.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualizar una lista", "description": "Cambia el nombre de una lista o su descripción. Solo se leen `name` y `description`; cualquier otro campo se ignora, de modo que `list_type` y `entry_type` conservan los valores con los que se crearon. Las listas del sistema no se pueden modificar y devuelven `400`. La respuesta contiene solo `name` y `description`: llama a [Obtener una lista](https://docs.didit.me/es/management-api/lists/get) para obtener la lista completa. Una clave de API con alcance limitado necesita `workflows: write`.", "operationId": "update_list", "x-didit-sdk": { "resource": "lists", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID de la lista, tal como lo devuelven Listar listas o Crear una lista.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Nuevo nombre. Debe ser distinto del nombre de todas las demás listas de la aplicación." }, "description": { "type": "string", "description": "Nueva descripción. Envía una cadena vacía para eliminarla." } } }, "examples": { "Rename": { "value": { "name": "Trusted office and VPN IPs" } }, "Rename and describe": { "value": { "name": "Trusted office and VPN IPs", "description": "Office egress ranges and the corporate VPN" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"name\": \"Trusted office and VPN IPs\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.lists.update(\n \"11111111-2222-3333-4444-555555555555\",\n name=\"Trusted office and VPN IPs\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.lists.update(\"11111111-2222-3333-4444-555555555555\", {\n name: \"Trusted office and VPN IPs\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsUpdateParams{\n\tName: didit.String(\"Trusted office and VPN IPs\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.ListsUpdateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.lists().update(\"11111111-2222-3333-4444-555555555555\", ListsUpdateParams.builder()\n .name(\"Trusted office and VPN IPs\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "lists->update('11111111-2222-3333-4444-555555555555', [\n 'name' => 'Trusted office and VPN IPs',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.lists.update(\n \"11111111-2222-3333-4444-555555555555\",\n name: \"Trusted office and VPN IPs\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Lists.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new ListsUpdateParams\n{\n Name = \"Trusted office and VPN IPs\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La lista se actualizó. Solo se devuelven los campos editables.", "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string", "description": "El nombre de la lista después de la actualización." }, "description": { "type": "string", "description": "La descripción de la lista después de la actualización." } } }, "examples": { "Renamed": { "value": { "name": "Trusted office and VPN IPs", "description": "Office egress ranges" } } } } } }, "400": { "description": "La lista es una lista del sistema, o el cuerpo no es válido.", "content": { "application/json": { "examples": { "System list": { "value": { "non_field_errors": [ "System lists cannot be modified." ] } }, "Duplicate name": { "value": { "name": [ "A list with this name already exists for this application." ] } }, "Blank name": { "value": { "name": [ "This field may not be blank." ] } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Los demás fallos de autenticación devuelven `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta el encabezado `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), o una clave de API con alcance limitado no tiene `workflows: write` o se usa desde una dirección IP que no está en su lista de permitidas.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "404": { "description": "No existe ninguna lista con este UUID en la aplicación de la clave de API, o se eliminó.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No List matches the given query." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Eliminar una lista", "description": "Elimina una lista de permitidos o una lista personalizada junto con sus entradas. La eliminación es irreversible: la lista y sus entradas dejan de aparecer en cualquier lectura, y las condiciones de las reglas de flujos y de transacciones que hacen referencia a la lista la evalúan como una lista vacía a partir de ese momento. Las sesiones y transacciones ya evaluadas conservan sus resultados, y el nombre puede reutilizarse para una lista nueva. Las listas del sistema no se pueden eliminar y devuelven `400`; para vaciar una, [elimina sus entradas](https://docs.didit.me/es/management-api/lists/delete-entry). Una clave de API con alcance limitado necesita `workflows: write`.", "operationId": "delete_list", "x-didit-sdk": { "resource": "lists", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID de la lista, tal como lo devuelven Listar listas o Crear una lista.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.lists.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.lists.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Lists.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.lists().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "lists->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.lists.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Lists.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ], "responses": { "204": { "description": "La lista y sus entradas se eliminaron. Sin cuerpo." }, "400": { "description": "La lista es una lista del sistema.", "content": { "application/json": { "examples": { "System list": { "value": { "detail": "System lists cannot be deleted." } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Los demás fallos de autenticación devuelven `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta el encabezado `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), o una clave de API con alcance limitado no tiene `workflows: write` o se usa desde una dirección IP que no está en su lista de permitidas.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "404": { "description": "No existe ninguna lista con este UUID en la aplicación de la clave de API, o ya se eliminó.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No List matches the given query." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/lists/{list_uuid}/entries/": { "get": { "summary": "Listar entradas de una lista", "description": "Devuelve las entradas actuales de una lista, de más reciente a más antigua. `search` busca coincidencias con una parte del `value` o del `display_label` de una entrada sin distinguir mayúsculas de minúsculas, y `reference_session_id` limita los resultados a las entradas tomadas de una sesión de verificación de persona. Las URL de imágenes en `metadata` son URL firmadas de corta duración que se emiten de nuevo en cada llamada; una clave de API con alcance limitado sin `media: read` recibe `null` en su lugar. Una clave de API con alcance limitado necesita `workflows: read`.", "operationId": "list_list_entries", "x-didit-sdk": { "resource": "lists.entries", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID de la lista, tal como lo devuelven Listar listas o Crear una lista.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "search", "in": "query", "required": false, "description": "Texto, sin distinguir mayúsculas y minúsculas, que debe contener el `value` o el `display_label` de la entrada.", "schema": { "type": "string" } }, { "name": "reference_session_id", "in": "query", "required": false, "description": "Solo las entradas tomadas de esta sesión de verificación de persona, por ejemplo para ver cuáles de sus rostros ya están en una lista.", "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "description": "Tamaño de página. El valor predeterminado es 50. Un valor superior a 1000000 devuelve `400`; cero, un valor negativo o un valor no numérico hacen que se use 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 } }, { "name": "offset", "in": "query", "required": false, "description": "Índice, empezando en cero, del primer elemento que se devuelve. Es preferible seguir `next`. Un valor superior a 1000000 devuelve `400`; un valor negativo o no numérico se toma como 0.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/?search=example.com' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.lists.entries.list(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.lists.entries.list(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Lists.Entries.ListAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.lists().entries().list(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "lists->entries->list('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.lists.entries.list(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Lists.Entries.ListAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Una página de entradas, de la más reciente a la más antigua.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Número total de entradas que coinciden con los filtros." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la página siguiente, o `null` en la última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la página anterior, o `null` en la primera página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ComplianceListEntry" } } } }, "examples": { "Entries": { "value": { "count": 2, "next": null, "previous": null, "results": [ { "uuid": "bbbbbbbb-cccc-dddd-eeee-ffffffffffff", "value": "X1234567", "display_label": "Jane Doe - X1234567", "comment": "", "added_by": "api", "reference_session_id": "33333333-4444-5555-6666-777777777777", "reference_session_number": 1042, "reference_session_type": "kyc", "reference_object_uuid": "66666666-7777-8888-9999-000000000000", "metadata": { "full_name": "Jane Doe", "issuing_state": "ESP", "document_type": "ID", "region": "", "document_number": "X1234567" }, "created_at": "2026-10-12T10:06:12.774915Z" }, { "uuid": "eeeeeeee-ffff-0000-1111-222222222222", "value": "y7654321", "display_label": "", "comment": "Reported by a partner", "added_by": "api", "reference_session_id": null, "reference_session_number": null, "reference_session_type": null, "reference_object_uuid": null, "metadata": null, "created_at": "2026-10-03T07:48:30.552810Z" } ] } } } } } }, "400": { "description": "Un parámetro de consulta no es válido.", "content": { "application/json": { "examples": { "Invalid session id": { "value": { "reference_session_id": [ "Must be a valid UUID." ] } }, "Limit too large": { "value": [ "limit must not exceed 1000000." ] } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Los demás fallos de autenticación devuelven `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta el encabezado `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), o una clave de API con alcance limitado no tiene `workflows: read` o se usa desde una dirección IP que no está en su lista de permitidas.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no read access to workflows." } } } } } }, "404": { "description": "No existe ninguna lista con este UUID en la aplicación de la clave de API, o se eliminó.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "List not found." } } } } } }, "429": { "description": "Se superó el límite de lectura compartido de 600 solicitudes por minuto por clave de API. Respeta `Retry-After` antes de reintentar.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crear una entrada de lista", "description": "Añade una entrada a una lista, de una de estas tres formas: por `value`; desde una sesión de verificación con `reference_session_id`, en cuyo caso Didit lee el valor del registro más reciente de la sesión del tipo de entrada de la lista y vincula la entrada a él; o por `value` con un `reference_object_uuid` y un `metadata.reference_type` que apuntan a una transacción, un usuario o una empresa. En las listas de bloqueo del sistema de rostros, documentos, teléfonos y correos electrónicos, el registro leído de la sesión también se marca como bloqueado, de modo que se rechazan las nuevas sesiones que coinciden; en las listas de bloqueo del sistema de usuarios y empresas, los usuarios o empresas que coinciden pasan a `BLOCKED`. Las sesiones y transacciones que ya finalizaron no se modifican. Una clave de API con alcance limitado necesita `workflows: write`. Consulta [Crear una entrada de lista](https://docs.didit.me/es/management-api/lists/create-entry) para cada modo.", "operationId": "create_list_entry", "x-didit-sdk": { "resource": "lists.entries", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID de la lista a la que se añade. Para un rostro del que solo tienes una imagen, usa en su lugar Subir un rostro a una lista.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Envía `value`, `reference_session_id` o ambos. Los campos que aplican dependen del `entry_type` de la lista.", "properties": { "value": { "type": "string", "description": "El valor que se añade a la lista, validado según el `entry_type` de la lista: `email`, una dirección de correo electrónico válida; `phone`, un número internacional válido, almacenado en E.164; `ip_address`, una dirección IP o un rango CIDR (por ejemplo, `10.0.0.0/8`); `device_fingerprint`, al menos 8 caracteres entre letras, dígitos, `-`, `_`, `:` y `.` (una lista de bloqueo rechaza una huella digital que hayan reportado varios dispositivos distintos); `country`, un código ISO 3166-1 alfa-2 o alfa-3, almacenado como alfa-3; `user` y `business`, el `vendor_data`; cualquier otro tipo, una cadena no vacía. Se almacena en minúsculas, salvo los números de teléfono y los códigos de país, y una lista contiene cada valor una sola vez (sin distinguir mayúsculas de minúsculas). Obligatorio salvo que se envíe `reference_session_id`; debe dejarse vacío con un `face_image_source` de captura de documento." }, "reference_session_id": { "type": "string", "format": "uuid", "description": "Una sesión de verificación de persona o de empresa de tu aplicación de la que tomar el valor. Didit lee el registro más reciente de la sesión del tipo de entrada de la lista (`face`, `document`, `phone`, `email`, `ip_address` o `device_fingerprint`), vincula la entrada a la sesión y a ese registro, y rellena `display_label` y `metadata` para los documentos. En una lista de bloqueo `device_fingerprint`, se rechaza una sesión que solo tiene una huella de clase de dispositivo, o que se completó en más de un dispositivo: envía la huella exacta como `value`. Para otros tipos de entrada, o cuando la sesión no tiene ese registro, envía también `value`; en ese caso se almacena tu `value` y la entrada sigue vinculada a la sesión." }, "reference_object_uuid": { "type": "string", "format": "uuid", "description": "UUID del registro que representa la entrada cuando no procede de una sesión: un UUID de transacción o el `didit_internal_id` de un usuario o una empresa. Combínalo con `metadata.reference_type`. Se sustituye por el registro de la sesión cuando `reference_session_id` aporta uno." }, "face_image_source": { "type": "string", "enum": [ "liveness", "front_image_camera_front", "back_image_camera_front" ], "default": "liveness", "description": "Listas de rostros con `reference_session_id`: indica de cuál de las imágenes de la sesión se toma el rostro. `liveness` (valor predeterminado) es la selfie de la prueba de vida. `front_image_camera_front` y `back_image_camera_front` son las selfies que tomó la cámara frontal mientras el usuario fotografiaba el anverso o el reverso de su documento: solo se aceptan en la lista de bloqueo de rostros del sistema, con `reference_session_id` y un `value` vacío. Cada selfie puede añadirse una sola vez y debe mostrar un único rostro nítido." }, "reference_node_id": { "type": "string", "nullable": true, "maxLength": 100, "description": "Con un `face_image_source` de captura de documento: el nodo de verificación de identidad cuya selfie se usará, para flujos con más de uno. De forma predeterminada, la verificación de identidad más reciente que tenga esa imagen. Se rechaza con `liveness`." }, "display_label": { "type": "string", "maxLength": 512, "description": "Etiqueta legible. Si está vacía, Didit genera una a partir de la sesión cuando es posible (por ejemplo, el nombre del titular y el número de documento)." }, "comment": { "type": "string", "description": "Nota en texto libre, como el motivo de la inclusión en la lista." }, "metadata": { "type": "object", "additionalProperties": true, "description": "JSON libre que se guarda con la entrada y se devuelve tal como se guardó. Usa `reference_type` y `reference_id` para que la consola enlace al origen. `reference_image_url` y `front_image_url` solo los establece Didit y se descartan si los envías. En una entrada leída de una sesión, las claves de Didit se combinan con las tuyas.", "properties": { "reference_type": { "type": "string", "enum": [ "transaction", "vendor_user", "vendor_business" ], "description": "A qué apunta `reference_object_uuid`." }, "reference_id": { "type": "string", "description": "Identificador del registro de origen." } } } } }, "examples": { "By value": { "value": { "value": "+14155552671", "comment": "Reported fraud" } }, "From a session": { "value": { "reference_session_id": "33333333-4444-5555-6666-777777777777" } }, "Face from a document-capture selfie": { "value": { "reference_session_id": "33333333-4444-5555-6666-777777777777", "face_image_source": "front_image_camera_front" } }, "From a transaction": { "value": { "value": "0x52908400098527886E0F7030069857D2E4169EE7", "reference_object_uuid": "55555555-6666-7777-8888-999999999999", "comment": "Linked to a chargeback", "metadata": { "reference_type": "transaction", "reference_id": "55555555-6666-7777-8888-999999999999" } } }, "Country": { "value": { "value": "PRK", "comment": "Sanctioned jurisdiction" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"value\": \"+14155552671\", \"comment\": \"Reported fraud\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.lists.entries.create(\n \"11111111-2222-3333-4444-555555555555\",\n value=\"+14155552671\",\n comment=\"Reported fraud\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.lists.entries.create(\"11111111-2222-3333-4444-555555555555\", {\n value: \"+14155552671\",\n comment: \"Reported fraud\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Entries.Create(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesCreateParams{\n\tValue: didit.String(\"+14155552671\"),\n\tComment: didit.String(\"Reported fraud\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.ListsEntriesCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.lists().entries().create(\"11111111-2222-3333-4444-555555555555\", ListsEntriesCreateParams.builder()\n .value(\"+14155552671\")\n .comment(\"Reported fraud\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "lists->entries->create('11111111-2222-3333-4444-555555555555', [\n 'value' => '+14155552671',\n 'comment' => 'Reported fraud',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.lists.entries.create(\n \"11111111-2222-3333-4444-555555555555\",\n value: \"+14155552671\",\n comment: \"Reported fraud\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Lists.Entries.CreateAsync(\"11111111-2222-3333-4444-555555555555\", new ListsEntriesCreateParams\n{\n Value = \"+14155552671\",\n Comment = \"Reported fraud\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Se creó la entrada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceListEntry" }, "examples": { "By value": { "value": { "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "value": "+14155552671", "display_label": "", "comment": "Reported fraud", "added_by": "api", "reference_session_id": null, "reference_session_number": null, "reference_session_type": null, "reference_object_uuid": null, "metadata": null, "created_at": "2026-10-12T10:04:51.220391Z" } }, "Document from a session": { "value": { "uuid": "bbbbbbbb-cccc-dddd-eeee-ffffffffffff", "value": "X1234567", "display_label": "Jane Doe - X1234567", "comment": "", "added_by": "api", "reference_session_id": "33333333-4444-5555-6666-777777777777", "reference_session_number": 1042, "reference_session_type": "kyc", "reference_object_uuid": "66666666-7777-8888-9999-000000000000", "metadata": { "full_name": "Jane Doe", "issuing_state": "ESP", "document_type": "ID", "region": "", "document_number": "X1234567" }, "created_at": "2026-10-12T10:06:12.774915Z" } }, "From a transaction": { "value": { "uuid": "dddddddd-eeee-ffff-0000-111111111111", "value": "0x52908400098527886e0f7030069857d2e4169ee7", "display_label": "", "comment": "Linked to a chargeback", "added_by": "api", "reference_session_id": null, "reference_session_number": null, "reference_session_type": null, "reference_object_uuid": "55555555-6666-7777-8888-999999999999", "metadata": { "reference_type": "transaction", "reference_id": "55555555-6666-7777-8888-999999999999" }, "created_at": "2026-10-12T10:20:40.117062Z" } } } } } }, "400": { "description": "El cuerpo no es válido, el valor ya está en la lista o la sesión no puede proporcionar el valor.", "content": { "application/json": { "examples": { "Nothing to list": { "value": { "value": [ "Either 'value' or 'reference_session_id' must be provided." ] } }, "Duplicate value": { "value": { "value": [ "An entry with this value already exists in this list." ] } }, "Invalid phone": { "value": { "value": [ "Invalid phone number. Provide a valid international number (e.g. +1234567890)." ] } }, "Invalid IP": { "value": { "value": [ "Invalid IP address or CIDR range (e.g. 192.168.1.1 or 10.0.0.0/24)." ] } }, "Invalid country": { "value": { "value": [ "Invalid country code: XX. Provide a valid ISO 3166-1 alpha-2 or alpha-3 country code." ] } }, "Device-class fingerprint": { "value": { "value": [ "This value is a device-class fingerprint: several distinct devices have reported it, so blocklisting it would decline unrelated people. Block the user by document, face, email or phone instead." ] } }, "Unknown session": { "value": { "reference_session_id": [ "Session not found or does not belong to this application." ] } }, "No data in session": { "value": { "value": [ "Either provide a 'value' or ensure the session contains data for this entry type." ] } }, "Selfie on another list": { "value": { "face_image_source": [ "A document-capture selfie can only be added to the face blocklist." ] } }, "No clear face in selfie": { "value": { "face_image_source": [ "No clear face was found in this selfie, so it cannot be blocklisted." ] } }, "Selfie already listed": { "value": { "face_image_source": [ "This selfie is already in the blocklist." ] } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Los demás fallos de autenticación devuelven `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta el encabezado `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), o una clave de API con alcance limitado no tiene `workflows: write` o se usa desde una dirección IP que no está en su lista de permitidas.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "404": { "description": "No existe ninguna lista con este UUID en la aplicación de la clave de API, o se eliminó.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "List not found." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" }, "503": { "description": "El análisis facial de una selfie de captura de documento no está disponible temporalmente. No se añadió nada; vuelve a intentarlo más tarde.", "content": { "application/json": { "examples": { "Unavailable": { "value": { "detail": "Service temporarily unavailable. Please try again later." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/lists/{list_uuid}/entries/{entry_uuid}/": { "delete": { "summary": "Eliminar una entrada de lista", "description": "Elimina una entrada de una lista, incluidas las listas del sistema. La entrada deja de generar coincidencias de inmediato, y la eliminación es irreversible: para volver a incluir el valor, crea una entrada nueva. En una lista de bloqueo del sistema de rostros, documentos, teléfonos o correos electrónicos, el registro que representa la entrada deja de estar marcado como bloqueado; en la lista de bloqueo del sistema de usuarios o de empresas, los usuarios o empresas de la aplicación cuyo `vendor_data` coincide con el valor de la entrada (o cuyo `didit_internal_id` coincide con su `reference_object_uuid`) y que están en `BLOCKED` vuelven a `ACTIVE`. Las sesiones y transacciones que ya finalizaron conservan su estado. Una clave de API con alcance limitado necesita `workflows: write`.", "operationId": "delete_list_entry", "x-didit-sdk": { "resource": "lists.entries", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID de la lista que contiene la entrada.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "entry_uuid", "in": "path", "required": true, "description": "UUID de la entrada, tal como lo devuelven Listar entradas de lista o Crear una entrada de lista.", "schema": { "type": "string", "format": "uuid" }, "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.lists.entries.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.lists.entries.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Lists.Entries.Delete(ctx, \"11111111-2222-3333-4444-555555555555\", \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.lists().entries().delete(\"11111111-2222-3333-4444-555555555555\", \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\");" }, { "lang": "php", "label": "PHP", "source": "lists->entries->delete('11111111-2222-3333-4444-555555555555', 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.lists.entries.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Lists.Entries.DeleteAsync(\"11111111-2222-3333-4444-555555555555\", \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\");" } ], "responses": { "204": { "description": "Se eliminó la entrada. Sin cuerpo." }, "401": { "description": "La clave de API con alcance limitado ha expirado. Los demás fallos de autenticación devuelven `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta el encabezado `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), o una clave de API con alcance limitado no tiene `workflows: write` o se usa desde una dirección IP que no está en su lista de permitidas.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "404": { "description": "No existe ninguna entrada con este UUID en esta lista, la lista no está en la aplicación de la clave de API o se eliminó, o la entrada ya se eliminó.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No ListEntry matches the given query." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/lists/{list_uuid}/entries/face-upload/": { "post": { "summary": "Subir un rostro a una lista", "description": "Añade un rostro a una lista de bloqueo de rostros o a una lista de permitidos de rostros a partir de una imagen JPEG o PNG codificada en base64, para cuando no tienes una sesión de verificación a la que hacer referencia. Didit detecta los rostros de la imagen, usa el más grande y crea una entrada cuyos `value` y `reference_object_uuid` son el UUID del nuevo rostro. Un rostro en la lista de bloqueo rechaza las nuevas sesiones cuyo rostro coincide; un rostro en la lista de permitidos omite la acción de rostro duplicado y nunca anula una coincidencia con la lista de bloqueo. En una aplicación de sandbox, la imagen no se analiza y la entrada no coincide con nada. Una clave de API con alcance limitado necesita `workflows: write`. Para añadir a una lista un rostro de una sesión existente, usa en su lugar [Crear una entrada de lista](https://docs.didit.me/es/management-api/lists/create-entry) con `reference_session_id`.", "operationId": "upload_list_entry_face", "x-didit-sdk": { "resource": "lists.entries", "method": "upload_face", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID de una lista con `entry_type: face` y `list_type: blocklist` o `allowlist`.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "image" ], "properties": { "image": { "type": "string", "format": "byte", "description": "Imagen JPEG o PNG codificada en base64, de 2 MB como máximo una vez decodificada, que muestre un rostro claramente visible. Envía solo la cadena base64, sin el prefijo `data:image/...;base64,`." }, "comment": { "type": "string", "default": "", "description": "Nota opcional en texto libre, como el motivo de la inclusión en la lista." } } }, "examples": { "Face image": { "value": { "image": "/9j/4AAQSkZJRgABAQAAAQABAAD...", "comment": "Known fraud attempt" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/face-upload/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d \"{\\\"image\\\": \\\"$(base64 < face.jpg | tr -d '\\n')\\\", \\\"comment\\\": \\\"Known fraud attempt\\\"}\"" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.lists.entries.upload_face(\n \"11111111-2222-3333-4444-555555555555\",\n image=\"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n comment=\"Known fraud attempt\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.lists.entries.uploadFace(\"11111111-2222-3333-4444-555555555555\", {\n image: \"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n comment: \"Known fraud attempt\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Entries.UploadFace(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesUploadFaceParams{\n\tImage: \"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n\tComment: didit.String(\"Known fraud attempt\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.ListsEntriesUploadFaceParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.lists().entries().uploadFace(\"11111111-2222-3333-4444-555555555555\", ListsEntriesUploadFaceParams.builder()\n .image(\"/9j/4AAQSkZJRgABAQAAAQABAAD...\")\n .comment(\"Known fraud attempt\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "lists->entries->uploadFace('11111111-2222-3333-4444-555555555555', [\n 'image' => '/9j/4AAQSkZJRgABAQAAAQABAAD...',\n 'comment' => 'Known fraud attempt',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.lists.entries.upload_face(\n \"11111111-2222-3333-4444-555555555555\",\n image: \"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n comment: \"Known fraud attempt\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Lists.Entries.UploadFaceAsync(\"11111111-2222-3333-4444-555555555555\", new ListsEntriesUploadFaceParams\n{\n Image = \"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n Comment = \"Known fraud attempt\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Se creó la entrada del rostro.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceListEntry" }, "examples": { "Uploaded face": { "value": { "uuid": "cccccccc-dddd-eeee-ffff-000000000000", "value": "44444444-5555-6666-7777-888888888888", "display_label": "Manually uploaded face", "comment": "Known fraud attempt", "added_by": "api", "reference_session_id": null, "reference_session_number": null, "reference_session_type": null, "reference_object_uuid": "44444444-5555-6666-7777-888888888888", "metadata": { "reference_image_url": "https://media.example.com/faces/reference.jpg?expires=1760263938&signature=3f9a1c" }, "created_at": "2026-10-12T10:12:18.904467Z" } }, "Sandbox application": { "value": { "uuid": "cccccccc-dddd-eeee-ffff-000000000000", "value": "44444444-5555-6666-7777-888888888888", "display_label": "Sandbox face entry", "comment": "Known fraud attempt", "added_by": "api", "reference_session_id": null, "reference_session_number": null, "reference_session_type": null, "reference_object_uuid": "44444444-5555-6666-7777-888888888888", "metadata": { "sandbox": true }, "created_at": "2026-10-12T10:12:18.904467Z" } } } } } }, "400": { "description": "La lista no admite cargas de rostros, o la imagen falta, no es válida, es demasiado grande o no muestra un rostro utilizable. No se creó ninguna entrada.", "content": { "application/json": { "examples": { "Not a face list": { "value": { "detail": "Face upload is only available for face-type lists." } }, "Custom face list": { "value": { "detail": "Face upload is only available for face blocklists and allowlists." } }, "Missing image": { "value": { "image": [ "This field is required." ] } }, "Invalid base64": { "value": { "image": [ "Invalid base64 encoding." ] } }, "Too large": { "value": { "image": [ "Image exceeds maximum size of 2 MB." ] } }, "Unreadable image": { "value": { "image": "Invalid image. Provide a valid base64-encoded JPG or PNG." } }, "No face": { "value": { "image": "No face detected in the image. Please upload a clear photo with a visible face." } }, "No usable face": { "value": { "image": "Could not extract face embedding. Try a different image." } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Los demás fallos de autenticación devuelven `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta el encabezado `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), o una clave de API con alcance limitado no tiene `workflows: write` o se usa desde una dirección IP que no está en su lista de permitidas.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "404": { "description": "No existe ninguna lista con este UUID en la aplicación de la clave de API, o se eliminó.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "List not found." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" }, "503": { "description": "El análisis facial no está disponible temporalmente. No se creó ninguna entrada; vuelve a intentarlo más tarde.", "content": { "application/json": { "examples": { "Unavailable": { "value": { "detail": "Service temporarily unavailable. Please try again later." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/blocklist/": { "get": { "summary": "Listar elementos de la lista de bloqueo", "description": "Devuelve un único feed paginado de las caras, los documentos de identidad, los números de teléfono y las direcciones de correo electrónico de las sesiones de verificación de la aplicación que están actualmente en una lista de bloqueo, de más reciente a más antiguo según `blocklisted_at`; filtra con `item_type`. No se incluyen los elementos de sesiones eliminadas. El feed abarca los registros bloqueados desde una sesión (con [Añadir elementos de la sesión a la lista de bloqueo](https://docs.didit.me/es/management-api/blocklist/add), desde la consola o mediante una entrada de lista creada a partir de una sesión); los valores añadidos a mano a una lista, las caras subidas, las caras de una selfie de captura de documento y los demás tipos de entrada se consultan con [Listar entradas de una lista](https://docs.didit.me/es/management-api/lists/list-entries). `face_image` y `front_image` son URL firmadas de corta duración, y una clave de API con alcance limitado sin `media: read` recibe `null`. Una clave de API con alcance limitado necesita `workflows: read`.", "operationId": "list_blocklist_items", "x-didit-sdk": { "resource": "blocklist", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Blocklist" ], "parameters": [ { "name": "item_type", "in": "query", "required": false, "description": "Solo elementos de este tipo. Si se omite, se devuelven todos los tipos.", "schema": { "type": "string", "enum": [ "face", "document", "phone", "email" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Tamaño de página. El valor predeterminado es 50. Un valor superior a 1000000 devuelve `400`; cero, un valor negativo o un valor no numérico hacen que se use 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 } }, { "name": "offset", "in": "query", "required": false, "description": "Índice, empezando en cero, del primer elemento que se devuelve. Es preferible seguir `next`. Un valor superior a 1000000 devuelve `400`; un valor negativo o no numérico se toma como 0.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/blocklist/?item_type=document' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.blocklist.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.blocklist.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Blocklist.ListAutoPaging(ctx, didit.BlocklistListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.blocklist().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "blocklist->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.blocklist.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Blocklist.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Una página de elementos de la lista de bloqueo, del más reciente al más antiguo.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Número total de elementos de la lista de bloqueo que coinciden con los filtros." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la página siguiente, o `null` en la última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la página anterior, o `null` en la primera página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/BlocklistedItem" } } } }, "examples": { "Mixed feed": { "value": { "count": 2, "next": null, "previous": null, "results": [ { "type": "document", "session_id": "33333333-4444-5555-6666-777777777777", "session_number": 1042, "blocklisted_at": "2026-10-12T10:06:12.701553Z", "face_image": null, "document_type": "ID", "document_number": "X1234567", "front_image": "https://media.example.com/documents/front.jpg?expires=1760263938&signature=8b2e47", "phone_number": null, "country_code": null, "email": null }, { "type": "phone", "session_id": "77777777-8888-9999-0000-111111111111", "session_number": 1017, "blocklisted_at": "2026-10-08T15:31:09.400127Z", "face_image": null, "document_type": null, "document_number": null, "front_image": null, "phone_number": "+14155552671", "country_code": "US", "email": null } ] } } } } } }, "400": { "description": "Un parámetro de consulta no es válido.", "content": { "application/json": { "examples": { "Unknown item type": { "value": { "item_type": [ "\"wallet\" is not a valid choice." ] } }, "Limit too large": { "value": [ "limit must not exceed 1000000." ] } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Los demás fallos de autenticación devuelven `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta el encabezado `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), o una clave de API con alcance limitado no tiene `workflows: read` o se usa desde una dirección IP que no está en su lista de permitidas.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no read access to workflows." } } } } } }, "429": { "description": "Se superó el límite de lectura compartido de 600 solicitudes por minuto por clave de API. Respeta `Retry-After` antes de reintentar.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/blocklist/add/": { "post": { "summary": "Añadir elementos de la sesión a la lista de bloqueo", "description": "Añade a la lista de bloqueo el rostro, el documento de identidad, el número de teléfono o la dirección de correo electrónico de una sesión de verificación de persona de la aplicación. Para cada tipo seleccionado, Didit toma el registro más reciente de la sesión, lo marca como bloqueado y añade a la lista de bloqueo del sistema correspondiente una entrada vinculada a la sesión (`added_by: \"api\"`). Así, se rechazan las nuevas sesiones con un rostro, un número de documento, un número de teléfono o una dirección de correo electrónico coincidentes. Primero se comprueba cada elemento seleccionado, por lo que si falta alguno no se bloquea nada. Repetir la llamada para un elemento que ya está en la lista mantiene su única entrada y actualiza `blocklisted_at`. Ni la propia sesión ni las sesiones que ya finalizaron se modifican. Una clave de API con alcance necesita `workflows: write`.", "operationId": "add_to_blocklist", "x-didit-sdk": { "resource": "blocklist", "method": "add", "auth": "api_key", "server": true }, "tags": [ "Blocklist" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "session_id" ], "description": "Al menos un indicador `blocklist_*` debe ser `true`.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Una sesión de verificación de persona de tu aplicación. Se rechazan las sesiones eliminadas." }, "blocklist_face": { "type": "boolean", "default": false, "description": "Añadir a la lista de bloqueo el rostro de la sesión." }, "blocklist_document": { "type": "boolean", "default": false, "description": "Añadir a la lista de bloqueo el documento de identidad de la sesión. El documento debe tener su estado emisor, el tipo de documento, el número de documento y el nombre completo." }, "blocklist_phone": { "type": "boolean", "default": false, "description": "Añadir a la lista de bloqueo el número de teléfono de la sesión." }, "blocklist_email": { "type": "boolean", "default": false, "description": "Añadir a la lista de bloqueo la dirección de correo electrónico de la sesión." } } }, "examples": { "Face and document": { "value": { "session_id": "33333333-4444-5555-6666-777777777777", "blocklist_face": true, "blocklist_document": true } }, "Phone only": { "value": { "session_id": "33333333-4444-5555-6666-777777777777", "blocklist_phone": true } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/blocklist/add/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"session_id\": \"33333333-4444-5555-6666-777777777777\",\n \"blocklist_face\": true,\n \"blocklist_document\": true\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.blocklist.add(\n session_id=\"33333333-4444-5555-6666-777777777777\",\n blocklist_face=True,\n blocklist_document=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.blocklist.add({\n session_id: \"33333333-4444-5555-6666-777777777777\",\n blocklist_face: true,\n blocklist_document: true,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Blocklist.Add(ctx, didit.BlocklistAddParams{\n\tSessionID: \"33333333-4444-5555-6666-777777777777\",\n\tBlocklistFace: didit.Bool(true),\n\tBlocklistDocument: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BlocklistAddParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.blocklist().add(BlocklistAddParams.builder()\n .sessionId(\"33333333-4444-5555-6666-777777777777\")\n .blocklistFace(true)\n .blocklistDocument(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "blocklist->add([\n 'session_id' => '33333333-4444-5555-6666-777777777777',\n 'blocklist_face' => true,\n 'blocklist_document' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.blocklist.add(\n session_id: \"33333333-4444-5555-6666-777777777777\",\n blocklist_face: true,\n blocklist_document: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Blocklist.AddAsync(new BlocklistAddParams\n{\n SessionId = \"33333333-4444-5555-6666-777777777777\",\n BlocklistFace = true,\n BlocklistDocument = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Los elementos seleccionados se añadieron a la lista de bloqueo.", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string", "description": "Siempre `Successfully updated blocklist.`" } } }, "examples": { "Blocklisted": { "value": { "message": "Successfully updated blocklist." } } } } } }, "400": { "description": "El cuerpo no es válido, la sesión no es una sesión de verificación de esta aplicación o no tiene ningún registro de un tipo seleccionado. No se añadió nada a la lista de bloqueo.", "content": { "application/json": { "examples": { "Unknown session": { "value": { "non_field_errors": [ "Session not found" ] } }, "No item selected": { "value": { "non_field_errors": [ "Must specify at least one item to blocklist" ] } }, "No face record": { "value": { "non_field_errors": [ "Session does not have a face record" ] } }, "Incomplete document": { "value": { "non_field_errors": [ "To blocklist a document, the document must have an issuing state, document type, document number and full name" ] } }, "Invalid session id": { "value": { "session_id": [ "Must be a valid UUID." ] } }, "Missing session id": { "value": { "session_id": [ "This field is required." ] } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Los demás fallos de autenticación devuelven `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta el encabezado `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), o una clave de API con alcance limitado no tiene `workflows: write` o se usa desde una dirección IP que no está en su lista de permitidas.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/blocklist/remove/": { "post": { "summary": "Eliminar elementos de la sesión de la lista de bloqueo", "description": "Levanta el bloqueo del rostro, el documento de identidad, el número de teléfono o la dirección de correo electrónico de una sesión de verificación de persona de la aplicación. Para cada tipo seleccionado, Didit toma el registro más reciente de la sesión, quita su marca de lista de bloqueo y elimina las entradas de la lista de bloqueo del sistema creadas a partir de ese registro, de modo que deja de rechazar nuevas sesiones. Las entradas añadidas a una lista por valor no se modifican: búscalas con [Listar las entradas de una lista](https://docs.didit.me/es/management-api/lists/list-entries) y elimínalas con [Eliminar una entrada de una lista](https://docs.didit.me/es/management-api/lists/delete-entry). Desbloquear un registro que no está en la lista de bloqueo se completa correctamente y no cambia nada, y las sesiones que ya finalizaron no se modifican. Una clave de API con alcance limitado necesita `workflows: write`.", "operationId": "remove_from_blocklist", "x-didit-sdk": { "resource": "blocklist", "method": "remove", "auth": "api_key", "server": true }, "tags": [ "Blocklist" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "session_id" ], "description": "Al menos un indicador `unblock_*` debe ser `true`.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Una sesión de verificación de persona de tu aplicación. Se rechazan las sesiones eliminadas." }, "unblock_face": { "type": "boolean", "default": false, "description": "Levanta el bloqueo del rostro de la sesión." }, "unblock_document": { "type": "boolean", "default": false, "description": "Levanta el bloqueo del documento de identidad de la sesión." }, "unblock_phone": { "type": "boolean", "default": false, "description": "Levanta el bloqueo del número de teléfono de la sesión." }, "unblock_email": { "type": "boolean", "default": false, "description": "Levanta el bloqueo de la dirección de correo electrónico de la sesión." } } }, "examples": { "Face and document": { "value": { "session_id": "33333333-4444-5555-6666-777777777777", "unblock_face": true, "unblock_document": true } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/blocklist/remove/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"session_id\": \"33333333-4444-5555-6666-777777777777\",\n \"unblock_face\": true,\n \"unblock_document\": true\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.blocklist.remove(\n session_id=\"33333333-4444-5555-6666-777777777777\",\n unblock_face=True,\n unblock_document=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.blocklist.remove({\n session_id: \"33333333-4444-5555-6666-777777777777\",\n unblock_face: true,\n unblock_document: true,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Blocklist.Remove(ctx, didit.BlocklistRemoveParams{\n\tSessionID: \"33333333-4444-5555-6666-777777777777\",\n\tUnblockFace: didit.Bool(true),\n\tUnblockDocument: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BlocklistRemoveParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.blocklist().remove(BlocklistRemoveParams.builder()\n .sessionId(\"33333333-4444-5555-6666-777777777777\")\n .unblockFace(true)\n .unblockDocument(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "blocklist->remove([\n 'session_id' => '33333333-4444-5555-6666-777777777777',\n 'unblock_face' => true,\n 'unblock_document' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.blocklist.remove(\n session_id: \"33333333-4444-5555-6666-777777777777\",\n unblock_face: true,\n unblock_document: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Blocklist.RemoveAsync(new BlocklistRemoveParams\n{\n SessionId = \"33333333-4444-5555-6666-777777777777\",\n UnblockFace = true,\n UnblockDocument = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Se levantó el bloqueo de los elementos seleccionados.", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string", "description": "Siempre `Successfully removed from blocklist.`" } } }, "examples": { "Unblocked": { "value": { "message": "Successfully removed from blocklist." } } } } } }, "400": { "description": "El cuerpo no es válido, la sesión no es una sesión de verificación de esta aplicación o no tiene ningún registro de un tipo seleccionado. No se cambió nada.", "content": { "application/json": { "examples": { "Unknown session": { "value": { "non_field_errors": [ "Session not found" ] } }, "No item selected": { "value": { "non_field_errors": [ "Must specify at least one item to unblock" ] } }, "No email record": { "value": { "non_field_errors": [ "Session does not have an email record" ] } }, "Invalid session id": { "value": { "session_id": [ "Must be a valid UUID." ] } }, "Missing session id": { "value": { "session_id": [ "This field is required." ] } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Los demás fallos de autenticación devuelven `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta el encabezado `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), o una clave de API con alcance limitado no tiene `workflows: write` o se usa desde una dirección IP que no está en su lista de permitidas.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/": { "get": { "summary": "Obtener la configuración de webhooks", "description": "Devuelve la configuración de webhooks de la aplicación en una sola llamada: cada [destino de webhook](https://docs.didit.me/es/management-api/webhook/list-destinations) con su secreto de firma, los tipos de evento a los que se puede suscribir un destino, la URL, la versión y el secreto del webhook a nivel de aplicación (heredado), la política de retención de datos y de plantillas biométricas, y los hosts de retorno de la wallet de Digital ID. Didit entrega los webhooks a los destinos, cada uno firmado con su propio `secret_shared_key`; los campos de nivel superior `webhook_url`, `webhook_version` y `secret_shared_key` solo se usan mientras no haya ningún destino habilitado, y en ese caso solo para `status.updated` y `data.updated`. La respuesta contiene secretos de firma, así que mantenla fuera de los registros y del código del lado del cliente. Una clave de API con permisos limitados necesita `webhooks: read`.", "operationId": "get_webhook_config", "x-didit-sdk": { "resource": "webhooks", "method": "retrieve_config", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.retrieve_config()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.retrieveConfig();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.RetrieveConfig(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().retrieveConfig();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->retrieveConfig();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.retrieve_config\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.RetrieveConfigAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La configuración del webhook.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookConfig" }, "examples": { "One destination": { "value": { "webhook_url": "https://yourapp.com/webhooks/didit", "webhook_version": "v3", "secret_shared_key": "dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA", "capture_method": "MOBILE", "data_retention_months": 24, "face_retention_policy": "delete_with_session", "face_retention_days": null, "biometric_consent_mode": "auto", "available_events": [ { "value": "status.updated", "label": "Session status updated" }, { "value": "data.updated", "label": "Session data updated" }, { "value": "user.status.updated", "label": "User status updated" }, { "value": "user.data.updated", "label": "User data updated" }, { "value": "business.status.updated", "label": "Business status updated" }, { "value": "business.data.updated", "label": "Business data updated" }, { "value": "activity.created", "label": "Activity created" }, { "value": "transaction.created", "label": "Transaction created" }, { "value": "transaction.status.updated", "label": "Transaction status updated" }, { "value": "travel_rule.status.updated", "label": "Travel Rule Status Updated" }, { "value": "workflow.compliance_changed", "label": "Workflow Compliance Changed" } ], "allowed_return_hosts": [ "shop.example.com" ], "endpoints": [ { "uuid": "11111111-2222-3333-4444-555555555555", "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "enabled": true, "webhook_version": "v3", "secret_shared_key": "dGhpcy1pcy1hbi1leGFtcGxlLXNlY3JldC0wMDAwMDA", "subscribed_events": [ "status.updated", "data.updated" ], "created_at": "2026-01-04T08:00:00.000000Z", "updated_at": "2026-04-22T14:09:11.523671Z" } ] } } } } } }, "401": { "description": "La clave de API ha expirado: se creó con una fecha de caducidad que ya pasó. Una clave incorrecta o revocada también recibe `401`; si falta la clave, se recibe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Si falta `x-api-key`, o no es válida o está revocada, se recibe `You do not have permission to perform this action.` Una clave con alcance limitado sin el acceso que necesita este endpoint recibe un mensaje que indica el acceso que falta, y una clave usada desde fuera de su lista de IP permitidas recibe `This API key can't be used from this IP address.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without webhooks read": { "value": { "detail": "This API key has no read access to webhooks." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Límite de solicitudes superado: más de 600 solicitudes GET en la ventana actual de un minuto para esta clave de API. Espera `Retry-After` segundos antes de reintentar.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas en la ventana de un minuto (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Tiempo Unix (segundos) en que se restablece la ventana actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nombre del presupuesto que se superó.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualizar la configuración de webhooks", "description": "Actualiza parcialmente la configuración a nivel de aplicación: la URL, la versión y el secreto del webhook heredado, la política de retención de datos y de plantillas biométricas, y los hosts de retorno de la wallet de Digital ID. Envía solo los campos que quieras cambiar; la respuesta es la configuración completa, con la misma estructura que `GET /v3/webhook/`. Los destinos no se gestionan aquí: créalos, actualízalos y elimínalos con los endpoints `/v3/webhook/destinations/`, y no envíes un campo `endpoints` a este endpoint. Un cambio en `data_retention_months` también se aplica a las sesiones existentes, y las sesiones que elimina no se pueden restaurar; lee primero [Retención de datos](https://docs.didit.me/es/console/data-retention). Una clave de API con alcance limitado necesita `webhooks: write`.", "operationId": "update_webhook_config", "x-didit-sdk": { "resource": "webhooks", "method": "update_config", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Envía solo los campos que quieras cambiar. Los destinos no se gestionan aquí.", "properties": { "webhook_url": { "type": "string", "format": "uri", "nullable": true, "maxLength": 2000, "description": "URL de webhook heredada a nivel de aplicación. Didit solo la usa mientras la aplicación no tiene ningún destino habilitado, y en ese caso solo para `status.updated` y `data.updated`. No crea un destino, y la siguiente creación, actualización o eliminación de un destino la reemplaza. Para recibir webhooks, crea un destino con `POST /v3/webhook/destinations/`." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Versión del payload de la `webhook_url` heredada." }, "rotate_secret_key": { "type": "boolean", "default": false, "description": "`true` sustituye de inmediato la `secret_shared_key` a nivel de aplicación por un nuevo valor aleatorio; el nuevo valor viene en la respuesta. Los secretos de los destinos no cambian. Cada llamada con `true` genera un secreto nuevo, por lo que no es idempotente." }, "capture_method": { "type": "string", "enum": [ "MOBILE", "MOBILE_AND_DESKTOP" ], "description": "Configuración heredada de la aplicación. El flujo de verificación no la lee." }, "data_retention_months": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 120, "description": "Plazo de eliminación automática en meses (un mes equivale a 30 días), o `null` para no eliminar automáticamente. Un cambio también se aplica a las sesiones existentes: toda sesión de verificación de usuarios con una antigüedad mayor que el nuevo plazo se elimina automáticamente, y esa eliminación es irreversible." }, "face_retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "Qué ocurre con el embedding facial de una sesión cuando se elimina la sesión. `retain_until_user_deleted` requiere `face_retention_days` en la misma solicitud o ya configurado. Un cambio se aplica a las eliminaciones de sesiones a partir de ese momento; no crea ni purga ninguna plantilla biométrica existente." }, "face_retention_days": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 3650, "description": "Periodo de retención, en días, de las plantillas biométricas con `retain_until_user_deleted`." }, "biometric_consent_mode": { "type": "string", "enum": [ "auto", "always", "never" ], "description": "Cuándo el flujo alojado y los SDK nativos piden a la persona su consentimiento biométrico explícito antes de capturar el rostro. `auto` (predeterminado) lo pide solo donde aplica un disparador: un estado declarado, la IP de la persona o el emisor del documento de identidad está en Illinois, Texas o Colorado, o la persona parece estar en EE. UU. sin un estado conocido. `always` lo pide a toda persona cuyo flujo capture el rostro. `never` nunca muestra el paso, y tú mismo recoges el consentimiento antes del selfie. Cada cambio se registra en el registro de auditoría. Consulta [Consentimiento biométrico](https://docs.didit.me/es/getting-started/biometric-consent)." }, "allowed_return_hosts": { "type": "array", "maxItems": 20, "description": "Reemplaza toda la lista de hosts de retorno de wallets de Digital ID. Solo nombres de host simples, como `shop.example.com`: sin esquema, puerto, ruta ni comodines. Los valores se convierten a minúsculas y se eliminan los duplicados. Envía `[]` para vaciar la lista.", "items": { "type": "string", "maxLength": 253 } }, "allowed_domains": { "type": "array", "maxItems": 50, "items": { "type": "string", "maxLength": 300 }, "description": "Reemplaza toda la lista de orígenes permitidos. Son los orígenes (por ejemplo, `https://app.example.com`; `http` solo para `localhost`) en los que se puede integrar el flujo de verificación alojado y a los que puede devolver al usuario con un callback de sesión. Las llamadas de servidor a servidor no se ven afectadas. Una lista vacía significa que no hay ninguna restricción. Didit guarda cada origen en minúsculas y sin el puerto predeterminado. Una entrada no válida falla con `400` en `allowed_domains`. Envía `[]` para eliminar la restricción.", "example": [ "https://app.example.com" ] } } }, "examples": { "Enable biometric template retention": { "value": { "face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365, "biometric_consent_mode": "auto" } }, "Rotate the legacy secret": { "value": { "rotate_secret_key": true } }, "Set data retention": { "value": { "data_retention_months": 24 } }, "Register return hosts": { "value": { "allowed_return_hosts": [ "shop.example.com", "app.example.com" ] } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/webhook/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"face_retention_policy\": \"retain_until_user_deleted\", \"face_retention_days\": 365}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.update_config(\n face_retention_policy=\"retain_until_user_deleted\",\n face_retention_days=365,\n biometric_consent_mode=\"auto\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.updateConfig({\n face_retention_policy: \"retain_until_user_deleted\",\n face_retention_days: 365,\n biometric_consent_mode: \"auto\",\n});\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.WebhooksUpdateConfigParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder()\n .faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of(\"retain_until_user_deleted\"))\n .faceRetentionDays(365L)\n .biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of(\"auto\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->updateConfig([\n 'face_retention_policy' => 'retain_until_user_deleted',\n 'face_retention_days' => 365,\n 'biometric_consent_mode' => 'auto',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.update_config(\n face_retention_policy: \"retain_until_user_deleted\",\n face_retention_days: 365,\n biometric_consent_mode: \"auto\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.UpdateConfigAsync(new WebhooksUpdateConfigParams\n{\n FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy(\"retain_until_user_deleted\"),\n FaceRetentionDays = 365,\n BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode(\"auto\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La configuración completa después de la actualización, con la misma forma que `GET /v3/webhook/`. Si rotaste el secreto, guarda el nuevo `secret_shared_key` antes de descartar la respuesta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookConfig" }, "examples": { "Retention enabled": { "value": { "webhook_url": "https://yourapp.com/webhooks/didit", "webhook_version": "v3", "secret_shared_key": "dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA", "capture_method": "MOBILE", "data_retention_months": 24, "face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365, "biometric_consent_mode": "auto", "available_events": [ { "value": "status.updated", "label": "Session status updated" }, { "value": "data.updated", "label": "Session data updated" }, { "value": "user.status.updated", "label": "User status updated" }, { "value": "user.data.updated", "label": "User data updated" }, { "value": "business.status.updated", "label": "Business status updated" }, { "value": "business.data.updated", "label": "Business data updated" }, { "value": "activity.created", "label": "Activity created" }, { "value": "transaction.created", "label": "Transaction created" }, { "value": "transaction.status.updated", "label": "Transaction status updated" }, { "value": "travel_rule.status.updated", "label": "Travel Rule Status Updated" }, { "value": "workflow.compliance_changed", "label": "Workflow Compliance Changed" } ], "allowed_return_hosts": [ "shop.example.com" ], "endpoints": [ { "uuid": "11111111-2222-3333-4444-555555555555", "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "enabled": true, "webhook_version": "v3", "secret_shared_key": "dGhpcy1pcy1hbi1leGFtcGxlLXNlY3JldC0wMDAwMDA", "subscribed_events": [ "status.updated", "data.updated" ], "created_at": "2026-01-04T08:00:00.000000Z", "updated_at": "2026-04-22T14:09:11.523671Z" } ] } } } } } }, "400": { "description": "Error de validación: cada campo no válido se asigna a una lista de mensajes y no se modifica nada. Un cuerpo que no es JSON válido devuelve `{\"detail\": \"JSON parse error - ...\"}`.", "content": { "application/json": { "schema": { "type": "object", "description": "Cada campo no válido asociado a una lista de mensajes.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "examples": { "Retention days missing": { "value": { "face_retention_days": [ "A finite retention duration is required when face retention is enabled." ], "biometric_consent_mode": "auto" } }, "Retention window out of range": { "value": { "data_retention_months": [ "Ensure this value is less than or equal to 120." ] } }, "Invalid return host": { "value": { "allowed_return_hosts": [ "'https://shop.example.com' is not a hostname. Register the bare host (e.g. shop.example.com): no scheme, port, path or wildcard." ] } }, "Invalid choice": { "value": { "face_retention_policy": [ "\"forever\" is not a valid choice." ] } } } } } }, "401": { "description": "La clave de API ha expirado: se creó con una fecha de caducidad que ya pasó. Una clave incorrecta o revocada también recibe `401`; si falta la clave, se recibe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Si falta `x-api-key`, o no es válida o está revocada, se recibe `You do not have permission to perform this action.` Una clave con alcance limitado sin el acceso que necesita este endpoint recibe un mensaje que indica el acceso que falta, y una clave usada desde fuera de su lista de IP permitidas recibe `This API key can't be used from this IP address.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without webhooks write": { "value": { "detail": "This API key has no write access to webhooks." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Límite de solicitudes superado: más de 300 solicitudes de escritura (POST, PATCH, PUT, DELETE) en la ventana actual de un minuto para esta clave de API. Espera `Retry-After` segundos antes de reintentar.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas en la ventana de un minuto (300).", "schema": { "type": "integer", "example": 300 } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Tiempo Unix (segundos) en que se restablece la ventana actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nombre del presupuesto que se superó.", "schema": { "type": "string", "example": "generic-write" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/{destination_uuid}/analytics/": { "get": { "summary": "Obtener las analíticas del destino de webhook", "description": "Totales de entregas, tasa de fallos y tiempos de respuesta de un destino de webhook, para todo el intervalo (`summary`) y por día UTC (`points`). Cada intento cuenta como una entrega: el primer envío de un evento, cada [reintento](https://docs.didit.me/es/integration/webhooks#política-de-reintentos) automático y cada reenvío. Una entrega es fallida cuando el estado HTTP registrado es 400 o superior, por lo que los tiempos de espera agotados (registrados como `504`) y los fallos de conexión (`503`) cuentan como fallidos; una entrega que sigue en cola solo cuenta en `total_deliveries`. Los registros de entrega están disponibles durante unos 30 días. Una clave de API con alcance limitado necesita `webhooks: read`.", "operationId": "get_webhook_destination_analytics", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "retrieve_analytics", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID del destino (el `uuid` que devuelve `GET /v3/webhook/destinations/`).", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "date_from", "in": "query", "required": false, "description": "Primer día UTC que se incluye, en formato `YYYY-MM-DD` (inclusive). Omítelo para empezar desde la entrega más antigua disponible. `dateFrom` se acepta como alias.", "schema": { "type": "string", "format": "date" }, "example": "2026-10-01" }, { "name": "date_to", "in": "query", "required": false, "description": "Último día UTC que se incluye, en formato `YYYY-MM-DD` (inclusive). No puede ser anterior a `date_from`. Se acepta `dateTo` como alias.", "schema": { "type": "string", "format": "date" }, "example": "2026-10-16" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/analytics/?date_from=2026-10-01&date_to=2026-10-16' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.retrieve_analytics(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.retrieveAnalytics(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.RetrieveAnalytics(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WebhooksDestinationsRetrieveAnalyticsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().retrieveAnalytics(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->retrieveAnalytics('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.retrieve_analytics(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.RetrieveAnalyticsAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Estadísticas de entrega del destino.", "content": { "application/json": { "schema": { "type": "object", "required": [ "summary", "points" ], "properties": { "summary": { "type": "object", "description": "Totales del intervalo solicitado.", "required": [ "total_deliveries", "failed_deliveries", "min_response_time_ms", "avg_response_time_ms", "max_response_time_ms", "error_rate_percentage" ], "properties": { "total_deliveries": { "type": "integer", "minimum": 0, "description": "Intentos de entrega, incluidos los que están en cola." }, "failed_deliveries": { "type": "integer", "minimum": 0, "description": "Intentos cuyo estado HTTP registrado es 400 o superior." }, "min_response_time_ms": { "type": "integer", "nullable": true, "description": "Intento más rápido en milisegundos, o `null` cuando ningún intento tiene un tiempo registrado." }, "avg_response_time_ms": { "type": "integer", "nullable": true, "description": "Tiempo medio por intento en milisegundos, redondeado, o `null` cuando ningún intento tiene un tiempo registrado." }, "max_response_time_ms": { "type": "integer", "nullable": true, "description": "Intento más lento en milisegundos, o `null` cuando ningún intento tiene un tiempo registrado." }, "error_rate_percentage": { "type": "integer", "minimum": 0, "maximum": 100, "description": "`failed_deliveries` / `total_deliveries` x 100, redondeado a un número entero. `0` cuando no hay entregas." } } }, "points": { "type": "array", "description": "Una entrada por cada día UTC con entregas, de la más antigua a la más reciente. Los días sin entregas se omiten, así que rellena los huecos con ceros al representarlos en un gráfico.", "items": { "type": "object", "required": [ "date", "total_deliveries", "failed_deliveries", "min_response_time_ms", "avg_response_time_ms", "max_response_time_ms" ], "properties": { "date": { "type": "string", "format": "date", "description": "Día UTC, `YYYY-MM-DD`." }, "total_deliveries": { "type": "integer", "minimum": 0, "description": "Intentos de entrega, incluidos los que están en cola." }, "failed_deliveries": { "type": "integer", "minimum": 0, "description": "Intentos cuyo estado HTTP registrado es 400 o superior." }, "min_response_time_ms": { "type": "integer", "nullable": true, "description": "Intento más rápido en milisegundos, o `null` cuando ningún intento tiene un tiempo registrado." }, "avg_response_time_ms": { "type": "integer", "nullable": true, "description": "Tiempo medio por intento en milisegundos, redondeado, o `null` cuando ningún intento tiene un tiempo registrado." }, "max_response_time_ms": { "type": "integer", "nullable": true, "description": "Intento más lento en milisegundos, o `null` cuando ningún intento tiene un tiempo registrado." } } } } } }, "examples": { "Three days of deliveries": { "value": { "summary": { "total_deliveries": 1250, "failed_deliveries": 12, "min_response_time_ms": 38, "avg_response_time_ms": 164, "max_response_time_ms": 5004, "error_rate_percentage": 1 }, "points": [ { "date": "2026-10-14", "total_deliveries": 410, "failed_deliveries": 0, "min_response_time_ms": 38, "avg_response_time_ms": 152, "max_response_time_ms": 911 }, { "date": "2026-10-15", "total_deliveries": 395, "failed_deliveries": 12, "min_response_time_ms": 41, "avg_response_time_ms": 190, "max_response_time_ms": 5004 }, { "date": "2026-10-16", "total_deliveries": 445, "failed_deliveries": 0, "min_response_time_ms": 40, "avg_response_time_ms": 151, "max_response_time_ms": 1220 } ] } }, "No deliveries in range": { "value": { "summary": { "total_deliveries": 0, "failed_deliveries": 0, "min_response_time_ms": null, "avg_response_time_ms": null, "max_response_time_ms": null, "error_rate_percentage": 0 }, "points": [] } } } } } }, "400": { "description": "`date_from` o `date_to` no es una fecha `YYYY-MM-DD`, o `date_to` es anterior a `date_from`.", "content": { "application/json": { "schema": { "type": "object", "description": "Cada campo no válido asociado a una lista de mensajes.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "examples": { "Malformed date": { "value": { "date_from": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } }, "Reversed range": { "value": { "date_to": [ "date_to must be greater than or equal to date_from." ] } } } } } }, "401": { "description": "La clave de API ha expirado: se creó con una fecha de caducidad que ya pasó. Una clave incorrecta o revocada también recibe `401`; si falta la clave, se recibe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Si falta `x-api-key`, o no es válida o está revocada, se recibe `You do not have permission to perform this action.` Una clave con alcance limitado sin el acceso que necesita este endpoint recibe un mensaje que indica el acceso que falta, y una clave usada desde fuera de su lista de IP permitidas recibe `This API key can't be used from this IP address.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without webhooks read": { "value": { "detail": "This API key has no read access to webhooks." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "No existe ningún destino con este UUID para la aplicación, o se ha eliminado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "Límite de solicitudes superado: más de 600 solicitudes GET en la ventana actual de un minuto para esta clave de API. Espera `Retry-After` segundos antes de reintentar.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas en la ventana de un minuto (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Tiempo Unix (segundos) en que se restablece la ventana actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nombre del presupuesto que se superó.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/{destination_uuid}/deliveries/": { "get": { "summary": "Listar entregas de destinos de webhook", "description": "Recorre página a página todos los intentos de entrega a un destino de webhook, del más reciente al más antiguo. El primer envío de cada evento, cada [reintento](https://docs.didit.me/es/integration/webhooks#política-de-reintentos) automático y cada reenvío son entradas independientes. Las entradas incluyen el estado HTTP y el tiempo de respuesta, pero no el payload: obtén una entrega concreta para leer sus encabezados y su cuerpo. `count` es exacto hasta 100 y muestra 100 por encima de esa cifra, así que sigue `next` hasta que sea `null`. Los registros de entrega están disponibles durante unos 30 días. Una clave de API con alcance limitado necesita `webhooks: read` y `decisions: read`; una clave limitada a algunos flujos o a sesiones aprobadas no puede usar este endpoint.", "operationId": "list_webhook_destination_deliveries", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "list_deliveries", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID del destino (el `uuid` que devuelve `GET /v3/webhook/destinations/`).", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "limit", "in": "query", "required": false, "description": "Número máximo de entregas por página. El valor predeterminado es 50. Un valor que no sea un entero positivo se sustituye por 50; un valor superior a 1000000 devuelve `400`.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 50 }, { "name": "offset", "in": "query", "required": false, "description": "Número de entregas que se omiten. El valor predeterminado es 0. Es preferible seguir las URL `next` y `previous` de la respuesta.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 0 }, { "name": "date_from", "in": "query", "required": false, "description": "Primer día UTC que se incluye, en formato `YYYY-MM-DD` (inclusive). Omítelo para empezar desde la entrega más antigua disponible. `dateFrom` se acepta como alias.", "schema": { "type": "string", "format": "date" }, "example": "2026-10-01" }, { "name": "date_to", "in": "query", "required": false, "description": "Último día UTC que se incluye, en formato `YYYY-MM-DD` (inclusive). No puede ser anterior a `date_from`. Se acepta `dateTo` como alias.", "schema": { "type": "string", "format": "date" }, "example": "2026-10-16" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/deliveries/?limit=50&date_from=2026-10-01' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.webhooks.destinations.list_deliveries(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.webhooks.destinations.listDeliveries(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Webhooks.Destinations.ListDeliveriesAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WebhooksDestinationsListDeliveriesParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.webhooks().destinations().listDeliveries(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->listDeliveries('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.webhooks.destinations.list_deliveries(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Webhooks.Destinations.ListDeliveriesAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Una página de entregas, de la más reciente a la más antigua.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Entregas que coinciden, con el número exacto hasta 100 y limitado a 100 por encima de esa cifra. Usa `next` para saber si hay más páginas." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la página siguiente, o `null` en la última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la página anterior, o `null` en la primera página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDestinationDelivery" } } } }, "examples": { "Failed delivery, its retry and a queued event": { "value": { "count": 3, "next": null, "previous": null, "results": [ { "uuid": "66666666-7777-8888-9999-000000000003", "session_id": null, "request_url": "https://yourapp.com/webhooks/didit", "response_status": null, "response_time_ms": null, "status": "APPROVED", "webhook_type": "transaction.created", "created_at": "2026-10-15T09:23:02.871190Z" }, { "uuid": "66666666-7777-8888-9999-000000000002", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 200, "response_time_ms": 143, "status": "In Progress", "webhook_type": "status.updated", "created_at": "2026-10-15T09:22:19.104233Z" }, { "uuid": "66666666-7777-8888-9999-000000000001", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 503, "response_time_ms": 412, "status": "In Progress", "webhook_type": "status.updated", "created_at": "2026-10-15T09:21:18.412345Z" } ] } } } } } }, "400": { "description": "`date_from` o `date_to` no es una fecha `YYYY-MM-DD`, `date_to` es anterior a `date_from`, o `limit` u `offset` es superior a 1000000 (ese error es un array JSON de mensajes).", "content": { "application/json": { "examples": { "Malformed date": { "value": { "date_from": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } }, "Reversed range": { "value": { "date_to": [ "date_to must be greater than or equal to date_from." ] } }, "Limit too large": { "value": [ "limit must not exceed 1000000." ] } } } } }, "401": { "description": "La clave de API ha expirado: se creó con una fecha de caducidad que ya pasó. Una clave incorrecta o revocada también recibe `401`; si falta la clave, se recibe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Una `x-api-key` ausente, no válida o revocada recibe `You do not have permission to perform this action.` Una clave con alcance limitado que no tiene el acceso que necesita este endpoint recibe un mensaje que indica el acceso que falta, y una clave usada desde fuera de su lista de IP permitidas recibe `This API key can't be used from this IP address.` Una clave limitada a algunos flujos o a sesiones aprobadas recibe `This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without webhooks read": { "value": { "detail": "This API key has no read access to webhooks." } }, "Scoped key without decisions read": { "value": { "detail": "This API key has no read access to decisions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "No existe ningún destino con este UUID para la aplicación, o se ha eliminado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "Límite de solicitudes superado: más de 600 solicitudes GET en la ventana actual de un minuto para esta clave de API. Espera `Retry-After` segundos antes de reintentar.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas en la ventana de un minuto (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Tiempo Unix (segundos) en que se restablece la ventana actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nombre del presupuesto que se superó.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/": { "get": { "summary": "Obtener una entrega del destino de webhook", "description": "Obtén un intento de entrega a un destino de webhook con los encabezados exactos de la solicitud y el cuerpo JSON que envió Didit, el código de estado HTTP que devolvió tu endpoint y el tiempo de respuesta. `request_header` y `request_body` son texto JSON: analízalos para leer los encabezados de firma y el payload, por ejemplo para comprobar tu [verificación de firma](https://docs.didit.me/es/integration/webhooks#verificación-de-firma) con la `secret_shared_key` del destino. Una entrega nunca contiene el secreto de firma, y Didit no registra el cuerpo de la respuesta de tu endpoint. Una clave de API con alcance limitado necesita `webhooks: read` y `decisions: read`; una clave limitada a algunos flujos o a sesiones aprobadas no puede usar este endpoint.", "operationId": "get_webhook_destination_delivery", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "retrieve_delivery", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID del destino al que se envió la entrega.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "delivery_uuid", "in": "path", "required": true, "description": "UUID de la entrega: el `uuid` de una entrada devuelta por `GET /v3/webhook/destinations/{destination_uuid}/deliveries/`.", "schema": { "type": "string", "format": "uuid" }, "example": "66666666-7777-8888-9999-000000000001" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/deliveries/66666666-7777-8888-9999-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.retrieve_delivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.retrieveDelivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.RetrieveDelivery(ctx, \"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().retrieveDelivery(\"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->retrieveDelivery('11111111-2222-3333-4444-555555555555', '66666666-7777-8888-9999-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.retrieve_delivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.RetrieveDeliveryAsync(\"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La entrega, con los encabezados y el cuerpo de su solicitud.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDestinationDeliveryDetail" }, "examples": { "Connection failure": { "value": { "uuid": "66666666-7777-8888-9999-000000000001", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 503, "response_time_ms": 412, "status": "In Progress", "webhook_type": "status.updated", "created_at": "2026-10-15T09:21:18.412345Z", "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"a5e02a03404e1337a0198e6be15d34abbd053c658a0e51e5d0e78554213ef29b\", \"X-Signature-V2\": \"927e7cb770c94ce745939bff73f04aa200015f3bc64795ba46c2aaf78a6cedc5\", \"X-Signature-Simple\": \"e37b0d4c716c72bb5ae7127b9cc455d28ab4686e9e22312b4ec2327409a73302\", \"X-Timestamp\": \"1792056078\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}", "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792056078,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}" } } } } } }, "401": { "description": "La clave de API ha expirado: se creó con una fecha de caducidad que ya pasó. Una clave incorrecta o revocada también recibe `401`; si falta la clave, se recibe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Una `x-api-key` ausente, no válida o revocada recibe `You do not have permission to perform this action.` Una clave con alcance limitado que no tiene el acceso que necesita este endpoint recibe un mensaje que indica el acceso que falta, y una clave usada desde fuera de su lista de IP permitidas recibe `This API key can't be used from this IP address.` Una clave limitada a algunos flujos o a sesiones aprobadas recibe `This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without webhooks read": { "value": { "detail": "This API key has no read access to webhooks." } }, "Scoped key without decisions read": { "value": { "detail": "This API key has no read access to decisions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "El destino no existe para la aplicación o se ha eliminado, o la entrega no existe, pertenece a otro destino o ya no está disponible.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } }, "Delivery not found": { "value": { "detail": "Webhook delivery not found." } } } } } }, "429": { "description": "Límite de solicitudes superado: más de 600 solicitudes GET en la ventana actual de un minuto para esta clave de API. Espera `Retry-After` segundos antes de reintentar.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas en la ventana de un minuto (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Tiempo Unix (segundos) en que se restablece la ventana actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nombre del presupuesto que se superó.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/resend/": { "post": { "summary": "Reenviar la entrega del destino de webhook", "description": "Vuelve a enviar una entrega anterior, por ejemplo después de que tu endpoint haya estado caído. Didit toma el payload almacenado, establece un `timestamp` nuevo, lo vuelve a firmar con el `secret_shared_key` actual del destino (`X-Signature`, `X-Signature-V2`, `X-Signature-Simple` y `X-Timestamp`) y lo publica en el `request_url` de la entrega, aunque la URL del destino haya cambiado desde entonces o el destino esté desactivado. `event_id` y el resto del payload no cambian, así que elimina duplicados por `event_id`. La llamada espera hasta 5 segundos a tu endpoint y devuelve la nueva entrega con `200` sea cual sea la respuesta de tu endpoint: consulta `response_status`. Un reenvío no se reintenta automáticamente, cada llamada vuelve a enviar y crea una nueva entrega, y la solicitud no tiene cuerpo. Una clave de API con alcance limitado necesita `webhooks: write` y `decisions: read`; una clave limitada a algunos flujos o a sesiones aprobadas no puede usar este endpoint.", "operationId": "resend_webhook_destination_delivery", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "resend_delivery", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID del destino al que se envió la entrega.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "delivery_uuid", "in": "path", "required": true, "description": "UUID de la entrega que se va a reenviar: el `uuid` de una entrada devuelta por `GET /v3/webhook/destinations/{destination_uuid}/deliveries/`.", "schema": { "type": "string", "format": "uuid" }, "example": "66666666-7777-8888-9999-000000000001" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/deliveries/66666666-7777-8888-9999-000000000001/resend/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.resend_delivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.resendDelivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.ResendDelivery(ctx, \"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().resendDelivery(\"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->resendDelivery('11111111-2222-3333-4444-555555555555', '66666666-7777-8888-9999-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.resend_delivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.ResendDeliveryAsync(\"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La nueva entrega, ya intentada. `response_status` es lo que respondió tu endpoint esta vez (`504` tiempo de espera agotado, `503` fallo de conexión). La entrega original no cambia.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDestinationDeliveryDetail" }, "examples": { "Accepted on resend": { "value": { "uuid": "66666666-7777-8888-9999-000000000004", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 200, "response_time_ms": 151, "status": "In Progress", "webhook_type": "status.updated", "created_at": "2026-10-16T14:05:42.330981Z", "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"b8eb1e376517ee0cad8ba98ff7f8fd35fc72eca231000963a96a335f82328835\", \"X-Signature-V2\": \"9efd2ce9ed1303e1d05273ef9608a59363ed9789a05253db4748b3e8e50cb109\", \"X-Signature-Simple\": \"bf3a9dc04b2c20ab539203b0cd5cca2a10f630bf62d8feb6d68d82af80f64774\", \"X-Timestamp\": \"1792159542\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}", "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792159542,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}" } } } } } }, "400": { "description": "No se pudo volver a firmar la entrega almacenada. No se envía nada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." }, "code": { "type": "string", "description": "Código de error estable legible por máquina. Usa este valor para bifurcar la lógica, no `detail`." } } }, "examples": { "Unsignable delivery": { "value": { "detail": "Invalid webhook data format", "code": "invalid_webhook_payload" } } } } } }, "401": { "description": "La clave de API ha expirado: se creó con una fecha de caducidad que ya pasó. Una clave incorrecta o revocada también recibe `401`; si falta la clave, se recibe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Una `x-api-key` ausente, no válida o revocada recibe `You do not have permission to perform this action.` Una clave con alcance limitado que no tiene el acceso que necesita este endpoint recibe un mensaje que indica el acceso que falta, y una clave usada desde fuera de su lista de IP permitidas recibe `This API key can't be used from this IP address.` Una clave limitada a algunos flujos o a sesiones aprobadas recibe `This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without webhooks write": { "value": { "detail": "This API key has no write access to webhooks." } }, "Scoped key without decisions read": { "value": { "detail": "This API key has no read access to decisions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "El destino no existe para la aplicación o se ha eliminado, o la entrega no existe, pertenece a otro destino o ya no está disponible.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } }, "Delivery not found": { "value": { "detail": "Webhook delivery not found." } } } } } }, "429": { "description": "Límite de solicitudes superado: más de 300 solicitudes de escritura (POST, PATCH, PUT, DELETE) en la ventana actual de un minuto para esta clave de API. Espera `Retry-After` segundos antes de reintentar.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas en la ventana de un minuto (300).", "schema": { "type": "integer", "example": 300 } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Tiempo Unix (segundos) en que se restablece la ventana actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nombre del presupuesto que se superó.", "schema": { "type": "string", "example": "generic-write" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/": { "get": { "summary": "Listar eventos de monitorización", "description": "Lista los eventos de monitorización almacenados para tu aplicación, primero los de `occurred_at` más reciente, con filtros opcionales que se combinan con AND. Los filtros de varios valores (`event_category`, `action_type`, `status`, `retention_class`) repiten el parámetro y coinciden con cualquiera de los valores; los demás filtros buscan coincidencias exactas, y los valores desconocidos simplemente no devuelven eventos. Cada resultado es un resumen: llama a `GET /v3/events/{event_uuid}/` para obtener el payload, el contexto del dispositivo, el enriquecimiento de IP y la evidencia de las reglas, y usa preferentemente `GET /v3/events/subjects/{vendor_data}/` para el historial de un solo sujeto. Las lecturas funcionan tanto si la ingesta de eventos está activada como si no. Una clave de API con alcance limitado necesita `transactions: read`. Consulta [Ingesta de eventos](https://docs.didit.me/es/transaction-monitoring/events).", "operationId": "list_monitoring_events", "x-didit-sdk": { "resource": "monitoring_events", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Número máximo de eventos por página. El valor predeterminado es 50. Los valores superiores a 1000000 devuelven `400`; un valor no numérico, cero o negativo se sustituye por 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 50 }, { "name": "offset", "in": "query", "required": false, "description": "Número de eventos que se omiten. El valor predeterminado es 0. Es preferible seguir la URL `next` de la respuesta.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 0 }, { "name": "event_category", "in": "query", "required": false, "description": "Solo eventos de estas categorías. Repite el parámetro para indicar varios valores (`?event_category=payment&event_category=dispute`); se devuelve cualquier evento que coincida con alguno de ellos.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ] } }, "example": [ "payment", "dispute" ] }, { "name": "action_type", "in": "query", "required": false, "description": "Solo eventos con estos tipos de acción (coincidencia exacta, distingue mayúsculas y minúsculas). Repite el parámetro para indicar varios valores.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "deposit_completed", "chargeback_opened" ] }, { "name": "status", "in": "query", "required": false, "description": "Solo eventos con estos estados. Repite el parámetro para indicar varios valores.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ] } }, "example": [ "IN_REVIEW", "DECLINED" ] }, { "name": "retention_class", "in": "query", "required": false, "description": "Solo eventos de estas clases de retención. Repite el parámetro para indicar varios valores.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ] } }, "example": [ "risk_relevant" ] }, { "name": "subject_vendor_data", "in": "query", "required": false, "description": "Coincidencia exacta con el `vendor_data` del sujeto. El mismo id puede designar a una persona física y a una empresa; añade `subject_entity_type` para elegir uno, o usa `GET /v3/events/subjects/{vendor_data}/`.", "schema": { "type": "string" }, "example": "user-42" }, { "name": "subject_entity_type", "in": "query", "required": false, "description": "`company` devuelve solo eventos de sujetos de tipo empresa; cualquier otro valor no vacío (por ejemplo, `individual`) devuelve solo eventos de personas físicas. Omítelo para obtener ambos.", "schema": { "type": "string", "enum": [ "individual", "company" ] }, "example": "individual" }, { "name": "business_vendor_data", "in": "query", "required": false, "description": "Coincidencia exacta con el `business.vendor_data` enviado con el evento.", "schema": { "type": "string" }, "example": "merchant-7" }, { "name": "session_id", "in": "query", "required": false, "description": "Coincidencia exacta con `session.session_id`.", "schema": { "type": "string" }, "example": "web-session-abc" }, { "name": "device_fingerprint", "in": "query", "required": false, "description": "Coincidencia exacta con `device_context.fingerprint`.", "schema": { "type": "string" }, "example": "fp-a8c1" }, { "name": "ip_address", "in": "query", "required": false, "description": "Coincidencia exacta con la dirección IP del evento.", "schema": { "type": "string" }, "example": "203.0.113.42" }, { "name": "game_id", "in": "query", "required": false, "description": "Coincidencia exacta con el `game_id` promovido.", "schema": { "type": "string" }, "example": "poker-holdem-01" }, { "name": "round_id", "in": "query", "required": false, "description": "Coincidencia exacta con el `round_id` promovido.", "schema": { "type": "string" }, "example": "round-88231" }, { "name": "affiliate_code", "in": "query", "required": false, "description": "Coincidencia exacta con el `affiliate_code` promovido.", "schema": { "type": "string" }, "example": "aff-summer" }, { "name": "payment_reference_id", "in": "query", "required": false, "description": "Coincidencia exacta con la referencia de pago (de `transaction_context.payment_reference_id` o `payload.payment_reference_id`).", "schema": { "type": "string" }, "example": "dep_735" }, { "name": "counterparty_vendor_data", "in": "query", "required": false, "description": "Coincidencia exacta con el `counterparty_vendor_data` promovido.", "schema": { "type": "string" }, "example": "user-77" }, { "name": "matched_only", "in": "query", "required": false, "description": "`true` (también `1` o `yes`, sin distinguir mayúsculas de minúsculas) devuelve solo los eventos en los que coincidió al menos una regla (`rules_matched_count` mayor que 0). Cualquier otro valor se ignora.", "schema": { "type": "boolean", "default": false }, "example": true }, { "name": "occurred_from", "in": "query", "required": false, "description": "Solo eventos con `occurred_at` igual o posterior a este instante (inclusive). Envía un valor ISO 8601: `2026-10-01T00:00:00Z`, un desfase explícito con el `+` codificado en formato porcentual (`2026-10-01T02:00:00%2B02:00`; un `+` sin codificar se decodifica como un espacio y el valor deja de poder interpretarse) o solo una fecha (`2026-10-01`), que equivale a las 00:00:00 UTC de ese día. Un valor sin desfase se interpreta como UTC. No se aceptan valores en ningún otro formato.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-01T00:00:00Z" }, { "name": "occurred_to", "in": "query", "required": false, "description": "Solo eventos con `occurred_at` igual o anterior a este instante (inclusive). Una fecha sola equivale al inicio de ese día, por lo que `occurred_to=2026-10-15` excluye el resto del 15 de octubre; envía `2026-10-15T23:59:59Z` para incluirlo. Envía un valor ISO 8601: `2026-10-01T00:00:00Z`, un desfase explícito con el `+` codificado en formato porcentual (`2026-10-01T02:00:00%2B02:00`; un `+` sin codificar se decodifica como un espacio y el valor deja de poder interpretarse) o solo una fecha (`2026-10-01`), que equivale a las 00:00:00 UTC de ese día. Un valor sin desfase se interpreta como UTC. No se aceptan valores en ningún otro formato.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-17T23:59:59Z" }, { "name": "search", "in": "query", "required": false, "description": "Coincidencia de subcadena, sin distinguir mayúsculas y minúsculas, en `event_id`, `action_type`, `subject_vendor_data` o `counterparty_vendor_data`.", "schema": { "type": "string" }, "example": "chargeback" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/events/?event_category=payment&event_category=dispute&matched_only=true&occurred_from=2026-10-01T00:00:00Z&limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.monitoring_events.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.monitoringEvents.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.MonitoringEvents.ListAutoPaging(ctx, didit.MonitoringEventsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.monitoringEvents().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.monitoring_events.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.MonitoringEvents.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Una página de resúmenes de eventos.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringEventPage" }, "examples": { "Payment and dispute events": { "value": { "count": 2, "next": null, "previous": null, "results": [ { "event_uuid": "11111111-2222-3333-4444-555555555555", "event_id": "chargeback-2026-10-16-000318", "event_category": "dispute", "action_type": "chargeback_opened", "occurred_at": "2026-10-16T14:02:11Z", "received_at": "2026-10-16T14:02:12.418230Z", "status": "IN_REVIEW", "score": 60, "subject_vendor_data": "user-42", "subject_entity_type": "individual", "subject_uuid": "66666666-7777-8888-9999-000000000000", "counterparty_vendor_data": null, "session_id": null, "device_fingerprint": null, "ip_address": null, "ip_country": null, "amount": "250.000000000000000000", "currency": "EUR", "game_id": null, "round_id": null, "bonus_id": null, "affiliate_code": null, "payment_reference_id": "dep_735", "retention_class": "monetary_or_compliance", "rules_matched_count": 1, "correlation_pending": false, "is_droppable": false }, { "event_uuid": "22222222-3333-4444-5555-666666666666", "event_id": "login-2026-10-15-000912", "event_category": "auth", "action_type": "login", "occurred_at": "2026-10-15T08:30:00.120000Z", "received_at": "2026-10-15T08:30:00.734512Z", "status": "ACCEPTED", "score": 0, "subject_vendor_data": "user-42", "subject_entity_type": "individual", "subject_uuid": "66666666-7777-8888-9999-000000000000", "counterparty_vendor_data": null, "session_id": "web-session-abc", "device_fingerprint": "fp-a8c1", "ip_address": "203.0.113.42", "ip_country": "ES", "amount": null, "currency": null, "game_id": null, "round_id": null, "bonus_id": null, "affiliate_code": null, "payment_reference_id": null, "retention_class": "standard", "rules_matched_count": 0, "correlation_pending": false, "is_droppable": true } ] } } } } } }, "400": { "description": "`limit` u `offset` es mayor que 1000000. El cuerpo es un array JSON con un mensaje. Un `limit` no numérico o no positivo recurre al valor predeterminado de 50 en lugar de fallar.", "content": { "application/json": { "examples": { "limit too large": { "summary": "limit superior a 1000000", "value": [ "limit must not exceed 1000000." ] }, "offset too large": { "summary": "offset superior a 1000000", "value": [ "offset must not exceed 1000000." ] } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Solo una clave expirada recibe `401`; una clave ausente o no válida recibe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), una clave con permisos limitados sin `transactions: read`, una clave limitada a algunos flujos o a sesiones aprobadas (una clave así nunca accede a los datos de monitorización de transacciones), o una solicitud desde fuera de la lista de IP permitidas de la clave.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no read access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Límite de solicitudes superado: las solicitudes `GET` comparten un cupo de 600 solicitudes por minuto por clave de API. Espera `Retry-After` segundos y vuelve a intentarlo.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crear evento de monitorización", "description": "Envía desde tu backend un evento no monetario (inicio de sesión, sesión, juego, bono, afiliado, pago, disputa, seguridad, juego responsable o personalizado). El evento se valida según el contrato de su categoría, se almacena, se enriquece con datos de IP una vez por cada dirección pública única y se evalúa con tus reglas de eventos en tiempo real antes de que se devuelva la respuesta; las reglas que abarcan varios sujetos o ventanas largas se ejecutan de forma asíncrona (`correlation_pending: true`), y en una aplicación de sandbox no se ejecuta ninguna regla. `event_id` es la clave de idempotencia: el mismo `event_id` con los mismos `event_category`, `action_type`, `occurred_at`, `subject.vendor_data` y `payload` devuelve `200` con `idempotent_replay: true` y el resultado almacenado (los demás campos del sobre no se comparan), mientras que valores distintos devuelven `409`. La ingesta de eventos se activa por aplicación: hasta que se active, este endpoint devuelve `403` con `code: event_monitoring_disabled` y no almacena nada. Una clave de API con alcance limitado necesita `transactions: write`. Consulta [Ingesta de eventos](https://docs.didit.me/es/transaction-monitoring/events) y [Reglas sobre eventos](https://docs.didit.me/es/transaction-monitoring/event-rules); para enviar eventos desde un navegador o una aplicación, usa [Envío de eventos con el SDK](https://docs.didit.me/es/transaction-monitoring/sdk-event-submission).", "operationId": "create_monitoring_event", "x-didit-sdk": { "resource": "monitoring_events", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringEventCreateRequest" }, "examples": { "Login": { "value": { "event_id": "login-2026-10-17-000001", "event_category": "auth", "action_type": "login", "occurred_at": "2026-10-17T09:15:02.481Z", "time_zone": "Europe/Madrid", "subject": { "vendor_data": "user-42", "entity_type": "individual" }, "session": { "session_id": "web-session-abc", "sequence": 142 }, "device_context": { "fingerprint": "fp-a8c1", "network_context": { "ip_address": "203.0.113.42" } }, "payload": { "method": "password" }, "custom_values": { "vip_tier": "gold" } } }, "Deposit completed": { "value": { "event_id": "deposit-2026-10-17-000002", "event_category": "payment", "action_type": "deposit_completed", "occurred_at": "2026-10-17T09:16:40Z", "subject": { "vendor_data": "user-42" }, "transaction_context": { "amount": "100.00", "currency": "EUR", "direction": "inbound", "payment_reference_id": "dep_736" }, "payload": { "payment_method": "card", "status": "completed" } } }, "Chargeback opened": { "value": { "event_id": "chargeback-2026-10-16-000318", "event_category": "dispute", "action_type": "chargeback_opened", "occurred_at": "2026-10-16T14:02:11Z", "subject": { "vendor_data": "user-42" }, "payload": { "payment_reference_id": "dep_735", "chargeback_id": "cb_5521", "amount": "250.00", "currency": "EUR", "reason_code": "fraud" } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/events/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"event_id\": \"login-2026-10-17-000001\",\n \"event_category\": \"auth\",\n \"action_type\": \"login\",\n \"occurred_at\": \"2026-10-17T09:15:02.481Z\",\n \"subject\": {\"vendor_data\": \"user-42\", \"entity_type\": \"individual\"},\n \"session\": {\"session_id\": \"web-session-abc\", \"sequence\": 142},\n \"device_context\": {\n \"fingerprint\": \"fp-a8c1\",\n \"network_context\": {\"ip_address\": \"203.0.113.42\"}\n },\n \"payload\": {\"method\": \"password\"}\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.monitoring_events.create(\n event_id=\"login-2026-10-17-000001\",\n event_category=\"auth\",\n action_type=\"login\",\n occurred_at=\"2026-10-17T09:15:02.481Z\",\n time_zone=\"Europe/Madrid\",\n subject={\n \"vendor_data\": \"user-42\",\n \"entity_type\": \"individual\",\n },\n session={\n \"session_id\": \"web-session-abc\",\n \"sequence\": 142,\n },\n device_context={\n \"fingerprint\": \"fp-a8c1\",\n \"network_context\": {\n \"ip_address\": \"203.0.113.42\",\n },\n },\n payload={\"method\": \"password\"},\n custom_values={\"vip_tier\": \"gold\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.monitoringEvents.create({\n event_id: \"login-2026-10-17-000001\",\n event_category: \"auth\",\n action_type: \"login\",\n occurred_at: \"2026-10-17T09:15:02.481Z\",\n time_zone: \"Europe/Madrid\",\n subject: {\n vendor_data: \"user-42\",\n entity_type: \"individual\",\n },\n session: {\n session_id: \"web-session-abc\",\n sequence: 142,\n },\n device_context: {\n fingerprint: \"fp-a8c1\",\n network_context: {\n ip_address: \"203.0.113.42\",\n },\n },\n payload: { method: \"password\" },\n custom_values: { vip_tier: \"gold\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.MonitoringEvents.Create(ctx, didit.MonitoringEventCreateRequest{\n\tEventID: \"login-2026-10-17-000001\",\n\tEventCategory: \"auth\",\n\tActionType: \"login\",\n\tOccurredAt: time.Date(2026, 10, 17, 9, 15, 2, 0, time.UTC),\n\tTimeZone: didit.String(\"Europe/Madrid\"),\n\tSubject: didit.MonitoringEventCreateRequestSubject{\n\t\tVendorData: \"user-42\",\n\t\tEntityType: didit.String(\"individual\"),\n\t},\n\tSession: didit.Some(didit.MonitoringEventCreateRequestSession{\n\t\tSessionID: didit.String(\"web-session-abc\"),\n\t\tSequence: didit.Int(142),\n\t}),\n\tDeviceContext: didit.Some(didit.MonitoringEventCreateRequestDeviceContext{\n\t\tFingerprint: didit.String(\"fp-a8c1\"),\n\t\tNetworkContext: didit.Some(didit.MonitoringEventCreateRequestDeviceContextNetworkContext{\n\t\t\tIPAddress: didit.String(\"203.0.113.42\"),\n\t\t}),\n\t}),\n\tPayload: didit.Some(map[string]any{\"method\": \"password\"}),\n\tCustomValues: didit.Some(map[string]any{\"vip_tier\": \"gold\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.OffsetDateTime;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.MonitoringEventCreateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.monitoringEvents().create(MonitoringEventCreateRequest.builder()\n .eventId(\"login-2026-10-17-000001\")\n .eventCategory(MonitoringEventCreateRequest.EventCategory.of(\"auth\"))\n .actionType(\"login\")\n .occurredAt(OffsetDateTime.parse(\"2026-10-17T09:15:02.481Z\"))\n .timeZone(\"Europe/Madrid\")\n .subject(MonitoringEventCreateRequest.Subject.builder()\n .vendorData(\"user-42\")\n .entityType(\"individual\")\n .build())\n .session(MonitoringEventCreateRequest.Session.builder()\n .sessionId(\"web-session-abc\")\n .sequence(142L)\n .build())\n .deviceContext(MonitoringEventCreateRequest.DeviceContext.builder()\n .fingerprint(\"fp-a8c1\")\n .networkContext(MonitoringEventCreateRequest.DeviceContext.NetworkContext.builder()\n .ipAddress(\"203.0.113.42\")\n .build())\n .build())\n .payload(Map.of(\"method\", \"password\"))\n .customValues(Map.of(\"vip_tier\", MonitoringEventCreateRequest.CustomValuesValue.ofString(\"gold\")))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->create([\n 'event_id' => 'login-2026-10-17-000001',\n 'event_category' => 'auth',\n 'action_type' => 'login',\n 'occurred_at' => '2026-10-17T09:15:02.481Z',\n 'time_zone' => 'Europe/Madrid',\n 'subject' => [\n 'vendor_data' => 'user-42',\n 'entity_type' => 'individual',\n ],\n 'session' => [\n 'session_id' => 'web-session-abc',\n 'sequence' => 142,\n ],\n 'device_context' => [\n 'fingerprint' => 'fp-a8c1',\n 'network_context' => [\n 'ip_address' => '203.0.113.42',\n ],\n ],\n 'payload' => ['method' => 'password'],\n 'custom_values' => ['vip_tier' => 'gold'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.monitoring_events.create(\n event_id: \"login-2026-10-17-000001\",\n event_category: \"auth\",\n action_type: \"login\",\n occurred_at: \"2026-10-17T09:15:02.481Z\",\n time_zone: \"Europe/Madrid\",\n subject: {\n vendor_data: \"user-42\",\n entity_type: \"individual\",\n },\n session: {\n session_id: \"web-session-abc\",\n sequence: 142,\n },\n device_context: {\n fingerprint: \"fp-a8c1\",\n network_context: {\n ip_address: \"203.0.113.42\",\n },\n },\n payload: { method: \"password\" },\n custom_values: { vip_tier: \"gold\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.MonitoringEvents.CreateAsync(new MonitoringEventCreateRequest\n{\n EventId = \"login-2026-10-17-000001\",\n EventCategory = \"auth\",\n ActionType = \"login\",\n OccurredAt = DateTimeOffset.Parse(\"2026-10-17T09:15:02.481Z\"),\n TimeZone = \"Europe/Madrid\",\n Subject = new()\n {\n VendorData = \"user-42\",\n EntityType = \"individual\",\n },\n Session = new MonitoringEventCreateRequestSession\n {\n SessionId = \"web-session-abc\",\n Sequence = 142,\n },\n DeviceContext = new MonitoringEventCreateRequestDeviceContext\n {\n Fingerprint = \"fp-a8c1\",\n NetworkContext = new MonitoringEventCreateRequestDeviceContextNetworkContext\n {\n IpAddress = \"203.0.113.42\",\n },\n },\n Payload = new Dictionary { [\"method\"] = \"password\" },\n CustomValues = new Dictionary { [\"vip_tier\"] = \"gold\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "El evento se almacenó y se evaluó.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringEventIngestResult" }, "examples": { "Stored, no rule matched": { "value": { "event_uuid": "33333333-4444-5555-6666-777777777777", "event_id": "login-2026-10-17-000001", "status": "ACCEPTED", "score": 0, "rules_evaluated_count": 6, "rules_matched_count": 0, "correlation_pending": false, "retention_class": "standard", "expires_at": "2026-11-16T09:15:02.481000Z", "idempotent_replay": false, "rule_matches": [] } }, "Rule matched, async rule pending": { "value": { "event_uuid": "33333333-4444-5555-6666-777777777777", "event_id": "login-2026-10-17-000001", "status": "IN_REVIEW", "score": 40, "rules_evaluated_count": 6, "rules_matched_count": 1, "correlation_pending": true, "retention_class": "risk_relevant", "expires_at": "2027-01-15T09:15:02.481000Z", "idempotent_replay": false, "rule_matches": [ { "rule_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "library_key": null, "mode": "ACTIVE", "is_async": false } ] } } } } } }, "200": { "description": "Reproducción idempotente: ya hay almacenado un evento con este `event_id` y el mismo contenido. No se ha vuelto a almacenar ni a evaluar nada; el cuerpo describe el evento almacenado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringEventIngestResult" }, "examples": { "Replay": { "value": { "event_uuid": "33333333-4444-5555-6666-777777777777", "event_id": "login-2026-10-17-000001", "status": "ACCEPTED", "score": 0, "rules_evaluated_count": 6, "rules_matched_count": 0, "correlation_pending": false, "retention_class": "standard", "expires_at": "2026-11-16T09:15:02.481000Z", "idempotent_replay": true, "rule_matches": [] } } } } } }, "400": { "description": "La validación ha fallado. El cuerpo se agrupa por campo; los campos anidados son objetos anidados. No se guarda nada.", "content": { "application/json": { "examples": { "Missing fields": { "value": { "event_id": [ "This field is required." ], "subject": [ "This field is required." ] } }, "Unknown category": { "value": { "event_category": [ "\"login\" is not a valid choice." ] } }, "occurred_at too old": { "value": { "occurred_at": [ "occurred_at is more than 7 days in the past. Use the batch import lane for backfills." ] } }, "occurred_at in the future": { "value": { "occurred_at": [ "occurred_at is more than 5 minutes in the future." ] } }, "Missing subject vendor_data": { "value": { "subject": { "vendor_data": [ "This field is required." ] } } }, "Missing required payload keys": { "value": { "payload": [ "payment.deposit_completed requires: payment_method, status." ] } }, "Missing one-of payload key": { "value": { "payload": [ "dispute.chargeback_opened requires one of: dispute_id, chargeback_id." ] } }, "Security change without changed_field": { "value": { "payload": [ "security.*_changed requires 'changed_field'." ] } }, "Payload too large": { "value": { "payload": [ "payload exceeds 16384 bytes. Summarise telemetry client-side." ] } }, "Too many custom_values": { "value": { "custom_values": [ "custom_values accepts at most 100 keys." ] } }, "Nested custom value": { "value": { "custom_values": [ "custom_values['limits'] must be a scalar - rule conditions cannot address nested values." ] } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Solo una clave expirada recibe `401`; una clave ausente o no válida recibe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), una clave con permisos limitados sin `transactions: write`, una clave limitada a algunos flujos o a sesiones aprobadas (una clave así nunca accede a los datos de monitorización de transacciones), o una solicitud desde fuera de la lista de IP permitidas de la clave. También se devuelve con `code: event_monitoring_disabled` mientras la ingesta de eventos está desactivada para la aplicación; en ese caso no se almacena nada, y la comprobación se ejecuta antes de validar el cuerpo.", "content": { "application/json": { "examples": { "Event monitoring disabled": { "value": { "detail": "Event monitoring is not enabled for this application. Turn on event ingestion in the transaction monitoring settings before submitting events.", "code": "event_monitoring_disabled" } }, "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no write access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "409": { "description": "`event_id` ya se usó para un evento con contenido diferente (categoría, tipo de acción, `occurred_at`, `vendor_data` del sujeto o payload). Envía el evento con un nuevo `event_id`.", "content": { "application/json": { "examples": { "event_id reused": { "value": { "event_id": "event_id 'login-2026-10-17-000001' already exists with a different payload." } } } } } }, "429": { "description": "Límite de solicitudes superado: las solicitudes de escritura (`POST`, `PATCH`, `DELETE`) comparten un cupo de 300 solicitudes por minuto por clave de API. Espera `Retry-After` segundos y vuelve a intentarlo.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/batch/": { "post": { "summary": "Crear eventos de monitorización en lote", "description": "Envía de 1 a 500 eventos en una sola solicitud, cada uno con el mismo sobre que `POST /v3/events/`. Cada elemento se valida, se almacena y se evalúa por separado y obtiene su propio resultado (`accepted`, `replayed` o `rejected`), de modo que un evento mal formado nunca revierte los demás: la respuesta es `201` cuando no se rechazó ningún elemento y `207` cuando se rechazó al menos uno, y ambas significan que la solicitud se procesó. Envía `{\"events\": [...]}`; también se acepta un array JSON de eventos sin envolver. La ingesta de eventos debe estar activada para la aplicación; de lo contrario, toda la solicitud devuelve `403` con `code: event_monitoring_disabled` y no se almacena nada. Una clave de API con permisos limitados necesita `transactions: write`. Consulta [Lotes](https://docs.didit.me/es/transaction-monitoring/events#lotes).", "operationId": "create_monitoring_events_batch", "x-didit-sdk": { "resource": "monitoring_events", "method": "create_batch", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "events" ], "properties": { "events": { "type": "array", "minItems": 1, "maxItems": 500, "description": "De 1 a 500 eventos. Cada elemento sigue `MonitoringEventCreateRequest`, incluida la ventana de 7 días en el pasado y 5 minutos en el futuro para `occurred_at`.", "items": { "$ref": "#/components/schemas/MonitoringEventCreateRequest" } } } }, "example": { "events": [ { "event_id": "login-2026-10-17-000001", "event_category": "auth", "action_type": "login", "occurred_at": "2026-10-17T09:15:02.481Z", "subject": { "vendor_data": "user-42" } }, { "event_id": "deposit-2026-10-17-000002", "event_category": "payment", "action_type": "deposit_completed", "occurred_at": "2026-10-17T09:16:40Z", "subject": { "vendor_data": "user-42" }, "transaction_context": { "amount": "100.00", "currency": "EUR", "payment_reference_id": "dep_736" }, "payload": { "payment_method": "card", "status": "completed" } } ] } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/events/batch/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"events\": [\n {\"event_id\": \"login-2026-10-17-000001\", \"event_category\": \"auth\", \"action_type\": \"login\",\n \"occurred_at\": \"2026-10-17T09:15:02.481Z\", \"subject\": {\"vendor_data\": \"user-42\"}},\n {\"event_id\": \"deposit-2026-10-17-000002\", \"event_category\": \"payment\", \"action_type\": \"deposit_completed\",\n \"occurred_at\": \"2026-10-17T09:16:40.000Z\", \"subject\": {\"vendor_data\": \"user-42\"},\n \"transaction_context\": {\"amount\": \"100.00\", \"currency\": \"EUR\", \"payment_reference_id\": \"dep_736\"},\n \"payload\": {\"payment_method\": \"card\", \"status\": \"completed\"}}\n ]\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.monitoring_events.create_batch(\n events=[{\n \"event_id\": \"login-2026-10-17-000001\",\n \"event_category\": \"auth\",\n \"action_type\": \"login\",\n \"occurred_at\": \"2026-10-17T09:15:02.481Z\",\n \"subject\": {\n \"vendor_data\": \"user-42\",\n },\n }, {\n \"event_id\": \"deposit-2026-10-17-000002\",\n \"event_category\": \"payment\",\n \"action_type\": \"deposit_completed\",\n \"occurred_at\": \"2026-10-17T09:16:40Z\",\n \"subject\": {\n \"vendor_data\": \"user-42\",\n },\n \"transaction_context\": {\n \"amount\": \"100.00\",\n \"currency\": \"EUR\",\n \"payment_reference_id\": \"dep_736\",\n },\n \"payload\": {\"payment_method\": \"card\", \"status\": \"completed\"},\n }],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.monitoringEvents.createBatch({\n events: [{\n event_id: \"login-2026-10-17-000001\",\n event_category: \"auth\",\n action_type: \"login\",\n occurred_at: \"2026-10-17T09:15:02.481Z\",\n subject: {\n vendor_data: \"user-42\",\n },\n }, {\n event_id: \"deposit-2026-10-17-000002\",\n event_category: \"payment\",\n action_type: \"deposit_completed\",\n occurred_at: \"2026-10-17T09:16:40Z\",\n subject: {\n vendor_data: \"user-42\",\n },\n transaction_context: {\n amount: \"100.00\",\n currency: \"EUR\",\n payment_reference_id: \"dep_736\",\n },\n payload: { payment_method: \"card\", status: \"completed\" },\n }],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.MonitoringEvents.CreateBatch(ctx, didit.MonitoringEventsCreateBatchParams{\n\tEvents: []didit.MonitoringEventCreateRequest{{\n\t\tEventID: \"login-2026-10-17-000001\",\n\t\tEventCategory: \"auth\",\n\t\tActionType: \"login\",\n\t\tOccurredAt: time.Date(2026, 10, 17, 9, 15, 2, 0, time.UTC),\n\t\tSubject: didit.MonitoringEventCreateRequestSubject{\n\t\t\tVendorData: \"user-42\",\n\t\t},\n\t}, {\n\t\tEventID: \"deposit-2026-10-17-000002\",\n\t\tEventCategory: \"payment\",\n\t\tActionType: \"deposit_completed\",\n\t\tOccurredAt: time.Date(2026, 10, 17, 9, 16, 40, 0, time.UTC),\n\t\tSubject: didit.MonitoringEventCreateRequestSubject{\n\t\t\tVendorData: \"user-42\",\n\t\t},\n\t\tTransactionContext: didit.Some(didit.MonitoringEventCreateRequestTransactionContext{\n\t\t\tAmount: didit.String(\"100.00\"),\n\t\t\tCurrency: didit.String(\"EUR\"),\n\t\t\tPaymentReferenceID: didit.String(\"dep_736\"),\n\t\t}),\n\t\tPayload: didit.Some(map[string]any{\"payment_method\": \"card\", \"status\": \"completed\"}),\n\t}},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.MonitoringEventCreateRequest;\nimport me.didit.types.MonitoringEventsCreateBatchParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.monitoringEvents().createBatch(MonitoringEventsCreateBatchParams.builder()\n .events(List.of(\n MonitoringEventCreateRequest.builder()\n .eventId(\"login-2026-10-17-000001\")\n .eventCategory(MonitoringEventCreateRequest.EventCategory.of(\"auth\"))\n .actionType(\"login\")\n .occurredAt(OffsetDateTime.parse(\"2026-10-17T09:15:02.481Z\"))\n .subject(MonitoringEventCreateRequest.Subject.builder()\n .vendorData(\"user-42\")\n .build())\n .build(),\n MonitoringEventCreateRequest.builder()\n .eventId(\"deposit-2026-10-17-000002\")\n .eventCategory(MonitoringEventCreateRequest.EventCategory.of(\"payment\"))\n .actionType(\"deposit_completed\")\n .occurredAt(OffsetDateTime.parse(\"2026-10-17T09:16:40Z\"))\n .subject(MonitoringEventCreateRequest.Subject.builder()\n .vendorData(\"user-42\")\n .build())\n .transactionContext(MonitoringEventCreateRequest.TransactionContext.builder()\n .amount(\"100.00\")\n .currency(\"EUR\")\n .paymentReferenceId(\"dep_736\")\n .build())\n .payload(Map.of(\"payment_method\", \"card\", \"status\", \"completed\"))\n .build()))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->createBatch([\n 'events' => [[\n 'event_id' => 'login-2026-10-17-000001',\n 'event_category' => 'auth',\n 'action_type' => 'login',\n 'occurred_at' => '2026-10-17T09:15:02.481Z',\n 'subject' => [\n 'vendor_data' => 'user-42',\n ],\n ], [\n 'event_id' => 'deposit-2026-10-17-000002',\n 'event_category' => 'payment',\n 'action_type' => 'deposit_completed',\n 'occurred_at' => '2026-10-17T09:16:40Z',\n 'subject' => [\n 'vendor_data' => 'user-42',\n ],\n 'transaction_context' => [\n 'amount' => '100.00',\n 'currency' => 'EUR',\n 'payment_reference_id' => 'dep_736',\n ],\n 'payload' => ['payment_method' => 'card', 'status' => 'completed'],\n ]],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.monitoring_events.create_batch(\n events: [{\n event_id: \"login-2026-10-17-000001\",\n event_category: \"auth\",\n action_type: \"login\",\n occurred_at: \"2026-10-17T09:15:02.481Z\",\n subject: {\n vendor_data: \"user-42\",\n },\n }, {\n event_id: \"deposit-2026-10-17-000002\",\n event_category: \"payment\",\n action_type: \"deposit_completed\",\n occurred_at: \"2026-10-17T09:16:40Z\",\n subject: {\n vendor_data: \"user-42\",\n },\n transaction_context: {\n amount: \"100.00\",\n currency: \"EUR\",\n payment_reference_id: \"dep_736\",\n },\n payload: { payment_method: \"card\", status: \"completed\" },\n }]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.MonitoringEvents.CreateBatchAsync(new MonitoringEventsCreateBatchParams\n{\n Events = new MonitoringEventCreateRequest[]\n {\n new()\n {\n EventId = \"login-2026-10-17-000001\",\n EventCategory = \"auth\",\n ActionType = \"login\",\n OccurredAt = DateTimeOffset.Parse(\"2026-10-17T09:15:02.481Z\"),\n Subject = new()\n {\n VendorData = \"user-42\",\n },\n },\n new()\n {\n EventId = \"deposit-2026-10-17-000002\",\n EventCategory = \"payment\",\n ActionType = \"deposit_completed\",\n OccurredAt = DateTimeOffset.Parse(\"2026-10-17T09:16:40Z\"),\n Subject = new()\n {\n VendorData = \"user-42\",\n },\n TransactionContext = new MonitoringEventCreateRequestTransactionContext\n {\n Amount = \"100.00\",\n Currency = \"EUR\",\n PaymentReferenceId = \"dep_736\",\n },\n Payload = new Dictionary { [\"payment_method\"] = \"card\", [\"status\"] = \"completed\" },\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "No se rechazó ningún elemento: todos los elementos están `accepted` o `replayed`.", "content": { "application/json": { "schema": { "type": "object", "required": [ "accepted_count", "replayed_count", "rejected_count", "results" ], "properties": { "accepted_count": { "type": "integer", "minimum": 0, "description": "Elementos almacenados y evaluados." }, "replayed_count": { "type": "integer", "minimum": 0, "description": "Elementos ya almacenados con el mismo contenido." }, "rejected_count": { "type": "integer", "minimum": 0, "description": "Elementos no almacenados." }, "results": { "type": "array", "description": "Una entrada por elemento, en el orden de la solicitud.", "items": { "type": "object", "description": "Resultado de un elemento. Los elementos aceptados y repetidos también incluyen todos los campos de `MonitoringEventIngestResult`; los elementos rechazados incluyen `event_id` y `errors` en su lugar.", "required": [ "index", "outcome" ], "properties": { "index": { "type": "integer", "minimum": 0, "description": "Posición del elemento en tu array `events`." }, "outcome": { "type": "string", "enum": [ "accepted", "replayed", "rejected" ], "description": "`accepted`: almacenado y evaluado. `replayed`: ya estaba almacenado con el mismo contenido. `rejected`: no se almacenó; consulta `errors`." }, "event_id": { "type": "string", "nullable": true, "description": "Tu `event_id`. En los elementos rechazados por la validación, se lee de la clave `event_id` en snake_case del elemento, por lo que es null cuando el elemento la omitió o envió el alias `eventId`." }, "errors": { "type": "object", "additionalProperties": true, "description": "Solo los elementos rechazados. Errores de validación indexados por campo, con la misma estructura que el `400` de `POST /v3/events/`; un `event_id` reutilizado con contenido distinto se indica como cadena en `errors.event_id`." }, "event_uuid": { "type": "string", "format": "uuid", "description": "Solo los elementos aceptados y reenviados." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "Solo los elementos aceptados y reenviados." }, "score": { "type": "integer", "description": "Solo los elementos aceptados y reenviados." }, "rules_evaluated_count": { "type": "integer", "description": "Solo los elementos aceptados y reenviados." }, "rules_matched_count": { "type": "integer", "description": "Solo los elementos aceptados y reenviados." }, "correlation_pending": { "type": "boolean", "description": "Solo los elementos aceptados y reenviados." }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Solo los elementos aceptados y reenviados." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Solo los elementos aceptados y reenviados." }, "idempotent_replay": { "type": "boolean", "description": "Solo los elementos aceptados y reenviados." }, "rule_matches": { "type": "array", "description": "Solo los elementos aceptados y reenviados.", "items": { "type": "object", "required": [ "rule_id", "library_key", "mode", "is_async" ], "properties": { "rule_id": { "type": "string", "format": "uuid", "description": "UUID de la regla." }, "library_key": { "type": "string", "nullable": true, "description": "Clave de la biblioteca cuando la regla se instaló desde la biblioteca de reglas; en caso contrario, null." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Las reglas `TEST` registran la coincidencia, pero no aplican ninguna acción." }, "is_async": { "type": "boolean", "description": "`true` cuando la coincidencia procede de la pasada asíncrona." } } } } } } } } }, "examples": { "All landed": { "value": { "accepted_count": 1, "replayed_count": 1, "rejected_count": 0, "results": [ { "index": 0, "outcome": "accepted", "event_uuid": "33333333-4444-5555-6666-777777777777", "event_id": "login-2026-10-17-000001", "status": "ACCEPTED", "score": 0, "rules_evaluated_count": 6, "rules_matched_count": 0, "correlation_pending": false, "retention_class": "standard", "expires_at": "2026-11-16T09:15:02.481000Z", "idempotent_replay": false, "rule_matches": [] }, { "index": 1, "outcome": "replayed", "event_uuid": "11111111-2222-3333-4444-555555555555", "event_id": "deposit-2026-10-17-000002", "status": "ACCEPTED", "score": 0, "rules_evaluated_count": 6, "rules_matched_count": 0, "correlation_pending": false, "retention_class": "monetary_or_compliance", "expires_at": null, "idempotent_replay": true, "rule_matches": [] } ] } } } } } }, "207": { "description": "Se rechazó al menos un elemento. Los demás elementos se almacenaron. Corrige y reenvía solo los rechazados (reenviar un elemento aceptado es seguro, ya que se devuelve como `replayed`).", "content": { "application/json": { "schema": { "type": "object", "required": [ "accepted_count", "replayed_count", "rejected_count", "results" ], "properties": { "accepted_count": { "type": "integer", "minimum": 0, "description": "Elementos almacenados y evaluados." }, "replayed_count": { "type": "integer", "minimum": 0, "description": "Elementos ya almacenados con el mismo contenido." }, "rejected_count": { "type": "integer", "minimum": 0, "description": "Elementos no almacenados." }, "results": { "type": "array", "description": "Una entrada por elemento, en el orden de la solicitud.", "items": { "type": "object", "description": "Resultado de un elemento. Los elementos aceptados y repetidos también incluyen todos los campos de `MonitoringEventIngestResult`; los elementos rechazados incluyen `event_id` y `errors` en su lugar.", "required": [ "index", "outcome" ], "properties": { "index": { "type": "integer", "minimum": 0, "description": "Posición del elemento en tu array `events`." }, "outcome": { "type": "string", "enum": [ "accepted", "replayed", "rejected" ], "description": "`accepted`: almacenado y evaluado. `replayed`: ya estaba almacenado con el mismo contenido. `rejected`: no se almacenó; consulta `errors`." }, "event_id": { "type": "string", "nullable": true, "description": "Tu `event_id`. En los elementos rechazados por la validación, se lee de la clave `event_id` en snake_case del elemento, por lo que es null cuando el elemento la omitió o envió el alias `eventId`." }, "errors": { "type": "object", "additionalProperties": true, "description": "Solo los elementos rechazados. Errores de validación indexados por campo, con la misma estructura que el `400` de `POST /v3/events/`; un `event_id` reutilizado con contenido distinto se indica como cadena en `errors.event_id`." }, "event_uuid": { "type": "string", "format": "uuid", "description": "Solo los elementos aceptados y reenviados." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "Solo los elementos aceptados y reenviados." }, "score": { "type": "integer", "description": "Solo los elementos aceptados y reenviados." }, "rules_evaluated_count": { "type": "integer", "description": "Solo los elementos aceptados y reenviados." }, "rules_matched_count": { "type": "integer", "description": "Solo los elementos aceptados y reenviados." }, "correlation_pending": { "type": "boolean", "description": "Solo los elementos aceptados y reenviados." }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Solo los elementos aceptados y reenviados." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Solo los elementos aceptados y reenviados." }, "idempotent_replay": { "type": "boolean", "description": "Solo los elementos aceptados y reenviados." }, "rule_matches": { "type": "array", "description": "Solo los elementos aceptados y reenviados.", "items": { "type": "object", "required": [ "rule_id", "library_key", "mode", "is_async" ], "properties": { "rule_id": { "type": "string", "format": "uuid", "description": "UUID de la regla." }, "library_key": { "type": "string", "nullable": true, "description": "Clave de la biblioteca cuando la regla se instaló desde la biblioteca de reglas; en caso contrario, null." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Las reglas `TEST` registran la coincidencia, pero no aplican ninguna acción." }, "is_async": { "type": "boolean", "description": "`true` cuando la coincidencia procede de la pasada asíncrona." } } } } } } } } }, "examples": { "Partial success": { "value": { "accepted_count": 1, "replayed_count": 0, "rejected_count": 2, "results": [ { "index": 0, "outcome": "accepted", "event_uuid": "33333333-4444-5555-6666-777777777777", "event_id": "login-2026-10-17-000001", "status": "ACCEPTED", "score": 0, "rules_evaluated_count": 6, "rules_matched_count": 0, "correlation_pending": false, "retention_class": "standard", "expires_at": "2026-11-16T09:15:02.481000Z", "idempotent_replay": false, "rule_matches": [] }, { "index": 1, "event_id": "deposit-2026-10-17-000002", "outcome": "rejected", "errors": { "payload": [ "payment.deposit_completed requires: payment_method, status." ] } }, { "index": 2, "event_id": "login-2026-10-16-000777", "outcome": "rejected", "errors": { "event_id": "event_id 'login-2026-10-16-000777' already exists with a different payload." } } ] } } } } } }, "400": { "description": "El lote en sí tiene un formato incorrecto: falta `events` o no es un array, está vacío o tiene más de 500 elementos. No se almacena nada; divide los lotes grandes.", "content": { "application/json": { "examples": { "Not a list": { "value": { "events": "Expected a list of events." } }, "Empty": { "value": { "events": "At least one event is required." } }, "Too many": { "value": { "events": "A batch accepts at most 500 events; received 612." } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Solo una clave expirada recibe `401`; una clave ausente o no válida recibe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), una clave con permisos limitados sin `transactions: write`, una clave limitada a algunos flujos o a sesiones aprobadas (una clave así nunca accede a los datos de monitorización de transacciones), o una solicitud desde fuera de la lista de IP permitidas de la clave. También se devuelve con `code: event_monitoring_disabled` mientras la ingesta de eventos está desactivada para la aplicación; en ese caso no se almacena nada, y la comprobación se ejecuta antes de validar el cuerpo.", "content": { "application/json": { "examples": { "Event monitoring disabled": { "value": { "detail": "Event monitoring is not enabled for this application. Turn on event ingestion in the transaction monitoring settings before submitting events.", "code": "event_monitoring_disabled" } }, "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no write access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Límite de solicitudes superado: las solicitudes de escritura (`POST`, `PATCH`, `DELETE`) comparten un cupo de 300 solicitudes por minuto por clave de API. Espera `Retry-After` segundos y vuelve a intentarlo.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/sdk-token/": { "post": { "summary": "Emitir un token del SDK de monitorización", "description": "Emite una credencial de dispositivo de corta duración vinculada a un único sujeto, para que tu aplicación web o móvil pueda enviar los eventos de ese usuario directamente a Didit sin una clave de API. La aplicación envía el `monitoring_token` devuelto en el encabezado `X-Monitoring-Token` al canal de dispositivo (`POST /v1/events/` y `POST /v1/events/batch/`). Allí el sujeto siempre se sobrescribe con este `vendor_data`, los eventos fuera de `allowed_event_categories` se rechazan, cada evento enviado consume un uso y se rechaza toda solicitud cuyo `Origin` no sea igual a `bind_to_origin`. Llámalo solo desde tu backend; la emisión crea la credencial y nada más (no se crea ningún usuario). La ingesta de eventos debe estar activada para la aplicación; de lo contrario, este endpoint devuelve `403` con `code: event_monitoring_disabled` en lugar de emitir una credencial que nunca podría escribir. Una clave de API con alcance limitado necesita `transactions: write`. Consulta [Envío de eventos desde el SDK](https://docs.didit.me/es/transaction-monitoring/sdk-event-submission).", "operationId": "create_monitoring_event_sdk_token", "x-didit-sdk": { "resource": "monitoring_events", "method": "create_sdk_token", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Se aceptan alias en camelCase: `vendorData`, `entityType`, `allowedEventCategories`, `ttlSeconds`, `maxUses`, `bindToOrigin`.", "required": [ "vendor_data" ], "properties": { "vendor_data": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Tu ID para el sujeto al que pertenecen todos los eventos enviados con esta credencial." }, "entity_type": { "type": "string", "maxLength": 32, "default": "individual", "description": "`company` vincula un sujeto de tipo empresa; cualquier otro valor (por defecto, `individual`) vincula una persona física." }, "allowed_event_categories": { "type": "array", "items": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ] }, "description": "Categorías que la credencial puede enviar. Omítelo o envía `[]` para permitir todas las categorías." }, "ttl_seconds": { "type": "integer", "minimum": 60, "maximum": 86400, "default": 900, "description": "Vida útil de la credencial en segundos." }, "max_uses": { "type": "integer", "minimum": 1, "nullable": true, "default": 1000, "description": "Número de eventos que la credencial puede enviar (un lote consume un uso por evento). Envía `null` para no establecer límite dentro de su vigencia." }, "bind_to_origin": { "type": "string", "maxLength": 255, "nullable": true, "description": "Si se define, el encabezado `Origin` del navegador de cada solicitud del dispositivo debe ser exactamente igual a este valor; se rechaza toda solicitud sin `Origin`." } } }, "example": { "vendor_data": "user-42", "allowed_event_categories": [ "auth", "session", "gameplay" ], "ttl_seconds": 900, "max_uses": 1000, "bind_to_origin": "https://app.example.com" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/events/sdk-token/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"vendor_data\": \"user-42\",\n \"allowed_event_categories\": [\"auth\", \"session\", \"gameplay\"],\n \"ttl_seconds\": 900,\n \"max_uses\": 1000,\n \"bind_to_origin\": \"https://app.example.com\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.monitoring_events.create_sdk_token(\n vendor_data=\"user-42\",\n allowed_event_categories=[\"auth\", \"session\", \"gameplay\"],\n ttl_seconds=900,\n max_uses=1000,\n bind_to_origin=\"https://app.example.com\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.monitoringEvents.createSdkToken({\n vendor_data: \"user-42\",\n allowed_event_categories: [\"auth\", \"session\", \"gameplay\"],\n ttl_seconds: 900,\n max_uses: 1000,\n bind_to_origin: \"https://app.example.com\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.MonitoringEvents.CreateSDKToken(ctx, didit.MonitoringEventsCreateSDKTokenParams{\n\tVendorData: \"user-42\",\n\tAllowedEventCategories: didit.Some([]didit.MonitoringEventsCreateSDKTokenParamsAllowedEventCategories{\"auth\", \"session\", \"gameplay\"}),\n\tTTLSeconds: didit.Int(900),\n\tMaxUses: didit.Int(1000),\n\tBindToOrigin: didit.String(\"https://app.example.com\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.MonitoringEventsCreateSdkTokenParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.monitoringEvents().createSdkToken(MonitoringEventsCreateSdkTokenParams.builder()\n .vendorData(\"user-42\")\n .allowedEventCategories(List.of(MonitoringEventsCreateSdkTokenParams.AllowedEventCategories.of(\"auth\"), MonitoringEventsCreateSdkTokenParams.AllowedEventCategories.of(\"session\"), MonitoringEventsCreateSdkTokenParams.AllowedEventCategories.of(\"gameplay\")))\n .ttlSeconds(900L)\n .maxUses(1000L)\n .bindToOrigin(\"https://app.example.com\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->createSdkToken([\n 'vendor_data' => 'user-42',\n 'allowed_event_categories' => ['auth', 'session', 'gameplay'],\n 'ttl_seconds' => 900,\n 'max_uses' => 1000,\n 'bind_to_origin' => 'https://app.example.com',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.monitoring_events.create_sdk_token(\n vendor_data: \"user-42\",\n allowed_event_categories: [\"auth\", \"session\", \"gameplay\"],\n ttl_seconds: 900,\n max_uses: 1000,\n bind_to_origin: \"https://app.example.com\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.MonitoringEvents.CreateSdkTokenAsync(new MonitoringEventsCreateSdkTokenParams\n{\n VendorData = \"user-42\",\n AllowedEventCategories = new MonitoringEventsCreateSdkTokenParamsAllowedEventCategories[] { \"auth\", \"session\", \"gameplay\" },\n TtlSeconds = 900,\n MaxUses = 1000,\n BindToOrigin = \"https://app.example.com\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Se emitió la credencial. Entrega `monitoring_token` a la app y trátalo como un secreto hasta `expires_at`.", "content": { "application/json": { "schema": { "type": "object", "required": [ "monitoring_token", "expires_at", "allowed_event_categories", "max_uses", "bind_to_origin" ], "properties": { "monitoring_token": { "type": "string", "description": "La credencial del dispositivo (un token de 43 caracteres seguro para URL). Envíala en el encabezado `X-Monitoring-Token`." }, "expires_at": { "type": "string", "format": "date-time", "description": "Cuándo deja de aceptarse la credencial." }, "allowed_event_categories": { "type": "array", "items": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ] }, "description": "Categorías que la credencial puede enviar; `[]` significa todas las categorías." }, "max_uses": { "type": "integer", "nullable": true, "description": "Presupuesto de eventos de la credencial; null significa que no hay límite." }, "bind_to_origin": { "type": "string", "nullable": true, "description": "Origen al que está vinculada la credencial, o null." } } }, "example": { "monitoring_token": "q7ZtR2xKp9VbN4mWc8LdH1sYfJ3gT6uEaQ0oPiXzBkC", "expires_at": "2026-10-17T09:30:02.481000Z", "allowed_event_categories": [ "auth", "session", "gameplay" ], "max_uses": 1000, "bind_to_origin": "https://app.example.com" } } } }, "400": { "description": "Error de validación: falta `vendor_data`, `ttl_seconds` está fuera del rango de 60 a 86400, `max_uses` es inferior a 1 o hay una categoría desconocida (identificada por su posición en el array).", "content": { "application/json": { "examples": { "Missing vendor_data": { "value": { "vendor_data": [ "This field is required." ] } }, "ttl_seconds too short": { "value": { "ttl_seconds": [ "Ensure this value is greater than or equal to 60." ] } }, "Unknown category": { "value": { "allowed_event_categories": { "1": [ "\"login\" is not a valid choice." ] } } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Solo una clave expirada recibe `401`; una clave ausente o no válida recibe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), una clave con permisos limitados sin `transactions: write`, una clave limitada a algunos flujos o a sesiones aprobadas (una clave así nunca accede a los datos de monitorización de transacciones), o una solicitud desde fuera de la lista de IP permitidas de la clave. También se devuelve con `code: event_monitoring_disabled` mientras la ingesta de eventos está desactivada para la aplicación; en ese caso no se almacena nada, y la comprobación se ejecuta antes de validar el cuerpo.", "content": { "application/json": { "examples": { "Event monitoring disabled": { "value": { "detail": "Event monitoring is not enabled for this application. Turn on event ingestion in the transaction monitoring settings before submitting events.", "code": "event_monitoring_disabled" } }, "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no write access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Límite de solicitudes superado: las solicitudes de escritura (`POST`, `PATCH`, `DELETE`) comparten un cupo de 300 solicitudes por minuto por clave de API. Espera `Retry-After` segundos y vuelve a intentarlo.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/{event_uuid}/": { "get": { "summary": "Obtener un evento de monitorización", "description": "Obtén un evento de monitorización con todo lo que devuelve la lista, además del payload, los valores personalizados, el contexto del dispositivo, la procedencia de los campos (`field_sources`), los campos de dominio promovidos, `expires_at`, cada ejecución de regla coincidente con su evidencia, el enriquecimiento de IP y las etiquetas que añadieron las reglas. Mientras `correlation_pending` sea `true`, todavía queda por ejecutarse una regla asíncrona; vuelve a leer el evento unos minutos después para obtener los valores finales de `status`, `score` y `rule_runs`. Las lecturas funcionan tanto si la ingesta de eventos está activada como si no. Una clave de API con alcance limitado necesita `transactions: read`. Consulta [Evidencia](https://docs.didit.me/es/transaction-monitoring/event-rules#evidencia) y [Enriquecimiento de IP](https://docs.didit.me/es/transaction-monitoring/ip-enrichment).", "operationId": "get_monitoring_event", "x-didit-sdk": { "resource": "monitoring_events", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "parameters": [ { "name": "event_uuid", "in": "path", "required": true, "description": "Identificador de Didit del evento (`event_uuid` de la respuesta de creación, lote, listado o cronología), no tu propio `event_id`.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/events/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.monitoring_events.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.monitoringEvents.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.MonitoringEvents.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.monitoringEvents().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.monitoring_events.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.MonitoringEvents.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "El evento con su evidencia.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringEventDetail" }, "examples": { "Login from a VPN, in review": { "value": { "event_uuid": "33333333-4444-5555-6666-777777777777", "event_id": "login-2026-10-17-000001", "event_category": "auth", "action_type": "login", "occurred_at": "2026-10-17T09:15:02.481000Z", "received_at": "2026-10-17T09:15:02.903114Z", "status": "IN_REVIEW", "score": 40, "subject_vendor_data": "user-42", "subject_entity_type": "individual", "subject_uuid": "66666666-7777-8888-9999-000000000000", "counterparty_vendor_data": null, "session_id": "web-session-abc", "device_fingerprint": "fp-a8c1", "ip_address": "203.0.113.42", "ip_country": "ES", "amount": null, "currency": null, "game_id": null, "round_id": null, "bonus_id": null, "affiliate_code": null, "payment_reference_id": null, "retention_class": "risk_relevant", "rules_matched_count": 1, "correlation_pending": false, "is_droppable": true, "payload": { "method": "password" }, "custom_values": { "vip_tier": "gold", "vpn_or_proxy_detected": true }, "device_context": { "fingerprint": "fp-a8c1", "network_context": { "ip_address": "203.0.113.42", "ip_country": "Spain", "ip_country_code": "ES", "ip_city": "Madrid", "asn_number": 64500, "asn_organization": "Example Networks", "is_vpn_or_tor": true, "is_data_center": false } }, "field_sources": { "subject.vendor_data": "customer", "event_category": "customer", "action_type": "customer", "occurred_at": "customer", "received_at": "server", "payload.method": "customer", "session.session_id": "customer", "session.sequence": "customer", "device_context.fingerprint": "customer", "device_context.network_context.ip_address": "customer", "device_context.network_context.ip_country": "server", "device_context.network_context.ip_country_code": "server", "device_context.network_context.ip_city": "server", "device_context.network_context.asn_number": "server", "device_context.network_context.asn_organization": "server", "device_context.network_context.is_vpn_or_tor": "server", "device_context.network_context.is_data_center": "server" }, "session_sequence": 142, "table_id": null, "hand_id": null, "match_id": null, "market_id": null, "side": null, "role": null, "net_result_amount": null, "payment_fingerprint": null, "instrument_reference_hash": null, "withdrawal_address_hash": null, "dispute_id": null, "chargeback_id": null, "changed_field": null, "identity_match_ref": null, "schema_version": 1, "expires_at": "2027-01-15T09:15:02.481000Z", "rules_evaluated_count": 6, "rule_runs": [ { "rule_uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "rule_title": "Login from VPN or Tor", "library_key": null, "matched": true, "mode": "ACTIVE", "is_async": false, "severity": "MEDIUM", "score_delta": 40, "action_summary": "score +40; add_tag:VPN_LOGIN", "matched_payload": [ { "field": "event.ip.is_vpn_or_tor", "operator": "eq", "expected_value": true, "current_value": true, "matched": true, "group_index": null, "group_logic": "AND", "field_source": "server" } ], "created_at": "2026-10-17T09:15:02.951207Z" } ], "ip_enrichment": { "ip_country_code": "ES", "ip_city": "Madrid", "asn_number": 64500, "asn_organization": "Example Networks", "is_vpn_or_tor": true, "is_data_center": false, "proxy_type": null, "last_enriched_at": "2026-10-17T09:15:02.910442Z" }, "subject_profile": null, "tags": [ "VPN_LOGIN" ] } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Solo una clave expirada recibe `401`; una clave ausente o no válida recibe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), una clave con permisos limitados sin `transactions: read`, una clave limitada a algunos flujos o a sesiones aprobadas (una clave así nunca accede a los datos de monitorización de transacciones), o una solicitud desde fuera de la lista de IP permitidas de la clave.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no read access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "No existe ningún evento con este `event_uuid` en la aplicación: nunca se almacenó, se eliminó o pertenece a otra aplicación. Un segmento de ruta que no es un UUID no coincide con la ruta y también devuelve `404`.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No MonitoringEvent matches the given query." } } } } } }, "429": { "description": "Límite de solicitudes superado: las solicitudes `GET` comparten un cupo de 600 solicitudes por minuto por clave de API. Espera `Retry-After` segundos y vuelve a intentarlo.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/subjects/{vendor_data}/": { "get": { "summary": "Obtener la cronología de eventos de un sujeto", "description": "Lista todos los eventos de monitorización de un sujeto, del `occurred_at` más reciente al más antiguo. Un `vendor_data` es único solo dentro de un tipo de entidad, por lo que el mismo id puede designar a una persona física y a una empresa: `entity_type` determina qué cronología obtienes y su valor predeterminado es `individual`, así que los eventos de una empresa requieren `entity_type=company`. Los filtros de `GET /v3/events/` se aplican adicionalmente, y un `vendor_data` sin eventos devuelve una página vacía en lugar de `404`. Una clave de API con alcance limitado necesita `transactions: read`. Consulta [Lectura de eventos](https://docs.didit.me/es/transaction-monitoring/events#lectura-de-eventos).", "operationId": "get_monitoring_event_subject_timeline", "x-didit-sdk": { "resource": "monitoring_events", "method": "retrieve_subject_timeline", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "description": "Tu ID para el sujeto (`subject.vendor_data` de sus eventos). Codifícalo para URL; un valor que contenga `/` no se puede usar con este endpoint.", "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "example": "user-42" }, { "name": "entity_type", "in": "query", "required": false, "description": "`company` devuelve la empresa con este `vendor_data`; cualquier otro valor, o ninguno, devuelve la persona física. Se acepta `subject_entity_type` como alias cuando falta `entity_type`.", "schema": { "type": "string", "enum": [ "individual", "company" ], "default": "individual" }, "example": "individual" }, { "name": "limit", "in": "query", "required": false, "description": "Número máximo de eventos por página. El valor predeterminado es 50. Los valores superiores a 1000000 devuelven `400`; un valor no numérico, cero o negativo se sustituye por 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 50 }, { "name": "offset", "in": "query", "required": false, "description": "Número de eventos que se omiten. El valor predeterminado es 0. Es preferible seguir la URL `next` de la respuesta.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 0 }, { "name": "event_category", "in": "query", "required": false, "description": "Solo eventos de estas categorías. Repite el parámetro para indicar varios valores (`?event_category=payment&event_category=dispute`); se devuelve cualquier evento que coincida con alguno de ellos.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ] } }, "example": [ "payment", "dispute" ] }, { "name": "action_type", "in": "query", "required": false, "description": "Solo eventos con estos tipos de acción (coincidencia exacta, distingue mayúsculas y minúsculas). Repite el parámetro para indicar varios valores.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "deposit_completed", "chargeback_opened" ] }, { "name": "status", "in": "query", "required": false, "description": "Solo eventos con estos estados. Repite el parámetro para indicar varios valores.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ] } }, "example": [ "IN_REVIEW", "DECLINED" ] }, { "name": "retention_class", "in": "query", "required": false, "description": "Solo eventos de estas clases de retención. Repite el parámetro para indicar varios valores.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ] } }, "example": [ "risk_relevant" ] }, { "name": "business_vendor_data", "in": "query", "required": false, "description": "Coincidencia exacta con el `business.vendor_data` enviado con el evento.", "schema": { "type": "string" }, "example": "merchant-7" }, { "name": "session_id", "in": "query", "required": false, "description": "Coincidencia exacta con `session.session_id`.", "schema": { "type": "string" }, "example": "web-session-abc" }, { "name": "device_fingerprint", "in": "query", "required": false, "description": "Coincidencia exacta con `device_context.fingerprint`.", "schema": { "type": "string" }, "example": "fp-a8c1" }, { "name": "ip_address", "in": "query", "required": false, "description": "Coincidencia exacta con la dirección IP del evento.", "schema": { "type": "string" }, "example": "203.0.113.42" }, { "name": "game_id", "in": "query", "required": false, "description": "Coincidencia exacta con el `game_id` promovido.", "schema": { "type": "string" }, "example": "poker-holdem-01" }, { "name": "round_id", "in": "query", "required": false, "description": "Coincidencia exacta con el `round_id` promovido.", "schema": { "type": "string" }, "example": "round-88231" }, { "name": "affiliate_code", "in": "query", "required": false, "description": "Coincidencia exacta con el `affiliate_code` promovido.", "schema": { "type": "string" }, "example": "aff-summer" }, { "name": "payment_reference_id", "in": "query", "required": false, "description": "Coincidencia exacta con la referencia de pago (de `transaction_context.payment_reference_id` o `payload.payment_reference_id`).", "schema": { "type": "string" }, "example": "dep_735" }, { "name": "counterparty_vendor_data", "in": "query", "required": false, "description": "Coincidencia exacta con el `counterparty_vendor_data` promovido.", "schema": { "type": "string" }, "example": "user-77" }, { "name": "matched_only", "in": "query", "required": false, "description": "`true` (también `1` o `yes`, sin distinguir mayúsculas de minúsculas) devuelve solo los eventos en los que coincidió al menos una regla (`rules_matched_count` mayor que 0). Cualquier otro valor se ignora.", "schema": { "type": "boolean", "default": false }, "example": true }, { "name": "occurred_from", "in": "query", "required": false, "description": "Solo eventos con `occurred_at` igual o posterior a este instante (inclusive). Envía un valor ISO 8601: `2026-10-01T00:00:00Z`, un desfase explícito con el `+` codificado en formato porcentual (`2026-10-01T02:00:00%2B02:00`; un `+` sin codificar se decodifica como un espacio y el valor deja de poder interpretarse) o solo una fecha (`2026-10-01`), que equivale a las 00:00:00 UTC de ese día. Un valor sin desfase se interpreta como UTC. No se aceptan valores en ningún otro formato.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-01T00:00:00Z" }, { "name": "occurred_to", "in": "query", "required": false, "description": "Solo eventos con `occurred_at` igual o anterior a este instante (inclusive). Una fecha sola equivale al inicio de ese día, por lo que `occurred_to=2026-10-15` excluye el resto del 15 de octubre; envía `2026-10-15T23:59:59Z` para incluirlo. Envía un valor ISO 8601: `2026-10-01T00:00:00Z`, un desfase explícito con el `+` codificado en formato porcentual (`2026-10-01T02:00:00%2B02:00`; un `+` sin codificar se decodifica como un espacio y el valor deja de poder interpretarse) o solo una fecha (`2026-10-01`), que equivale a las 00:00:00 UTC de ese día. Un valor sin desfase se interpreta como UTC. No se aceptan valores en ningún otro formato.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-17T23:59:59Z" }, { "name": "search", "in": "query", "required": false, "description": "Coincidencia de subcadena, sin distinguir mayúsculas y minúsculas, en `event_id`, `action_type`, `subject_vendor_data` o `counterparty_vendor_data`.", "schema": { "type": "string" }, "example": "chargeback" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/events/subjects/user-42/?entity_type=individual&limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.monitoring_events.retrieve_subject_timeline(\n \"user-42\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.monitoringEvents.retrieveSubjectTimeline(\"user-42\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.MonitoringEvents.RetrieveSubjectTimelineAutoPaging(ctx, \"user-42\", didit.MonitoringEventsRetrieveSubjectTimelineParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.monitoringEvents().retrieveSubjectTimeline(\"user-42\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->retrieveSubjectTimeline('user-42') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.monitoring_events.retrieve_subject_timeline(\"user-42\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.MonitoringEvents.RetrieveSubjectTimelineAsync(\"user-42\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Una página de los eventos del sujeto.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringEventPage" }, "examples": { "Individual timeline": { "value": { "count": 2, "next": null, "previous": null, "results": [ { "event_uuid": "11111111-2222-3333-4444-555555555555", "event_id": "chargeback-2026-10-16-000318", "event_category": "dispute", "action_type": "chargeback_opened", "occurred_at": "2026-10-16T14:02:11Z", "received_at": "2026-10-16T14:02:12.418230Z", "status": "IN_REVIEW", "score": 60, "subject_vendor_data": "user-42", "subject_entity_type": "individual", "subject_uuid": "66666666-7777-8888-9999-000000000000", "counterparty_vendor_data": null, "session_id": null, "device_fingerprint": null, "ip_address": null, "ip_country": null, "amount": "250.000000000000000000", "currency": "EUR", "game_id": null, "round_id": null, "bonus_id": null, "affiliate_code": null, "payment_reference_id": "dep_735", "retention_class": "monetary_or_compliance", "rules_matched_count": 1, "correlation_pending": false, "is_droppable": false }, { "event_uuid": "22222222-3333-4444-5555-666666666666", "event_id": "login-2026-10-15-000912", "event_category": "auth", "action_type": "login", "occurred_at": "2026-10-15T08:30:00.120000Z", "received_at": "2026-10-15T08:30:00.734512Z", "status": "ACCEPTED", "score": 0, "subject_vendor_data": "user-42", "subject_entity_type": "individual", "subject_uuid": "66666666-7777-8888-9999-000000000000", "counterparty_vendor_data": null, "session_id": "web-session-abc", "device_fingerprint": "fp-a8c1", "ip_address": "203.0.113.42", "ip_country": "ES", "amount": null, "currency": null, "game_id": null, "round_id": null, "bonus_id": null, "affiliate_code": null, "payment_reference_id": null, "retention_class": "standard", "rules_matched_count": 0, "correlation_pending": false, "is_droppable": true } ] } }, "No events": { "value": { "count": 0, "next": null, "previous": null, "results": [] } } } } } }, "400": { "description": "`limit` u `offset` es mayor que 1000000. El cuerpo es un array JSON con un mensaje. Un `limit` no numérico o no positivo recurre al valor predeterminado de 50 en lugar de fallar.", "content": { "application/json": { "examples": { "limit too large": { "summary": "limit superior a 1000000", "value": [ "limit must not exceed 1000000." ] }, "offset too large": { "summary": "offset superior a 1000000", "value": [ "offset must not exceed 1000000." ] } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Solo una clave expirada recibe `401`; una clave ausente o no válida recibe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), una clave con permisos limitados sin `transactions: read`, una clave limitada a algunos flujos o a sesiones aprobadas (una clave así nunca accede a los datos de monitorización de transacciones), o una solicitud desde fuera de la lista de IP permitidas de la clave.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no read access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Límite de solicitudes superado: las solicitudes `GET` comparten un cupo de 600 solicitudes por minuto por clave de API. Espera `Retry-After` segundos y vuelve a intentarlo.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/enrichment-metrics/": { "get": { "summary": "Obtener las métricas de enriquecimiento de eventos", "description": "Devuelve los contadores de ingesta de eventos y de enriquecimiento de IP de tu aplicación para un periodo, sumados en todos los canales (servidor, lote y dispositivo), para que puedas vigilar el volumen de eventos y confirmar que el enriquecimiento se resuelve una vez por dirección única y no una vez por evento. El periodo abarca el día de hoy más los `days` días anteriores, contados por fecha natural en UTC. Las tres ratios son null cuando su denominador es cero. Una clave de API con alcance limitado necesita `transactions: read`. Consulta [Enriquecimiento de IP](https://docs.didit.me/es/transaction-monitoring/events#enriquecimiento-de-ip).", "operationId": "get_monitoring_event_enrichment_metrics", "x-didit-sdk": { "resource": "monitoring_events", "method": "retrieve_enrichment_metrics", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "parameters": [ { "name": "days", "in": "query", "required": false, "description": "Duración del periodo en días. El valor predeterminado es 30; los valores se limitan al rango de 1 a 365 y un valor no entero se sustituye por 30. El valor aplicado se devuelve como `period_days`.", "schema": { "type": "integer", "default": 30, "minimum": 1, "maximum": 365 }, "example": 30 } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/events/enrichment-metrics/?days=30' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.monitoring_events.retrieve_enrichment_metrics()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.monitoringEvents.retrieveEnrichmentMetrics();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.MonitoringEvents.RetrieveEnrichmentMetrics(ctx, didit.MonitoringEventsRetrieveEnrichmentMetricsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.monitoringEvents().retrieveEnrichmentMetrics();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->retrieveEnrichmentMetrics();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.monitoring_events.retrieve_enrichment_metrics\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.MonitoringEvents.RetrieveEnrichmentMetricsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Contadores y ratios del período.", "content": { "application/json": { "schema": { "type": "object", "required": [ "events_ingested", "events_rejected", "enrichment_lookups", "enrichment_cache_hits", "enrichment_provider_calls", "enrichment_skipped_low_value", "unique_ips_seen", "period_days", "cache_hit_rate", "unique_ip_ratio", "provider_calls_per_1k_events" ], "properties": { "events_ingested": { "type": "integer", "description": "Nuevos eventos almacenados. Las repeticiones idempotentes no se cuentan." }, "events_rejected": { "type": "integer", "description": "Elementos rechazados dentro de solicitudes por lotes (canales de servidor y de dispositivo). Una solicitud de un solo evento rechazada no se cuenta." }, "enrichment_lookups": { "type": "integer", "description": "Eventos cuya dirección IP pública se resolvió, desde la caché o con una consulta nueva." }, "enrichment_cache_hits": { "type": "integer", "description": "Consultas respondidas desde la caché." }, "enrichment_provider_calls": { "type": "integer", "description": "Consultas que requirieron una nueva resolución de la dirección." }, "enrichment_skipped_low_value": { "type": "integer", "description": "Eventos de telemetría de poco valor cuya dirección aún no se conocía. Nunca provocan por sí mismos una nueva resolución." }, "unique_ips_seen": { "type": "integer", "description": "Direcciones que necesitaron una nueva resolución." }, "period_days": { "type": "integer", "description": "El valor de `days` aplicado después de limitarlo al rango permitido." }, "cache_hit_rate": { "type": "number", "nullable": true, "description": "`enrichment_cache_hits / enrichment_lookups`, redondeado a 4 decimales. Null cuando no hubo consultas." }, "unique_ip_ratio": { "type": "number", "nullable": true, "description": "`unique_ips_seen / events_ingested`, redondeado a 4 decimales. Null cuando no se ingirió ningún evento." }, "provider_calls_per_1k_events": { "type": "number", "nullable": true, "description": "Resoluciones nuevas por cada 1000 eventos ingeridos, redondeadas a 2 decimales. Null cuando no se ingirió ningún evento." } } }, "examples": { "Last 30 days": { "value": { "events_ingested": 128450, "events_rejected": 214, "enrichment_lookups": 41230, "enrichment_cache_hits": 40118, "enrichment_provider_calls": 1112, "enrichment_skipped_low_value": 74320, "unique_ips_seen": 1112, "period_days": 30, "cache_hit_rate": 0.973, "unique_ip_ratio": 0.0087, "provider_calls_per_1k_events": 8.66 } }, "No events yet": { "value": { "events_ingested": 0, "events_rejected": 0, "enrichment_lookups": 0, "enrichment_cache_hits": 0, "enrichment_provider_calls": 0, "enrichment_skipped_low_value": 0, "unique_ips_seen": 0, "period_days": 30, "cache_hit_rate": null, "unique_ip_ratio": null, "provider_calls_per_1k_events": null } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Solo una clave expirada recibe `401`; una clave ausente o no válida recibe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), una clave con permisos limitados sin `transactions: read`, una clave limitada a algunos flujos o a sesiones aprobadas (una clave así nunca accede a los datos de monitorización de transacciones), o una solicitud desde fuera de la lista de IP permitidas de la clave.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no read access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Límite de solicitudes superado: las solicitudes `GET` comparten un cupo de 600 solicitudes por minuto por clave de API. Espera `Retry-After` segundos y vuelve a intentarlo.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/{event_uuid}/delete/": { "delete": { "summary": "Eliminar evento de monitorización", "description": "Elimina de forma permanente un evento de monitorización junto con sus ejecuciones de reglas, notas y vínculos de etiquetas, por ejemplo, un evento enviado por error. Tras el `204`, el evento desaparece de todas las lecturas (la consulta devuelve `404` y ya no aparece en el listado ni en la cronología del sujeto), la eliminación es irreversible y su `event_id` queda libre para usarse en un nuevo evento. No se ven afectados: el usuario o la empresa a los que se asoció el evento, los casos que abrió una regla, las entradas de lista que añadió una regla ni las puntuaciones y estados ya aplicados a otros eventos. Para borrar todo lo relativo a una persona o una empresa, elimina en su lugar el usuario o la empresa, lo que también elimina sus eventos. Una clave de API con alcance limitado necesita `transactions: write`.", "operationId": "delete_monitoring_event", "x-didit-sdk": { "resource": "monitoring_events", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "parameters": [ { "name": "event_uuid", "in": "path", "required": true, "description": "Identificador de Didit del evento (`event_uuid` de la respuesta de creación, lote, listado o cronología), no tu propio `event_id`.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/events/11111111-2222-3333-4444-555555555555/delete/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.monitoring_events.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.monitoringEvents.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.MonitoringEvents.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.monitoringEvents().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.monitoring_events.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.MonitoringEvents.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ], "responses": { "204": { "description": "Se eliminó el evento. Sin cuerpo." }, "401": { "description": "La clave de API con alcance limitado ha expirado. Solo una clave expirada recibe `401`; una clave ausente o no válida recibe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), una clave con permisos limitados sin `transactions: write`, una clave limitada a algunos flujos o a sesiones aprobadas (una clave así nunca accede a los datos de monitorización de transacciones), o una solicitud desde fuera de la lista de IP permitidas de la clave.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no write access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "No existe ningún evento con este `event_uuid` en la aplicación: nunca se almacenó, se eliminó o pertenece a otra aplicación. Un segmento de ruta que no es un UUID no coincide con la ruta y también devuelve `404`.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No MonitoringEvent matches the given query." } } } } } }, "429": { "description": "Límite de solicitudes superado: las solicitudes de escritura (`POST`, `PATCH`, `DELETE`) comparten un cupo de 300 solicitudes por minuto por clave de API. Espera `Retry-After` segundos y vuelve a intentarlo.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/kyb/parties/{partyUuid}/regenerate/": { "post": { "summary": "Regenerar la sesión de KYC de una parte de Personas clave", "description": "Asigna a una parte de Personas clave de una sesión de Verificación de empresas (KYB) una nueva sesión KYC individual después de que la anterior se eliminara o expirara antes de que la persona la iniciara, para que la comprobación de Personas clave pueda completarse de nuevo; no envíes cuerpo en la solicitud. Funciona cuando la sesión KYC de la parte se eliminó (`kyc_session_deleted: true`) o expiró antes de que la persona la iniciara (`Expired`, nunca iniciada). Una sesión aún en curso o que terminó en cualquier otro estado (`Approved`, `Declined`, `In Review`, `Abandoned`, ...) devuelve `409` salvo que se haya eliminado. Una parte que nunca tuvo una o una parte que es una empresa siempre devuelve `409`. Didit crea una nueva sesión KYC alojada con el flujo de verificación (workflow) con el que se verificó la parte (su última versión publicada) o, cuando ya no se conoce, con el flujo que tu configuración de Personas clave asigna al rol de la parte, de modo que su enlace dura el tiempo de expiración de sesión de ese flujo KYC; envía el enlace por correo electrónico a la parte cuando hay un correo registrado, restablece `is_skipped` y vuelve a calcular la comprobación de Personas clave y el estado de la sesión de empresa. Después envía un [webhook](https://docs.didit.me/es/integration/webhooks) `data.updated` de la sesión de empresa con el disparador `console_key_people_regenerate`; para eximir a la parte en su lugar, usa `PATCH /v3/session/{sessionId}/kyb/parties/{partyUuid}/`. Una clave de API con alcance limitado necesita `decisions: write` y, sin `sessions: write`, recibe `kyc_session_url` como `null`. Las sesiones eliminadas cumplen los requisitos aunque la persona ya hubiera iniciado o terminado la verificación. Las sesiones importadas no cumplen los requisitos por expiración; deben haberse eliminado.", "operationId": "post_v3_session_kyb_party_regenerate", "x-didit-sdk": { "resource": "sessions", "method": "regenerate_kyb_party", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión principal de Verificación de empresas (KYB).", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "partyUuid", "in": "path", "required": true, "description": "UUID de la parte de Personas clave (`key_people_checks[].submitted.parties[].uuid` en la decisión de la sesión de empresa). Debe pertenecer a la sesión referenciada por `sessionId`.", "schema": { "type": "string", "format": "uuid", "example": "0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/session/33333333-4444-5555-6666-777777777777/kyb/parties/0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41/regenerate/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.regenerate_kyb_party(\n \"33333333-4444-5555-6666-777777777777\",\n \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.regenerateKybParty(\n \"33333333-4444-5555-6666-777777777777\",\n \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.RegenerateKYBParty(ctx, \"33333333-4444-5555-6666-777777777777\", \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().regenerateKybParty(\"33333333-4444-5555-6666-777777777777\", \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->regenerateKybParty('33333333-4444-5555-6666-777777777777', '0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.regenerate_kyb_party(\n \"33333333-4444-5555-6666-777777777777\",\n \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.RegenerateKybPartyAsync(\"33333333-4444-5555-6666-777777777777\", \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Se ha creado una nueva sesión KYC. Devuelve la parte actualizada con su nueva sesión secundaria, que expira según el tiempo de expiración de sesión de su flujo KYC.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KYBKeyPeopleParty" }, "example": { "uuid": "0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41", "entity_type": "person", "source": "USER", "name": "Jane Smith", "first_name": "Jane", "last_name": "Smith", "company_name": null, "registration_number": null, "email": "user@example.com", "nationality": "GB", "phone_number": null, "date_of_birth": "1980-05-04", "position": "Director", "custom_fields": {}, "is_active": true, "is_skipped": false, "requires_verification": true, "roles": [ { "role": "director", "ownership_percent": null, "voting_percent": null } ], "kyc_session_id": "55555555-6666-7777-8888-999999999999", "kyc_session_status": "Not Started", "kyc_session_url": "https://verify.didit.me/session/abc123def456", "kyc_session_deleted": false, "kyb_sub_session_id": null, "kyb_sub_session_status": null, "kyb_sub_session_url": null, "kyb_sub_session_deleted": false, "verification_workflow_type": "kyc", "verification_workflow_id": "12121212-3434-5656-7878-909090909090", "verification_workflow_label": "Key People KYC", "verification_workflow_features": [ { "feature": "ID_VERIFICATION", "status": "Not Finished" }, { "feature": "LIVENESS", "status": "Not Finished" }, { "feature": "AML", "status": "Not Finished" } ], "didit_internal_id": null } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Este es el único caso que devuelve `401`: una clave ausente, no válida o revocada devuelve `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "summary": "La fecha de caducidad de la clave ya pasó", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallo de autenticación o autorización. Si falta la clave, se devuelve `403`, al igual que con una clave de otra aplicación, una clave con alcance limitado sin el permiso que necesita este endpoint y una solicitud desde fuera de la lista de IP permitidas de la clave; una clave incorrecta, revocada o expirada devuelve `401`. Distínguelos por `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la validación", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clave válida que pertenece a una aplicación distinta de la de la sesión", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clave con alcance limitado le falta decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Solicitud desde fuera de la lista de IP permitidas de la clave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión no existe, se ha eliminado o está fuera de los límites de una clave con alcance restringido; no existe ninguna parte con este UUID en tu aplicación; o la parte pertenece a otra sesión. Cada caso tiene su propio `detail`. La búsqueda de la sesión se ejecuta antes de comprobar la credencial, por lo que un `sessionId` desconocido devuelve `404` incluso sin una clave válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Unknown session": { "summary": "No existe ninguna sesión con este ID, o se eliminó", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "La sesión está fuera de los límites de flujo o de solo aprobadas de una clave con alcance restringido", "value": { "detail": "Session not found." } }, "Unknown party": { "summary": "No hay ninguna parte con este UUID en tu aplicación", "value": { "detail": "No BusinessParty matches the given query." } }, "Party of another session": { "summary": "partyUuid existe, pero pertenece a otra sesión", "value": { "detail": "Party does not belong to the given session." } } } } } }, "409": { "description": "La parte no tiene ninguna sesión KYC elegible que reemplazar. Salvo que se haya eliminado, una sesión todavía en curso o que terminó en otro estado (`Approved`, `Declined`, `In Review`, `Abandoned`, ...) no se puede regenerar. Una parte que nunca tuvo una sesión o una parte que es una empresa también devuelve `409`. Una sesión elegible es la que se eliminó o expiró antes de que la persona la iniciara. Las sesiones eliminadas son elegibles aunque la persona ya hubiera iniciado o terminado la verificación. Las sesiones importadas no son elegibles por expiración; deben haberse eliminado. Ramifica según `code`.", "content": { "application/json": { "schema": { "type": "object", "required": [ "detail", "code" ], "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." }, "code": { "type": "string", "enum": [ "kyb_party_kyc_session_not_deleted" ], "description": "Código de error estable legible por máquina." } } }, "example": { "detail": "This party's KYC session is still live (it has neither been deleted nor expired without starting), so it cannot be regenerated.", "code": "kyb_party_kyc_session_not_deleted" } } } }, "429": { "description": "Límite de solicitudes superado: 300 solicitudes de escritura (POST, PATCH, DELETE) por minuto por clave de API. Espera los segundos indicados en `Retry-After` antes de reintentar; los encabezados `X-RateLimit-*` muestran el presupuesto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Rate limited": { "summary": "Presupuesto del minuto actual agotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/transactions/{transaction_id}/notes/": { "get": { "summary": "Listar notas de transacciones", "description": "Lista las notas de una transacción monitorizada, de la más reciente a la más antigua (`created_at` descendente): las notas que añades a través de la API, las notas y los cambios de estado que hacen los revisores en la Console, y las notas que Didit añade automáticamente (la acción `add_note` de una regla, o un problema al crear la sesión de verificación de la acción del usuario), que llevan el `actor_name` `Rule Engine`. `metadata` distingue los tipos de nota.\n\nPaginado con `limit` y `offset`. `count` es exacto hasta 100 y se limita a 100 por encima de esa cifra, así que sigue `next` hasta que sea `null` en lugar de calcular las páginas a partir de `count`. Es una lectura sin efectos secundarios.\n\nUna clave de API con alcance limitado necesita `transactions: read`; una clave limitada a algunos flujos o a sesiones aprobadas no puede llamar a este endpoint. Los revisores ven la misma lista en **Notas** del [detalle de la transacción](https://docs.didit.me/es/transaction-monitoring/console#detalle-de-la-transacción).", "operationId": "list_transaction_notes", "x-didit-sdk": { "resource": "transactions.notes", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "UUID de transacción de Didit: el `uuid` que devuelven `POST /v3/transactions/` y `GET /v3/transactions/`. No se acepta tu propio `txn_id`.", "schema": { "type": "string", "format": "uuid" }, "example": "abcdef12-3456-7890-abcd-ef1234567890" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "description": "Número de notas por página. El valor predeterminado es 50. Un valor que no sea un entero positivo vuelve a 50; un valor superior a 1000000 devuelve `400`." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Posición, empezando en cero, de la primera nota que se devuelve. Es preferible seguir `next`. Un valor que no sea un número entero se toma como 0; un valor superior a 1000000 devuelve `400`." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/abcdef12-3456-7890-abcd-ef1234567890/notes/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.transactions.notes.list(\n \"abcdef12-3456-7890-abcd-ef1234567890\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.transactions.notes.list(\"abcdef12-3456-7890-abcd-ef1234567890\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Transactions.Notes.ListAutoPaging(ctx, \"abcdef12-3456-7890-abcd-ef1234567890\", didit.TransactionsNotesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.transactions().notes().list(\"abcdef12-3456-7890-abcd-ef1234567890\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "transactions->notes->list('abcdef12-3456-7890-abcd-ef1234567890') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.notes.list(\"abcdef12-3456-7890-abcd-ef1234567890\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Transactions.Notes.ListAsync(\"abcdef12-3456-7890-abcd-ef1234567890\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Una página de notas, de la más reciente a la más antigua.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Número de notas de la transacción: exacto hasta 100, limitado a 100 por encima de esa cifra. Sigue `next` en lugar de calcular páginas a partir de él." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la página siguiente, o `null` en la última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la página anterior, o `null` en la primera página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionNote" } } } }, "examples": { "API, Console and rule notes": { "value": { "count": 3, "next": null, "previous": null, "results": [ { "uuid": "c1111111-2222-4333-8444-555555555555", "note": "Customer confirmed the withdrawal by phone.", "actor_email": null, "actor_name": null, "metadata": { "mentioned_emails": [ "analyst@example.com" ] }, "created_at": "2026-10-16T10:05:12.481203Z" }, { "uuid": "c2222222-3333-4444-8555-666666666666", "note": "Status changed from IN_REVIEW to APPROVED. Reason: Source of funds verified", "actor_email": "reviewer@example.com", "actor_name": "Alex Reviewer", "metadata": { "type": "status_change", "previous_status": "IN_REVIEW", "new_status": "APPROVED", "reason_code": "SOF_VERIFIED", "reason_label": "Source of funds verified" }, "created_at": "2026-10-15T17:22:40.103911Z" }, { "uuid": "c3333333-4444-4555-8666-777777777777", "note": "Large withdrawal to a new wallet: check the source of funds.", "actor_email": null, "actor_name": "Rule Engine", "metadata": { "rule_uuid": "d1111111-2222-4333-8444-555555555555", "source": "rule_action" }, "created_at": "2026-10-15T08:42:12.004518Z" } ] } }, "No notes yet": { "value": { "count": 0, "next": null, "previous": null, "results": [] } } } } } }, "400": { "description": "`limit` u `offset` supera 1000000. El cuerpo es un array JSON de mensajes, no un objeto.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "Limit too large": { "value": [ "limit must not exceed 1000000." ] }, "Offset too large": { "value": [ "offset must not exceed 1000000." ] } } } } }, "401": { "description": "La clave de API ha expirado. Solo puede expirar una clave creada con fecha de caducidad; a partir de esa fecha, toda solicitud que la use responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Si falta la clave, se recibe el mensaje genérico; una clave incorrecta, revocada o expirada recibe `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without transactions read": { "value": { "detail": "This API key has no read access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "No existe ninguna transacción con este UUID en la aplicación (nunca se creó, se eliminó o pertenece a otra aplicación). Un `transaction_id` que no es un UUID no llega a la API: devuelve una página HTML `404` en lugar de este cuerpo JSON.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not found": { "value": { "detail": "No Transaction matches the given query." } } } } } }, "429": { "description": "Más de 600 solicitudes GET por minuto con esta clave de API. Espera el número de segundos indicado en `Retry-After` y vuelve a intentarlo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos hasta que se reinicia la ventana actual de un minuto.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas por minuto en este presupuesto.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Tiempo Unix en que se restablece la ventana.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crear nota de transacción", "description": "Añade una nota de texto sin formato a la cronología de revisión de una transacción monitorizada, donde la ven los revisores de la Console. Una nota es contexto, no una decisión: el `status`, el `score` y las alertas de la transacción no cambian, no se envía ningún webhook y no se factura nada. Las `activities` de la transacción reciben una entrada `TRANSACTION_NOTE_ADDED`.\n\nLas notas creadas con una clave de API no tienen autor: `actor_email` y `actor_name` son `null`, así que incluye el autor en el texto si lo necesitas. Cada dirección de `mentioned_emails` debe pertenecer a un miembro de tu organización; de lo contrario, toda la solicitud falla con `400`. Las menciones se guardan en minúsculas y sin duplicados, y este endpoint no notifica a los miembros mencionados.\n\nCada llamada crea una nota nueva, así que reintentar una solicitud que agotó el tiempo de espera puede añadirla dos veces: lista las notas antes de reintentar. No hay ningún endpoint de la API para editar o eliminar una nota. Una clave de API con alcance limitado necesita `transactions: write`; una clave limitada a algunos flujos o a sesiones aprobadas no puede llamar a este endpoint.", "operationId": "create_transaction_note", "x-didit-sdk": { "resource": "transactions.notes", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "UUID de transacción de Didit: el `uuid` que devuelven `POST /v3/transactions/` y `GET /v3/transactions/`. No se acepta tu propio `txn_id`.", "schema": { "type": "string", "format": "uuid" }, "example": "abcdef12-3456-7890-abcd-ef1234567890" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "note" ], "properties": { "note": { "type": "string", "minLength": 1, "description": "Nota en texto plano. Se eliminan los espacios en blanco al principio y al final, y se rechaza una nota vacía. Sin límite de longitud." }, "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email" }, "default": [], "description": "Correos electrónicos de los miembros de tu organización a los que mencionar. Cada uno debe ser un correo válido de un miembro de la organización." } } }, "examples": { "Note with a mention": { "value": { "note": "Customer confirmed the withdrawal by phone.", "mentioned_emails": [ "analyst@example.com" ] } }, "Plain note": { "value": { "note": "Source of funds document requested by email." } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/transactions/abcdef12-3456-7890-abcd-ef1234567890/notes/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"note\": \"Customer confirmed the withdrawal by phone.\", \"mentioned_emails\": [\"analyst@example.com\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.notes.create(\n \"abcdef12-3456-7890-abcd-ef1234567890\",\n note=\"Customer confirmed the withdrawal by phone.\",\n mentioned_emails=[\"analyst@example.com\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.notes.create(\"abcdef12-3456-7890-abcd-ef1234567890\", {\n note: \"Customer confirmed the withdrawal by phone.\",\n mentioned_emails: [\"analyst@example.com\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Notes.Create(ctx, \"abcdef12-3456-7890-abcd-ef1234567890\", didit.TransactionsNotesCreateParams{\n\tNote: \"Customer confirmed the withdrawal by phone.\",\n\tMentionedEmails: didit.Some([]string{\"analyst@example.com\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.TransactionsNotesCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().notes().create(\"abcdef12-3456-7890-abcd-ef1234567890\", TransactionsNotesCreateParams.builder()\n .note(\"Customer confirmed the withdrawal by phone.\")\n .mentionedEmails(List.of(\"analyst@example.com\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->notes->create('abcdef12-3456-7890-abcd-ef1234567890', [\n 'note' => 'Customer confirmed the withdrawal by phone.',\n 'mentioned_emails' => ['analyst@example.com'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.notes.create(\n \"abcdef12-3456-7890-abcd-ef1234567890\",\n note: \"Customer confirmed the withdrawal by phone.\",\n mentioned_emails: [\"analyst@example.com\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Notes.CreateAsync(\"abcdef12-3456-7890-abcd-ef1234567890\", new TransactionsNotesCreateParams\n{\n Note = \"Customer confirmed the withdrawal by phone.\",\n MentionedEmails = new string[] { \"analyst@example.com\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Se creó la nota.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionNote" }, "examples": { "Created": { "value": { "uuid": "c1111111-2222-4333-8444-555555555555", "note": "Customer confirmed the withdrawal by phone.", "actor_email": null, "actor_name": null, "metadata": { "mentioned_emails": [ "analyst@example.com" ] }, "created_at": "2026-10-16T10:05:12.481203Z" } } } } } }, "400": { "description": "El cuerpo no es válido: falta `note`, es null o está vacío, hay una dirección no válida en `mentioned_emails` (errores indexados por posición en la lista) o una dirección mencionada que no es miembro de tu organización. No se crea nada.", "content": { "application/json": { "schema": { "type": "object", "description": "Errores de campo indexados por nombre de campo.", "additionalProperties": {} }, "examples": { "Missing note": { "value": { "note": [ "This field is required." ] } }, "Blank note": { "value": { "note": [ "This field may not be blank." ] } }, "Invalid email": { "value": { "mentioned_emails": { "0": [ "Enter a valid email address." ] } } }, "Not an organization member": { "value": { "mentioned_emails": [ "Mentioned users must belong to this organization and have access to this application." ] } } } } } }, "401": { "description": "La clave de API ha expirado. Solo puede expirar una clave creada con fecha de caducidad; a partir de esa fecha, toda solicitud que la use responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Si falta la clave, se recibe el mensaje genérico; una clave incorrecta, revocada o expirada recibe `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without transactions write": { "value": { "detail": "This API key has no write access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "No existe ninguna transacción con este UUID en la aplicación (nunca se creó, se eliminó o pertenece a otra aplicación). Un `transaction_id` que no es un UUID no llega a la API: devuelve una página HTML `404` en lugar de este cuerpo JSON.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not found": { "value": { "detail": "No Transaction matches the given query." } } } } } }, "429": { "description": "Más de 300 solicitudes de escritura por minuto con esta clave de API. Espera el número de segundos indicado en `Retry-After` y vuelve a intentarlo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos hasta que se reinicia la ventana actual de un minuto.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas por minuto en este presupuesto.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Tiempo Unix en que se restablece la ventana.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/transactions/{transaction_id}/related/": { "get": { "summary": "Listar transacciones relacionadas", "description": "Lista las demás transacciones de tu aplicación en las que intervienen las mismas personas o empresas que en esta. Una transacción está relacionada cuando cualquiera de sus partes, en cualquier rol, tiene el mismo `vendor_data` que una de las partes de esta transacción. La propia transacción nunca se devuelve, y las partes sin `vendor_data` se ignoran: cuando ninguna de las partes de esta transacción tiene uno, el resultado siempre está vacío.\n\nLos resultados usan el formato resumido de `GET /v3/transactions/`, de más reciente a más antiguo (`txn_date` y luego `created_at`). Se paginan con `limit` y `offset`; `count` es exacto hasta 100 y se limita a 100 por encima de esa cifra, así que sigue `next` hasta que sea `null`.\n\nUna clave de API con alcance limitado necesita `transactions: read`; una clave limitada a algunos flujos o a sesiones aprobadas no puede llamar a este endpoint. Envía el mismo `vendor_data` para la misma persona o empresa en cada [transacción](https://docs.didit.me/es/transaction-monitoring/transactions#sujeto-y-contraparte) para que esta lista esté completa.", "operationId": "list_related_transactions", "x-didit-sdk": { "resource": "transactions", "method": "list_related", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "UUID de transacción de Didit: el `uuid` que devuelven `POST /v3/transactions/` y `GET /v3/transactions/`. No se acepta tu propio `txn_id`.", "schema": { "type": "string", "format": "uuid" }, "example": "abcdef12-3456-7890-abcd-ef1234567890" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "description": "Número de transacciones por página. El valor predeterminado es 50. Un valor que no sea un entero positivo se sustituye por 50; un valor superior a 1000000 devuelve `400`." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Posición, empezando en cero, de la primera transacción que se devuelve. Es preferible seguir `next`. Un valor que no sea un número entero se toma como 0; un valor superior a 1000000 devuelve `400`." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/abcdef12-3456-7890-abcd-ef1234567890/related/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.transactions.list_related(\n \"abcdef12-3456-7890-abcd-ef1234567890\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.transactions.listRelated(\"abcdef12-3456-7890-abcd-ef1234567890\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Transactions.ListRelatedAutoPaging(ctx, \"abcdef12-3456-7890-abcd-ef1234567890\", didit.TransactionsListRelatedParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.transactions().listRelated(\"abcdef12-3456-7890-abcd-ef1234567890\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "transactions->listRelated('abcdef12-3456-7890-abcd-ef1234567890') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.list_related(\"abcdef12-3456-7890-abcd-ef1234567890\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Transactions.ListRelatedAsync(\"abcdef12-3456-7890-abcd-ef1234567890\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Una página de transacciones relacionadas, de la más reciente a la más antigua.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Número de transacciones relacionadas: exacto hasta 100 y limitado a 100 por encima de esa cifra. Sigue `next` en lugar de calcular las páginas a partir de este valor." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la página siguiente, o `null` en la última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la página anterior, o `null` en la primera página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionSummary" } } } }, "examples": { "One related transaction": { "value": { "count": 1, "next": null, "previous": null, "results": [ { "uuid": "abcdef99-3456-4890-abcd-ef1234567890", "transaction_number": 4087, "txn_id": "your-txn-2026-10-02-017", "transaction_type": "finance", "action_type": "deposit", "status": "APPROVED", "source": "LIVE", "direction": "INBOUND", "amount": "250", "currency": "EUR", "currency_type": "fiat", "preferred_currency_amount": "270.08", "preferred_currency_code": "USD", "payment_details": "Card top-up", "txn_date": "2026-10-02T14:10:00Z", "created_at": "2026-10-02T14:10:03.512244Z", "score": 12, "severity": "LOW", "decision_reason_code": null, "decision_reason_label": null, "tags": [], "subject_name": "Maria Garcia", "subject_vendor_data": "user-12345", "subject_type": "user", "subject_uuid": "e1111111-2222-4333-8444-555555555555", "counterparty_name": null, "counterparty_vendor_data": null, "counterparty_country": null, "subject_country": "ESP", "assigned_to_name": null, "travel_rule_status": null, "application_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "application_name": "Production app", "organization_id": "11111111-2222-3333-4444-555555555555", "organization_name": "Example Org" } ] } }, "No party has vendor_data": { "value": { "count": 0, "next": null, "previous": null, "results": [] } } } } } }, "400": { "description": "`limit` u `offset` supera 1000000. El cuerpo es un array JSON de mensajes, no un objeto.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "Limit too large": { "value": [ "limit must not exceed 1000000." ] }, "Offset too large": { "value": [ "offset must not exceed 1000000." ] } } } } }, "401": { "description": "La clave de API ha expirado. Solo puede expirar una clave creada con fecha de caducidad; a partir de esa fecha, toda solicitud que la use responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Si falta la clave, se recibe el mensaje genérico; una clave incorrecta, revocada o expirada recibe `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without transactions read": { "value": { "detail": "This API key has no read access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "No existe ninguna transacción con este UUID en la aplicación (nunca se creó, se eliminó o pertenece a otra aplicación). Un `transaction_id` que no es un UUID no llega a la API: devuelve una página HTML `404` en lugar de este cuerpo JSON.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not found": { "value": { "detail": "No Transaction matches the given query." } } } } } }, "429": { "description": "Más de 600 solicitudes GET por minuto con esta clave de API. Espera el número de segundos indicado en `Retry-After` y vuelve a intentarlo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos hasta que se reinicia la ventana actual de un minuto.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas por minuto en este presupuesto.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Tiempo Unix en que se restablece la ventana.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/businesses/{business_session_id}/pdf/": { "get": { "summary": "Descargar el informe PDF de una sesión de empresa", "description": "Genera el informe PDF de una sesión de Verificación de empresas (KYB): datos del registro de empresas, personas clave y beneficiarios finales, documentos, resultados AML y las demás funciones del flujo de verificación (workflow), además de las etiquetas y la actividad de revisión de la sesión. Con la personalización de marca blanca activada, el informe incluye tu logotipo y la URL de tu política de privacidad. El cuerpo es el propio PDF (`application/pdf`), no JSON.\n\nLa sesión debe estar en `Approved`, `Declined` o `In Review`; cualquier otro estado devuelve `403`, así que espera primero al [webhook](https://docs.didit.me/es/integration/webhooks) `status.updated`. El informe se genera en cada llamada y no se factura nada, así que guarda el archivo en lugar de obtenerlo repetidamente. `GET /v3/session/{sessionId}/generate-pdf/` genera el mismo tipo de informe solo con el ID de la sesión.\n\nUn informe PDF cuenta como contenido multimedia: una clave de API con alcance limitado necesita `businesses: read` y `media: read`, y una clave limitada a algunos flujos o a sesiones aprobadas no puede llamarlo.", "operationId": "get_business_session_pdf", "x-didit-sdk": { "resource": "businesses", "method": "generate_session_pdf", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Businesses" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación. Debe ser la aplicación a la que pertenece la clave de API: una clave usada en cualquier otra aplicación recibe `403`.", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, { "name": "business_session_id", "in": "path", "required": true, "description": "`session_id` de la sesión de verificación de empresas (KYB), tal como se devolvió al crear la sesión. Una sesión de otra aplicación devuelve `404`.", "schema": { "type": "string", "format": "uuid" }, "example": "22222222-3333-4444-5555-666666666666" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl --fail -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/businesses/22222222-3333-4444-5555-666666666666/pdf/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n --output business_report.pdf" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\ncontent = client.businesses.generate_session_pdf(\n \"22222222-3333-4444-5555-666666666666\",\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst content = await didit.businesses.generateSessionPdf(\"22222222-3333-4444-5555-666666666666\");\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresp, err := client.Businesses.GenerateSessionPDF(ctx, \"22222222-3333-4444-5555-666666666666\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.businesses().generateSessionPdf(\"22222222-3333-4444-5555-666666666666\")\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "businesses->generateSessionPdf('22222222-3333-4444-5555-666666666666');\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ncontent = didit.businesses.generate_session_pdf(\"22222222-3333-4444-5555-666666666666\")\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar content = await client.Businesses.GenerateSessionPdfAsync(\"22222222-3333-4444-5555-666666666666\");\nawait content.SaveToAsync(\"download.pdf\");" } ], "responses": { "200": { "description": "El PDF generado, devuelto directamente como binario `application/pdf`.", "headers": { "Content-Disposition": { "description": "Siempre `attachment; filename=business_{business_session_id}.pdf`.", "schema": { "type": "string", "example": "attachment; filename=business_22222222-3333-4444-5555-666666666666.pdf" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "La clave de API ha expirado. Solo puede expirar una clave creada con fecha de caducidad; a partir de esa fecha, toda solicitud que la use responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida o la sesión no ha terminado. Lee `detail`: una sesión que no está en `Approved`, `Declined` o `In Review`, falta la clave de API (una clave incorrecta, revocada o expirada recibe `401`), un `application_id` que no es la aplicación de la clave, una clave con alcance limitado sin `media: read` o `businesses: read`, una clave limitada a flujos o a sesiones aprobadas, o una solicitud desde fuera de la lista de IP de la clave.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Session not finished": { "value": { "detail": "You can only generate a PDF for sessions in review, declined or approved." } }, "Missing or invalid key": { "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Another application": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without media read": { "value": { "detail": "This API key has no read access to media." } }, "Scoped key without businesses read": { "value": { "detail": "This API key has no read access to companies." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "No existe ninguna sesión de empresa con este ID en la aplicación (nunca se creó, se eliminó o pertenece a otra aplicación). Un valor que no es un UUID devuelve una página HTML `404` en lugar de este cuerpo JSON.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not found": { "value": { "detail": "Business session not found." } } } } } }, "429": { "description": "Más de 600 solicitudes GET por minuto con esta clave de API. Espera el número de segundos indicado en `Retry-After` y vuelve a intentarlo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos hasta que se reinicia la ventana actual de un minuto.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas por minuto en este presupuesto.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Tiempo Unix en que se restablece la ventana.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/pdf/": { "get": { "summary": "Descargar el informe PDF de una transacción", "description": "Genera un informe en PDF de una transacción monitorizada: resumen y veredicto, partes y métodos de pago, propiedades personalizadas, alertas y ejecuciones de reglas, resultados del análisis y de Travel Rule, el resumen de la red, el desglose de costes, hasta 50 transacciones relacionadas y las 20 entradas de actividad más recientes. El cuerpo es el propio PDF (`application/pdf`), no JSON.\n\nEl informe se genera a partir de los datos actuales de la transacción en cada llamada, así que vuelve a solicitarlo tras un cambio de estado. No se almacena nada y no se factura nada. La generación puede tardar unos segundos, así que usa un tiempo de espera generoso en el cliente.\n\nEste endpoint se encuentra en una ruta con alcance de aplicación: incluye en la URL el ID de tu organización y el ID de la aplicación a la que pertenece tu clave de API ([encuentra el ID de tu organización](https://docs.didit.me/es/getting-started/api-authentication#dónde-encontrar-el-id-de-tu-organización)). Un informe en PDF cuenta como contenido multimedia: una clave de API con alcance limitado necesita `media: read` y `transactions: read`, y una clave limitada a algunos flujos o a sesiones aprobadas no puede llamarlo.", "operationId": "get_transaction_pdf", "x-didit-sdk": { "resource": "transactions", "method": "generate_pdf", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Transactions" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación. Debe ser la aplicación a la que pertenece la clave de API: una clave usada en cualquier otra aplicación recibe `403`.", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, { "name": "transaction_uuid", "in": "path", "required": true, "description": "UUID de transacción de Didit: el `uuid` que devuelven `POST /v3/transactions/` y `GET /v3/transactions/`. No se acepta tu propio `txn_id`.", "schema": { "type": "string", "format": "uuid" }, "example": "abcdef12-3456-7890-abcd-ef1234567890" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl --fail -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/transactions/abcdef12-3456-7890-abcd-ef1234567890/pdf/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n --output transaction_report.pdf" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\ncontent = client.transactions.generate_pdf(\n \"abcdef12-3456-7890-abcd-ef1234567890\",\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst content = await didit.transactions.generatePdf(\"abcdef12-3456-7890-abcd-ef1234567890\");\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresp, err := client.Transactions.GeneratePDF(ctx, \"abcdef12-3456-7890-abcd-ef1234567890\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.transactions().generatePdf(\"abcdef12-3456-7890-abcd-ef1234567890\")\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "transactions->generatePdf('abcdef12-3456-7890-abcd-ef1234567890');\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ncontent = didit.transactions.generate_pdf(\"abcdef12-3456-7890-abcd-ef1234567890\")\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar content = await client.Transactions.GeneratePdfAsync(\"abcdef12-3456-7890-abcd-ef1234567890\");\nawait content.SaveToAsync(\"download.pdf\");" } ], "responses": { "200": { "description": "El PDF generado, devuelto directamente como binario `application/pdf`.", "headers": { "Content-Disposition": { "description": "Siempre `attachment; filename=transaction_{transaction_uuid}.pdf`.", "schema": { "type": "string", "example": "attachment; filename=transaction_abcdef12-3456-7890-abcd-ef1234567890.pdf" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "La clave de API ha expirado. Solo puede expirar una clave creada con fecha de caducidad; a partir de esa fecha, toda solicitud que la use responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Lee `detail`: falta la clave de API (una clave incorrecta, revocada o expirada recibe `401`), un `application_id` que no es la aplicación de la clave, una clave con alcance limitado sin `media: read` o `transactions: read`, una clave limitada a flujos o a sesiones aprobadas, o una solicitud desde fuera de la lista de IP de la clave.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid key": { "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Another application": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without media read": { "value": { "detail": "This API key has no read access to media." } }, "Scoped key without transactions read": { "value": { "detail": "This API key has no read access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "No existe ninguna transacción con este UUID en la aplicación (nunca se creó, se eliminó o pertenece a otra aplicación). Un `transaction_uuid` que no es un UUID no llega a la API: devuelve una página HTML `404` en lugar de este cuerpo JSON.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not found": { "value": { "detail": "No Transaction matches the given query." } } } } } }, "429": { "description": "Más de 600 solicitudes GET por minuto con esta clave de API. Espera el número de segundos indicado en `Retry-After` y vuelve a intentarlo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos hasta que se reinicia la ventana actual de un minuto.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas por minuto en este presupuesto.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Tiempo Unix en que se restablece la ventana.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/analytics/": { "get": { "summary": "Obtener las analíticas de la aplicación", "description": "Lee las cifras del [panel de analíticas](https://docs.didit.me/es/console/analytics) de la Business Console para un rango de fechas. Sin `scope` ni `widget_keys`, la respuesta es el resumen de verificación de usuarios (KYC) (`ApplicationAnalyticsSummary`): número diario de sesiones, totales por estado, tasa de conversión, las mismas cifras para el periodo anterior de igual duración, ubicaciones, datos demográficos, dispositivos, embudos de los flujos, tiempo activo de verificación, reenvíos, advertencias y series temporales. Con `scope` o `widget_keys`, la respuesta son los widgets de una pestaña del panel (`ApplicationAnalyticsWidgetResponse`): `kyc`, `kyb`, `transactions` o `home`.\n\nLas sesiones se cuentan según su fecha de creación (UTC) y reflejan el estado actual de cada sesión. Proceden de agregados diarios que se actualizan en segundo plano, por lo que la actividad más reciente puede tardar un poco en aparecer. Los IDs y las versiones de flujo no válidos se ignoran en lugar de rechazarse. No se factura nada.\n\nSolo una clave de API con acceso completo puede llamar a este endpoint: cualquier clave con alcance limitado recibe `403`, sea cual sea el acceso que tenga, y lo mismo ocurre con una clave de otra aplicación. Consulta [Claves de API](https://docs.didit.me/es/console/api-keys).", "operationId": "get_application_analytics", "x-didit-sdk": { "resource": "analytics", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Analytics" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación. Debe ser la aplicación a la que pertenece la clave de API: una clave usada en cualquier otra aplicación recibe `403`.", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2026-10-01" }, "description": "Primer día del rango, `YYYY-MM-DD`, inclusive (UTC). Envíalo junto con `end_date`: si falta cualquiera de los dos, se ignoran ambos y el rango va desde 30 días antes de hoy hasta hoy." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2026-10-15" }, "description": "Último día del rango, `YYYY-MM-DD`, inclusive (UTC). Una fecha futura cuenta como hoy. El rango no puede superar los 730 días." }, { "name": "scope", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "home", "kyc", "kyb", "transactions" ] }, "description": "Pestaña del panel cuyos widgets se devuelven (no distingue mayúsculas de minúsculas). Omítela, junto con `widget_keys`, para obtener el resumen de KYC. Enviar solo `widget_keys` implica `kyc`. `home` acepta cualquier widget de KYC, KYB o transacciones y, por defecto, usa el diseño de inicio guardado de la aplicación." }, { "name": "widget_keys", "in": "query", "required": false, "schema": { "type": "string", "example": "tx_count_total,tx_count_daily" }, "description": "Claves de widgets separadas por comas, que se devuelven en este orden. Las claves que el ámbito no acepta se descartan; si no queda ninguna, recibes los valores predeterminados del ámbito. KYC: `kyc_sessions_volume`, `kyc_warning_insights`, `kyc_id_locations`, `kyc_ip_locations`, `kyc_workflow_funnel`, `kyc_average_verification_time`, `kyc_conversion_rate`, `kyc_conversion_by_country`, `kyc_resubmission_insights`, `kyc_original_status_distribution`, `kyc_database_validation_coverage`, `kyc_database_validation_latency`, `kyc_demographics`, `kyc_device_details`. KYB: `kyb_sessions_volume`, `kyb_workflow_funnel`, `kyb_average_verification_time`, `kyb_ip_locations`, `kyb_business_country_distribution`, `kyb_warning_insights`, `kyb_conversion_rate`, `kyb_conversion_by_country`, `kyb_industry_breakdown`, `kyb_resubmission_insights`, `kyb_original_status_distribution`, `kyb_registry_coverage`, `kyb_registry_data_completeness`, `kyb_device_details`. Transacciones: `tx_count_total`, `tx_count_daily`, `tx_volume_total_preferred_currency`, `tx_volume_daily_preferred_currency`, `tx_average_amount`, `tx_average_amount_daily`, `tx_transaction_category_breakdown`, `tx_action_type_breakdown`, `tx_status_volume_trend`, `tx_user_ip_or_country_distribution`, `tx_tag_breakdown`, `tx_top_rules_triggered`, `tx_team_member_performance`, `tx_score_histogram`." }, { "name": "workflow_ids", "in": "query", "required": false, "schema": { "type": "string", "example": "33333333-4444-5555-6666-777777777777" }, "description": "IDs de flujos separados por comas. Limita el resumen de KYC y los widgets de KYC y KYB a esos flujos. Los valores que no son UUID se ignoran; si ninguno es válido, se descarta el filtro. El resumen también acepta `workflow_id`." }, { "name": "versions", "in": "query", "required": false, "schema": { "type": "string", "example": "3,4" }, "description": "Números de versión de flujo separados por comas. Solo se aplica junto con `workflow_ids`; los valores que no son números enteros se ignoran. También se acepta `version` como alias." }, { "name": "branch_path_ids", "in": "query", "required": false, "schema": { "type": "string", "example": "default" }, "description": "IDs de rutas de rama separados por comas. Solo se aplica junto con `workflow_ids` y solo a las cifras de KYC. Actualmente las cifras solo se registran para `default` (todas las rutas combinadas), por lo que cualquier otro valor devuelve cifras vacías. Se acepta `branch_path_id` como alias." }, { "name": "tag", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Solo widgets de transacciones: UUID o nombres de etiquetas separados por comas." }, { "name": "transaction_type", "in": "query", "required": false, "schema": { "type": "string", "example": "finance" }, "description": "Solo widgets de transacciones: categorías de transacción separadas por comas." }, { "name": "action_type", "in": "query", "required": false, "schema": { "type": "string", "example": "withdrawal" }, "description": "Solo widgets de transacciones: tipos de acción separados por comas (sin distinguir mayúsculas de minúsculas)." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/analytics/?start_date=2026-10-01&end_date=2026-10-15' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.analytics.retrieve()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.analytics.retrieve();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Analytics.Retrieve(ctx, didit.AnalyticsRetrieveParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.analytics().retrieve();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "analytics->retrieve();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.analytics.retrieve\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Analytics.RetrieveAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "El resumen de KYC, o los widgets solicitados cuando se envía `scope` o `widget_keys`.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ApplicationAnalyticsSummary" }, { "$ref": "#/components/schemas/ApplicationAnalyticsWidgetResponse" } ] }, "examples": { "KYC summary": { "value": { "grouping_mode": "day", "data_points": [ { "rounded_date": "2026-10-14", "total": 12, "approved": 8, "declined": 1, "canceled": 1, "pending": 2, "in_review": 1, "expired": 1, "abandoned": 0, "in_progress": 1, "not_started": 0, "manually_approved": 1, "manually_declined": 0 }, { "rounded_date": "2026-10-15", "total": 10, "approved": 6, "declined": 2, "canceled": 0, "pending": 2, "in_review": 2, "expired": 0, "abandoned": 0, "in_progress": 0, "not_started": 0, "manually_approved": 0, "manually_declined": 1 } ], "request_breakdown": { "total_approved": 14, "total_in_review": 3, "total_declined": 3, "total_canceled": 1, "total_pending": 4, "total_expired": 1, "total_abandoned": 0, "total_in_progress": 1, "total_not_started": 0, "total_manually_approved": 1, "total_manually_declined": 1 }, "conversion_rate": 70.0, "location_stats": { "countries": [ { "session_count": 15, "country": "Spain", "country_code": "ES" }, { "session_count": 7, "country": "Portugal", "country_code": "PT" } ], "ip_countries": [ { "session_count": 15, "country": "Spain", "country_code": "ES" }, { "session_count": 7, "country": "Portugal", "country_code": "PT" } ], "id_countries": [ { "country": "Spain", "country_code": "ES", "session_count": 14 }, { "country": "Portugal", "country_code": "PT", "session_count": 6 } ], "conversion_by_country": [ { "country": "Spain", "country_code": "ES", "finished": 13, "approved": 10 }, { "country": "Portugal", "country_code": "PT", "finished": 6, "approved": 4 } ], "cities": [ { "session_count": 9, "location": "Madrid, Spain", "latitude": 40.4168, "longitude": -3.7038 } ] }, "demographic_stats": { "age_distribution": { "under_18": 0, "18_24": 5, "25_34": 8, "35_44": 4, "45_64": 2, "65_plus": 1 }, "gender_distribution": { "M": 11, "F": 9 } }, "device_details": { "device_models": [ { "device": "Apple", "count": 12 }, { "device": "Android", "count": 10 } ], "browsers": [ { "browser": "Safari", "count": 12 }, { "browser": "Chrome", "count": 10 } ], "operating_systems": [ { "os": "iOS", "count": 12 }, { "os": "Android", "count": 10 } ] }, "workflow_funnel_stats": { "33333333-4444-5555-6666-777777777777": { "total": 22, "steps": { "OCR": { "reached": 21 }, "LIVENESS": { "reached": 19 }, "FACE_MATCH": { "reached": 19 }, "AML": { "reached": 18 } } } }, "verification_time_stats": { "overall_avg_seconds": 64.0, "overall_count": 18, "per_feature": { "OCR": { "avg_seconds": 41.2, "total_seconds": 741.6, "count": 18 }, "LIVENESS": { "avg_seconds": 22.8, "total_seconds": 410.4, "count": 18 } }, "per_sub_step": { "OCR": { "front_id_photo": { "avg_seconds": 18.3, "total_seconds": 329.4, "count": 18 } } } }, "resubmission_stats": { "first_pass": 17, "second": 2, "third_plus": 1, "abandoned": 0 }, "warning_stats": { "ID_VERIFICATION": { "total": 21, "risks": { "DOCUMENT_EXPIRED": { "error": 1, "warning": 0, "information": 0 } } }, "LIVENESS": { "total": 19, "risks": { "LOW_LIVENESS_SCORE": { "error": 0, "warning": 2, "information": 0 } } } }, "original_status_stats": { "approved": 13, "in_review": 5, "declined": 2 }, "demographic_time_series": [ { "date": "2026-10-14", "age_distribution": { "under_18": 0, "18_24": 3, "25_34": 4, "35_44": 2, "45_64": 1, "65_plus": 0 }, "gender_distribution": { "M": 6, "F": 4 } }, { "date": "2026-10-15", "age_distribution": { "under_18": 0, "18_24": 2, "25_34": 4, "35_44": 2, "45_64": 1, "65_plus": 1 }, "gender_distribution": { "M": 5, "F": 5 } } ], "device_time_series": [ { "date": "2026-10-14", "devices": { "Apple": 7, "Android": 5 }, "browsers": { "Safari": 7, "Chrome": 5 }, "operating_systems": { "iOS": 7, "Android": 5 } }, { "date": "2026-10-15", "devices": { "Apple": 5, "Android": 5 }, "browsers": { "Safari": 5, "Chrome": 5 }, "operating_systems": { "iOS": 5, "Android": 5 } } ], "verification_time_time_series": [ { "date": "2026-10-14", "overall_avg": 66.1, "per_feature": { "OCR": 42.0, "LIVENESS": 24.1 } }, { "date": "2026-10-15", "overall_avg": 61.5, "per_feature": { "OCR": 40.2, "LIVENESS": 21.3 } } ], "resubmission_time_series": [ { "date": "2026-10-14", "first_pass": 9, "second": 1, "third_plus": 0, "abandoned": 0 }, { "date": "2026-10-15", "first_pass": 8, "second": 1, "third_plus": 1, "abandoned": 0 } ], "original_status_time_series": [ { "date": "2026-10-14", "approved": 7, "in_review": 3, "declined": 1 }, { "date": "2026-10-15", "approved": 6, "in_review": 2, "declined": 1 } ], "previous_data_points": [ { "rounded_date": "2026-10-12", "total": 9, "approved": 6, "declined": 1, "canceled": 1, "pending": 1 }, { "rounded_date": "2026-10-13", "total": 11, "approved": 7, "declined": 2, "canceled": 0, "pending": 2 } ], "previous_request_breakdown": { "total_approved": 13, "total_in_review": 2, "total_declined": 3, "total_canceled": 1, "total_pending": 3 } } }, "Transaction widgets": { "value": { "scope": "transactions", "available_widget_keys": [ "tx_count_total", "tx_count_daily", "tx_volume_total_preferred_currency", "tx_volume_daily_preferred_currency", "tx_average_amount", "tx_average_amount_daily", "tx_transaction_category_breakdown", "tx_action_type_breakdown", "tx_status_volume_trend", "tx_user_ip_or_country_distribution", "tx_tag_breakdown", "tx_top_rules_triggered", "tx_team_member_performance", "tx_score_histogram" ], "requested_widget_keys": [ "tx_count_total", "tx_count_daily" ], "widgets": { "tx_count_total": { "kind": "metric", "title": "Transaction count", "value": 42 }, "tx_count_daily": { "kind": "time_series", "title": "Transaction count", "items": [ { "date": "2026-10-14", "value": 20 }, { "date": "2026-10-15", "value": 22 } ], "previous_items": [ { "date": "2026-10-12", "value": 18 }, { "date": "2026-10-13", "value": 15 } ] } } } } } } } }, "400": { "description": "Rango de fechas o alcance no válido. El cuerpo es un objeto cuyas claves son los parámetros erróneos, con un mensaje de texto.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Bad date format": { "value": { "start_date": "Invalid date format. Use YYYY-MM-DD (e.g., 2024-01-15)." } }, "Start after end": { "value": { "start_date": "Start date must be before or equal to end date." } }, "Range too long": { "value": { "date_range": "Date range cannot exceed 730 days (2 years)." } }, "Unknown scope": { "value": { "scope": "Unsupported analytics scope." } } } } } }, "401": { "description": "La clave de API ha expirado. Solo puede expirar una clave creada con fecha de caducidad; a partir de esa fecha, toda solicitud que la use responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Lee `detail`: falta la clave de API (una clave incorrecta, revocada o expirada recibe `401`), la clave es de otra aplicación, es cualquier clave con alcance limitado, o la solicitud llega desde fuera de la lista de IP de la clave.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid key": { "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Another application": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key": { "value": { "detail": "This API key has no access to this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Más de 600 solicitudes GET por minuto con esta clave de API. Espera el número de segundos indicado en `Retry-After` y vuelve a intentarlo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos hasta que se reinicia la ventana actual de un minuto.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas por minuto en este presupuesto.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Tiempo Unix en que se restablece la ventana.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/analytics/today/": { "get": { "summary": "Obtener las verificaciones de hoy por hora", "operationId": "get_application_analytics_today", "x-didit-sdk": { "resource": "analytics", "method": "retrieve_today", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Analytics" ], "description": "Sesiones de verificación de usuarios (KYC) de hoy, desde la medianoche local en `tz`, contadas por la hora local en la que se crearon, junto a las mismas horas del mismo día de la semana una semana antes, y desglosadas según el resultado que tiene cada una ahora: aprobada, en revisión o rechazada. Es la tarjeta de volumen de la página de inicio de Business Console.\n\n`total` es lo que va de hoy. `previous_total_so_far` cuenta el día de comparación solo hasta la misma hora local, de modo que una variación entre ambos compara la misma parte de los dos días. Las horas que aún quedan hoy valen `0`. Un día en que cambia la hora tiene 23 o 25 horas: la hora que falta se queda en `0` y la hora repetida contiene ambas.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación. Debe ser la aplicación a la que pertenece la clave de API: una clave usada en cualquier otra aplicación recibe `403`.", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "default": "UTC", "example": "Europe/Madrid" }, "description": "Zona horaria IANA cuya medianoche marca el inicio de hoy, por ejemplo `Europe/Madrid` o `America/Mexico_City`. Omítela para usar UTC." } ], "responses": { "200": { "description": "Verificaciones de hoy por hora local, las del día de comparación y los resultados de hoy.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationAnalyticsToday" }, "examples": { "Madrid, 14:00": { "value": { "time_zone": "Europe/Madrid", "date": "2026-10-30", "current_hour": 14, "previous_date": "2026-10-23", "hours": [ 3, 1, 0, 0, 1, 2, 4, 9, 14, 18, 21, 19, 22, 24, 27, 0, 0, 0, 0, 0, 0, 0, 0, 0 ], "previous_hours": [ 2, 1, 1, 0, 1, 3, 5, 8, 12, 16, 19, 18, 20, 22, 24, 26, 23, 19, 15, 12, 9, 7, 5, 3 ], "total": 165, "previous_total_so_far": 151, "outcomes": { "approved": 139, "in_review": 6, "declined": 18 } } } } } } }, "400": { "description": "Zona horaria desconocida. El cuerpo está indexado por el parámetro, con una lista de mensajes.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "examples": { "Unknown time zone": { "value": { "tz": [ "Unknown time zone: Europe/Atlantis." ] } } } } } }, "401": { "description": "La clave de API ha expirado. Solo puede expirar una clave creada con fecha de caducidad; a partir de esa fecha, toda solicitud que la use responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Lee `detail`: falta la clave de API o no es válida (nunca `401`), la clave es de otra aplicación, es cualquier clave con alcance limitado, o la solicitud llega desde fuera de la lista de IP de la clave.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid key": { "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Another application": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key": { "value": { "detail": "This API key has no access to this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Más de 600 solicitudes GET por minuto con esta clave de API. Espera el número de segundos indicado en `Retry-After` y vuelve a intentarlo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos hasta que se reinicia la ventana actual de un minuto.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas por minuto en este presupuesto.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Tiempo Unix en que se restablece la ventana.", "schema": { "type": "integer" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/analytics/today/?tz=Europe%2FMadrid' \\\n -H 'x-api-key: YOUR_API_KEY'" } ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/webhooks/": { "get": { "summary": "Listar las entregas de webhook de la sesión", "description": "Lista todas las entregas de webhook que Didit registró para una sesión de verificación, un usuario (KYC) o una empresa (KYB), de la más reciente a la más antigua, como un array JSON simple (sin paginar). Cada entrada es un intento a un destino: el primer envío, cada [reintento](https://docs.didit.me/es/integration/webhooks#política-de-reintentos) automático y cada reenvío son entradas independientes con su propio `uuid`, y los reintentos y reenvíos conservan el `event_id` del payload. `request_header` y `request_body` son texto JSON; analízalos para leer las firmas y el payload. Los registros de entrega están disponibles durante unos 30 días, por lo que un array vacío significa que todavía no se ha enviado ningún webhook para la sesión o que todas las entregas son anteriores a ese plazo. Una clave de API con alcance limitado necesita `sessions: read` y `decisions: read`.", "operationId": "get_v3_session_webhooks", "x-didit-sdk": { "resource": "sessions.webhooks", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de verificación, de usuario (KYC) o de empresa (KYB): el `session_id` que devuelve `POST /v3/session/`. El servidor lo resuelve en ambos tipos de sesión.\n\n**Debe ser un UUID válido.** La ruta solo coincide con UUID bien formados, por lo que el enrutador de URL rechaza un valor mal formado antes de que se ejecute el código de la aplicación, y la respuesta es una página **HTML** `404` en lugar del envoltorio JSON `{\"detail\": ...}` que se muestra a continuación.", "schema": { "type": "string", "format": "uuid" }, "example": "22222222-3333-4444-5555-666666666666" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/session/22222222-3333-4444-5555-666666666666/webhooks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.webhooks.list(\n \"22222222-3333-4444-5555-666666666666\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.webhooks.list(\"22222222-3333-4444-5555-666666666666\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Webhooks.List(ctx, \"22222222-3333-4444-5555-666666666666\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().webhooks().list(\"22222222-3333-4444-5555-666666666666\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->webhooks->list('22222222-3333-4444-5555-666666666666');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.webhooks.list(\"22222222-3333-4444-5555-666666666666\").each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Webhooks.ListAsync(\"22222222-3333-4444-5555-666666666666\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Todas las entregas registradas para la sesión, de la más reciente a la más antigua.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionWebhookDelivery" } }, "examples": { "Failed delivery and its successful retry": { "value": [ { "uuid": "66666666-7777-8888-9999-000000000002", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 200, "status": "In Progress", "webhook_type": "status.updated", "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"9188851d160b5b3aacfc946e4dde1f061b7e568662518942c927ddaf507f533d\", \"X-Signature-V2\": \"381236af514d3fb538579365ac5a24f2464ce1b8224c6e770c60d8201c43ecc5\", \"X-Signature-Simple\": \"4740131dc38f29e78a8508371979be74967d5307464494bd3148a03b4d6c8716\", \"X-Timestamp\": \"1792056139\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}", "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792056139,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}", "created_at": "2026-10-15T09:22:19.104233Z" }, { "uuid": "66666666-7777-8888-9999-000000000001", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 503, "status": "In Progress", "webhook_type": "status.updated", "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"a5e02a03404e1337a0198e6be15d34abbd053c658a0e51e5d0e78554213ef29b\", \"X-Signature-V2\": \"927e7cb770c94ce745939bff73f04aa200015f3bc64795ba46c2aaf78a6cedc5\", \"X-Signature-Simple\": \"e37b0d4c716c72bb5ae7127b9cc455d28ab4686e9e22312b4ec2327409a73302\", \"X-Timestamp\": \"1792056078\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}", "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792056078,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}", "created_at": "2026-10-15T09:21:18.412345Z" } ] }, "No webhook sent yet": { "value": [] } } } } }, "401": { "description": "La clave de API ha expirado: se creó con una fecha de caducidad que ya pasó. Una clave incorrecta o revocada también recibe `401`; si falta la clave, se recibe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Si no se envía `x-api-key`, o la clave no es válida o está revocada, se recibe `Authentication credentials were not provided or are invalid.` Una clave de otra aplicación recibe `You do not have permission to perform this action.` Una clave con alcance limitado que no tiene el acceso que necesita este endpoint recibe un mensaje que indica el acceso que falta, y una clave usada desde fuera de su lista de IP permitidas recibe `This API key can't be used from this IP address.` Un `sessionId` desconocido devuelve `404` antes de que se compruebe la credencial.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Key of another application": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without sessions read": { "value": { "detail": "This API key has no read access to sessions." } }, "Scoped key without decisions read": { "value": { "detail": "This API key has no read access to decisions." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión no existe o se ha eliminado (`Not found.`, que se devuelve antes de comprobar la credencial), o está fuera de los límites de flujo o de estado de una clave con alcance restringido (`Session not found.`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Unknown session": { "value": { "detail": "Not found." } }, "Outside the key's limits": { "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Límite de solicitudes superado: más de 600 solicitudes GET en la ventana actual de un minuto para esta clave de API. Espera `Retry-After` segundos antes de reintentar.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas en la ventana de un minuto (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Tiempo Unix (segundos) en que se restablece la ventana actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nombre del presupuesto que se superó.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/webhook/{webhook_uuid}": { "get": { "summary": "Obtener una entrega de webhook de una sesión", "description": "Obtén una entrega de webhook de una sesión de verificación: la URL a la que se envió, el código de estado HTTP que devolvió tu endpoint y los encabezados exactos y el cuerpo JSON que envió Didit. `request_header` y `request_body` son texto JSON; para comprobar tu [verificación de firma](https://docs.didit.me/es/integration/webhooks#verificación-de-firma), vuelve a calcular `X-Signature-V2` a partir del cuerpo analizado con el secreto del destino al que se envió (o con el secreto a nivel de aplicación en el caso de una entrega a la URL de webhook heredada). La ruta no termina en barra: si la incluyes, devuelve `404`. Una clave de API con alcance limitado necesita `sessions: read` y `decisions: read`.", "operationId": "get_v3_session_webhook", "x-didit-sdk": { "resource": "sessions.webhooks", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de verificación, de usuario (KYC) o de empresa (KYB): el `session_id` que devuelve `POST /v3/session/`. El servidor lo resuelve en ambos tipos de sesión.\n\n**Debe ser un UUID válido.** La ruta solo coincide con UUID bien formados, por lo que el enrutador de URL rechaza un valor mal formado antes de que se ejecute el código de la aplicación, y la respuesta es una página **HTML** `404` en lugar del envoltorio JSON `{\"detail\": ...}` que se muestra a continuación.", "schema": { "type": "string", "format": "uuid" }, "example": "22222222-3333-4444-5555-666666666666" }, { "name": "webhook_uuid", "in": "path", "required": true, "description": "UUID de la entrega: el `uuid` de una entrada devuelta por `GET /v3/session/{sessionId}/webhooks/`. Debe pertenecer a la sesión indicada en la ruta.", "schema": { "type": "string", "format": "uuid" }, "example": "66666666-7777-8888-9999-000000000001" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/session/22222222-3333-4444-5555-666666666666/webhook/66666666-7777-8888-9999-000000000001' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.webhooks.retrieve(\n \"22222222-3333-4444-5555-666666666666\",\n \"66666666-7777-8888-9999-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.webhooks.retrieve(\n \"22222222-3333-4444-5555-666666666666\",\n \"66666666-7777-8888-9999-000000000001\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Webhooks.Retrieve(ctx, \"22222222-3333-4444-5555-666666666666\", \"66666666-7777-8888-9999-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().webhooks().retrieve(\"22222222-3333-4444-5555-666666666666\", \"66666666-7777-8888-9999-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->webhooks->retrieve('22222222-3333-4444-5555-666666666666', '66666666-7777-8888-9999-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.webhooks.retrieve(\n \"22222222-3333-4444-5555-666666666666\",\n \"66666666-7777-8888-9999-000000000001\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Webhooks.RetrieveAsync(\"22222222-3333-4444-5555-666666666666\", \"66666666-7777-8888-9999-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La entrega, con los encabezados y el cuerpo de su solicitud.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionWebhookDelivery" }, "examples": { "Connection failure": { "value": { "uuid": "66666666-7777-8888-9999-000000000001", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 503, "status": "In Progress", "webhook_type": "status.updated", "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"a5e02a03404e1337a0198e6be15d34abbd053c658a0e51e5d0e78554213ef29b\", \"X-Signature-V2\": \"927e7cb770c94ce745939bff73f04aa200015f3bc64795ba46c2aaf78a6cedc5\", \"X-Signature-Simple\": \"e37b0d4c716c72bb5ae7127b9cc455d28ab4686e9e22312b4ec2327409a73302\", \"X-Timestamp\": \"1792056078\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}", "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792056078,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}", "created_at": "2026-10-15T09:21:18.412345Z" } } } } } }, "401": { "description": "La clave de API ha expirado: se creó con una fecha de caducidad que ya pasó. Una clave incorrecta o revocada también recibe `401`; si falta la clave, se recibe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Si no se envía `x-api-key`, o la clave no es válida o está revocada, se recibe `Authentication credentials were not provided or are invalid.` Una clave de otra aplicación recibe `You do not have permission to perform this action.` Una clave con alcance limitado que no tiene el acceso que necesita este endpoint recibe un mensaje que indica el acceso que falta, y una clave usada desde fuera de su lista de IP permitidas recibe `This API key can't be used from this IP address.` Un `sessionId` desconocido devuelve `404` antes de que se compruebe la credencial.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Key of another application": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without sessions read": { "value": { "detail": "This API key has no read access to sessions." } }, "Scoped key without decisions read": { "value": { "detail": "This API key has no read access to decisions." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión no existe o se ha eliminado (`Not found.`, que se devuelve antes de comprobar la credencial), o está fuera de los límites de flujo o de estado de una clave con alcance restringido (`Session not found.`). Una entrega que no existe, pertenece a otra sesión o ya no está disponible devuelve `No WebhookLog matches the given query.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Unknown session": { "value": { "detail": "Not found." } }, "Outside the key's limits": { "value": { "detail": "Session not found." } }, "Delivery not in this session": { "value": { "detail": "No WebhookLog matches the given query." } } } } } }, "429": { "description": "Límite de solicitudes superado: más de 600 solicitudes GET en la ventana actual de un minuto para esta clave de API. Espera `Retry-After` segundos antes de reintentar.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas en la ventana de un minuto (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Tiempo Unix (segundos) en que se restablece la ventana actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nombre del presupuesto que se superó.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/webhook/{webhook_uuid}/resend": { "post": { "summary": "Reenviar la entrega del webhook de la sesión", "description": "Vuelve a enviar un webhook de sesión registrado a la URL a la que se envió originalmente, con el mismo payload y `event_id`, y con un `timestamp`, un encabezado `X-Timestamp` y unas firmas nuevos. Didit lo firma con el secreto actual del destino al que pertenece la entrega (o con el secreto a nivel de aplicación si la entrega fue a la URL de webhook heredada), espera hasta 5 segundos a tu endpoint, registra el intento como una nueva entrega y la devuelve con `200` sea cual sea la respuesta de tu endpoint: consulta `response_status`. Un reenvío no se reintenta automáticamente y cada llamada vuelve a enviar, así que haz que tu endpoint sea idempotente respecto a `event_id`. La ruta no lleva barra final y la solicitud no tiene cuerpo. Una clave de API con alcance limitado necesita `webhooks: write` y `decisions: read`.", "operationId": "post_v3_session_webhook_resend", "x-didit-sdk": { "resource": "sessions.webhooks", "method": "resend", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de verificación, de usuario (KYC) o de empresa (KYB): el `session_id` que devuelve `POST /v3/session/`. El servidor lo resuelve en ambos tipos de sesión.\n\n**Debe ser un UUID válido.** La ruta solo coincide con UUID bien formados, por lo que el enrutador de URL rechaza un valor mal formado antes de que se ejecute el código de la aplicación, y la respuesta es una página **HTML** `404` en lugar del envoltorio JSON `{\"detail\": ...}` que se muestra a continuación.", "schema": { "type": "string", "format": "uuid" }, "example": "22222222-3333-4444-5555-666666666666" }, { "name": "webhook_uuid", "in": "path", "required": true, "description": "UUID de la entrega que se va a reenviar: el `uuid` de una entrada devuelta por `GET /v3/session/{sessionId}/webhooks/`. Debe pertenecer a la sesión indicada en la ruta.", "schema": { "type": "string", "format": "uuid" }, "example": "66666666-7777-8888-9999-000000000001" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/session/22222222-3333-4444-5555-666666666666/webhook/66666666-7777-8888-9999-000000000001/resend' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.webhooks.resend(\n \"22222222-3333-4444-5555-666666666666\",\n \"66666666-7777-8888-9999-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.webhooks.resend(\n \"22222222-3333-4444-5555-666666666666\",\n \"66666666-7777-8888-9999-000000000001\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Webhooks.Resend(ctx, \"22222222-3333-4444-5555-666666666666\", \"66666666-7777-8888-9999-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().webhooks().resend(\"22222222-3333-4444-5555-666666666666\", \"66666666-7777-8888-9999-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->webhooks->resend('22222222-3333-4444-5555-666666666666', '66666666-7777-8888-9999-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.webhooks.resend(\n \"22222222-3333-4444-5555-666666666666\",\n \"66666666-7777-8888-9999-000000000001\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Webhooks.ResendAsync(\"22222222-3333-4444-5555-666666666666\", \"66666666-7777-8888-9999-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La nueva entrega, ya intentada. `response_status` es lo que respondió tu endpoint esta vez. La entrega original no cambia.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionWebhookDelivery" }, "examples": { "Accepted on resend": { "value": { "uuid": "66666666-7777-8888-9999-000000000004", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 200, "status": "In Progress", "webhook_type": "status.updated", "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"b8eb1e376517ee0cad8ba98ff7f8fd35fc72eca231000963a96a335f82328835\", \"X-Signature-V2\": \"9efd2ce9ed1303e1d05273ef9608a59363ed9789a05253db4748b3e8e50cb109\", \"X-Signature-Simple\": \"bf3a9dc04b2c20ab539203b0cd5cca2a10f630bf62d8feb6d68d82af80f64774\", \"X-Timestamp\": \"1792159542\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}", "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792159542,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}", "created_at": "2026-10-16T14:05:42.330981Z" } } } } } }, "400": { "description": "No se pudo reenviar la entrega. Actúa según el valor de `code`: `webhook_url_missing` significa que la entrega no tiene ninguna URL registrada y no se envía nada; `webhook_resend_error` significa que la entrega almacenada no pudo volver a firmarse o que el intento no pudo completarse. Después de `webhook_resend_error`, `detail` empieza con `Error processing webhook resend:` seguido de un texto de diagnóstico que puede cambiar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." }, "code": { "type": "string", "description": "Código de error estable legible por máquina. Usa este valor para bifurcar la lógica, no `detail`." } } }, "examples": { "No recorded URL": { "value": { "detail": "The webhook delivery does not have a request URL configured", "code": "webhook_url_missing" } }, "Resend failed": { "value": { "detail": "Error processing webhook resend: Invalid webhook data format", "code": "webhook_resend_error" } } } } } }, "401": { "description": "La clave de API ha expirado: se creó con una fecha de caducidad que ya pasó. Una clave incorrecta o revocada también recibe `401`; si falta la clave, se recibe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La solicitud no está permitida. Si no se envía `x-api-key`, o la clave no es válida o está revocada, se recibe `Authentication credentials were not provided or are invalid.` Una clave de otra aplicación recibe `You do not have permission to perform this action.` Una clave con alcance limitado que no tiene el acceso que necesita este endpoint recibe un mensaje que indica el acceso que falta, y una clave usada desde fuera de su lista de IP permitidas recibe `This API key can't be used from this IP address.` Un `sessionId` desconocido devuelve `404` antes de que se compruebe la credencial.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Key of another application": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without webhooks write": { "value": { "detail": "This API key has no write access to webhooks." } }, "Scoped key without decisions read": { "value": { "detail": "This API key has no read access to decisions." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión no existe o se ha eliminado (`Not found.`, que se devuelve antes de comprobar la credencial), o está fuera de los límites de flujo o de estado de una clave con alcance restringido (`Session not found.`). Una entrega que no existe, pertenece a otra sesión o ya no está disponible devuelve `Webhook log not found`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Unknown session": { "value": { "detail": "Not found." } }, "Outside the key's limits": { "value": { "detail": "Session not found." } }, "Delivery not in this session": { "value": { "detail": "Webhook log not found" } } } } } }, "429": { "description": "Límite de solicitudes superado: más de 300 solicitudes de escritura (POST, PATCH, PUT, DELETE) en la ventana actual de un minuto para esta clave de API. Espera `Retry-After` segundos antes de reintentar.", "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Solicitudes permitidas en la ventana de un minuto (300).", "schema": { "type": "integer", "example": 300 } }, "X-RateLimit-Remaining": { "description": "Solicitudes restantes en la ventana actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Tiempo Unix (segundos) en que se restablece la ventana actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nombre del presupuesto que se superó.", "schema": { "type": "string", "example": "generic-write" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/events/": { "get": { "summary": "Listar los eventos de la sesión", "description": "Lee la cronología de eventos de una sesión de verificación, de más reciente a más antiguo según `sent_at`: las pantallas que vio el usuario, los botones y las subidas de archivos, los intentos fallidos, los cambios de estado y de paso de función, y la traza de enrutamiento del flujo. Funciona con IDs de sesión de Verificación de usuarios (KYC) y de Verificación de empresas (KYB). Los eventos se almacenan de forma asíncrona, por lo que un evento nuevo puede tardar unos segundos en aparecer. Los resultados se paginan con `limit` y `offset`; sigue `next` hasta que sea `null`. Una clave de API con alcance limitado necesita `sessions: read` y `decisions: read`, y sin `media: read` recibe `file_url` como `null`. Los eventos de enrutamiento se describen en [Obtener sesión](https://docs.didit.me/es/sessions-api/retrieve-session).", "operationId": "get_v3_session_events", "x-didit-sdk": { "resource": "sessions", "method": "list_events", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de verificación (el `session_id` que devuelve `POST /v3/session/`). Acepta ID de sesión tanto de Verificación de usuarios (KYC) como de Verificación de empresas (KYB): el servidor resuelve el ID en ambos tipos de sesión. Debe ser un UUID con formato válido; un valor mal formado no coincide con la ruta y devuelve un `404` en HTML.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "limit", "in": "query", "required": false, "description": "Número máximo de eventos por página. El valor predeterminado es 50. Un valor inferior a 1 o no numérico se sustituye por 50; un valor superior a 1,000,000 devuelve `400`.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000, "example": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Número de resultados que se omiten antes del primero devuelto. El valor predeterminado es 0; un valor negativo o no numérico se sustituye por 0, y un valor superior a 1,000,000 devuelve `400`. Es preferible seguir las URL `next` y `previous`.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000, "example": 0 } }, { "name": "ordering", "in": "query", "required": false, "description": "Ordenación opcional personalizada. El orden predeterminado es `-sent_at`. Pasa el nombre de un campo del resultado (por ejemplo `sent_at`, `created_at`, `event_type`, `feature_step` o `step`) para ordenar de forma ascendente, antepón `-` para ordenar de forma descendente y separa varios campos con comas. Los campos desconocidos se ignoran.", "schema": { "type": "string", "example": "sent_at" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/events/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.sessions.list_events(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.sessions.listEvents(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.ListEventsAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsListEventsParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.sessions().listEvents(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "sessions->listEvents('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.list_events(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Sessions.ListEventsAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Una página de los eventos de la sesión, del más reciente al más antiguo.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Número total de eventos de la sesión." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la página siguiente, o `null` en la última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la página anterior, o `null` en la primera página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SessionEvent" } } } }, "examples": { "Completed session": { "value": { "count": 3, "next": null, "previous": null, "results": [ { "uuid": "aaaaaaaa-1111-2222-3333-444444444444", "event_type": "SESSION_STATUS_CHANGED", "created_at": "2026-09-14T10:02:13.904512Z", "component": null, "feature_step": null, "step": null, "details": { "old_status": "In Progress", "current_status": "Approved" }, "ip_address": null, "user_agent": null, "device_info": null, "file_url": null, "sent_at": 1789380131482 }, { "uuid": "bbbbbbbb-1111-2222-3333-444444444444", "event_type": "FEATURE_STEP_CHANGED", "created_at": "2026-09-14T10:01:49.210377Z", "component": null, "feature_step": null, "step": null, "details": { "old_feature_step": "OCR", "current_feature_step": "LIVENESS" }, "ip_address": null, "user_agent": null, "device_info": null, "file_url": null, "sent_at": 1789380107103 }, { "uuid": "cccccccc-1111-2222-3333-444444444444", "event_type": "STEP_RENDERED", "created_at": "2026-09-14T10:01:00.581930Z", "component": "DocumentCapture", "feature_step": "OCR", "step": "DOCUMENT_CAPTURE_FRONT", "details": {}, "ip_address": "203.0.113.24", "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.5 Mobile/15E148 Safari/604.1", "device_info": { "device_model": "iPhone" }, "file_url": null, "sent_at": 1789380058776 } ] } } } } } }, "400": { "description": "`limit` u `offset` supera 1,000,000. El cuerpo es un array JSON con un mensaje.", "content": { "application/json": { "examples": { "Limit too large": { "summary": "limit=2000000", "value": [ "limit must not exceed 1000000." ] }, "Offset too large": { "summary": "offset=2000000", "value": [ "offset must not exceed 1000000." ] } }, "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Este es el único caso que devuelve `401`: una clave ausente, no válida o revocada devuelve `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "summary": "La fecha de caducidad de la clave ya pasó", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallo de autenticación o autorización. Si falta la clave, se devuelve `403`, al igual que con una clave de otra aplicación, una clave con alcance limitado sin el permiso que necesita este endpoint y una solicitud desde fuera de la lista de IP permitidas de la clave; una clave incorrecta, revocada o expirada devuelve `401`. Distínguelos por `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la validación", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clave válida que pertenece a una aplicación distinta de la de la sesión", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without sessions read": { "summary": "A la clave con alcance limitado le falta sessions: read", "value": { "detail": "This API key has no read access to sessions." } }, "Scoped key without decisions read": { "summary": "A la clave con alcance limitado le falta decisions: read", "value": { "detail": "This API key has no read access to decisions." } }, "IP not allowed": { "summary": "Solicitud desde fuera de la lista de IP permitidas de la clave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión no existe, se ha eliminado o está fuera de los límites de flujo o de solo aprobadas de una clave con alcance restringido. La búsqueda de la sesión se ejecuta antes de comprobar la credencial, por lo que un `sessionId` desconocido devuelve `404` incluso sin una clave válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Unknown session": { "summary": "No existe ninguna sesión con este ID, o se eliminó", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "La sesión está fuera de los límites de flujo o de solo aprobadas de una clave con alcance restringido", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Límite de solicitudes superado: 600 solicitudes GET por minuto por clave de API. Espera los segundos indicados en `Retry-After` antes de reintentar; los encabezados `X-RateLimit-*` muestran el presupuesto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Rate limited": { "summary": "Presupuesto del minuto actual agotado", "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/aml-screening-history/": { "get": { "summary": "Listar el historial de análisis AML", "description": "Lista todos los re-análisis completados de la monitorización continua del control AML de una sesión, del más reciente al más antiguo según `completed_at`, incluidas las ejecuciones en las que no cambió nada: las alertas, las entradas de actividad y los webhooks solo se disparan cuando cambia un resultado, por lo que este historial es la prueba de que se seguía analizando a un sujeto sin coincidencias. Funciona con IDs de sesión KYC y KYB; pasa `node_id` cuando la sesión ejecutó más de un paso AML. Solo se listan los re-análisis de monitorización continua (el primer análisis forma parte de la decisión de la sesión) y las ejecuciones anteriores a la existencia de este historial no se reconstruyen, por lo que una sesión sin monitorización continua devuelve una lista vacía. `count` es exacto hasta 100 y se limita a 100 por encima de esa cifra, así que sigue `next` hasta que sea `null`. Pasa `month` para leer un mes natural cada vez. Una clave de API con alcance limitado necesita `decisions: read`; consulta [Monitorización AML continua](https://docs.didit.me/es/core-technology/aml-screening/continuous-monitoring-aml-screening).", "operationId": "get_v3_session_aml_screening_history", "x-didit-sdk": { "resource": "sessions", "method": "list_aml_screening_history", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de verificación (el `session_id` que devuelve `POST /v3/session/`). Acepta ID de sesión tanto de Verificación de usuarios (KYC) como de Verificación de empresas (KYB): el servidor resuelve el ID en ambos tipos de sesión. Debe ser un UUID con formato válido; un valor mal formado no coincide con la ruta y devuelve un `404` en HTML.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "ID del nodo del grafo del flujo correspondiente al análisis AML. Solo es necesario cuando la sesión ejecutó más de un paso AML; sin él, se usa el análisis AML más reciente. Un nodo desconocido devuelve `404`.", "schema": { "type": "string", "example": "feature_aml_1" } }, { "name": "month", "in": "query", "required": false, "description": "Un mes natural en UTC con el formato `YYYY-MM`. Solo se devuelven los análisis completados en ese mes; sin él, se devuelven todos los meses. Un mes con formato incorrecto devuelve `400`.", "schema": { "type": "string", "pattern": "^\\d{4}-(0[1-9]|1[0-2])$", "example": "2026-09" } }, { "name": "limit", "in": "query", "required": false, "description": "Número máximo de análisis por página. El valor predeterminado es 50. Un valor inferior a 1 o no numérico se sustituye por 50; un valor superior a 1,000,000 devuelve `400`.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000, "example": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Número de resultados que se omiten antes del primero devuelto. El valor predeterminado es 0; un valor negativo o no numérico se sustituye por 0, y un valor superior a 1,000,000 devuelve `400`. Es preferible seguir las URL `next` y `previous`.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000, "example": 0 } }, { "name": "ordering", "in": "query", "required": false, "description": "Ordenación opcional personalizada. El orden predeterminado es `-completed_at`. Pasa el nombre de un campo del resultado (por ejemplo `completed_at`, `started_at`, `outcome` o `score`) para ordenar de forma ascendente, antepón `-` para ordenar de forma descendente y separa varios campos con comas. Los campos desconocidos se ignoran.", "schema": { "type": "string", "example": "completed_at" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/aml-screening-history/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.sessions.list_aml_screening_history(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.sessions.listAmlScreeningHistory(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.ListAMLScreeningHistoryAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsListAMLScreeningHistoryParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.sessions().listAmlScreeningHistory(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "sessions->listAmlScreeningHistory('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.list_aml_screening_history(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Sessions.ListAmlScreeningHistoryAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Una página de ejecuciones de análisis, de la más reciente a la más antigua.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "maximum": 100, "description": "Número de ejecuciones, exacto hasta 100 y limitado a 100 por encima de esa cifra." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la página siguiente, o `null` en la última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la página anterior, o `null` en la primera página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AMLScreeningRun" } } } }, "examples": { "Monitored subject": { "value": { "count": 2, "next": null, "previous": null, "results": [ { "uuid": "dddddddd-1111-2222-3333-444444444444", "run_id": "aaaaaaaa-1111-2222-3333-444444444444", "completed_at": "2026-09-14T04:12:33.481207Z", "started_at": "2026-09-14T04:00:01.002311Z", "outcome": "NO_CHANGE", "trigger": "ONGOING_MONITORING", "provider": "aml_data_source", "status": "Approved", "score": 0.0, "total_hits": 0, "new_hits": 0, "entities_screened": 1, "dataset_freshness": { "captured_at": "2026-09-14T03:58:02.114820+00:00", "provider": "aml_data_source", "catalog_version": "2026-09-13", "sources": { "sanctions": { "last_updated_at": "2026-09-13T21:10:00+00:00", "oldest_updated_at": "2026-09-11T06:00:00+00:00", "dataset_count": 120, "dated_dataset_count": 120 }, "pep": { "last_updated_at": "2026-09-13T08:00:00+00:00", "oldest_updated_at": null, "dataset_count": 45, "dated_dataset_count": 44 }, "warnings": { "last_updated_at": "2026-09-12T18:45:00+00:00", "oldest_updated_at": "2026-09-01T00:00:00+00:00", "dataset_count": 30, "dated_dataset_count": 30 } } } }, { "uuid": "eeeeeeee-1111-2222-3333-444444444444", "run_id": "bbbbbbbb-1111-2222-3333-444444444444", "completed_at": "2026-09-13T04:11:58.020914Z", "started_at": "2026-09-13T04:00:00.871022Z", "outcome": "FAILED", "trigger": "ONGOING_MONITORING", "provider": "aml_data_source", "status": "Approved", "score": 0.0, "total_hits": 0, "new_hits": null, "entities_screened": 0, "dataset_freshness": null } ] } } } } } }, "400": { "description": "`limit` u `offset` supera 1,000,000 (un array JSON con un mensaje), o `month` no es un mes natural `YYYY-MM` (un objeto con la clave `month`).", "content": { "application/json": { "examples": { "Limit too large": { "summary": "limit=2000000", "value": [ "limit must not exceed 1000000." ] }, "Offset too large": { "summary": "offset=2000000", "value": [ "offset must not exceed 1000000." ] }, "Malformed month": { "summary": "month=2026-13", "value": { "month": [ "Not a calendar month. Use YYYY-MM." ] } } }, "schema": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "object", "properties": { "month": { "type": "array", "items": { "type": "string" } } } } ] } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Este es el único caso que devuelve `401`: una clave ausente, no válida o revocada devuelve `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "summary": "La fecha de caducidad de la clave ya pasó", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallo de autenticación o autorización. Si falta la clave, se devuelve `403`, al igual que con una clave de otra aplicación, una clave con alcance limitado sin el permiso que necesita este endpoint y una solicitud desde fuera de la lista de IP permitidas de la clave; una clave incorrecta, revocada o expirada devuelve `401`. Distínguelos por `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la validación", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clave válida que pertenece a una aplicación distinta de la de la sesión", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions read": { "summary": "A la clave con alcance limitado le falta decisions: read", "value": { "detail": "This API key has no read access to decisions." } }, "IP not allowed": { "summary": "Solicitud desde fuera de la lista de IP permitidas de la clave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión no existe, se ha eliminado o está fuera de los límites de una clave con alcance restringido, o no tiene ninguna comprobación AML (para el `node_id` indicado). La búsqueda de la sesión se ejecuta antes de comprobar la credencial, por lo que un `sessionId` desconocido devuelve `404` incluso sin una clave válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Unknown session": { "summary": "No existe ninguna sesión con este ID, o se eliminó", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "La sesión está fuera de los límites de una clave con alcance restringido (también se devuelve para una sesión eliminada hace unos instantes)", "value": { "detail": "Session not found." } }, "No AML check": { "summary": "La sesión nunca ejecutó un paso AML", "value": { "detail": "The session does not have an AML check." } }, "No AML check for node": { "summary": "node_id no corresponde a ninguna comprobación AML de la sesión", "value": { "detail": "The session does not have an AML check for node 'feature_aml_2'." } } } } } }, "429": { "description": "Límite de solicitudes superado: 600 solicitudes GET por minuto por clave de API. Espera los segundos indicados en `Retry-After` antes de reintentar; los encabezados `X-RateLimit-*` muestran el presupuesto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Rate limited": { "summary": "Presupuesto del minuto actual agotado", "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/aml-screening-history/export/": { "get": { "summary": "Exportar el historial de análisis AML como CSV", "description": "Descarga el mismo historial de monitorización continua que `GET /v3/session/{sessionId}/aml-screening-history/` como archivo CSV, con una línea por cada nuevo análisis completado, del más reciente al más antiguo, listo para entregar a un auditor. El archivo se transmite completo (sin paginación) y empieza con una línea de encabezado; una celda vacía significa desconocido, las fechas de los conjuntos de datos nunca se estiman y a cualquier valor que empezaría una fórmula de hoja de cálculo se le antepone un apóstrofo. Funciona con IDs de sesiones KYC y KYB; pasa `node_id` cuando la sesión ejecutó más de un paso AML. Pasa `month` para exportar un mes natural. Los errores se devuelven en JSON, no en CSV. Una clave de API con alcance necesita `decisions: read` y `media: read`: la respuesta es un archivo, así que una clave sin `media: read` recibe `403`.", "operationId": "get_v3_session_aml_screening_history_export", "x-didit-sdk": { "resource": "sessions", "method": "export_aml_screening_history", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de verificación (el `session_id` que devuelve `POST /v3/session/`). Acepta ID de sesión tanto de Verificación de usuarios (KYC) como de Verificación de empresas (KYB): el servidor resuelve el ID en ambos tipos de sesión. Debe ser un UUID con formato válido; un valor mal formado no coincide con la ruta y devuelve un `404` en HTML.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "ID del nodo del grafo del flujo correspondiente al análisis AML. Solo es necesario cuando la sesión ejecutó más de un paso AML; sin él, se usa el análisis AML más reciente. Un nodo desconocido devuelve `404`.", "schema": { "type": "string", "example": "feature_aml_1" } }, { "name": "month", "in": "query", "required": false, "description": "Un mes natural en UTC con el formato `YYYY-MM`. Solo se devuelven los análisis completados en ese mes; sin él, se devuelven todos los meses. Un mes con formato incorrecto devuelve `400`.", "schema": { "type": "string", "pattern": "^\\d{4}-(0[1-9]|1[0-2])$", "example": "2026-09" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/aml-screening-history/export/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -o aml-screening-history.csv" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.sessions.export_aml_screening_history(\n \"11111111-2222-3333-4444-555555555555\",\n)\nwith open(\"download.csv\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.sessions.exportAmlScreeningHistory(\"11111111-2222-3333-4444-555555555555\");\nawait writeFile(\"download.csv\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Sessions.ExportAMLScreeningHistory(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsExportAMLScreeningHistoryParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.csv\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.sessions().exportAmlScreeningHistory(\"11111111-2222-3333-4444-555555555555\")\n .writeTo(Path.of(\"download.csv\"));" }, { "lang": "php", "label": "PHP", "source": "sessions->exportAmlScreeningHistory('11111111-2222-3333-4444-555555555555');\n$content->saveTo('download.csv');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.sessions.export_aml_screening_history(\"11111111-2222-3333-4444-555555555555\")\nFile.binwrite(\"download.csv\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Sessions.ExportAmlScreeningHistoryAsync(\"11111111-2222-3333-4444-555555555555\");\nawait content.SaveToAsync(\"download.csv\");" } ], "responses": { "200": { "description": "El archivo CSV, transmitido como `text/csv` con finales de línea CRLF. Columnas, en orden: `screened_at` (cuándo terminó el nuevo análisis), `outcome` (`NO_CHANGE`, `CHANGED` o `FAILED`), `provider` (identificador opaco de la fuente de datos AML; no bases tu lógica en él), `aml_status`, `aml_score`, `total_hits`, `datasets_captured_at`, `datasets_sanctions_last_updated_at`, `datasets_pep_last_updated_at`, `datasets_warnings_last_updated_at`, `datasets_adverse_media_last_updated_at`, `datasets_catalog_version`, `run_id` (la ejecución de monitorización), `entities_screened` (`1`, o `0` en una ejecución fallida) y `new_hits` (vacío cuando se desconoce). Las fechas están en ISO 8601 con desfase UTC. Una sesión que aún no tiene nuevos análisis devuelve solo la línea de encabezado.", "headers": { "Content-Disposition": { "description": "`attachment; filename=\"aml-screening-history-{sessionId}.csv\"`, o `aml-screening-history-{sessionId}-{month}.csv` cuando se pasa `month`.", "schema": { "type": "string", "example": "attachment; filename=\"aml-screening-history-11111111-2222-3333-4444-555555555555.csv\"" } } }, "content": { "text/csv": { "schema": { "type": "string", "format": "binary" }, "example": "screened_at,outcome,provider,aml_status,aml_score,total_hits,datasets_captured_at,datasets_sanctions_last_updated_at,datasets_pep_last_updated_at,datasets_warnings_last_updated_at,datasets_adverse_media_last_updated_at,datasets_catalog_version,run_id,entities_screened,new_hits\r\n2026-09-14T04:12:33.481207+00:00,NO_CHANGE,aml_data_source,Approved,0.0,0,2026-09-14T03:58:02.114820+00:00,2026-09-13T21:10:00+00:00,2026-09-13T08:00:00+00:00,2026-09-12T18:45:00+00:00,,2026-09-13,aaaaaaaa-1111-2222-3333-444444444444,1,0\r\n2026-09-13T04:11:58.020914+00:00,FAILED,aml_data_source,Approved,0.0,0,,,,,,,bbbbbbbb-1111-2222-3333-444444444444,0,\r\n" } } }, "400": { "description": "`month` no es un mes natural `YYYY-MM`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "month": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Malformed month": { "summary": "month=2026-13", "value": { "month": [ "Not a calendar month. Use YYYY-MM." ] } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Este es el único caso que devuelve `401`: una clave ausente, no válida o revocada devuelve `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "summary": "La fecha de caducidad de la clave ya pasó", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallo de autenticación o autorización. Si falta la clave, se devuelve `403`, al igual que con una clave de otra aplicación, una clave con alcance limitado sin el permiso que necesita este endpoint y una solicitud desde fuera de la lista de IP permitidas de la clave; una clave incorrecta, revocada o expirada devuelve `401`. Distínguelos por `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la validación", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clave válida que pertenece a una aplicación distinta de la de la sesión", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions read": { "summary": "A la clave con alcance limitado le falta decisions: read", "value": { "detail": "This API key has no read access to decisions." } }, "Scoped key without media read": { "summary": "A la clave con alcance limitado le falta media: read (la respuesta es un archivo)", "value": { "detail": "This API key has no read access to media." } }, "IP not allowed": { "summary": "Solicitud desde fuera de la lista de IP permitidas de la clave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión no existe, se ha eliminado o está fuera de los límites de una clave con alcance restringido, o no tiene ninguna comprobación AML (para el `node_id` indicado). La búsqueda de la sesión se ejecuta antes de comprobar la credencial, por lo que un `sessionId` desconocido devuelve `404` incluso sin una clave válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Unknown session": { "summary": "No existe ninguna sesión con este ID, o se eliminó", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "La sesión está fuera de los límites de una clave con alcance restringido (también se devuelve para una sesión eliminada hace unos instantes)", "value": { "detail": "Session not found." } }, "No AML check": { "summary": "La sesión nunca ejecutó un paso AML", "value": { "detail": "The session does not have an AML check." } }, "No AML check for node": { "summary": "node_id no corresponde a ninguna comprobación AML de la sesión", "value": { "detail": "The session does not have an AML check for node 'feature_aml_2'." } } } } } }, "429": { "description": "Límite de solicitudes superado: 600 solicitudes GET por minuto por clave de API. Espera los segundos indicados en `Retry-After` antes de reintentar; los encabezados `X-RateLimit-*` muestran el presupuesto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Rate limited": { "summary": "Presupuesto del minuto actual agotado", "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/add-images/": { "patch": { "summary": "Añadir una imagen a una sesión", "description": "Adjunta una imagen o un PDF adicional al resultado de Verificación de identidad (`model_type=kyc`) o de Prueba de domicilio (`model_type=poa`) de una sesión de Verificación de usuarios (KYC) finalizada, por ejemplo, evidencia recopilada fuera del flujo. La sesión debe estar en `Approved`, `Declined`, `In Review` o `Kyc Expired` y contener el resultado indicado por `model_type`. Las sesiones de Verificación de empresas (KYB) no son compatibles. Cada llamada añade un archivo (al resultado más reciente cuando el paso se ejecutó más de una vez), conserva los archivos existentes y registra una entrada `FILE_ADDED` en el registro de actividad de la sesión. La subida no envía ningún webhook y no cambia el estado de la sesión. El archivo se comprime al subirse y se devuelve en `extra_files` de la decisión de la sesión. Este endpoint está limitado a 10 solicitudes por minuto por clave de API. Una clave de API con alcance limitado necesita `sessions: write`, y sin `media: read` recibe los enlaces de `extra_files` como `null`.", "operationId": "patch_v3_session_add_images", "x-didit-sdk": { "resource": "sessions", "method": "add_images", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de Verificación de usuarios (KYC) a la que se añade el archivo (el `session_id` que devuelve `POST /v3/session/`). Un ID de sesión de Verificación de empresas (KYB) devuelve `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file", "model_type" ], "properties": { "file": { "type": "string", "format": "binary", "description": "La imagen o el PDF. Extensiones permitidas: `jpg`, `jpeg`, `png`, `webp`, `tiff`, `pdf`. Como máximo 15 MB al subirlo; después, el archivo se comprime y se rechaza con `400` si sigue superando los 2 MB (2,097,152 bytes). Los archivos vacíos se rechazan." }, "model_type": { "type": "string", "enum": [ "kyc", "poa" ], "description": "`kyc` añade el archivo al resultado de la verificación de identidad; `poa`, al resultado de la Prueba de domicilio.", "example": "kyc" }, "file_password": { "type": "string", "description": "Contraseña de un PDF cifrado. Sin ella, o con una incorrecta, un PDF cifrado devuelve `400`." } } }, "example": { "file": "(binary)", "model_type": "kyc" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/add-images/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'file=@./back-of-id.jpg' \\\n -F 'model_type=kyc'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.add_images(\n \"11111111-2222-3333-4444-555555555555\",\n file=open(\"image.jpg\", \"rb\"),\n model_type=\"kyc\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.addImages(\"11111111-2222-3333-4444-555555555555\", {\n file: await fileFromPath(\"image.jpg\"),\n model_type: \"kyc\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.AddImages(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsAddImagesParams{\n\tFile: didit.FileFromPath(\"image.jpg\"),\n\tModelType: \"kyc\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.SessionsAddImagesParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().addImages(\"11111111-2222-3333-4444-555555555555\", SessionsAddImagesParams.builder()\n .file(Path.of(\"image.jpg\"))\n .modelType(SessionsAddImagesParams.ModelType.of(\"kyc\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->addImages('11111111-2222-3333-4444-555555555555', [\n 'file' => File::fromPath('image.jpg'),\n 'model_type' => 'kyc',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.add_images(\n \"11111111-2222-3333-4444-555555555555\",\n file: Pathname(\"image.jpg\"),\n model_type: \"kyc\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.AddImagesAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsAddImagesParams\n{\n File = FileUpload.FromPath(\"image.jpg\"),\n ModelType = \"kyc\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Archivo añadido. Devuelve todos los archivos adicionales de ese resultado, incluido el nuevo.", "content": { "application/json": { "schema": { "type": "object", "required": [ "extra_files" ], "properties": { "extra_files": { "type": "array", "description": "Enlaces prefirmados de corta duración a todos los archivos adicionales del resultado indicado por `model_type`, del más antiguo al más reciente. Cada enlace es `null` para una clave de API con alcance limitado sin `media: read`. Más adelante, obtén enlaces nuevos de la decisión de la sesión.", "items": { "type": "string", "format": "uri", "nullable": true } } } }, "example": { "extra_files": [ "https://media.example.com/session/11111111-2222-3333-4444-555555555555/kyc-extra-files/66666666-7777-8888-9999-000000000000.jpg?expires=1789383731&signature=abc123" ] } } } }, "400": { "description": "Error de validación. Los errores de campo llegan como `{\"\": [\"\"]}`; los errores de PDF cifrado, como `{\"detail\": \"...\"}`.", "content": { "application/json": { "examples": { "Missing file": { "summary": "No hay ninguna parte de archivo en el formulario", "value": { "file": [ "No file was submitted." ] } }, "Missing model_type": { "summary": "Se omitió model_type", "value": { "model_type": [ "This field is required." ] } }, "Invalid model_type": { "summary": "model_type no es kyc ni poa", "value": { "model_type": [ "\"passport\" is not a valid choice." ] } }, "File too large": { "summary": "Archivo de más de 15 MB", "value": { "file": [ "File size should not exceed 15 MB" ] } }, "Too large after compression": { "summary": "Sigue superando los 2 MB tras la compresión", "value": { "file": [ "File size is too big. Max allowed size is 2097152 bytes." ] } }, "Encrypted PDF": { "summary": "PDF cifrado sin file_password", "value": { "detail": "The PDF is encrypted. Please upload a decrypted PDF or a photo instead." } }, "Wrong PDF password": { "summary": "file_password no abre el PDF", "value": { "detail": "The PDF password is incorrect. Please provide the correct password." } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Este es el único caso que devuelve `401`: una clave ausente, no válida o revocada devuelve `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "summary": "La fecha de caducidad de la clave ya pasó", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallo de autenticación o autorización. Si falta la clave, se devuelve `403`, al igual que con una clave de otra aplicación, una clave con alcance limitado sin el permiso que necesita este endpoint y una solicitud desde fuera de la lista de IP permitidas de la clave; una clave incorrecta, revocada o expirada devuelve `401`. Distínguelos por `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la validación", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clave válida que pertenece a una aplicación distinta de la de la sesión", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without sessions write": { "summary": "A la clave con alcance limitado le falta sessions: write", "value": { "detail": "This API key has no write access to sessions." } }, "IP not allowed": { "summary": "Solicitud desde fuera de la lista de IP permitidas de la clave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión no existe, se ha eliminado o está fuera de los límites de una clave con alcance restringido; es una sesión KYB o no está en `Approved`, `Declined`, `In Review` o `Kyc Expired`; o no tiene ningún resultado del `model_type` solicitado (se comprueba antes de validar el archivo). La búsqueda de la sesión se ejecuta antes de comprobar la credencial, por lo que un `sessionId` desconocido devuelve `404` incluso sin una clave válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Unknown session": { "summary": "No existe ninguna sesión con este ID, o se eliminó", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "La sesión está fuera de los límites de flujo o de solo aprobadas de una clave con alcance restringido", "value": { "detail": "Session not found." } }, "Not eligible": { "summary": "La sesión aún no ha terminado, o se trata de un ID de sesión KYB", "value": { "detail": "No Session matches the given query." } }, "No ID verification": { "summary": "model_type=kyc en una sesión sin verificación de identidad", "value": { "detail": "The session does not have KYC data." } }, "No Proof of Address": { "summary": "model_type=poa en una sesión sin prueba de domicilio", "value": { "detail": "The session does not have POA data." } } } } } }, "429": { "description": "Límite de solicitudes superado: 10 solicitudes de añadir imágenes por minuto por clave de API (las solicitudes rechazadas también cuentan). También se aplica el presupuesto compartido de 300 solicitudes de escritura por minuto. Espera los segundos indicados en `Retry-After` antes de reintentar; los encabezados `X-RateLimit-*` muestran el presupuesto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Rate limited": { "summary": "Presupuesto del minuto actual agotado", "value": { "detail": "Session add-images rate limit exceeded. You can make up to 10 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/update-aml-status/": { "patch": { "summary": "Actualizar el estado de un análisis AML", "description": "Establece el estado de la comprobación de análisis AML de una sesión en su conjunto (el `status` de una entrada de `aml_screenings[]` en la decisión de la sesión), por ejemplo `Approved` después de que tu equipo haya descartado todos los resultados. Funciona con los ID de sesión de KYC y KYB; pasa `node_id` (parámetro de consulta o campo del cuerpo) cuando la sesión ejecutó más de un paso AML; de lo contrario, se actualiza la comprobación AML más reciente. Cuando el estado cambia realmente, se registra una entrada de actividad `AML_STATUS_UPDATED` y se envía un [webhook](https://docs.didit.me/es/integration/webhooks) `data.updated`; enviar el estado actual devuelve `200` y no cambia nada. El estado de la sesión no se vuelve a calcular: usa `PATCH /v3/session/{sessionId}/update-status/` para la decisión de la sesión y `PATCH /v3/session/{sessionId}/update-aml-hit-status/` para resultados individuales. Una clave de API con alcance limitado necesita `decisions: write`.", "operationId": "patch_v3_session_update_aml_status", "x-didit-sdk": { "resource": "sessions", "method": "update_aml_status", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de verificación (el `session_id` que devuelve `POST /v3/session/`). Acepta ID de sesión tanto de Verificación de usuarios (KYC) como de Verificación de empresas (KYB): el servidor resuelve el ID en ambos tipos de sesión. Debe ser un UUID con formato válido; un valor mal formado no coincide con la ruta y devuelve un `404` en HTML.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "ID del nodo del grafo del flujo correspondiente al análisis AML que se va a actualizar. Solo es necesario cuando la sesión ejecutó más de un paso AML. Tiene prioridad sobre `node_id` en el cuerpo.", "schema": { "type": "string", "example": "feature_aml_1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Nuevo estado de la comprobación AML.", "example": "Approved" }, "node_id": { "type": "string", "description": "ID del nodo del grafo del flujo correspondiente al análisis AML, como alternativa al parámetro de consulta.", "example": "feature_aml_1" } } }, "example": { "status": "Approved" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-aml-status/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"status\": \"Approved\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_aml_status(\n \"11111111-2222-3333-4444-555555555555\",\n status=\"Approved\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateAmlStatus(\"11111111-2222-3333-4444-555555555555\", {\n status: \"Approved\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateAMLStatus(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsUpdateAMLStatusParams{\n\tStatus: \"Approved\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsUpdateAmlStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateAmlStatus(\"11111111-2222-3333-4444-555555555555\", SessionsUpdateAmlStatusParams.builder()\n .status(SessionsUpdateAmlStatusParams.Status.of(\"Approved\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateAmlStatus('11111111-2222-3333-4444-555555555555', [\n 'status' => 'Approved',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_aml_status(\n \"11111111-2222-3333-4444-555555555555\",\n status: \"Approved\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateAmlStatusAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsUpdateAmlStatusParams\n{\n Status = \"Approved\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Estado del análisis AML establecido (o sin cambios si ya tenía este valor).", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "status", "previous_status" ], "properties": { "message": { "type": "string", "description": "Siempre `AML status updated successfully`." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estado actual de la comprobación AML." }, "previous_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estado antes de la llamada. Igual a `status` cuando no cambió nada." } } }, "example": { "message": "AML status updated successfully", "status": "Approved", "previous_status": "In Review" } } } }, "400": { "description": "Error de validación: falta `status` o no es uno de los valores permitidos. La búsqueda del control AML se ejecuta primero, por lo que una sesión sin control AML devuelve `404` aunque el cuerpo no sea válido.", "content": { "application/json": { "examples": { "Missing status": { "summary": "Cuerpo vacío o sin estado", "value": { "status": [ "This field is required." ] } }, "Invalid status": { "summary": "status no está en el enum", "value": { "status": [ "\"Cleared\" is not a valid choice." ] } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Este es el único caso que devuelve `401`: una clave ausente, no válida o revocada devuelve `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "summary": "La fecha de caducidad de la clave ya pasó", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallo de autenticación o autorización. Si falta la clave, se devuelve `403`, al igual que con una clave de otra aplicación, una clave con alcance limitado sin el permiso que necesita este endpoint y una solicitud desde fuera de la lista de IP permitidas de la clave; una clave incorrecta, revocada o expirada devuelve `401`. Distínguelos por `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la validación", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clave válida que pertenece a una aplicación distinta de la de la sesión", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clave con alcance limitado le falta decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Solicitud desde fuera de la lista de IP permitidas de la clave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión no existe, se ha eliminado o está fuera de los límites de una clave con alcance restringido, o no tiene ninguna comprobación AML (para el `node_id` indicado). La búsqueda de la sesión se ejecuta antes de comprobar la credencial, por lo que un `sessionId` desconocido devuelve `404` incluso sin una clave válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Unknown session": { "summary": "No existe ninguna sesión con este ID, o se eliminó", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "La sesión está fuera de los límites de una clave con alcance restringido (también se devuelve para una sesión eliminada hace unos instantes)", "value": { "detail": "Session not found." } }, "No AML check": { "summary": "La sesión nunca ejecutó un paso AML", "value": { "detail": "The session does not have an AML check." } }, "No AML check for node": { "summary": "node_id no corresponde a ninguna comprobación AML de la sesión", "value": { "detail": "The session does not have an AML check for node 'feature_aml_2'." } } } } } }, "429": { "description": "Límite de solicitudes superado: 300 solicitudes de escritura (POST, PATCH, DELETE) por minuto por clave de API. Espera los segundos indicados en `Retry-After` antes de reintentar; los encabezados `X-RateLimit-*` muestran el presupuesto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Rate limited": { "summary": "Presupuesto del minuto actual agotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/status/": { "get": { "summary": "Obtener el estado del servicio (público, sin autenticación)", "description": "Devuelve el estado de cada servicio de Didit (`operational`, `degraded` o `down`), el estado general (el peor de ellos) y las incidencias que están en curso o que se resolvieron en los últimos 7 días. Úsalo para alimentar un widget de estado o para comprobar el estado de Didit desde tu integración.\n\nPúblico: no envíes ningún encabezado de autenticación. La respuesta no contiene datos de ninguna organización y es la misma para todos los que la llaman. Las respuestas se almacenan en caché durante 30 segundos, así que no consultes más de una vez cada 30 segundos.", "operationId": "get_v3_status", "tags": [ "Status" ], "security": [ {} ], "parameters": [], "responses": { "200": { "description": "Estado actual del servicio.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceStatusFeed" }, "examples": { "One service degraded": { "summary": "Un incidente en curso y otro resuelto esta semana", "value": { "status": "degraded", "updated_at": "2026-10-13T09:41:07.512345Z", "services": [ { "key": "service_id_verification", "name": "ID verification", "status": "operational" }, { "key": "service_liveness_face_match", "name": "Liveness and face match", "status": "operational" }, { "key": "service_aml_screening", "name": "AML screening", "status": "operational" }, { "key": "service_kyb_registries", "name": "KYB registries", "status": "operational" }, { "key": "service_database_validation", "name": "Database validation", "status": "degraded" }, { "key": "service_phone_delivery", "name": "Phone verification delivery", "status": "operational" }, { "key": "service_email_delivery", "name": "Email verification delivery", "status": "operational" }, { "key": "service_transaction_monitoring", "name": "Transaction monitoring", "status": "operational" } ], "incidents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "service": "service_database_validation", "service_name": "Database validation", "state": "degraded", "status": "ongoing", "title": "Database validation is degraded in Brazil.", "body": "Checks against Brazil (CPF) may be slow or fail since 08:55 UTC.", "affected": "Brazil (CPF)", "country_name": "Brazil", "started_at": "2026-10-13T08:55:00Z", "resolved_at": null, "duration_minutes": null }, { "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "service": "service_aml_screening", "service_name": "AML screening", "state": "down", "status": "resolved", "title": "AML screening is back to normal.", "body": "Recovered at 14:32 UTC after 17 minutes.", "affected": "", "country_name": "", "started_at": "2026-10-11T14:15:00Z", "resolved_at": "2026-10-11T14:32:00Z", "duration_minutes": 17 } ] } }, "All operational": { "summary": "Ningún incidente en los últimos 7 días", "value": { "status": "operational", "updated_at": "2026-10-13T09:41:07.512345Z", "services": [ { "key": "service_id_verification", "name": "ID verification", "status": "operational" }, { "key": "service_liveness_face_match", "name": "Liveness and face match", "status": "operational" }, { "key": "service_aml_screening", "name": "AML screening", "status": "operational" }, { "key": "service_kyb_registries", "name": "KYB registries", "status": "operational" }, { "key": "service_database_validation", "name": "Database validation", "status": "operational" }, { "key": "service_phone_delivery", "name": "Phone verification delivery", "status": "operational" }, { "key": "service_email_delivery", "name": "Email verification delivery", "status": "operational" }, { "key": "service_transaction_monitoring", "name": "Transaction monitoring", "status": "operational" } ], "incidents": [] } } } } } }, "429": { "description": "Más de 600 solicitudes GET en un minuto desde la misma dirección IP (o con la misma clave de API, si envías una). Respeta `Retry-After` antes de reintentar.", "content": { "application/json": { "schema": { "type": "object", "required": [ "detail" ], "properties": { "detail": { "type": "string" } } }, "example": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -fsS https://verification.didit.me/v3/status/" }, { "lang": "python", "label": "Python", "source": "import requests\n\nresp = requests.get('https://verification.didit.me/v3/status/', timeout=5)\nresp.raise_for_status()\nfeed = resp.json()\nprint(feed['status'])\nfor service in feed['services']:\n if service['status'] != 'operational':\n print(service['key'], service['status'])" }, { "lang": "javascript", "label": "JavaScript", "source": "const feed = await fetch('https://verification.didit.me/v3/status/').then((r) => r.json());\nconsole.log(feed.status);\nconst affected = feed.services.filter((s) => s.status !== 'operational');\nconsole.log(affected.map((s) => `${s.key}: ${s.status}`));" } ], "x-didit-sdk": { "resource": "system", "method": "retrieve_status", "auth": "public", "server": false } } }, "/v3/organization/bank-verification-pricing/": { "get": { "summary": "Obtener los precios de verificación bancaria (público, sin autenticación)", "description": "Devuelve el precio de lista de cada método de verificación bancaria en cada país: el inicio de sesión bancario con sus complementos de saldo y transacciones, y la comprobación de cuenta. La verificación bancaria todavía no está habilitada en producción, por lo que un paso bancario se rechaza en los flujos de producción hasta que lo esté; trata estos precios como un precio de lista, no como una oferta que puedas contratar hoy. Úsalo para presupuestar un paso bancario antes de crear un flujo, o para mostrar los precios bancarios en tu propio producto.\n\nPúblico: no envíes ningún encabezado de autenticación. La respuesta no contiene datos de ninguna organización y es la misma para todos los que la llaman. Se almacena en caché pública durante una hora e incluye un `ETag`, así que envía `If-None-Match` para recibir un `304 Not Modified` cuando nada haya cambiado.\n\nUn método está `available` solo donde Didit lo ofrece hoy en producción, y su `price_usd` es `null` en cualquier otro lugar, de modo que el feed nunca muestra un precio que no puedas contratar. `available: false` abarca un país sin precio aprobado, un método que el país no admite y una ruta que todavía no está activada.\n\nSon precios de lista antes del descuento de tu plan. El descuento de tu plan se aplica a todo el precio bancario, y un precio negociado o contractual sustituye al precio de lista para tu organización.", "operationId": "get_v3_bank_verification_pricing", "tags": [ "Pricing" ], "security": [ {} ], "parameters": [], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -fsS https://verification.didit.me/v3/organization/bank-verification-pricing/" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# This call needs no API key.\nclient = Didit()\n\nresult = client.pricing.bank_verification()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// This call needs no API key.\nconst didit = new Didit();\n\nconst result = await didit.pricing.bankVerification();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// This call needs no API key.\nclient := didit.NewClient()\n\nresult, err := client.Pricing.BankVerification(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// This call needs no API key.\nDidit client = new Didit();\n\nvar result = client.pricing().bankVerification();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "pricing->bankVerification();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# This call needs no API key.\ndidit = Didit::Client.new\n\nresult = didit.pricing.bank_verification\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// This call needs no API key.\nusing var client = new DiditClient();\n\nvar result = await client.Pricing.BankVerificationAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-sdk": { "resource": "pricing", "method": "bank_verification", "auth": "none", "server": true }, "responses": { "200": { "description": "Precios de lista de Verificación bancaria por país.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankVerificationPricing" }, "examples": { "Two countries": { "summary": "Un país con ambos métodos y otro con ninguno", "value": { "currency": "USD", "statement_upload": { "price_usd": "0.0000", "included_after_charged_bank_attempt": true, "standalone_available": false }, "own_provider_fee_usd": "0.0200", "countries": { "GBR": { "name": "United Kingdom", "methods": { "open_banking": { "available": true, "market": "UK and EEA", "price_usd": "0.7900", "add_ons": { "balance": "0.3500", "transactions": "1.3000" } }, "account_lookup": { "available": true, "price_usd": "0.4000" } } }, "CAN": { "name": "Canada", "methods": { "open_banking": { "available": false, "market": null, "price_usd": null, "add_ons": {} }, "account_lookup": { "available": false, "price_usd": null } } } } } } } } } }, "304": { "description": "Sin modificar: el `ETag` que enviaste en `If-None-Match` sigue coincidiendo. Sin cuerpo." } } } }, "/v3/session/{sessionId}/simulate/": { "post": { "summary": "Simular el estado de una sesión de sandbox", "description": "Fuerza un estado final en una sesión de sandbox a posteriori, desde tu backend, sin ejecutar el flujo. Solo para aplicaciones de sandbox: una sesión de producción devuelve `404`. Funciona con sesiones de Verificación de usuarios (KYC) y de Verificación de empresas (KYB).\n\nEstablece `new_status`, o deja que lo determine `scenario` o `risk`. `risk` (o el primer riesgo que incluyan los valores mágicos del escenario) añade esa advertencia a la sesión. El cambio queda registrado en la actividad de la sesión.\n\n`send_webhooks` (por defecto `true`) envía exactamente los mismos webhooks que un cambio de estado real. Con `false`, el estado cambia igualmente y la consola se sigue actualizando en tiempo real, pero no se registra ni se envía ningún webhook, la recuperación de webhooks perdidos nunca reenvía esa decisión y el siguiente cambio de estado envía webhooks con normalidad. La respuesta devuelve el valor aplicado.\n\nRequiere el privilegio `write:sessions`; una clave de API con alcance limitado necesita acceso de escritura a las sesiones. Un `session_id` desconocido devuelve `404` y una sesión de otra aplicación devuelve `403`, en ambos casos antes de leer el cuerpo; una sesión de producción devuelve `404` solo después de validar el cuerpo. Para simular desde el flujo alojado con el token propio de la sesión, usa `POST /v3/session/{sessionId}/sandbox/simulate/`. Consulta [Sandbox y datos de prueba](/es/integration/sandbox-testing) para ver el catálogo de escenarios.", "operationId": "post_v3_session_simulate", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sesión de verificación de sandbox. Acepta ID de sesión tanto de usuario (KYC) como de empresa (KYB).", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxSimulateRequest" }, "examples": { "Scenario Without Webhooks": { "summary": "Rechazar mediante un escenario sin enviar webhooks", "value": { "scenario": "decline_aml_hit", "send_webhooks": false } }, "Status Only": { "summary": "Aprobar y enviar los webhooks habituales", "value": { "new_status": "Approved" } } } } } }, "responses": { "200": { "description": "El estado cambió.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxSimulateResponse" }, "examples": { "Simulated": { "summary": "Rechazado mediante un escenario, sin enviar webhooks", "value": { "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "previous_status": "In Progress", "status": "Declined", "scenario": "decline_aml_hit", "risk": "POSSIBLE_MATCH_FOUND", "send_webhooks": false } } } } } }, "400": { "description": "Error de validación: un escenario o riesgo desconocido, falta `new_status` cuando ni `scenario` ni `risk` lo proporcionan, un estado que este endpoint no establece o la sesión ya tiene el estado solicitado (un array JSON simple).", "content": { "application/json": { "examples": { "Unknown Scenario": { "summary": "el escenario no está en el catálogo", "value": { "scenario": [ "Unknown sandbox scenario: 'not-a-scenario'." ] } }, "Unknown Risk": { "summary": "risk no está en el catálogo", "value": { "risk": [ "Unknown sandbox risk case: 'NOT_A_RISK'." ] } }, "Missing new_status": { "summary": "No se indicó new_status, scenario ni risk", "value": { "new_status": [ "This field is required." ] } }, "Invalid new_status": { "summary": "Un estado que la simulación no establece", "value": { "new_status": [ "\"Resubmitted\" is not a valid choice." ] } }, "Same Status": { "summary": "La sesión ya tiene este estado", "value": [ "The new status is the same as the current status." ] } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Clave de API con alcance limitado con la fecha de caducidad vencida", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Faltan las credenciales, quien llama no tiene el privilegio `write:sessions`, una clave de API con alcance limitado no tiene el acceso que necesita este endpoint, o el `session_id` pertenece a otra aplicación.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente o no válido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "El autor de la llamada no tiene write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Clave de API con alcance limitado sin este acceso", "value": { "detail": "This API key has no write access to sessions." } } } } } }, "404": { "description": "No existe ninguna sesión con este `session_id`, o es una sesión de producción (no de sandbox).", "content": { "application/json": { "examples": { "Not Found": { "summary": "Sesión desconocida o de producción", "value": { "detail": "Not found." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/simulate/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"scenario\": \"decline_aml_hit\", \"send_webhooks\": false}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.simulate(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n scenario=\"decline_aml_hit\",\n send_webhooks=False,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.simulate(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", {\n scenario: \"decline_aml_hit\",\n send_webhooks: false,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Simulate(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", didit.SandboxSimulateRequest{\n\tScenario: didit.String(\"decline_aml_hit\"),\n\tSendWebhooks: didit.Bool(false),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SandboxSimulateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().simulate(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", SandboxSimulateRequest.builder()\n .scenario(\"decline_aml_hit\")\n .sendWebhooks(false)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->simulate('3fa85f64-5717-4562-b3fc-2c963f66afa6', [\n 'scenario' => 'decline_aml_hit',\n 'send_webhooks' => false,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.simulate(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n scenario: \"decline_aml_hit\",\n send_webhooks: false\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.SimulateAsync(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", new SandboxSimulateRequest\n{\n Scenario = \"decline_aml_hit\",\n SendWebhooks = false,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-sdk": { "resource": "sessions", "method": "simulate", "auth": "api_key", "server": true } } }, "/v3/session/{sessionId}/sandbox/simulate/": { "post": { "summary": "Simular el estado de una sesión de sandbox desde el cliente", "description": "La misma simulación que `POST /v3/session/{sessionId}/simulate/`, autenticada con el propio `Session-Token` de la sesión (devuelto en `session_token` por [Crear sesión](/es/sessions-api/create-session)) en lugar de tu clave de API, para que un entorno de pruebas o el flujo alojado puedan llamarla desde el cliente. El cuerpo, la respuesta y `send_webhooks` se comportan exactamente igual que en ese endpoint.\n\nUn `Session-Token` de una aplicación en producción (no sandbox), o uno que no coincida con el `sessionId` de la ruta, devuelve `404`. Consulta [Sandbox y datos de prueba](/es/integration/sandbox-testing).", "operationId": "post_v3_session_sandbox_simulate", "tags": [ "Sessions" ], "security": [ { "SessionTokenAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sesión de verificación de sandbox. Debe coincidir con la sesión codificada en el Session-Token que se usa para autenticarse.", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxSimulateRequest" }, "examples": { "Scenario Without Webhooks": { "summary": "Rechazar mediante un escenario sin enviar webhooks", "value": { "scenario": "decline_aml_hit", "send_webhooks": false } }, "Status Only": { "summary": "Aprobar y enviar los webhooks habituales", "value": { "new_status": "Approved" } } } } } }, "responses": { "200": { "description": "El estado cambió.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxSimulateResponse" }, "examples": { "Simulated": { "summary": "Rechazado mediante un escenario, sin enviar webhooks", "value": { "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "previous_status": "In Progress", "status": "Declined", "scenario": "decline_aml_hit", "risk": "POSSIBLE_MATCH_FOUND", "send_webhooks": false } } } } } }, "400": { "description": "Error de validación: un escenario o riesgo desconocido, falta `new_status` cuando ni `scenario` ni `risk` lo proporcionan, un estado que este endpoint no establece o la sesión ya tiene el estado solicitado (un array JSON simple).", "content": { "application/json": { "examples": { "Unknown Scenario": { "summary": "el escenario no está en el catálogo", "value": { "scenario": [ "Unknown sandbox scenario: 'not-a-scenario'." ] } }, "Unknown Risk": { "summary": "risk no está en el catálogo", "value": { "risk": [ "Unknown sandbox risk case: 'NOT_A_RISK'." ] } }, "Missing new_status": { "summary": "No se indicó new_status, scenario ni risk", "value": { "new_status": [ "This field is required." ] } }, "Invalid new_status": { "summary": "Un estado que la simulación no establece", "value": { "new_status": [ "\"Resubmitted\" is not a valid choice." ] } }, "Same Status": { "summary": "La sesión ya tiene este estado", "value": [ "The new status is the same as the current status." ] } } } } }, "403": { "description": "Falta el encabezado `Session-Token` o no es válido.", "content": { "application/json": { "examples": { "Invalid Session Token": { "summary": "Session-Token ausente o no válido", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "El `Session-Token` pertenece a una aplicación de producción (no sandbox), o no coincide con el `sessionId` de la ruta.", "content": { "application/json": { "examples": { "Not Found": { "summary": "Sesión de producción, o session_id / token no coinciden", "value": { "detail": "Not found." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/sandbox/simulate/ \\\n -H 'Session-Token: YOUR_SESSION_TOKEN' \\\n -H 'Content-Type: application/json' \\\n -d '{\"new_status\": \"Approved\", \"send_webhooks\": false}'" }, { "lang": "python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/sandbox/simulate/\",\n headers={\"Session-Token\": \"YOUR_SESSION_TOKEN\"},\n json={\"new_status\": \"Approved\", \"send_webhooks\": False},\n)\nresponse.raise_for_status()\nprint(response.json())" } ], "x-didit-sdk": { "resource": "sessions", "method": "simulate_sandbox", "auth": "device_token", "server": false } } }, "/v3/session/{sessionId}/features/overrides/": { "get": { "summary": "Listar las anulaciones de controles de una sesión", "description": "Todas las anulaciones del estado de una función (paso) individual en una sesión de Verificación de usuarios (KYC) o de Verificación de empresas (KYB), de la más reciente a la más antigua y sin paginar: las aplicadas, las que esperan a que la persona termine el flujo (`pending_until_flow_finishes`) y las canceladas, cada una con quién la solicitó, su motivo y si se aplicó mientras la persona seguía en el flujo (`forced`).\n\n`person_in_flow` te indica si una nueva anulación con `defer_until_flow_finishes: true` tendría que esperar. `flow_finished_at` es el momento en que la persona terminó el flujo por última vez; es `null` mientras sigue en él (incluido un reenvío) y cuando la sesión se cerró antes de que lo terminara.\n\nRequiere el privilegio `read:sessions`; una clave de API con alcance limitado necesita acceso de lectura a las decisiones.", "operationId": "get_v3_session_feature_overrides", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sesión de verificación. Acepta ID de sesión tanto de usuario (KYC) como de empresa (KYB).", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } ], "responses": { "200": { "description": "Las anulaciones de comprobaciones de la sesión, de la más reciente a la más antigua.", "content": { "application/json": { "schema": { "type": "object", "required": [ "session_id", "person_in_flow", "flow_finished_at", "overrides" ], "properties": { "session_id": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "person_in_flow": { "type": "boolean", "description": "Si la persona sigue en el flujo, de modo que una nueva anulación con `defer_until_flow_finishes: true` quedaría en espera.", "example": true }, "flow_finished_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que la persona terminó el flujo por última vez. `null` mientras sigue en él (incluido un reenvío) y cuando la sesión se cerró antes de que terminara (abandonada, expirada o decidida a mitad del flujo).", "example": null }, "overrides": { "type": "array", "description": "Todas las anulaciones de la sesión, de la más reciente a la más antigua.", "items": { "$ref": "#/components/schemas/FeatureStatusOverride" } } } }, "examples": { "Overrides": { "summary": "Una modificación en espera, una aplicada", "value": { "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "person_in_flow": true, "flow_finished_at": null, "overrides": [ { "id": "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3", "node_id": "feature_liveness_1", "feature_type": "", "feature_model": "Face", "previous_status": "Declined", "new_status": "Approved", "state": "pending_until_flow_finishes", "forced": false, "reason": "Liveness retried with a reviewer present.", "requested_by": { "email": "reviewer@example.com", "name": "Alex Reviewer", "type": "CONSOLE_USER" }, "requested_at": "2026-10-13T09:15:00Z", "applied_at": null, "cancelled_at": null, "cancel_reason": null }, { "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "node_id": "feature_ocr_1", "feature_type": "", "feature_model": "KYC", "previous_status": "In Review", "new_status": "Approved", "state": "applied", "forced": true, "reason": "Document manually verified by compliance.", "requested_by": { "email": "reviewer@example.com", "name": "Alex Reviewer", "type": "CONSOLE_USER" }, "requested_at": "2026-10-13T09:15:00Z", "applied_at": "2026-10-13T09:15:00Z", "cancelled_at": null, "cancel_reason": null } ] } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Clave de API con alcance limitado con la fecha de caducidad vencida", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Faltan las credenciales, quien llama no tiene el privilegio `read:sessions`, una clave de API con alcance limitado no tiene el acceso que necesita este endpoint, o el `session_id` pertenece a otra aplicación.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente o no válido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "El autor de la llamada no tiene read:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Clave de API con alcance limitado sin este acceso", "value": { "detail": "This API key has no read access to decisions." } } } } } }, "404": { "description": "No existe ninguna sesión KYC o KYB con este `session_id`.", "content": { "application/json": { "examples": { "Not Found": { "summary": "session_id desconocido", "value": { "detail": "Not found." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET \\\n https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/features/overrides/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.list_feature_overrides(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.listFeatureOverrides(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ListFeatureOverrides(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().listFeatureOverrides(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->listFeatureOverrides('3fa85f64-5717-4562-b3fc-2c963f66afa6');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.list_feature_overrides(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ListFeatureOverridesAsync(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-sdk": { "resource": "sessions", "method": "list_feature_overrides", "auth": "api_key", "server": true } } }, "/v3/session/{sessionId}/features/overrides/{overrideId}/cancel/": { "post": { "summary": "Cancelar una anulación de comprobación que espera a que termine el flujo", "description": "Cancela una anulación del estado de una función (paso) que sigue en `pending_until_flow_finishes`, para que nunca se aplique. La comprobación conserva su estado, la cancelación se registra en la actividad de la sesión como `FEATURE_OVERRIDE_CANCELLED` y no se envía ningún webhook. La respuesta es la anulación con `state: cancelled` y `cancel_reason: cancelled_by_reviewer`.\n\nUna anulación que ya se aplicó o se canceló devuelve `409` con el código `feature_override_not_pending`. Encuentra los ID de anulación con `GET /v3/session/{sessionId}/features/overrides/` o en el `override` que devuelve la actualización del estado de la función.\n\nRequiere el privilegio `write:sessions`; una clave de API con alcance limitado necesita acceso de escritura a las decisiones.", "operationId": "post_v3_session_feature_override_cancel", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sesión de verificación. Acepta ID de sesión tanto de usuario (KYC) como de empresa (KYB).", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, { "in": "path", "name": "overrideId", "required": true, "description": "El `id` de la anulación que se va a cancelar.", "schema": { "type": "string", "format": "uuid", "example": "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3" } } ], "responses": { "200": { "description": "La anulación se cancela y nunca se aplicará.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureStatusOverride" }, "examples": { "Cancelled": { "summary": "La anulación manual cancelada", "value": { "id": "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3", "node_id": "feature_liveness_1", "feature_type": "", "feature_model": "Face", "previous_status": "Declined", "new_status": "Approved", "state": "cancelled", "forced": false, "reason": "Liveness retried with a reviewer present.", "requested_by": { "email": "reviewer@example.com", "name": "Alex Reviewer", "type": "CONSOLE_USER" }, "requested_at": "2026-10-13T09:15:00Z", "applied_at": null, "cancelled_at": "2026-10-13T09:20:00Z", "cancel_reason": "cancelled_by_reviewer" } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Clave de API con alcance limitado con la fecha de caducidad vencida", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Faltan las credenciales, quien llama no tiene el privilegio `write:sessions`, una clave de API con alcance limitado no tiene el acceso que necesita este endpoint, o el `session_id` pertenece a otra aplicación.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente o no válido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "El autor de la llamada no tiene write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Clave de API con alcance limitado sin este acceso", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "No existe ninguna sesión KYC o KYB con este `session_id`, o la sesión no tiene ninguna anulación con este `overrideId`.", "content": { "application/json": { "examples": { "Not Found": { "summary": "session_id desconocido", "value": { "detail": "Not found." } }, "Override Not Found": { "summary": "No hay ninguna anulación con este id en la sesión", "value": { "detail": "Override not found." } } } } } }, "409": { "description": "La anulación ya se aplicó o se canceló.", "content": { "application/json": { "examples": { "Not Pending": { "summary": "Solo se puede cancelar una anulación en espera", "value": { "detail": "This override is no longer pending: it already applied or was cancelled.", "code": "feature_override_not_pending" } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/features/overrides/9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3/cancel/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.cancel_feature_override(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.cancelFeatureOverride(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.CancelFeatureOverride(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", \"9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().cancelFeatureOverride(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", \"9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->cancelFeatureOverride('3fa85f64-5717-4562-b3fc-2c963f66afa6', '9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.cancel_feature_override(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.CancelFeatureOverrideAsync(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", \"9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-sdk": { "resource": "sessions", "method": "cancel_feature_override", "auth": "api_key", "server": true } } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/add/": { "post": { "summary": "Añadir una etiqueta a una red", "description": "Añade una de las etiquetas de tu aplicación a la red. Devuelve el detalle de la red, cuyo `tags` enumera las etiquetas de tu aplicación en la red, con `201` cuando se añadió la etiqueta y `200` cuando ya estaba en la red. Una etiqueta que pertenece a otra aplicación, o que no existe, devuelve 404 `Tag not found.`. Requiere una clave de API de acceso completo, o `write:networks` para un miembro de la consola.", "operationId": "add_network_tag", "tags": [ "Networks" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "description": "UUID de la red." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkTagRequest" }, "example": { "tag_uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/3fa85f64-5717-4562-b3fc-2c963f66afa6/tags/add/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"tag_uuid\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.add_tag(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n tag_uuid=\"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.addTag(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", {\n tag_uuid: \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.AddTag(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", didit.NetworkTagRequest{\n\tTagUUID: \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.NetworkTagRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().addTag(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", NetworkTagRequest.builder()\n .tagUuid(\"7c9e6679-7425-40de-944b-e07fc1f90ae7\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->addTag('3fa85f64-5717-4562-b3fc-2c963f66afa6', [\n 'tag_uuid' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.add_tag(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n tag_uuid: \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.AddTagAsync(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", new NetworkTagRequest\n{\n TagUuid = \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Se añadió la etiqueta. Devuelve el detalle de la red.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkDetailResponse" }, "example": { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "network_id": "N-0042", "name": null, "status": "in_review", "risk": { "score": 82, "band": "high", "bar": 0.82 }, "pattern_types": [ "exact_same_device", "same_email" ], "signal_types": [ "device", "email" ], "member_counts": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signal_coverage": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } }, "first_activity_at": "2026-10-01T09:12:44Z", "last_activity_at": "2026-10-12T16:03:10Z", "stats": { "members": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signals": { "total": 2, "by_type": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } } } }, "fraud_tags": [], "risk_signals": { "residential_proxy_reuse": { "detected": false, "signal_count": 0, "max_subject_count": 0 }, "email_intelligence": { "enriched_signal_count": 1, "high_risk_count": 0, "social_profile_count": 0 }, "phone_intelligence": { "enriched_signal_count": 0, "high_risk_count": 0 } }, "reviewed_at": "2026-10-12T16:30:00Z", "reviewed_by": "reviewer@example.com", "review_reason": "Shared device across three new accounts.", "notes_count": 0, "sharing_mode": "global", "cross_org_available": true, "cross_org_unavailable_reason": null, "tags": [ { "uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "name": "SUSPICIOUS", "color": "#6366F1", "source": "custom", "added_by": null, "added_at": "2026-10-13T08:15:00Z" } ], "outcomes": { "approved": 1, "declined": 1, "in_review": 0, "total": 3 }, "patterns": [ { "type": "background", "score": 0.8125, "members": 3, "reason": null, "computed_at": "2026-10-13T08:00:00Z" } ] } } } }, "200": { "description": "La etiqueta ya estaba en la red y se deja tal como está. Devuelve el detalle de la red.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkDetailResponse" }, "example": { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "network_id": "N-0042", "name": null, "status": "in_review", "risk": { "score": 82, "band": "high", "bar": 0.82 }, "pattern_types": [ "exact_same_device", "same_email" ], "signal_types": [ "device", "email" ], "member_counts": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signal_coverage": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } }, "first_activity_at": "2026-10-01T09:12:44Z", "last_activity_at": "2026-10-12T16:03:10Z", "stats": { "members": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signals": { "total": 2, "by_type": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } } } }, "fraud_tags": [], "risk_signals": { "residential_proxy_reuse": { "detected": false, "signal_count": 0, "max_subject_count": 0 }, "email_intelligence": { "enriched_signal_count": 1, "high_risk_count": 0, "social_profile_count": 0 }, "phone_intelligence": { "enriched_signal_count": 0, "high_risk_count": 0 } }, "reviewed_at": "2026-10-12T16:30:00Z", "reviewed_by": "reviewer@example.com", "review_reason": "Shared device across three new accounts.", "notes_count": 0, "sharing_mode": "global", "cross_org_available": true, "cross_org_unavailable_reason": null, "tags": [ { "uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "name": "SUSPICIOUS", "color": "#6366F1", "source": "custom", "added_by": null, "added_at": "2026-10-13T08:15:00Z" } ], "outcomes": { "approved": 1, "declined": 1, "in_review": 0, "total": 3 }, "patterns": [ { "type": "background", "score": 0.8125, "members": 3, "reason": null, "computed_at": "2026-10-13T08:00:00Z" } ] } } } }, "400": { "description": "Cuerpo no válido: falta `tag_uuid` o no es un UUID.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tag_uuid": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Missing tag_uuid": { "summary": "Falta tag_uuid", "value": { "tag_uuid": [ "This field is required." ] } }, "Invalid tag_uuid": { "summary": "tag_uuid no válido", "value": { "tag_uuid": [ "Must be a valid UUID." ] } } } } } }, "401": { "description": "Credenciales ausentes o no válidas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente en errores con código, por ejemplo `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Credenciales ausentes o no válidas", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "La clave de API pertenece a otra aplicación o es una clave con acceso restringido: los endpoints de Networks necesitan una clave de acceso completo. Un token de miembro de la consola necesita `write:networks`. También se devuelve con `code: networks_not_entitled` cuando Networks no está habilitado para la organización.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente en errores con código, por ejemplo `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Redes no habilitadas", "value": { "detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled" } }, "Restricted API key": { "summary": "Clave de API restringida", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Sin permiso", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No encontrado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente en errores con código, por ejemplo `networks_not_entitled`." } } }, "examples": { "Network not found": { "summary": "Red no encontrada", "value": { "detail": "Network not found." } }, "Tag not found": { "summary": "Etiqueta no encontrada", "value": { "detail": "Tag not found." } } } } } } }, "x-didit-sdk": { "resource": "networks", "method": "add_tag", "auth": "api_key", "server": true, "scope": "application" } } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/remove/": { "post": { "summary": "Quitar una etiqueta de una red", "description": "Quita de la red una de las etiquetas de tu aplicación. Devuelve el detalle de la red. Devuelve 404 cuando la etiqueta no está en la red o no pertenece a tu aplicación. Requiere una clave de API con acceso completo, o `write:networks` para un miembro de la consola.", "operationId": "remove_network_tag", "tags": [ "Networks" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "description": "UUID de la red." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkTagRequest" }, "example": { "tag_uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/3fa85f64-5717-4562-b3fc-2c963f66afa6/tags/remove/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"tag_uuid\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.remove_tag(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n tag_uuid=\"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.removeTag(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", {\n tag_uuid: \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.RemoveTag(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", didit.NetworkTagRequest{\n\tTagUUID: \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.NetworkTagRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().removeTag(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", NetworkTagRequest.builder()\n .tagUuid(\"7c9e6679-7425-40de-944b-e07fc1f90ae7\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->removeTag('3fa85f64-5717-4562-b3fc-2c963f66afa6', [\n 'tag_uuid' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.remove_tag(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n tag_uuid: \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.RemoveTagAsync(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", new NetworkTagRequest\n{\n TagUuid = \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Se eliminó la etiqueta de la red. Devuelve el detalle de la red.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkDetailResponse" }, "example": { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "network_id": "N-0042", "name": null, "status": "in_review", "risk": { "score": 82, "band": "high", "bar": 0.82 }, "pattern_types": [ "exact_same_device", "same_email" ], "signal_types": [ "device", "email" ], "member_counts": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signal_coverage": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } }, "first_activity_at": "2026-10-01T09:12:44Z", "last_activity_at": "2026-10-12T16:03:10Z", "stats": { "members": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signals": { "total": 2, "by_type": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } } } }, "fraud_tags": [], "risk_signals": { "residential_proxy_reuse": { "detected": false, "signal_count": 0, "max_subject_count": 0 }, "email_intelligence": { "enriched_signal_count": 1, "high_risk_count": 0, "social_profile_count": 0 }, "phone_intelligence": { "enriched_signal_count": 0, "high_risk_count": 0 } }, "reviewed_at": "2026-10-12T16:30:00Z", "reviewed_by": "reviewer@example.com", "review_reason": "Shared device across three new accounts.", "notes_count": 0, "sharing_mode": "global", "cross_org_available": true, "cross_org_unavailable_reason": null, "tags": [], "outcomes": { "approved": 1, "declined": 1, "in_review": 0, "total": 3 }, "patterns": [ { "type": "background", "score": 0.8125, "members": 3, "reason": null, "computed_at": "2026-10-13T08:00:00Z" } ] } } } }, "400": { "description": "Cuerpo no válido: falta `tag_uuid` o no es un UUID.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tag_uuid": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Missing tag_uuid": { "summary": "Falta tag_uuid", "value": { "tag_uuid": [ "This field is required." ] } }, "Invalid tag_uuid": { "summary": "tag_uuid no válido", "value": { "tag_uuid": [ "Must be a valid UUID." ] } } } } } }, "401": { "description": "Credenciales ausentes o no válidas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente en errores con código, por ejemplo `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Credenciales ausentes o no válidas", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "La clave de API pertenece a otra aplicación o es una clave con acceso restringido: los endpoints de Networks necesitan una clave de acceso completo. Un token de miembro de la consola necesita `write:networks`. También se devuelve con `code: networks_not_entitled` cuando Networks no está habilitado para la organización.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente en errores con código, por ejemplo `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Redes no habilitadas", "value": { "detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled" } }, "Restricted API key": { "summary": "Clave de API restringida", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Sin permiso", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No encontrado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente en errores con código, por ejemplo `networks_not_entitled`." } } }, "examples": { "Network not found": { "summary": "Red no encontrada", "value": { "detail": "Network not found." } }, "Tag not found": { "summary": "Etiqueta no encontrada", "value": { "detail": "Tag not found." } }, "Tag not on the network": { "summary": "La etiqueta no está en la red", "value": { "detail": "This tag is not on the network." } } } } } } }, "x-didit-sdk": { "resource": "networks", "method": "remove_tag", "auth": "api_key", "server": true, "scope": "application" } } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/{request_uuid}/remind/": { "post": { "summary": "Recordar al cliente una solicitud", "description": "Vuelve a enviar el correo de una solicitud al cliente en espera, al mismo destinatario verificado y con el mismo contenido. Puedes enviar un recordatorio de una solicitud como máximo una vez cada 24 horas. Un recordatorio no cambia nada más: la solicitud conserva su fecha límite y el caso conserva su estado. Cada recordatorio queda registrado en el caso como un evento CUSTOMER_REQUEST con la acción `reminded`. El `delivery_status` de la respuesta indica cómo terminó la entrega de este recordatorio: SENT, SIMULATED (el correo no se envió) o UNKNOWN (es posible que el correo se haya aceptado; no se vuelve a enviar automáticamente). `next_reminder_at` indica cuándo puedes volver a enviar un recordatorio de esta solicitud. Devuelve 409 con un `reason` cuando el cliente ya no tiene la solicitud pendiente de responder, y 429 con `retry_at` y un encabezado `Retry-After` cuando ya se envió un recordatorio de la solicitud en las últimas 24 horas. Requiere `write:cases`.", "operationId": "organization_application_cases_requests_remind_create", "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "UUID de la organización." }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "UUID de la aplicación." }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "UUID del caso." }, { "in": "path", "name": "request_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "UUID de la solicitud del cliente, tomado de la lista de solicitudes del caso." } ], "tags": [ "Case Management" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/requests/3fa85f64-5717-4562-b3fc-2c963f66afa6/remind/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.requests.remind(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requests.remind(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Requests.Remind(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requests().remind(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requests->remind('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.requests.remind(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Requests.RemindAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "El recordatorio se registró y se envió su correo electrónico.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request", "reminded_at", "delivery_status", "next_reminder_at" ], "properties": { "request": { "$ref": "#/components/schemas/CustomerMessagingCaseRequest" }, "reminded_at": { "type": "string", "format": "date-time", "description": "Cuándo se registró este recordatorio." }, "delivery_status": { "type": "string", "enum": [ "SENT", "SIMULATED", "UNKNOWN" ], "description": "Cómo terminó la entrega de este recordatorio. SIMULATED: el correo electrónico no se envió. UNKNOWN: es posible que el correo electrónico se haya aceptado; no se vuelve a enviar automáticamente." }, "next_reminder_at": { "type": "string", "format": "date-time", "description": "Cuándo puedes volver a enviar un recordatorio para esta solicitud: `reminded_at` más 24 horas." } } }, "example": { "request": { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "purpose": "confirm_details", "language": "en", "recipient": "customer@example.com", "expires_at": "2026-10-20T09:00:00Z", "actor_email": "reviewer@example.com", "delivery_status": "SENT", "delivered_at": "2026-10-13T09:00:04Z", "cancelled_at": null, "responded_at": null, "response": null, "has_attachment": false, "created_at": "2026-10-13T09:00:00Z" }, "reminded_at": "2026-10-14T10:30:00Z", "delivery_status": "SENT", "next_reminder_at": "2026-10-15T10:30:00Z" } } } }, "400": { "description": "El caso tiene una resolución pendiente de aprobación. El cuerpo es una lista de cadenas.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "Customer messages require an active case without a pending resolution." ] } } }, "403": { "description": "Quien hace la llamada no tiene el permiso de casos necesario." }, "404": { "description": "La solicitud o el caso no están disponibles para quien hace la llamada." }, "409": { "description": "La solicitud ya no está esperando al cliente, así que no hay nada que recordarle. `reason` indica el motivo: `answered` (el cliente respondió), `cancelled`, `expired`, `closed` (el caso se resolvió después de enviarse la solicitud, aunque se haya reabierto desde entonces), `not_actionable` (una actualización de revisión en curso no pide nada), `not_delivered` (el primer correo aún no se ha enviado) o `contact_unavailable` (el correo electrónico verificado ya no está disponible).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "case_request_not_waiting" ] }, "reason": { "type": "string", "enum": [ "answered", "cancelled", "expired", "closed", "not_actionable", "not_delivered", "contact_unavailable" ] } } }, "example": { "detail": "This request no longer waits on the customer, so there is nothing to remind them of.", "code": "case_request_not_waiting", "reason": "answered" } } } }, "429": { "description": "Ya se envió un recordatorio de la solicitud en las últimas 24 horas. `retry_at` y el encabezado `Retry-After` indican cuándo puedes volver a enviarlo.", "headers": { "Retry-After": { "description": "Segundos que debes esperar antes de poder volver a enviar un recordatorio de esta solicitud.", "schema": { "type": "integer", "minimum": 1, "example": 3600 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "case_request_reminder_too_soon" ] }, "retry_at": { "type": "string", "format": "date-time" } } }, "example": { "detail": "This request was already reminded in the last 24 hours.", "code": "case_request_reminder_too_soon", "retry_at": "2026-10-15T10:30:00Z" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-didit-sdk": { "resource": "cases.requests", "method": "remind", "auth": "api_key", "server": true, "scope": "application" } } }, "/v3/session/{sessionId}/decision-email-preview/": { "post": { "summary": "Vista previa del correo electrónico de decisión de una sesión", "description": "Genera el correo electrónico que recibe la persona cuando cambias una sesión a `Approved` o `Declined` con `send_email: true`, sin modificar la sesión ni enviar nada. La respuesta muestra el asunto y el HTML exactamente como se envían, el destinatario, el remitente, el idioma y si al confirmar el cambio se envía o no el correo (`will_be_sent`, `not_sent_reason`).\n\nEl destinatario es la dirección de la propia persona: la que verificó en un paso de verificación de correo electrónico del flujo o, si no la hay, la indicada en `contact_details` al crear la sesión. El remitente es el dominio de remitente verificado de tu aplicación cuando se aplica marca blanca (`sender_kind: customer`) o, en caso contrario, el remitente de Didit (`sender_kind: didit`).\n\nPara enviar exactamente lo que has previsualizado, llama a [Actualizar el estado de la sesión](/es/sessions-api/update-status) con el mismo `new_status`, `send_email: true`, `email_address` con el valor de `recipient`, `email_language` con el valor de `language` y `email_preview_token` con el valor de `preview_token`. El comprobante expira a los 15 minutos. Si el destinatario, el idioma, el estado de la sesión, el remitente o el correo han cambiado desde la vista previa, la actualización devuelve `409` antes de que cambie nada; vuelve a generar la vista previa y confirma con el nuevo comprobante.\n\nFunciona con sesiones de Verificación de usuarios (KYC) y Verificación de empresas (KYB) en estado `Approved`, `Declined`, `In Review`, `Kyc Expired`, `Abandoned` o `Resubmitted`. La comprobación del estado se ejecuta antes de validar el cuerpo. Requiere el privilegio `write:sessions`; una clave de API con alcance limitado necesita acceso de escritura a las decisiones. Las respuestas usan `Cache-Control: no-store`: trátalas como contenido de verificación sensible.", "operationId": "post_v3_session_decision_email_preview", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sesión de verificación. Acepta ID de sesión tanto de usuario (KYC) como de empresa (KYB).", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "new_status" ], "properties": { "new_status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "La decisión cuyo correo electrónico quieres previsualizar.", "example": "Approved" }, "email_language": { "type": "string", "default": "en", "description": "Idioma del correo electrónico, con el mismo valor predeterminado que Update Session Status. Un idioma que no se ofrece pasa a inglés; `language` en la respuesta indica cuál se usa.", "example": "en" } } }, "examples": { "Approved": { "summary": "Vista previa del correo electrónico de aprobación en inglés", "value": { "new_status": "Approved" } }, "Declined in Spanish": { "summary": "Vista previa del correo electrónico de rechazo en español", "value": { "new_status": "Declined", "email_language": "es" } } } } } }, "responses": { "200": { "description": "Solo vista previa. La sesión no cambia y no se envía ningún correo electrónico.", "headers": { "Cache-Control": { "description": "Siempre `no-store`: la vista previa contiene contenido de verificación y no debe almacenarse en caché.", "schema": { "type": "string", "example": "no-store" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "recipient", "recipient_source", "sender", "sender_name", "sender_email", "sender_kind", "subject", "html", "text", "language", "will_be_sent", "not_sent_reason", "preview_token" ], "properties": { "recipient": { "type": "string", "description": "La dirección a la que va el correo electrónico. Es una cadena vacía cuando no se conoce ninguna dirección de la persona: en ese caso no se puede enviar ningún correo y `preview_token` también está vacío. Pásala como `email_address` al confirmar.", "example": "person@example.com" }, "recipient_source": { "type": "string", "enum": [ "email_verification", "contact_details", "" ], "description": "De dónde procede `recipient`. `email_verification`: la dirección que la persona verificó en un paso de verificación de correo electrónico del flujo. `contact_details`: la dirección indicada en `contact_details` al crear la sesión. Una cadena vacía cuando no hay dirección.", "example": "email_verification" }, "sender": { "type": "string", "description": "El encabezado `From` con el que se envía el correo electrónico.", "example": "Example App " }, "sender_name": { "type": "string", "description": "La parte del nombre visible de `sender`.", "example": "Example App" }, "sender_email": { "type": "string", "format": "email", "description": "La parte de dirección de `sender`.", "example": "no-reply@mail.example.com" }, "sender_kind": { "type": "string", "enum": [ "customer", "didit" ], "description": "`customer`: el correo electrónico se envía desde el dominio de remitente verificado de tu aplicación (marca blanca). `didit`: se envía desde el remitente propio de Didit.", "example": "customer" }, "subject": { "type": "string", "description": "La línea de asunto exactamente como se envía.", "example": "Your verification has been approved in Example App" }, "html": { "type": "string", "description": "El HTML del correo electrónico exactamente como se envía, con su logotipo incrustado como data URL. Renderízalo en un frame aislado (sandbox), nunca directamente en el DOM de tu aplicación.", "example": "..." }, "text": { "type": "string", "description": "El texto del correo electrónico en texto plano, tal como lo conserva el hilo de Mensajes de la persona, para una vista previa compacta (el HTML sigue siendo el correo electrónico que recibe la persona).", "example": "Verification Approved\n\nYour identity has been successfully verified with Acme Pay. No further action is needed on your part." }, "language": { "type": "string", "description": "El idioma en el que está escrito el correo. Inglés (`en`) cuando el `email_language` que pediste no está disponible.", "example": "en" }, "will_be_sent": { "type": "boolean", "description": "Indica si confirmar el cambio con `send_email: true` envía este correo electrónico. `false` cuando `not_sent_reason` está definido.", "example": true }, "not_sent_reason": { "type": "string", "nullable": true, "enum": [ "status_unchanged", "notification_emails_disabled", "no_recipient", "sandbox", null ], "description": "Por qué la confirmación no enviaría ningún correo electrónico, o `null` cuando se enviará. `status_unchanged`: la sesión ya tiene este estado, así que la actualización no cambia nada y no envía nada. `notification_emails_disabled`: la sesión se creó sin `contact_details.send_notification_emails: true`, así que no se envía ningún correo de decisión a la dirección indicada en `contact_details`. `no_recipient`: no se conoce ninguna dirección de la persona. `sandbox`: una sesión de sandbox cuyo destinatario no ha aceptado la entrega de correos en sandbox, así que el envío solo se simula.", "example": null }, "preview_token": { "type": "string", "description": "Recibo firmado para este correo electrónico exacto, válido durante 15 minutos. Pásalo como `email_preview_token` a [Actualizar el estado de la sesión](/es/sessions-api/update-status). Una cadena vacía cuando no hay destinatario.", "example": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } } }, "examples": { "Will Be Sent": { "summary": "El correo electrónico de Aprobado se envía a la dirección verificada en el flujo", "value": { "recipient": "person@example.com", "recipient_source": "email_verification", "sender": "Example App ", "sender_name": "Example App", "sender_email": "no-reply@mail.example.com", "sender_kind": "customer", "subject": "Your verification has been approved in Example App", "html": "...", "language": "en", "will_be_sent": true, "not_sent_reason": null, "preview_token": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } }, "No Recipient": { "summary": "No se conoce ninguna dirección de la persona", "value": { "recipient": "", "recipient_source": "", "sender": "Example App ", "sender_name": "Example App", "sender_email": "no-reply@mail.example.com", "sender_kind": "customer", "subject": "Your verification has been declined in Example App", "html": "...", "language": "en", "will_be_sent": false, "not_sent_reason": "no_recipient", "preview_token": "" } } } } } }, "400": { "description": "La sesión no está en un estado que este endpoint acepte (`{\"detail\": ...}`), o el cuerpo no es válido (`{\"\": [\"\"]}`).", "content": { "application/json": { "examples": { "Wrong Current Status": { "summary": "La sesión no está en un estado que este endpoint acepte", "value": { "detail": "Only sessions with status Approved, Declined, In Review, Kyc Expired, Abandoned, Resubmitted can be updated. Current status: In Progress" } }, "Invalid new_status": { "summary": "new_status no es Approved ni Declined", "value": { "new_status": [ "\"Resubmitted\" is not a valid choice." ] } }, "Missing new_status": { "summary": "Campo obligatorio omitido", "value": { "new_status": [ "This field is required." ] } } } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Clave de API con alcance limitado con la fecha de caducidad vencida", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Faltan las credenciales, quien llama no tiene el privilegio `write:sessions`, una clave de API con alcance limitado no tiene el acceso que necesita este endpoint, o el `session_id` pertenece a otra aplicación.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente o no válido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "El autor de la llamada no tiene write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Clave de API con alcance limitado sin este acceso", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "No existe ninguna sesión KYC o KYB con este `session_id`.", "content": { "application/json": { "examples": { "Not Found": { "summary": "session_id desconocido", "value": { "detail": "Not found." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/decision-email-preview/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"new_status\": \"Approved\", \"email_language\": \"en\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.preview_decision_email(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n new_status=\"Approved\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.previewDecisionEmail(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", {\n new_status: \"Approved\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.PreviewDecisionEmail(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", didit.SessionsPreviewDecisionEmailParams{\n\tNewStatus: \"Approved\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsPreviewDecisionEmailParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().previewDecisionEmail(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", SessionsPreviewDecisionEmailParams.builder()\n .newStatus(SessionsPreviewDecisionEmailParams.NewStatus.of(\"Approved\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->previewDecisionEmail('3fa85f64-5717-4562-b3fc-2c963f66afa6', [\n 'new_status' => 'Approved',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.preview_decision_email(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n new_status: \"Approved\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.PreviewDecisionEmailAsync(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", new SessionsPreviewDecisionEmailParams\n{\n NewStatus = \"Approved\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-sdk": { "resource": "sessions", "method": "preview_decision_email", "auth": "api_key", "server": true } } }, "/v3/travel-rule/join/{token}/": { "get": { "summary": "Obtener una invitación de acceso libre", "description": "Público, sin autenticación. Muestra la invitación a la que corresponde un enlace para unirse mientras está abierta: quién la solicitó, la dirección a la que se envió y los valores del directorio que se rellenarán previamente. El token es la autenticación.", "operationId": "getTravelRuleJoinInvitation", "x-didit-sdk": { "resource": "travel_rule.join", "method": "get_invitation", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "description": "El token de invitación del enlace para unirse." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl https://verification.didit.me/v3/travel-rule/join/{token}/" } ], "responses": { "200": { "description": "La invitación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleJoinInvitation" } } } }, "404": { "description": "Ninguna invitación tiene este enlace." }, "410": { "description": "La invitación ya no está abierta: expiró, ya se usó o se retiró." } } }, "post": { "summary": "Registrar una cuenta gratuita de Travel Rule", "description": "Público, sin autenticación. Crea una cuenta gratuita de Travel Rule para una VASP contraparte que recibió una solicitud. El correo electrónico debe ser la dirección a la que se envió la invitación. Se envía a esa dirección un código de 6 caracteres; envíalo al endpoint de verificación para terminar. Los intentos de registro tienen un límite de solicitudes por dirección y por IP.", "operationId": "registerTravelRuleJoin", "x-didit-sdk": { "resource": "travel_rule.join", "method": "register", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "description": "El token de invitación del enlace para unirse." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleJoinRegisterRequest" }, "example": { "email": "compliance@example.com", "password": "a-long-passphrase" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/join/{token}/ \\\n -H 'Content-Type: application/json' \\\n -d '{\"email\": \"compliance@example.com\", \"password\": \"a-long-passphrase\"}'" } ], "responses": { "202": { "description": "Se creó la cuenta y se envió un código por correo electrónico.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Indica a la contraparte que revise su correo electrónico para obtener el código de verificación." }, "email": { "type": "string", "format": "email", "description": "La dirección a la que se envió el código." } } } } } }, "400": { "description": "El correo electrónico no es la dirección invitada, o se rechazó la contraseña o la dirección." }, "404": { "description": "Ninguna invitación tiene este enlace." }, "410": { "description": "La invitación ya no está abierta: expiró, ya se usó o se retiró." }, "429": { "description": "Demasiados intentos de unirse. Los encabezados `X-RateLimit-*` indican el cupo que se agotó." } } } }, "/v3/travel-rule/join/{token}/verify/": { "post": { "summary": "Verificar una cuenta gratuita de Travel Rule", "description": "Público, sin autenticación. Consume el código enviado por correo electrónico, crea la organización gratuita y responde con las credenciales que su aplicación usa en los endpoints del espacio de trabajo. Recibir datos de Travel Rule es gratuito.", "operationId": "verifyTravelRuleJoin", "x-didit-sdk": { "resource": "travel_rule.join", "method": "verify", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "description": "El token de invitación del enlace para unirse." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleJoinVerifyRequest" }, "example": { "email": "compliance@example.com", "code": "123456" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/join/{token}/verify/ \\\n -H 'Content-Type: application/json' \\\n -d '{\"email\": \"compliance@example.com\", \"code\": \"123456\"}'" } ], "responses": { "201": { "description": "Las credenciales de la organización y de la aplicación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleJoinCredentials" } } } }, "400": { "description": "Se rechazó el código o el correo electrónico." }, "404": { "description": "Ninguna invitación tiene este enlace." }, "410": { "description": "La invitación ya no está abierta: expiró, ya se usó o se retiró." }, "429": { "description": "Demasiados intentos de unirse. Los encabezados `X-RateLimit-*` indican el cupo que se agotó." } } } }, "/v3/travel-rule/workspace/": { "get": { "summary": "Obtener el espacio de trabajo gratuito de Travel Rule", "description": "Lee el espacio de trabajo gratuito de una aplicación que se unió de forma gratuita: reclamación en el directorio, prueba de dominio, facturación y presencia en el listado de la red de Didit.", "operationId": "getTravelRuleWorkspace", "x-didit-sdk": { "resource": "travel_rule.workspace", "method": "get", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/workspace/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.get()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.workspace.get();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.Workspace.Get(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().get();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->workspace->get();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.workspace.get\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.GetAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "El espacio de trabajo.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "404": { "description": "Esta aplicación no se unió de forma gratuita, por lo que no tiene un espacio de trabajo gratuito." } } } }, "/v3/travel-rule/workspace/claim/": { "post": { "summary": "Reclamar una entrada del directorio", "description": "Reclama la entrada del directorio que corresponde a este espacio de trabajo. Cuando el correo electrónico corporativo pertenece a un dominio que figura en la entrada, la reclamación queda demostrada y se aplica de inmediato: el perfil de VASP y la configuración de Travel Rule se completan a partir de la entrada y Travel Rule se activa, de modo que la siguiente transferencia a esa entidad se enruta a través de la red de Didit. En caso contrario, la reclamación queda pendiente de revisión (`pending_review`).", "operationId": "claimTravelRuleWorkspace", "x-didit-sdk": { "resource": "travel_rule.workspace", "method": "claim", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspaceClaimRequest" }, "example": { "vasp_id": "0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/workspace/claim/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"vasp_id\": \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.claim(\n vasp_id=\"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.workspace.claim({\n vasp_id: \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.Workspace.Claim(ctx, didit.TravelRuleWorkspaceClaimRequest{\n\tVASPID: \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleWorkspaceClaimRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().claim(TravelRuleWorkspaceClaimRequest.builder()\n .vaspId(\"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->workspace->claim([\n 'vasp_id' => '0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.workspace.claim(vasp_id: \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.ClaimAsync(new TravelRuleWorkspaceClaimRequest\n{\n VaspId = \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "El espacio de trabajo con su estado de reclamación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "Ninguna entrada del directorio tiene este id." }, "404": { "description": "Esta aplicación no se unió de forma gratuita, por lo que no tiene un espacio de trabajo gratuito." } } } }, "/v3/travel-rule/workspace/domain/code/": { "post": { "summary": "Enviar por correo electrónico un código de verificación de dominio", "description": "Envía por correo electrónico un código de un solo uso a la dirección de trabajo del espacio de trabajo para demostrar que controla el dominio de correo. Tiene límite de frecuencia y se acepta un número limitado de intentos fallidos por código. También devuelve el registro TXT para la alternativa por DNS.", "operationId": "sendTravelRuleWorkspaceDomainCode", "x-didit-sdk": { "resource": "travel_rule.workspace", "method": "send_domain_code", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/workspace/domain/code/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.send_domain_code()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.workspace.sendDomainCode();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.Workspace.SendDomainCode(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().sendDomainCode();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->workspace->sendDomainCode();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.workspace.send_domain_code\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.SendDomainCodeAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "El dominio, su estado y el registro TXT.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspaceDomainCodeResponse" } } } }, "404": { "description": "Esta aplicación no se unió de forma gratuita, por lo que no tiene un espacio de trabajo gratuito." } } } }, "/v3/travel-rule/workspace/domain/confirm/": { "post": { "summary": "Confirmar el código de verificación del dominio", "description": "Consume el código enviado por correo electrónico y marca el dominio de correo como verificado.", "operationId": "confirmTravelRuleWorkspaceDomain", "x-didit-sdk": { "resource": "travel_rule.workspace", "method": "confirm_domain", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspaceDomainConfirmRequest" }, "example": { "code": "123456" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/workspace/domain/confirm/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"code\": \"123456\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.confirm_domain(\n code=\"123456\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.workspace.confirmDomain({\n code: \"123456\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.Workspace.ConfirmDomain(ctx, didit.TravelRuleWorkspaceDomainConfirmRequest{\n\tCode: \"123456\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleWorkspaceDomainConfirmRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().confirmDomain(TravelRuleWorkspaceDomainConfirmRequest.builder()\n .code(\"123456\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->workspace->confirmDomain([\n 'code' => '123456',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.workspace.confirm_domain(code: \"123456\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.ConfirmDomainAsync(new TravelRuleWorkspaceDomainConfirmRequest\n{\n Code = \"123456\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "El espacio de trabajo.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "El código es incorrecto, ha expirado o ya se ha usado." }, "404": { "description": "Esta aplicación no se unió de forma gratuita, por lo que no tiene un espacio de trabajo gratuito." } } } }, "/v3/travel-rule/workspace/domain/dns/": { "post": { "summary": "Verificar el dominio a partir de su registro TXT", "description": "Busca el registro TXT `didit-tr-verify.` que devuelve el endpoint del código y marca el dominio como verificado cuando coincide. Basta con una de las dos pruebas: el código enviado por correo electrónico o el registro TXT.", "operationId": "verifyTravelRuleWorkspaceDomainDns", "x-didit-sdk": { "resource": "travel_rule.workspace", "method": "verify_domain_dns", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/workspace/domain/dns/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.verify_domain_dns()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.workspace.verifyDomainDns();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.Workspace.VerifyDomainDNS(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().verifyDomainDns();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->workspace->verifyDomainDns();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.workspace.verify_domain_dns\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.VerifyDomainDnsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "El espacio de trabajo.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "No se encontró el registro TXT o no coincide." }, "404": { "description": "Esta aplicación no se unió de forma gratuita, por lo que no tiene un espacio de trabajo gratuito." } } } }, "/v3/travel-rule/workspace/billing/": { "post": { "summary": "Activar la facturación saliente", "description": "Activa la facturación de Travel Rule saliente para el espacio de trabajo. La recepción sigue siendo gratuita. No se puede volver a desactivar a través de la API: contacta con el soporte de Didit.", "operationId": "enableTravelRuleWorkspaceBilling", "x-didit-sdk": { "resource": "travel_rule.workspace", "method": "enable_billing", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspaceBillingRequest" }, "example": { "enabled": true } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/workspace/billing/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"enabled\": true}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.enable_billing(\n enabled=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.workspace.enableBilling({\n enabled: true,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.Workspace.EnableBilling(ctx, didit.TravelRuleWorkspaceBillingRequest{\n\tEnabled: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleWorkspaceBillingRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().enableBilling(TravelRuleWorkspaceBillingRequest.builder()\n .enabled(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->workspace->enableBilling([\n 'enabled' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.workspace.enable_billing(enabled: true)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.EnableBillingAsync(new TravelRuleWorkspaceBillingRequest\n{\n Enabled = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "El espacio de trabajo con `billing_enabled` en true.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "`enabled` era false." }, "404": { "description": "Esta aplicación no se unió de forma gratuita, por lo que no tiene un espacio de trabajo gratuito." } } } }, "/v3/investigator/summary/": { "get": { "operationId": "investigator_summary", "summary": "Resumen del investigador", "description": "Etapa, recuentos de cada cola, informes preparados y decididos hoy, concordancia a 30 días, precios y nivel de autonomía de cada cola. Las claves restringidas necesitan el alcance `decisions` (lectura); las alertas de transacciones también necesitan `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "stage": { "type": "string" }, "last_report_at": { "type": "string", "format": "date-time", "nullable": true }, "prepared_today": { "type": "integer" }, "ready_to_accept": { "type": "integer" }, "open": { "type": "integer" }, "decided_today": { "type": "integer" }, "automation_rate_month": { "type": "number", "nullable": true }, "preparing": { "type": "integer" } } } } } }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "La clave no tiene el alcance necesario, el tipo de elemento no se puede leer o el plan no incluye el Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sesiones y casos que no abrió una regla de transacciones) o `transactions` (alertas de transacciones y casos que abrió una regla de transacciones)." }, { "in": "query", "name": "timezone", "schema": { "type": "string" }, "description": "Zona horaria IANA (por ejemplo, `Europe/Madrid`) desde la que se cuenta \"hoy\". UTC por defecto." } ], "x-didit-sdk": { "resource": "investigator", "method": "retrieve_summary", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.retrieve_summary()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.retrieveSummary();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.RetrieveSummary(ctx, didit.InvestigatorRetrieveSummaryParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().retrieveSummary();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->retrieveSummary();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.retrieve_summary\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.RetrieveSummaryAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/queue/": { "get": { "operationId": "investigator_queue", "summary": "Listar la cola del Investigator", "description": "Informes abiertos, primero los **Ready to accept** y luego por fecha límite, riesgo y tiempo de espera. `counts` abarca todos los tipos dentro del alcance. `count` tiene un máximo de 100. Las claves restringidas necesitan el alcance `decisions` (lectura); las alertas de transacciones también necesitan `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "counts": { "type": "object", "additionalProperties": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InvestigatorQueueRow" } } } } } } }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "La clave no tiene el alcance necesario, el tipo de elemento no se puede leer o el plan no incluye el Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sesiones y casos que no abrió una regla de transacciones) o `transactions` (alertas de transacciones y casos que abrió una regla de transacciones)." }, { "in": "query", "name": "kind", "schema": { "type": "string" }, "description": "`session`, `business_session`, `transaction` o `case`, o varios separados por comas." }, { "in": "query", "name": "queue", "schema": { "type": "string", "enum": [ "kyc", "kyb", "aml", "transactions", "cases" ] } }, { "in": "query", "name": "recommendation", "schema": { "type": "string", "enum": [ "approve", "decline", "escalate", "request" ] } }, { "in": "query", "name": "confidence", "schema": { "type": "string", "enum": [ "high", "moderate", "low" ] } }, { "in": "query", "name": "ready", "schema": { "type": "boolean" } }, { "in": "query", "name": "search", "schema": { "type": "string" }, "description": "Nombre, empresa, título del caso, número, ID de transacción o ID del elemento." }, { "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "x-didit-sdk": { "resource": "investigator", "method": "list_queue", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.investigator.list_queue():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.investigator.listQueue()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Investigator.ListQueueAutoPaging(ctx, didit.InvestigatorListQueueParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.investigator().listQueue()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "investigator->listQueue() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.investigator.list_queue.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Investigator.ListQueueAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/investigator/runs/{run_id}/": { "get": { "operationId": "investigator_run_retrieve", "summary": "Obtener un informe de Investigator", "description": "El informe completo de una ejecución. Devuelve 404 cuando la ejecución no tiene un informe completado o su elemento se eliminó. Las claves restringidas necesitan el ámbito `decisions` (lectura); las alertas de transacciones también necesitan `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorRunDetail" } } } }, "404": { "description": "No se encontró o no hay informe." }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "La clave no tiene el alcance necesario, el tipo de elemento no se puede leer o el plan no incluye el Investigator." } }, "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "x-didit-sdk": { "resource": "investigator", "method": "retrieve_run", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.retrieve_run(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.retrieveRun(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.RetrieveRun(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().retrieveRun(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->retrieveRun('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.retrieve_run(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.RetrieveRunAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/runs/{run_id}/accept/": { "post": { "operationId": "investigator_run_accept", "summary": "Aceptar una recomendación", "description": "Aplica la acción recomendada por la vía normal del elemento, por lo que se disparan tus webhooks habituales. Un `narrative` la marca como editada y aceptada. Las claves restringidas necesitan el ámbito `decisions` (escritura); las alertas de transacciones también necesitan `transactions` (escritura). Escalar una verificación o una transacción abre un caso.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorDecision" } } } }, "409": { "description": "Ya se tomó una decisión, el informe no está listo o una salvaguarda retiene el elemento." }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "La clave no tiene el alcance necesario, el tipo de elemento no se puede leer o el plan no incluye el Investigator." } }, "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorAcceptRequest" }, "example": { "send_email": false } } } }, "x-didit-sdk": { "resource": "investigator", "method": "accept_run", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.accept_run(\n \"11111111-2222-3333-4444-555555555555\",\n send_email=False,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.acceptRun(\"11111111-2222-3333-4444-555555555555\", {\n send_email: false,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.AcceptRun(ctx, \"11111111-2222-3333-4444-555555555555\", didit.InvestigatorAcceptRequest{\n\tSendEmail: didit.Bool(false),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.InvestigatorAcceptRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().acceptRun(\"11111111-2222-3333-4444-555555555555\", InvestigatorAcceptRequest.builder()\n .sendEmail(false)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->acceptRun('11111111-2222-3333-4444-555555555555', [\n 'send_email' => false,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.accept_run(\n \"11111111-2222-3333-4444-555555555555\",\n send_email: false\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.AcceptRunAsync(\"11111111-2222-3333-4444-555555555555\", new InvestigatorAcceptRequest\n{\n SendEmail = false,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/runs/{run_id}/override/": { "post": { "operationId": "investigator_run_override", "summary": "Anular una recomendación", "description": "Toma otra acción con una categoría y un motivo. También anula una decisión que el Investigator tomó por su cuenta mientras siga vigente. Las claves restringidas necesitan el alcance `decisions` (escritura); las alertas de transacciones también necesitan `transactions` (escritura). Escalar una verificación o una transacción abre un caso.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorDecision" } } } }, "409": { "description": "Ya se tomó una decisión, o una salvaguarda retiene el elemento." }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "La clave no tiene el alcance necesario, el tipo de elemento no se puede leer o el plan no incluye el Investigator." } }, "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorOverrideRequest" }, "example": { "action": "decline", "category": "evidence_misread", "reason": "The proof of address is older than three months." } } } }, "x-didit-sdk": { "resource": "investigator", "method": "override_run", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.override_run(\n \"11111111-2222-3333-4444-555555555555\",\n action=\"decline\",\n category=\"evidence_misread\",\n reason=\"The proof of address is older than three months.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.overrideRun(\"11111111-2222-3333-4444-555555555555\", {\n action: \"decline\",\n category: \"evidence_misread\",\n reason: \"The proof of address is older than three months.\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.OverrideRun(ctx, \"11111111-2222-3333-4444-555555555555\", didit.InvestigatorOverrideRequest{\n\tAction: \"decline\",\n\tCategory: \"evidence_misread\",\n\tReason: \"The proof of address is older than three months.\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.InvestigatorOverrideRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().overrideRun(\"11111111-2222-3333-4444-555555555555\", InvestigatorOverrideRequest.builder()\n .action(InvestigatorOverrideRequest.Action.of(\"decline\"))\n .category(InvestigatorOverrideRequest.Category.of(\"evidence_misread\"))\n .reason(\"The proof of address is older than three months.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->overrideRun('11111111-2222-3333-4444-555555555555', [\n 'action' => 'decline',\n 'category' => 'evidence_misread',\n 'reason' => 'The proof of address is older than three months.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.override_run(\n \"11111111-2222-3333-4444-555555555555\",\n action: \"decline\",\n category: \"evidence_misread\",\n reason: \"The proof of address is older than three months.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.OverrideRunAsync(\"11111111-2222-3333-4444-555555555555\", new InvestigatorOverrideRequest\n{\n Action = \"decline\",\n Category = \"evidence_misread\",\n Reason = \"The proof of address is older than three months.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/runs/batch-accept/": { "post": { "operationId": "investigator_batch_accept", "summary": "Aceptar recomendaciones en lote", "description": "Acepta hasta 50 informes marcados como Listo para aceptar. Cada uno es una decisión independiente: el que no se pueda aceptar se omite indicando el motivo. Las claves restringidas necesitan el alcance `decisions` (escritura); las alertas de transacciones también necesitan `transactions` (escritura). Escalar una verificación o una transacción abre un caso.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorBatchAcceptResponse" } } } }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "La clave no tiene el alcance necesario, el tipo de elemento no se puede leer o el plan no incluye el Investigator." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorBatchAcceptRequest" } } } }, "x-didit-sdk": { "resource": "investigator", "method": "batch_accept_runs", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.batch_accept_runs(\n run_ids=[\"11111111-2222-3333-4444-555555555555\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.batchAcceptRuns({\n run_ids: [\"11111111-2222-3333-4444-555555555555\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.BatchAcceptRuns(ctx, didit.InvestigatorBatchAcceptRequest{\n\tRunIDs: []string{\"11111111-2222-3333-4444-555555555555\"},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.InvestigatorBatchAcceptRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().batchAcceptRuns(InvestigatorBatchAcceptRequest.builder()\n .runIds(List.of(\"11111111-2222-3333-4444-555555555555\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->batchAcceptRuns([\n 'run_ids' => ['11111111-2222-3333-4444-555555555555'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.batch_accept_runs(run_ids: [\"11111111-2222-3333-4444-555555555555\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.BatchAcceptRunsAsync(new InvestigatorBatchAcceptRequest\n{\n RunIds = new string[] { \"11111111-2222-3333-4444-555555555555\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/transactions/{transaction_id}/": { "get": { "operationId": "investigator_transaction_retrieve", "summary": "Obtener la revisión de Investigator de una transacción", "description": "La revisión más reciente de la transacción, o `investigator: null` cuando nunca tuvo ninguna. Las claves restringidas necesitan los ámbitos `decisions` y `transactions` (lectura).", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "transaction_id": { "type": "string", "format": "uuid" }, "investigator": { "$ref": "#/components/schemas/InvestigatorBlock" } } } } } }, "404": { "description": "No es una transacción de esta aplicación." }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "La clave no tiene el alcance necesario, el tipo de elemento no se puede leer o el plan no incluye el Investigator." } }, "parameters": [ { "in": "path", "name": "transaction_id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "x-didit-sdk": { "resource": "investigator", "method": "retrieve_transaction", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.retrieve_transaction(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.retrieveTransaction(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.RetrieveTransaction(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().retrieveTransaction(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->retrieveTransaction('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.retrieve_transaction(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.RetrieveTransactionAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/guardrails/": { "get": { "operationId": "investigator_guardrails", "summary": "Listar las salvaguardas bloqueadas", "description": "Las cinco salvaguardas que se aplican a todas las colas. No se pueden desactivar. Las claves restringidas necesitan el ámbito `decisions` (lectura); las alertas de transacciones también necesitan `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "sanctions_to_person", "no_tipping_off", "no_protected_characteristics", "never_files_reports", "every_decision_logged" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "locked": { "type": "boolean" } } } } } } } } }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "La clave no tiene el alcance necesario, el tipo de elemento no se puede leer o el plan no incluye el Investigator." } }, "x-didit-sdk": { "resource": "investigator", "method": "list_guardrails", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.list_guardrails()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.listGuardrails();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.ListGuardrails(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().listGuardrails();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->listGuardrails();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.list_guardrails\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.ListGuardrailsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/dashboard/": { "get": { "operationId": "investigator_dashboard", "summary": "Panel del investigador", "description": "Los últimos 30 días: revisiones, decisiones, tasa de automatización, horas ahorradas, gasto, anulaciones, muestras de calidad desde la puesta en producción, y cifras por cola y por semana. Las claves restringidas necesitan el alcance `decisions` (lectura); las alertas de transacciones también necesitan `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "stage": { "type": "string" }, "window_days": { "type": "integer" }, "reviews": { "type": "integer" }, "decided": { "type": "integer" }, "automated": { "type": "integer" }, "automation_rate": { "type": "number", "nullable": true }, "hours_saved": { "type": "number", "nullable": true } } } } } }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "La clave no tiene el alcance necesario, el tipo de elemento no se puede leer o el plan no incluye el Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sesiones y casos que no abrió una regla de transacciones) o `transactions` (alertas de transacciones y casos que abrió una regla de transacciones)." } ], "x-didit-sdk": { "resource": "investigator", "method": "retrieve_dashboard", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.retrieve_dashboard()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.retrieveDashboard();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.RetrieveDashboard(ctx, didit.InvestigatorRetrieveDashboardParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().retrieveDashboard();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->retrieveDashboard();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.retrieve_dashboard\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.RetrieveDashboardAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/performance/": { "get": { "operationId": "investigator_performance", "summary": "Rendimiento del investigador", "description": "Concordancia con tu equipo, volumen, tiempo ahorrado, calibración de la confianza, resultados por cola, motivos de anulación y desacuerdos durante un periodo. Las claves restringidas requieren el ámbito `decisions` (lectura); las alertas de transacciones también requieren `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "period": { "type": "integer" }, "start": { "type": "string", "format": "date" }, "end": { "type": "string", "format": "date" }, "investigated": { "type": "integer" } } } } } }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "La clave no tiene el alcance necesario, el tipo de elemento no se puede leer o el plan no incluye el Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sesiones y casos que no abrió una regla de transacciones) o `transactions` (alertas de transacciones y casos que abrió una regla de transacciones)." }, { "in": "query", "name": "period", "schema": { "type": "string", "enum": [ "7", "30", "90" ], "default": "30" }, "description": "Días, hasta hoy inclusive." } ], "x-didit-sdk": { "resource": "investigator", "method": "retrieve_performance", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.retrieve_performance()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.retrievePerformance();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.RetrievePerformance(ctx, didit.InvestigatorRetrievePerformanceParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().retrievePerformance();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->retrievePerformance();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.retrieve_performance\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.RetrievePerformanceAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/activity/": { "get": { "operationId": "investigator_activity", "summary": "Listar la actividad de Investigator", "description": "El registro de auditoría de solo anexado, del más reciente al más antiguo. Una aceptación por lotes es una sola entrada. Añade `counts` por grupo y `actors`. Las claves restringidas necesitan el ámbito `decisions` (lectura); las alertas de transacciones también necesitan `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "counts": { "type": "object", "additionalProperties": true }, "actors": { "type": "array", "items": {} }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true, "description": "`id`, `at`, `kind`, `group`, `queue`, `run_id`, `item`, `actor`, `agent_version`, `data`, `report_version`, `steps`, `sources`, `batch`." } } } } } } }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "La clave no tiene el alcance necesario, el tipo de elemento no se puede leer o el plan no incluye el Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sesiones y casos que no abrió una regla de transacciones) o `transactions` (alertas de transacciones y casos que abrió una regla de transacciones)." }, { "in": "query", "name": "group", "schema": { "type": "string", "enum": [ "agent", "decisions", "overrides", "autonomy" ] } }, { "in": "query", "name": "actor", "schema": { "type": "string" }, "description": "`agent` para el Investigator, o el correo electrónico de una persona." }, { "in": "query", "name": "since", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "until", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "x-didit-sdk": { "resource": "investigator", "method": "list_activity", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.investigator.list_activity():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.investigator.listActivity()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Investigator.ListActivityAutoPaging(ctx, didit.InvestigatorListActivityParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.investigator().listActivity()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "investigator->listActivity() as $item) {\n print_r($item);\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.investigator.list_activity.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Investigator.ListActivityAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/investigator/activity/export/": { "get": { "operationId": "investigator_activity_export", "summary": "Exportar la actividad de Investigator", "description": "Las mismas entradas en CSV, una fila por decisión, de la más reciente a la más antigua, hasta 10,000 entradas. Las claves restringidas necesitan el alcance `decisions` (lectura); las alertas de transacciones también necesitan `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "text/csv": { "schema": { "type": "string" } } } }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "La clave no tiene el alcance necesario, el tipo de elemento no se puede leer o el plan no incluye el Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sesiones y casos que no abrió una regla de transacciones) o `transactions` (alertas de transacciones y casos que abrió una regla de transacciones)." }, { "in": "query", "name": "group", "schema": { "type": "string", "enum": [ "agent", "decisions", "overrides", "autonomy" ] } }, { "in": "query", "name": "actor", "schema": { "type": "string" }, "description": "`agent` para el Investigator, o el correo electrónico de una persona." }, { "in": "query", "name": "since", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "until", "schema": { "type": "string", "format": "date-time" } } ], "x-didit-sdk": { "resource": "investigator", "method": "export_activity", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.investigator.export_activity()\nwith open(\"download.csv\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.investigator.exportActivity();\nawait writeFile(\"download.csv\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Investigator.ExportActivity(ctx, didit.InvestigatorExportActivityParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.csv\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.investigator().exportActivity()\n .writeTo(Path.of(\"download.csv\"));" }, { "lang": "php", "label": "PHP", "source": "investigator->exportActivity();\n$content->saveTo('download.csv');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.investigator.export_activity\nFile.binwrite(\"download.csv\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Investigator.ExportActivityAsync();\nawait content.SaveToAsync(\"download.csv\");" } ] } }, "/v3/investigator/settings/": { "get": { "operationId": "investigator_settings_retrieve", "summary": "Obtener la configuración de Investigator", "description": "La etapa (`none`, `shadow` o `live`) y el límite de gasto mensual junto con el gasto de este mes. Las claves restringidas necesitan el alcance `applications` (lectura).", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorSettings" } } } }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "La clave no tiene el alcance necesario, el tipo de elemento no se puede leer o el plan no incluye el Investigator." } }, "x-didit-sdk": { "resource": "investigator", "method": "retrieve_settings", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.retrieve_settings()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.retrieveSettings();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.RetrieveSettings(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().retrieveSettings();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->retrieveSettings();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.retrieve_settings\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.RetrieveSettingsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "patch": { "operationId": "investigator_settings_update", "summary": "Actualizar la configuración de Investigator", "description": "Cambia la etapa, el límite de gasto mensual o ambos. Pasar de `none` requiere un plan que incluya el Investigator (Growth o superior); `live` también requiere un contrato que le asigne precio, si tienes uno. Las claves restringidas necesitan el alcance `applications` (escritura).", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorSettings" } } } }, "400": { "description": "No se envió ningún campo, o el valor no es válido." }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "La clave no tiene el alcance necesario, el tipo de elemento no se puede leer o el plan no incluye el Investigator." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorSettings" }, "example": { "stage": "shadow", "monthly_spend_limit": "500.00" } } } }, "x-didit-sdk": { "resource": "investigator", "method": "update_settings", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.update_settings(\n stage=\"shadow\",\n monthly_spend_limit=\"500.00\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.updateSettings({\n stage: \"shadow\",\n monthly_spend_limit: \"500.00\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.UpdateSettings(ctx, didit.InvestigatorSettingsParam{\n\tStage: didit.Some(didit.InvestigatorSettingsStage(\"shadow\")),\n\tMonthlySpendLimit: didit.String(\"500.00\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.InvestigatorSettings;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().updateSettings(InvestigatorSettings.builder()\n .stage(InvestigatorSettings.Stage.of(\"shadow\"))\n .monthlySpendLimit(\"500.00\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->updateSettings([\n 'stage' => 'shadow',\n 'monthly_spend_limit' => '500.00',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.update_settings(\n stage: \"shadow\",\n monthly_spend_limit: \"500.00\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.UpdateSettingsAsync(new InvestigatorSettings\n{\n Stage = new InvestigatorSettingsStage(\"shadow\"),\n MonthlySpendLimit = \"500.00\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/travel-rule/wallet-addresses/import/": { "post": { "summary": "Importar direcciones de wallet de forma masiva", "description": "Añade hasta 10,000 wallets a tu libreta de direcciones de Travel Rule en una sola llamada, como JSON o como archivo CSV. Puedes enviar una wallet por su dirección, por el SHA-256 de su dirección en minúsculas (`address_hash`) para mantener la dirección privada, o por ambos. La importación es idempotente: una wallet que ya está en la libreta se indica como `existing` y no se modifica, así que puedes volver a enviar el mismo archivo. Cada fila se valida por separado, por lo que una fila incorrecta nunca hace fallar a las demás. Una wallet importada solo por su hash coincide únicamente con transferencias a esa dirección y su propiedad puede demostrarse con el widget de propiedad de wallets, como cualquier otra entrada.", "operationId": "importTravelRuleWalletAddresses", "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-didit-sdk": { "resource": "travel_rule.wallet_addresses", "method": "bulk_import", "auth": "api_key", "server": true }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "required": [ "entries" ], "properties": { "entries": { "type": "array", "minItems": 1, "maxItems": 10000, "items": { "$ref": "#/components/schemas/WalletAddressImportRow" } } } }, { "type": "array", "minItems": 1, "maxItems": 10000, "items": { "$ref": "#/components/schemas/WalletAddressImportRow" } } ] }, "example": { "entries": [ { "address": "0xBeneficiaryWallet01", "chain": "ETH", "holder_name": "Ana Diaz", "holder_vendor_data": "user-042" }, { "address_hash": "4f7d2e1c9b8a7f6e5d4c3b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f2e", "chain": "bitcoin", "holder_vendor_data": "user-043" }, { "address": "rExchangeSharedAddress01", "chain": "XRP", "memo": "104729", "holder_name": "Ana Diaz" } ] } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary", "description": "Un archivo CSV en UTF-8 de 5 MB como máximo, con una fila de encabezado que nombre sus columnas (los campos de la fila o sus alias). Las celdas vacías se consideran no enviadas; las columnas que la importación no lee se ignoran." } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl (JSON)", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/wallet-addresses/import/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"entries\": [{\"address\": \"0xBeneficiaryWallet01\", \"chain\": \"ETH\", \"holder_name\": \"Ana Diaz\"}, {\"address\": \"rExchangeSharedAddress01\", \"chain\": \"XRP\", \"memo\": \"104729\"}]}'" }, { "lang": "curl", "label": "curl (CSV)", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/wallet-addresses/import/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'file=@wallets.csv;type=text/csv'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.wallet_addresses.bulk_import(\n body={\n \"entries\": [{\n \"address\": \"0xBeneficiaryWallet01\",\n \"chain\": \"ETH\",\n \"holder_name\": \"Ana Diaz\",\n \"holder_vendor_data\": \"user-042\",\n }, {\n \"address_hash\": \"4f7d2e1c9b8a7f6e5d4c3b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f2e\",\n \"chain\": \"bitcoin\",\n \"holder_vendor_data\": \"user-043\",\n }, {\n \"address\": \"rExchangeSharedAddress01\",\n \"chain\": \"XRP\",\n \"memo\": \"104729\",\n \"holder_name\": \"Ana Diaz\",\n }],\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.walletAddresses.bulkImport({\n file: await fileFromPath(\"wallet-addresses.csv\"),\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.WalletAddresses.BulkImport(ctx, didit.TravelRuleWalletAddressesBulkImportParams{\n\tFile: didit.Some(didit.FileFromPath(\"wallet-addresses.csv\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.TravelRuleWalletAddressesBulkImportParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().walletAddresses().bulkImport(TravelRuleWalletAddressesBulkImportParams.builder()\n .file(Path.of(\"wallet-addresses.csv\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletAddresses->bulkImport([\n 'file' => File::fromPath('wallet-addresses.csv'),\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.wallet_addresses.bulk_import(\n body: {\n entries: [{\n address: \"0xBeneficiaryWallet01\",\n chain: \"ETH\",\n holder_name: \"Ana Diaz\",\n holder_vendor_data: \"user-042\",\n }, {\n address_hash: \"4f7d2e1c9b8a7f6e5d4c3b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f2e\",\n chain: \"bitcoin\",\n holder_vendor_data: \"user-043\",\n }, {\n address: \"rExchangeSharedAddress01\",\n chain: \"XRP\",\n memo: \"104729\",\n holder_name: \"Ana Diaz\",\n }],\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.WalletAddresses.BulkImportAsync(new TravelRuleWalletAddressesBulkImportParams\n{\n File = FileUpload.FromPath(\"wallet-addresses.csv\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Cada fila se creó, ya existía en el registro o era una repetición de una fila anterior.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressImportReport" }, "example": { "total": 3, "created": 2, "existing": 1, "duplicate": 0, "failed": 0, "rows": [ { "row": 1, "status": "existing", "entry_id": "11111111-2222-3333-4444-555555555555", "errors": {}, "duplicate_of_row": null }, { "row": 2, "status": "created", "entry_id": "22222222-3333-4444-5555-666666666666", "errors": {}, "duplicate_of_row": null }, { "row": 3, "status": "created", "entry_id": "33333333-4444-5555-6666-777777777777", "errors": {}, "duplicate_of_row": null } ] } } } }, "207": { "description": "Falló al menos una fila. Las demás se importaron. Cada fila fallida indica sus errores.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressImportReport" }, "example": { "total": 2, "created": 1, "existing": 0, "duplicate": 0, "failed": 1, "rows": [ { "row": 1, "status": "created", "entry_id": "44444444-5555-6666-7777-888888888888", "errors": {}, "duplicate_of_row": null }, { "row": 2, "status": "failed", "entry_id": null, "errors": { "address": [ "Send address, address_hash or both." ] }, "duplicate_of_row": null } ] } } } }, "400": { "description": "No se puede leer la propia solicitud: incluye `entries` y un `file` a la vez, o ninguno de los dos; más de 10,000 filas; un archivo de más de 5 MB, que no es CSV en UTF-8, sin fila de encabezado o sin filas.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "file": [ "At most 10000 rows per import." ] } } } } } } }, "/v3/travel-rule/counterparty-contacts/": { "get": { "summary": "Listar contactos de contrapartes", "description": "Las direcciones de cumplimiento a las que puede escribir el canal EMAIL para tu aplicación: los contactos de la plataforma de Didit más los contactos privados de tu aplicación, incluidos los rebotados, de más reciente a más antiguo. Se pagina con `limit` (50 por defecto) y `offset`; `count` llega como máximo a 100, así que 100 significa 100 o más.", "operationId": "listTravelRuleCounterpartyContacts", "x-didit-sdk": { "resource": "travel_rule.counterparty_contacts", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "counterparty", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Solo los contactos de esta entrada del directorio. Debe ser un UUID; un valor vacío significa que no se aplica ningún filtro." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "Tamaño de página; 50 de forma predeterminada." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "Filas que se omiten." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/travel-rule/counterparty-contacts/?counterparty={vasp_id}' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.travel_rule.counterparty_contacts.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.travelRule.counterpartyContacts.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.TravelRule.CounterpartyContacts.ListAutoPaging(ctx, didit.TravelRuleCounterpartyContactsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.travelRule().counterpartyContacts().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "travelRule->counterpartyContacts->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.counterparty_contacts.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.TravelRule.CounterpartyContacts.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Los contactos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleCounterpartyContact" } } } }, "example": { "count": 1, "next": null, "previous": null, "results": [ { "uuid": "6c1f9b8e-2d4a-4f7e-8b3c-5a9d0e1f2a3b", "counterparty": "0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91", "counterparty_name": "Example Counterparty VASP", "email": "compliance@counterparty.example", "name": "Compliance desk", "source": "application", "scope": "application", "created_by": "", "verified_at": null, "is_invalid": false, "invalid_reason": "", "invalid_detail": "", "invalid_at": null, "created_at": "2026-10-19T09:00:00Z" } ] } } } }, "400": { "description": "`counterparty` no es un UUID.", "content": { "application/json": { "example": { "counterparty": [ "Must be a valid UUID." ] } } } } } }, "post": { "summary": "Añadir un contacto de la contraparte", "description": "Añade una dirección de cumplimiento privada para una entrada del directorio. Solo tu aplicación la ve y la usa, y el canal EMAIL escribe a ella antes que a cualquier contacto de la plataforma. Si añades una dirección que la entrada ya tiene entre tus propios contactos, se devuelve ese contacto.", "operationId": "createTravelRuleCounterpartyContact", "x-didit-sdk": { "resource": "travel_rule.counterparty_contacts", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyContactCreate" }, "example": { "counterparty": "0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91", "email": "compliance@counterparty.example", "name": "Compliance desk" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/counterparty-contacts/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"counterparty\": \"0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91\", \"email\": \"compliance@counterparty.example\", \"name\": \"Compliance desk\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.counterparty_contacts.create(\n counterparty=\"0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91\",\n email=\"compliance@counterparty.example\",\n name=\"Compliance desk\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.counterpartyContacts.create({\n counterparty: \"0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91\",\n email: \"compliance@counterparty.example\",\n name: \"Compliance desk\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.CounterpartyContacts.Create(ctx, didit.TravelRuleCounterpartyContactCreate{\n\tCounterparty: \"0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91\",\n\tEmail: \"compliance@counterparty.example\",\n\tName: didit.String(\"Compliance desk\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleCounterpartyContactCreate;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().counterpartyContacts().create(TravelRuleCounterpartyContactCreate.builder()\n .counterparty(\"0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91\")\n .email(\"compliance@counterparty.example\")\n .name(\"Compliance desk\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->counterpartyContacts->create([\n 'counterparty' => '0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91',\n 'email' => 'compliance@counterparty.example',\n 'name' => 'Compliance desk',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.counterparty_contacts.create(\n counterparty: \"0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91\",\n email: \"compliance@counterparty.example\",\n name: \"Compliance desk\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.CounterpartyContacts.CreateAsync(new TravelRuleCounterpartyContactCreate\n{\n Counterparty = \"0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91\",\n Email = \"compliance@counterparty.example\",\n Name = \"Compliance desk\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Se añadió el contacto.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyContact" }, "example": { "uuid": "6c1f9b8e-2d4a-4f7e-8b3c-5a9d0e1f2a3b", "counterparty": "0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91", "counterparty_name": "Example Counterparty VASP", "email": "compliance@counterparty.example", "name": "Compliance desk", "source": "application", "scope": "application", "created_by": "", "verified_at": null, "is_invalid": false, "invalid_reason": "", "invalid_detail": "", "invalid_at": null, "created_at": "2026-10-19T09:00:00Z" } } } }, "400": { "description": "Falta un campo o no es válido, o ninguna entrada del directorio tiene este id.", "content": { "application/json": { "example": { "counterparty": [ "No directory entry with this id." ] } } } } } } }, "/v3/travel-rule/counterparty-contacts/{contact_uuid}/": { "delete": { "summary": "Eliminar un contacto de contraparte", "description": "Elimina uno de los contactos propios de tu aplicación. El canal EMAIL deja de escribirle de inmediato. Los contactos de la plataforma no se pueden eliminar.", "operationId": "deleteTravelRuleCounterpartyContact", "x-didit-sdk": { "resource": "travel_rule.counterparty_contacts", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "contact_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE https://verification.didit.me/v3/travel-rule/counterparty-contacts/{contact_uuid}/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.travel_rule.counterparty_contacts.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.travelRule.counterpartyContacts.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.TravelRule.CounterpartyContacts.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.travelRule().counterpartyContacts().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "travelRule->counterpartyContacts->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.counterparty_contacts.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.TravelRule.CounterpartyContacts.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ], "responses": { "204": { "description": "Eliminado." }, "404": { "description": "Ningún contacto de tu aplicación tiene este id. Un contacto de la plataforma también responde 404." } } } }, "/v3/travel-rule/transfers/": { "get": { "summary": "Listar transferencias de Travel Rule", "description": "Las transferencias de Travel Rule de tu aplicación, de la más reciente a la más antigua, paginadas con `limit` (valor predeterminado: 50) y `offset`. Las filas solo contienen nombres de VASP, wallets y notas, nunca datos de personas. Los valores separados por comas seleccionan varios. Un valor desconocido devuelve 400 indicando el parámetro, por ejemplo `{\"direction\": [\"Unknown value(s): inbound.\"]}`.", "operationId": "listTravelRuleTransfers", "x-didit-sdk": { "resource": "travel_rule.transfers", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "direction", "in": "query", "required": false, "schema": { "type": "string" }, "description": "INBOUND, OUTBOUND o ambos separados por comas. Distingue mayúsculas y minúsculas." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Uno o más estados de transferencia, separados por comas." }, { "name": "rail", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Uno o más de INTERNAL, TRP, GTR, TRUST, VERIFYVASP, SYGNA, EMAIL, TEST_VASP, separados por comas." }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string" }, "description": "withdrawal, deposit o message, separados por comas." }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" }, "description": "La moneda de la transacción, sin distinguir mayúsculas de minúsculas." }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Transferencias creadas en este día (UTC) o después, YYYY-MM-DD." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Transferencias creadas en este día (UTC) o antes, YYYY-MM-DD." }, { "name": "counterparty", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "El `id` de una entrada del directorio o de un miembro de la red de Didit de GET /v3/travel-rule/vasps/: tus transferencias con esa contraparte. Un valor que no es un id válido responde 400." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "Tamaño de página; 50 de forma predeterminada." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "Filas que se omiten." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/travel-rule/transfers/?direction=OUTBOUND&status=AWAITING_COUNTERPARTY' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.travel_rule.transfers.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.travelRule.transfers.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.TravelRule.Transfers.ListAutoPaging(ctx, didit.TravelRuleTransfersListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.travelRule().transfers().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "travelRule->transfers->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.transfers.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.TravelRule.Transfers.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Una página de transferencias.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleTransferRow" } } } }, "example": { "count": 1, "next": null, "previous": null, "results": [ { "id": "5b0f6c2e-2a4d-4f0e-9a41-0c3f9a7e1d22", "transaction_id": "a3c1e8f4-7b62-4d1a-8e0b-2f9d6c4b7a10", "txn_id": "wd-2026-10-19-0042", "txn_date": "2026-10-19T08:41:12Z", "kind": "withdrawal", "direction": "OUTBOUND", "status": "AWAITING_COUNTERPARTY", "rail": "TRP", "asset": "ETH", "amount": "1.25", "originator_vasp": "Origin CASP SL", "beneficiary_vasp": "Example Counterparty VASP", "originator_wallet": "0x77ccff0cc624a53cd8b8d8703ced826710211ec7", "beneficiary_wallet": "0xede2d7e4f5b097e6391ab6bbcf2f47a53f4778cb", "originator_memo": "", "beneficiary_memo": "", "originator_wallet_type": "vasp", "beneficiary_wallet_type": "vasp", "matched_transaction_id": null, "deadline_at": "2026-10-21T08:41:13Z", "created_at": "2026-10-19T08:41:13Z" } ] } } } }, "400": { "description": "Un valor de filtro no es válido.", "content": { "application/json": { "example": { "start_date": [ "Use the YYYY-MM-DD format." ] } } } } } } }, "/v3/session/imports/providers/": { "get": { "summary": "Listar proveedores de migración", "description": "Los 15 proveedores desde los que puedes migrar verificaciones: qué necesita cada uno para conectarse, si su API puede listar registros, los permisos que necesita su clave y su mapeo de estados predeterminado.", "operationId": "get_v3_session_imports_providers_list", "x-didit-sdk": { "resource": "sessions.imports", "method": "list_providers", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "responses": { "200": { "description": "Proveedores de migración.", "content": { "application/json": { "schema": { "type": "object", "properties": { "providers": { "type": "array", "items": { "$ref": "#/components/schemas/ImportProvider" } }, "mapping_targets": { "type": "array", "items": { "type": "string" } }, "skipped_statuses": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Clave de API ausente, no válida o revocada, o quien llama no puede importar verificaciones para esta aplicación.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.list_providers()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.listProviders();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.ListProviders(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().listProviders();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->listProviders();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.list_providers\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.ListProvidersAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/providers/check/": { "post": { "summary": "Comprobar una clave de proveedor", "description": "Lee el proveedor con tu clave antes de crear una migración. No se almacena nada.", "operationId": "post_v3_session_imports_providers_check", "x-didit-sdk": { "resource": "sessions.imports", "method": "check_provider", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "sumsub", "jumio", "veriff", "onfido", "persona", "metamap", "socure", "idnow", "shufti", "idenfy", "ondato", "trulioo", "au10tix", "complycube", "other" ], "description": "Origen de la migración, obtenido de `GET /v3/session/imports/providers/`. Obligatorio cuando `source` es `provider`." }, "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "La clave de solo lectura del proveedor, con los nombres de campo que indica `credential_fields`. Se cifra en reposo, nunca se devuelve y se borra cuando termina la importación. Envíala como cadena JSON en multipart." }, "options": { "type": "object", "properties": { "region": { "type": "string", "description": "La región del proveedor, una de sus `regions` (Onfido: `eu`, `us`, `ca`)." } } }, "record_ids": { "type": "array", "items": { "type": "string" }, "description": "Para proveedores `api_ids`: el primer ID de registro de tu exportación." } }, "required": [ "provider", "credentials" ] }, "example": { "provider": "sumsub", "credentials": { "app_token": "YOUR_PROVIDER_APP_TOKEN", "secret_key": "YOUR_PROVIDER_SECRET_KEY" } } } } }, "responses": { "200": { "description": "La clave puede leer registros.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "provider": { "type": "string" }, "credential_hint": { "type": "string", "nullable": true } } } } } }, "400": { "description": "El proveedor rechazó la clave: `code`, `detail`, `missing_permissions`, `suggested_region`." }, "403": { "description": "Clave de API ausente, no válida o revocada, o quien llama no puede importar verificaciones para esta aplicación.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.check_provider(\n provider=\"sumsub\",\n credentials={\"app_token\": \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\": \"YOUR_PROVIDER_SECRET_KEY\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.checkProvider({\n provider: \"sumsub\",\n credentials: { app_token: \"YOUR_PROVIDER_APP_TOKEN\", secret_key: \"YOUR_PROVIDER_SECRET_KEY\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.CheckProvider(ctx, didit.SessionsImportsCheckProviderParams{\n\tProvider: \"sumsub\",\n\tCredentials: map[string]string{\"app_token\": \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\": \"YOUR_PROVIDER_SECRET_KEY\"},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsImportsCheckProviderParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().checkProvider(SessionsImportsCheckProviderParams.builder()\n .provider(SessionsImportsCheckProviderParams.Provider.of(\"sumsub\"))\n .credentials(Map.of(\"app_token\", \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\", \"YOUR_PROVIDER_SECRET_KEY\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->checkProvider([\n 'provider' => 'sumsub',\n 'credentials' => ['app_token' => 'YOUR_PROVIDER_APP_TOKEN', 'secret_key' => 'YOUR_PROVIDER_SECRET_KEY'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.check_provider(\n provider: \"sumsub\",\n credentials: { app_token: \"YOUR_PROVIDER_APP_TOKEN\", secret_key: \"YOUR_PROVIDER_SECRET_KEY\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.CheckProviderAsync(new SessionsImportsCheckProviderParams\n{\n Provider = \"sumsub\",\n Credentials = new Dictionary { [\"app_token\"] = \"YOUR_PROVIDER_APP_TOKEN\", [\"secret_key\"] = \"YOUR_PROVIDER_SECRET_KEY\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/start/": { "post": { "summary": "Iniciar una ejecución de prueba", "description": "Inicia una migración cuya simulación (dry run) ha terminado (`READY`): el mismo trabajo realiza la importación real, con el mapeo de estados y la elección de plantillas faciales tal como se envían ahora.", "operationId": "post_v3_session_imports_start", "x-didit-sdk": { "resource": "sessions.imports", "method": "start", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "status_mapping": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Not Finished", "Abandoned" ] }, "description": "Cambios en la correspondencia de estados predeterminada del proveedor: del estado de origen al estado de Didit. `Not Finished` y `Abandoned` se omiten y se contabilizan, pero nunca se importan." }, "face_templates": { "type": "boolean", "default": false, "description": "Genera plantillas faciales a partir de las selfies importadas y búscalas entre los rostros y la lista de bloqueo de la aplicación. Las coincidencias solo se marcan para revisión. Requiere `lawful_basis_confirmed`." }, "lawful_basis_confirmed": { "type": "boolean", "default": false, "description": "Confirma que tienes una base legal para compartir estas selfies con Didit como encargado del tratamiento." } } } } } }, "responses": { "200": { "description": "El trabajo de importación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "El trabajo no está en un estado al que se aplique esta acción." }, "403": { "description": "Clave de API ausente, no válida o revocada, o quien llama no puede importar verificaciones para esta aplicación.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.start(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.start(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Start(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsImportsStartParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().start(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->start('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.start(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.StartAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/pause/": { "post": { "summary": "Pausar un trabajo de importación", "description": "Pausa una importación en cola o en curso.", "operationId": "post_v3_session_imports_pause", "x-didit-sdk": { "resource": "sessions.imports", "method": "pause", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "El trabajo de importación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "El trabajo no está en un estado al que se aplique esta acción." }, "403": { "description": "Clave de API ausente, no válida o revocada, o quien llama no puede importar verificaciones para esta aplicación.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.pause(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.pause(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Pause(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().pause(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->pause('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.pause(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.PauseAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/resume/": { "post": { "summary": "Reanudar un trabajo de importación", "description": "Reanuda una importación que pausaste. Un trabajo pausado por el límite de solicitudes del proveedor se reanuda por sí solo.", "operationId": "post_v3_session_imports_resume", "x-didit-sdk": { "resource": "sessions.imports", "method": "resume", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "El trabajo de importación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "El trabajo no está en un estado al que se aplique esta acción." }, "403": { "description": "Clave de API ausente, no válida o revocada, o quien llama no puede importar verificaciones para esta aplicación.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.resume(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.resume(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Resume(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().resume(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->resume('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.resume(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.ResumeAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/cancel/": { "post": { "summary": "Cancelar un trabajo de importación", "description": "Cancela una importación. Lo que ya se importó se conserva; el archivo subido y la clave se borran.", "operationId": "post_v3_session_imports_cancel", "x-didit-sdk": { "resource": "sessions.imports", "method": "cancel", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "El trabajo de importación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "El trabajo no está en un estado al que se aplique esta acción." }, "403": { "description": "Clave de API ausente, no válida o revocada, o quien llama no puede importar verificaciones para esta aplicación.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.cancel(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.cancel(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Cancel(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().cancel(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->cancel('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.cancel(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.CancelAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/retry/": { "post": { "summary": "Reintentar una migración", "description": "Vuelve a ejecutar como un trabajo nuevo, con una clave nueva (la anterior se borró), una migración que ya terminó. Conserva el proveedor, el flujo, la región, la asignación de estados y la elección sobre las plantillas faciales; todo lo que ya está en Didit se omite.", "operationId": "post_v3_session_imports_retry", "x-didit-sdk": { "resource": "sessions.imports", "method": "retry", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "La clave de solo lectura del proveedor, con los nombres de campo que indica `credential_fields`. Se cifra en reposo, nunca se devuelve y se borra cuando termina la importación. Envíala como cadena JSON en multipart." }, "file": { "type": "string", "format": "binary", "description": "De nuevo los ID de registro o el archivo de exportación, para los proveedores `api_ids` y `export_file`." } } }, "example": { "credentials": { "app_token": "YOUR_PROVIDER_APP_TOKEN", "secret_key": "YOUR_PROVIDER_SECRET_KEY" } } } } }, "responses": { "201": { "description": "El nuevo trabajo de importación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "No es una migración, no ha finalizado o el proveedor rechazó la clave." }, "403": { "description": "Clave de API ausente, no válida o revocada, o quien llama no puede importar verificaciones para esta aplicación.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.retry(\n \"11111111-2222-3333-4444-555555555555\",\n credentials={\"app_token\": \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\": \"YOUR_PROVIDER_SECRET_KEY\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.retry(\"11111111-2222-3333-4444-555555555555\", {\n credentials: { app_token: \"YOUR_PROVIDER_APP_TOKEN\", secret_key: \"YOUR_PROVIDER_SECRET_KEY\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Retry(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsImportsRetryParams{\n\tCredentials: didit.Some(map[string]string{\"app_token\": \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\": \"YOUR_PROVIDER_SECRET_KEY\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsImportsRetryParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().retry(\"11111111-2222-3333-4444-555555555555\", SessionsImportsRetryParams.builder()\n .credentials(Map.of(\"app_token\", \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\", \"YOUR_PROVIDER_SECRET_KEY\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->retry('11111111-2222-3333-4444-555555555555', [\n 'credentials' => ['app_token' => 'YOUR_PROVIDER_APP_TOKEN', 'secret_key' => 'YOUR_PROVIDER_SECRET_KEY'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.retry(\n \"11111111-2222-3333-4444-555555555555\",\n credentials: { app_token: \"YOUR_PROVIDER_APP_TOKEN\", secret_key: \"YOUR_PROVIDER_SECRET_KEY\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.RetryAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsImportsRetryParams\n{\n Credentials = new Dictionary { [\"app_token\"] = \"YOUR_PROVIDER_APP_TOKEN\", [\"secret_key\"] = \"YOUR_PROVIDER_SECRET_KEY\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/import-jobs/": { "get": { "summary": "Listar trabajos de importación", "description": "Todas las importaciones de la aplicación con una única forma: importaciones de verificaciones y migraciones, de personas y de empresas.", "operationId": "get_v3_import_jobs_list", "x-didit-sdk": { "resource": "sessions.imports", "method": "list_jobs", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "scope", "in": "query", "schema": { "type": "string", "enum": [ "all", "sessions", "users", "businesses" ], "default": "all" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "responses": { "200": { "description": "Trabajos de importación, del más reciente al más antiguo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJobSummary" } }, "counts": { "type": "object", "properties": { "all": { "type": "integer" }, "running_and_waiting": { "type": "integer" }, "needs_attention": { "type": "integer" }, "done": { "type": "integer" } } } } } } } }, "403": { "description": "Clave de API ausente, no válida o revocada, o quien llama no puede importar verificaciones para esta aplicación.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.list_jobs()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.listJobs();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.ListJobs(ctx, didit.SessionsImportsListJobsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().listJobs();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->listJobs();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.list_jobs\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.ListJobsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/import-jobs/active/": { "get": { "summary": "Listar trabajos de importación activos", "description": "Lo que está en curso o en espera, además de lo que acaba de terminar, para un indicador de progreso.", "operationId": "get_v3_import_jobs_active", "x-didit-sdk": { "resource": "sessions.imports", "method": "list_active_jobs", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "responses": { "200": { "description": "Trabajos de importación activos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJobSummary" } }, "running": { "type": "integer" } } } } } }, "403": { "description": "Clave de API ausente, no válida o revocada, o quien llama no puede importar verificaciones para esta aplicación.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.list_active_jobs()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.listActiveJobs();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.ListActiveJobs(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().listActiveJobs();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->listActiveJobs();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.list_active_jobs\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.ListActiveJobsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/transactions/delete/": { "delete": { "summary": "Eliminar transacciones en lote", "description": "Elimina una o más transacciones de forma permanente. Selecciónalas con `transaction_uuids`, o elimina todas las transacciones de la aplicación con `delete_all: true`.\n\nUna transacción eliminada se elimina junto con los registros que le pertenecen solo a ella: sus partes, etiquetas, notas, vínculos con métodos de pago, documentos y todas las versiones almacenadas de sus archivos, ejecuciones de reglas, alertas, resultados de proveedores, instantánea de red y datos de Travel Rule. Los casos, las personas y las empresas se conservan; su vínculo con la transacción eliminada se borra. Los informes regulatorios en borrador dejan de incluirla y se regeneran sin ella. La eliminación es permanente e irreversible; no existe ningún endpoint para deshacerla.\n\nSi alguna de las transacciones seleccionadas figura en un informe regulatorio finalizado, se rechaza toda la solicitud con `409` y no se elimina nada. El cuerpo usa `code: in_filed_report` e indica cada transacción y los informes que la incluyen. Elimina esos informes y repite la solicitud.", "operationId": "batch_delete_transactions", "x-didit-sdk": { "resource": "transactions", "method": "batch_delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Transactions" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la organización." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la aplicación." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "oneOf": [ { "title": "Selected transactions", "required": [ "transaction_uuids" ], "properties": { "transaction_uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "UUID de transacciones de Didit que se van a eliminar. Obligatorio salvo que `delete_all` sea true.", "minItems": 1 }, "delete_all": { "type": "boolean", "enum": [ false ], "default": false, "description": "Omítelo o envía `false` cuando selecciones transacciones con `transaction_uuids`." } } }, { "title": "All transactions", "required": [ "delete_all" ], "properties": { "delete_all": { "type": "boolean", "enum": [ true ], "description": "Elimina todas las transacciones de la aplicación. `transaction_uuids` se ignora." }, "transaction_uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Se ignora cuando `delete_all` es true." } } } ] }, "examples": { "Selected transactions": { "value": { "transaction_uuids": [ "abcdef12-3456-7890-abcd-ef1234567890", "12345678-90ab-cdef-1234-567890abcdef" ] } }, "All transactions": { "value": { "delete_all": true } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl (selected transactions)", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/transactions/delete/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"transaction_uuids\": [\"abcdef12-3456-7890-abcd-ef1234567890\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.transactions.batch_delete(\n body={\n \"transaction_uuids\": [\"abcdef12-3456-7890-abcd-ef1234567890\", \"12345678-90ab-cdef-1234-567890abcdef\"],\n },\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.transactions.batchDelete({\n transaction_uuids: [\"abcdef12-3456-7890-abcd-ef1234567890\", \"12345678-90ab-cdef-1234-567890abcdef\"],\n});" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.TransactionsBatchDeleteParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.transactions().batchDelete(TransactionsBatchDeleteParams.builder()\n .putAdditionalProperty(\"transaction_uuids\", List.of(\"abcdef12-3456-7890-abcd-ef1234567890\", \"12345678-90ab-cdef-1234-567890abcdef\"))\n .build());" }, { "lang": "php", "label": "PHP", "source": "transactions->batchDelete([\n 'transaction_uuids' => ['abcdef12-3456-7890-abcd-ef1234567890', '12345678-90ab-cdef-1234-567890abcdef'],\n]);" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.transactions.batch_delete(\n body: {\n transaction_uuids: [\"abcdef12-3456-7890-abcd-ef1234567890\", \"12345678-90ab-cdef-1234-567890abcdef\"],\n }\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Transactions.BatchDeleteAsync(new TransactionsBatchDeleteParams\n{\n TransactionUuids = new string[] { \"abcdef12-3456-7890-abcd-ef1234567890\", \"12345678-90ab-cdef-1234-567890abcdef\" },\n});" } ], "responses": { "204": { "description": "Transacciones seleccionadas eliminadas." }, "400": { "description": "No se proporcionó ningún selector de transacción.", "content": { "application/json": { "schema": { "type": "object", "properties": { "transaction_uuids": { "type": "array", "items": { "type": "string" } } } }, "example": { "transaction_uuids": [ "This field is required unless delete_all is true." ] } } } }, "403": { "description": "La clave de API no puede eliminar transacciones. El endpoint requiere `write:transactions`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "409": { "description": "Al menos una de las transacciones seleccionadas figura en un informe regulatorio finalizado. No se elimina nada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/travel-rule/networks/": { "get": { "summary": "Obtener las redes de Travel Rule", "description": "Lee, para esta aplicación, el estado real de cada red: si envía a través de tu propia membresía o de la de Didit, y por qué todavía no puede hacerlo. También devuelve el cuestionario de diligencia debida y tus participantes. La lectura no crea nada.", "operationId": "getTravelRuleNetworks", "x-didit-sdk": { "resource": "travel_rule.networks", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/networks/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.networks.retrieve()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.networks.retrieve();\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().networks().retrieve();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->networks->retrieve();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.networks.retrieve\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Networks.RetrieveAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Estados, cuestionario y participantes de la red.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworksOverview" }, "examples": { "Before the questionnaire": { "value": { "platform_networks_enabled": false, "questionnaire": { "status": "draft", "answers": {}, "submitted_at": null, "reviewed_at": null, "review_note": "", "history": [], "updated_at": null }, "participants": [], "networks": { "gtr": { "rail": "GTR", "mode": "unavailable", "state": "didit_onboarding", "reason": "didit_membership_not_live", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 }, "trust": { "rail": "TRUST", "mode": "unavailable", "state": "unavailable", "reason": "own_membership_only", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 }, "verifyvasp": { "rail": "VERIFYVASP", "mode": "unavailable", "state": "didit_onboarding", "reason": "didit_membership_not_live", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 }, "sygna": { "rail": "SYGNA", "mode": "unavailable", "state": "didit_onboarding", "reason": "didit_membership_not_live", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 } } } } } } } }, "401": { "description": "Clave de API ausente o no válida." } } } }, "/v3/travel-rule/networks/questionnaire/": { "get": { "summary": "Obtener el cuestionario de la red", "description": "Lee el cuestionario de diligencia debida de la red de Didit para esta aplicación, su estado y la nota de revisión de Didit. Si una aplicación nunca guardó uno, se devuelve un borrador vacío.", "operationId": "getTravelRuleNetworkQuestionnaire", "x-didit-sdk": { "resource": "travel_rule.networks", "method": "retrieve_questionnaire", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/networks/questionnaire/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.networks.retrieve_questionnaire()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.networks.retrieveQuestionnaire();\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().networks().retrieveQuestionnaire();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->networks->retrieveQuestionnaire();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.networks.retrieve_questionnaire\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Networks.RetrieveQuestionnaireAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "El cuestionario.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" } } } }, "401": { "description": "Clave de API ausente o no válida." } } }, "put": { "summary": "Guardar las respuestas del cuestionario de red", "description": "Guarda las respuestas del cuestionario mientras está en estado draft o changes_requested. Los guardados son parciales: las respuestas que no envíes se conservan.", "operationId": "updateTravelRuleNetworkQuestionnaire", "x-didit-sdk": { "resource": "travel_rule.networks", "method": "update_questionnaire", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PUT https://verification.didit.me/v3/travel-rule/networks/questionnaire/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"legal_name\": \"Example VASP Ltd\", \"incorporation_country\": \"ES\", \"aml_ctf_policy_attested\": true}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.networks.update_questionnaire(\n legal_name=\"Example VASP Ltd\",\n incorporation_country=\"ES\",\n aml_ctf_policy_attested=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.networks.updateQuestionnaire({\n legal_name: \"Example VASP Ltd\",\n incorporation_country: \"ES\",\n aml_ctf_policy_attested: true,\n});\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleNetworkQuestionnaireAnswers;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().networks().updateQuestionnaire(TravelRuleNetworkQuestionnaireAnswers.builder()\n .legalName(\"Example VASP Ltd\")\n .incorporationCountry(\"ES\")\n .amlCtfPolicyAttested(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->networks->updateQuestionnaire([\n 'legal_name' => 'Example VASP Ltd',\n 'incorporation_country' => 'ES',\n 'aml_ctf_policy_attested' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.networks.update_questionnaire(\n legal_name: \"Example VASP Ltd\",\n incorporation_country: \"ES\",\n aml_ctf_policy_attested: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Networks.UpdateQuestionnaireAsync(new TravelRuleNetworkQuestionnaireAnswers\n{\n LegalName = \"Example VASP Ltd\",\n IncorporationCountry = \"ES\",\n AmlCtfPolicyAttested = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaireAnswers" }, "example": { "legal_name": "Example VASP Ltd", "incorporation_country": "ES", "aml_ctf_policy_attested": true } } } }, "responses": { "200": { "description": "El cuestionario con las respuestas combinadas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" } } } }, "400": { "description": "Error de validación, agrupado por campo." }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "El acceso a la red a través de la membresía de Didit aún no está abierto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_platform_networks_disabled" ] } } } } } }, "409": { "description": "El cuestionario está en manos de Didit o ya tiene una decisión: solo puede modificarse mientras está en draft o changes_requested.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_questionnaire_not_editable" ] } } } } } } } } }, "/v3/travel-rule/networks/questionnaire/submit/": { "post": { "summary": "Enviar el cuestionario de la red", "description": "Envía el cuestionario guardado a revisión de Didit. Las respuestas guardadas deben estar completas: todos los campos excepto lei y data_protection_contact_email, con las tres declaraciones en true. Didit lo aprueba, solicita cambios (edítalo y vuelve a enviarlo) o lo rechaza. Las redes que solicitaste mientras estaba pendiente pasan a su onboarding cuando se aprueba.", "operationId": "submitTravelRuleNetworkQuestionnaire", "x-didit-sdk": { "resource": "travel_rule.networks", "method": "submit_questionnaire", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/networks/questionnaire/submit/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.networks.submit_questionnaire()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.networks.submitQuestionnaire();\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().networks().submitQuestionnaire();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->networks->submitQuestionnaire();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.networks.submit_questionnaire\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Networks.SubmitQuestionnaireAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "El cuestionario enviado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" } } } }, "400": { "description": "Las respuestas guardadas están incompletas o no son válidas, agrupadas por campo." }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "El acceso a la red a través de la membresía de Didit aún no está abierto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_platform_networks_disabled" ] } } } } } }, "409": { "description": "El cuestionario está en manos de Didit o ya tiene una decisión: solo puede modificarse mientras está en draft o changes_requested.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_questionnaire_not_editable" ] } } } } } } } } }, "/v3/travel-rule/networks/{network}/request/": { "post": { "summary": "Solicitar una red de Travel Rule", "description": "Solicita un participante propio para esta aplicación en una red de la que Didit es miembro (GTR o Sygna). Sin un cuestionario aprobado, el participante queda a la espera de este (questionnaire_pending). Con uno, pasa al onboarding de la red (submitted_to_network) y se activa cuando la red le asigna un código. Idempotente: un participante pendiente, en onboarding o activo se devuelve sin cambios. Si la red rechazó el registro (last_error tiene valor), volver a solicitarlo reintenta el registro. TRUST y VerifyVASP solo son accesibles a través de tu propia membresía: TRUST admite miembros por VASP, y un Enclave de VerifyVASP atiende a un único ID de VASP.", "operationId": "requestTravelRuleNetworkAccess", "x-didit-sdk": { "resource": "travel_rule.networks", "method": "request_access", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "network", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "gtr", "sygna" ] }, "description": "La red a la que unirse a través de la membresía de Didit." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/networks/gtr/request/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.networks.request_access(\n \"your-network\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.networks.requestAccess(\"your-network\");\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().networks().requestAccess(\"your-network\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->networks->requestAccess('your-network');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.networks.request_access(\"your-network\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Networks.RequestAccessAsync(\"your-network\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Tu participante en la red.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkParticipant" } } } }, "400": { "description": "Red desconocida, una red que Didit no ofrece (conecta tu propia membresía) o una aplicación de sandbox.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_network_own_membership_only", "travel_rule_network_sandbox_application" ] } } } } } }, "401": { "description": "Clave de API ausente o no válida." }, "403": { "description": "El acceso a la red a través de la membresía de Didit aún no está abierto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_platform_networks_disabled" ] } } } } } } } } }, "/v3/address-validation/": { "post": { "summary": "Validar una dirección", "description": "Confirma que una dirección existe y obtenla normalizada: sus líneas de entrega, sus componentes y sus coordenadas. Solo confirma la dirección; nunca la vincula a una persona.\n\n**Solicitud.** Envía la dirección en una sola línea (`address`) o como campos estructurados (`address_line_1` y, de forma opcional, `address_line_2`, `city`, `region`, `postal_code`), nunca ambas cosas, y siempre su `country` (ISO 3166-1 alfa-2 o alfa-3).\n\n**Resultado.** `address_validation.status` es `verified` (confirmada hasta el edificio), `partially_verified` (confirmada solo hasta la calle o un nivel superior), `not_verified` (solo coincidió la región o la ciudad, o no coincidió nada) o `unavailable` (no se pudo ejecutar la validación). El código HTTP es `200` para toda solicitud completada, incluido `unavailable`; vuelve a intentarlo más tarde si obtienes un resultado `unavailable`.\n\n**Facturación.** Una llamada en producción cuesta $0.10 por dirección validada. Un resultado `unavailable` no se cobra. No se almacena nada aparte del registro de uso: no se crea ninguna sesión y el resultado solo se devuelve en esta respuesta.\n\n**Sandbox.** Las claves de sandbox validan la solicitud y siempre devuelven un resultado `verified` determinista que repite la dirección enviada, sin consumir créditos.\n\n**Autenticación.** Envía la clave de API de tu aplicación en `x-api-key`. Si las credenciales faltan o no son válidas, se devuelve `403`: esta API nunca devuelve `401`.\n\n**Límite de solicitudes.** Presupuesto de escritura compartido de 300 solicitudes por minuto por clave de API entre todos los endpoints POST/PATCH/DELETE.", "operationId": "post_v3_address_validation", "x-didit-sdk": { "resource": "address_validation", "method": "validate", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/address-validation/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"address_line_1\": \"1600 Amphitheatre Pkwy\",\n \"city\": \"Mountain View\",\n \"region\": \"CA\",\n \"postal_code\": \"94043\",\n \"country\": \"US\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.address_validation.validate(\n address_line_1=\"1600 Amphitheatre Pkwy\",\n city=\"Mountain View\",\n region=\"CA\",\n postal_code=\"94043\",\n country=\"US\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.addressValidation.validate({\n address_line_1: \"1600 Amphitheatre Pkwy\",\n city: \"Mountain View\",\n region: \"CA\",\n postal_code: \"94043\",\n country: \"US\",\n});\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.AddressValidationRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.addressValidation().validate(AddressValidationRequest.builder()\n .addressLine1(\"1600 Amphitheatre Pkwy\")\n .city(\"Mountain View\")\n .region(\"CA\")\n .postalCode(\"94043\")\n .country(\"US\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "addressValidation->validate([\n 'address_line_1' => '1600 Amphitheatre Pkwy',\n 'city' => 'Mountain View',\n 'region' => 'CA',\n 'postal_code' => '94043',\n 'country' => 'US',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.address_validation.validate(\n address_line_1: \"1600 Amphitheatre Pkwy\",\n city: \"Mountain View\",\n region: \"CA\",\n postal_code: \"94043\",\n country: \"US\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.AddressValidation.ValidateAsync(new AddressValidationRequest\n{\n AddressLine1 = \"1600 Amphitheatre Pkwy\",\n City = \"Mountain View\",\n Region = \"CA\",\n PostalCode = \"94043\",\n Country = \"US\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressValidationRequest" }, "examples": { "Structured": { "summary": "Campos estructurados de la dirección", "value": { "address_line_1": "1600 Amphitheatre Pkwy", "city": "Mountain View", "region": "CA", "postal_code": "94043", "country": "US" } }, "One line": { "summary": "La dirección completa en una sola línea", "value": { "address": "Paseo de la Castellana 259, 28046 Madrid", "country": "ES" } } } } } }, "responses": { "200": { "description": "La validación se completó. Lee `address_validation.status`; el código HTTP es siempre `200` para una solicitud completada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressValidationResponse" }, "examples": { "Verified": { "summary": "Una dirección real, confirmada hasta el edificio", "value": { "request_id": "6f7d2c1e-1c5a-4a1e-9b8f-2a1f0f4b9c3d", "address_validation": { "status": "verified", "verification_level": "premise", "address": { "address_line_1": "1600 Amphitheatre Pkwy", "address_line_2": null, "city": "Mountain View", "region": "CA", "postal_code": "94043-1351", "country": "US" }, "formatted_address": "1600 Amphitheatre Pkwy, Mountain View CA 94043-1351", "latitude": 37.422022, "longitude": -122.08429 }, "created_at": "2026-10-27T11:20:00.000000+00:00" } }, "Not verified": { "summary": "Una calle inventada: solo coincidió la ciudad", "value": { "request_id": "0b9e3f4a-6c2d-4e8b-a1f7-5d3c2b1a0e9f", "address_validation": { "status": "not_verified", "verification_level": "locality", "address": { "address_line_1": "Calle Inventada Que No Existe 99999 28046", "address_line_2": null, "city": "Madrid", "region": "Madrid", "postal_code": null, "country": "ES" }, "formatted_address": "Calle Inventada Que No Existe 99999 28046, Madrid, MADRID, SPAIN", "latitude": 40.42603054, "longitude": -3.68645331 }, "created_at": "2026-10-27T11:21:00.000000+00:00" } }, "Unavailable": { "summary": "No se pudo ejecutar la validación; no se cobra", "value": { "request_id": "3c1b2a0f-9e8d-4c7b-b6a5-1f0e9d8c7b6a", "address_validation": { "status": "unavailable", "verification_level": null, "address": null, "formatted_address": null, "latitude": null, "longitude": null }, "created_at": "2026-10-27T11:22:00.000000+00:00" } } } } } }, "400": { "$ref": "#/components/responses/AddressValidationValidationError" }, "403": { "$ref": "#/components/responses/AddressValidationPermissionDenied" }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } } } }, "/v3/travel-rule/wallet-proofs/": { "get": { "summary": "Listar las pruebas de wallet por captura de pantalla pendientes de revisión", "description": "Tu cola de revisión de pruebas de propiedad de wallet mediante captura de pantalla. Una captura de pantalla es la única prueba que Didit no puede comprobar por sí mismo: una vez que el usuario final la sube desde el widget, queda en PENDING hasta que la apruebes o la rechaces con POST /v3/travel-rule/wallet-proofs/{proof_uuid}/decision/. Las más antiguas primero, de modo que la cola se procesa a partir de la prueba que lleva más tiempo esperando. Solo aparecen las capturas de pantalla subidas, nunca una prueba cuyo usuario final aún no ha subido un archivo, ni una de una wallet que eliminaste de tu libreta de direcciones (Didit las cierra como OWNERSHIP_CHANGED).", "operationId": "listTravelRuleWalletProofs", "x-didit-sdk": { "resource": "travel_rule.wallet_proofs", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "status", "in": "query", "description": "Qué pruebas listar. El valor predeterminado es PENDING, las que aún están por decidir.", "schema": { "type": "string", "enum": [ "PENDING", "VERIFIED", "REJECTED", "EXPIRED" ], "default": "PENDING" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl https://verification.didit.me/v3/travel-rule/wallet-proofs/?status=PENDING \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.travel_rule.wallet_proofs.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.travelRule.walletProofs.list()) {\n console.log(item);\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.travelRule().walletProofs().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletProofs->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.wallet_proofs.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.TravelRule.WalletProofs.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Capturas de pantalla de prueba paginadas. count es exacto hasta 100 y, por encima, se limita a 100.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleWalletProofReview" } } } } } } }, "400": { "description": "Estado desconocido." }, "401": { "description": "x-api-key ausente o no válido." }, "403": { "description": "Quien hace la llamada no tiene el permiso de transacciones." } } } }, "/v3/travel-rule/wallet-proofs/{proof_uuid}/decision/": { "post": { "summary": "Aprobar o rechazar una prueba de wallet mediante captura de pantalla", "description": "Resuelve una prueba por captura de pantalla desde tu cola de revisión. approve verifica la prueba y la entrada de la libreta de direcciones y aplica la propiedad a la transferencia para la que se creó la sesión del widget, exactamente igual que una firma verificada. Una captura de pantalla nunca confirma una transferencia que otro cliente de Didit envió por el canal INTERNAL: para eso se necesita un mensaje firmado o un depósito de prueba. reject cierra la prueba como REJECTED con failure_reason REVIEW_REJECTED; el usuario final puede iniciar una nueva prueba desde el widget. La nota se conserva junto con la prueba.", "operationId": "decideTravelRuleWalletProof", "x-didit-sdk": { "resource": "travel_rule.wallet_proofs", "method": "decide", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "proof_uuid", "in": "path", "required": true, "description": "proof_id de la cola de revisión.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWalletProofDecision" }, "example": { "decision": "approve", "note": "Address matches the wallet app." } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/wallet-proofs/{proof_uuid}/decision/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"decision\": \"approve\", \"note\": \"Address matches the wallet app.\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.wallet_proofs.decide(\n \"11111111-2222-3333-4444-555555555555\",\n decision=\"approve\",\n note=\"Address matches the wallet app.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.walletProofs.decide(\"11111111-2222-3333-4444-555555555555\", {\n decision: \"approve\",\n note: \"Address matches the wallet app.\",\n});\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleWalletProofDecision;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().walletProofs().decide(\"11111111-2222-3333-4444-555555555555\", TravelRuleWalletProofDecision.builder()\n .decision(TravelRuleWalletProofDecision.Decision.of(\"approve\"))\n .note(\"Address matches the wallet app.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletProofs->decide('11111111-2222-3333-4444-555555555555', [\n 'decision' => 'approve',\n 'note' => 'Address matches the wallet app.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.wallet_proofs.decide(\n \"11111111-2222-3333-4444-555555555555\",\n decision: \"approve\",\n note: \"Address matches the wallet app.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.WalletProofs.DecideAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleWalletProofDecision\n{\n Decision = \"approve\",\n Note = \"Address matches the wallet app.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La prueba sobre la que se tomó la decisión.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWalletProofReview" } } } }, "400": { "description": "Decisión no válida o una nota de más de 512 caracteres." }, "401": { "description": "x-api-key ausente o no válido." }, "403": { "description": "Quien hace la llamada no tiene el permiso de transacciones." }, "404": { "description": "No hay ninguna prueba de captura de pantalla enviada con este id en tu aplicación." }, "409": { "description": "La prueba ya tiene una decisión (el cuerpo incluye su estado), o el código OWNERSHIP_CHANGED: el titular de la wallet cambió o la wallet se eliminó después de crearse la sesión del widget, por lo que la prueba está cerrada y el titular actual necesita una nueva.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } } } } }, "/v3/travel-rule/widget/{token}/proofs/": { "post": { "summary": "Iniciar una prueba de propiedad de wallet", "description": "Endpoint público identificado por el token de sesión del widget; no requiere clave de API: el widget alojado lo llama cuando el usuario final elige un método de prueba. Una prueba existe, y cuenta en tu embudo de pruebas, solo a partir de esta llamada. Elegir de nuevo el mismo método devuelve la prueba ya abierta (200, el mismo desafío o importe de depósito) en lugar de iniciar una segunda; elegir otro método cierra la que está sin terminar como METHOD_SWITCHED, salvo una captura de pantalla ya enviada o un depósito de prueba que todavía se está comprobando. MESSAGE_SIGNING devuelve el desafío que hay que firmar; SATOSHI_TEST, la dirección de depósito, el importe exacto y la ventana; SELF_DECLARATION se verifica al instante (status VERIFIED). Formatos de firma verificados por familia de cadenas: las cadenas EVM aceptan una firma personal_sign (EIP-191), codificada en hexadecimal; Bitcoin acepta una firma signmessage BIP-137 (direcciones P2PKH, P2SH-P2WPKH y P2WPKH) o una firma simple BIP-322 (direcciones P2WPKH y P2TR), codificada en base64; Solana acepta una firma Ed25519 sobre el desafío, codificada en base58; Tron acepta una firma signMessageV2 (TIP-191), codificada en hexadecimal. Una firma BIP-322 completa o de prueba de fondos, o una dirección multisig, falla con SIGNATURE_UNSUPPORTED_SCHEME.", "operationId": "createTravelRuleWidgetProof", "x-didit-sdk": { "resource": "travel_rule", "method": "create_widget_proof", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Token de sesión opaco devuelto cuando se generó la sesión del widget.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofCreate" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/widget/{token}/proofs/ \\\n -H 'Content-Type: application/json' \\\n -d '{\"method\": \"MESSAGE_SIGNING\"}'" } ], "responses": { "201": { "description": "Una nueva prueba en estado PENDING (VERIFIED para SELF_DECLARATION).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofSummary" } } } }, "200": { "description": "La prueba ya abierta para este método, reanudada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofSummary" } } } }, "400": { "description": "Cuerpo no válido, una wallet que no coincide con la transferencia, SCREENSHOT no permitido o el código CHAIN_UNSUPPORTED cuando el método no está disponible en la cadena.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "403": { "description": "SELF_DECLARATION no está permitido para esta aplicación." }, "404": { "description": "Token desconocido." }, "409": { "description": "código OWNERSHIP_CHANGED: el titular de la wallet cambió o la wallet se eliminó después de generar la sesión; genera una nueva sesión para el titular actual. También se devuelve para SATOSHI_TEST cuando la sesión no tiene satoshi_deposit_address, y cuando a la sesión no le quedan intentos (sin código; el cuerpo incluye max_attempts, attempts_used y attempts_remaining 0): genera una nueva sesión.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "410": { "description": "La sesión expiró." } } } }, "/v3/travel-rule/widget/{token}/proofs/{proof_id}/verify/": { "post": { "summary": "Enviar la evidencia de prueba de propiedad de la wallet", "description": "Endpoint público identificado por el token de sesión del widget; no requiere clave de API. Envía la evidencia que necesita el método de la prueba: signature para MESSAGE_SIGNING, txid para SATOSHI_TEST (JSON) o un archivo para SCREENSHOT (multipart). Cada envío cuenta como un intento. Si la firma no se verifica o el depósito no coincide, la respuesta es 400 con un código y la prueba queda en PENDING para que el usuario final pueda volver a intentarlo. Si el depósito se detecta pero aún no está confirmado, la respuesta es 200 con status PENDING y se vuelve a comprobar automáticamente hasta que se cierra la ventana. Una captura de pantalla devuelve 200 con status PENDING y espera en tu cola de revisión (GET /v3/travel-rule/wallet-proofs/). Una prueba EXPIRED o REJECTED nunca se verifica más tarde: inicia una nueva. Formatos de firma verificados por familia de cadenas: las cadenas EVM aceptan una firma personal_sign (EIP-191), codificada en hexadecimal; Bitcoin acepta una firma signmessage BIP-137 (direcciones P2PKH, P2SH-P2WPKH y P2WPKH) o una firma simple BIP-322 (direcciones P2WPKH y P2TR), codificada en base64; Solana acepta una firma Ed25519 sobre el desafío, codificada en base58; Tron acepta una firma signMessageV2 (TIP-191), codificada en hexadecimal. Una firma BIP-322 completa o de prueba de fondos, o una dirección multisig, falla con SIGNATURE_UNSUPPORTED_SCHEME.", "operationId": "verifyTravelRuleWidgetProof", "x-didit-sdk": { "resource": "travel_rule", "method": "verify_widget_proof", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Token de sesión opaco devuelto cuando se generó la sesión del widget.", "schema": { "type": "string" } }, { "name": "proof_id", "in": "path", "required": true, "description": "proof_id devuelto al iniciar la prueba.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "signature": { "type": "string", "description": "MESSAGE_SIGNING: la firma de la wallet sobre el desafío de la prueba." }, "txid": { "type": "string", "description": "SATOSHI_TEST: el id de la transacción del depósito de prueba." } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary", "description": "SCREENSHOT: una imagen que muestra la wallet en la app de wallet del usuario final." } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/widget/{token}/proofs/{proof_id}/verify/ \\\n -H 'Content-Type: application/json' \\\n -d '{\"signature\": \"0x...\"}'" } ], "responses": { "200": { "description": "VERIFIED, o todavía PENDING (una captura de pantalla pendiente de revisión, o un depósito aún no indexado o aún no confirmado, con el código DEPOSIT_NOT_FOUND o DEPOSIT_UNCONFIRMED).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofVerifyResult" } } } }, "400": { "description": "Falta la evidencia; un intento fallido que mantiene la prueba en PENDING para que el usuario final pueda volver a intentarlo (código SIGNATURE_INVALID, SIGNATURE_UNSUPPORTED_SCHEME o DEPOSIT_LOOKUP_FAILED); o un depósito de prueba que rechaza la prueba (código DEPOSIT_MISMATCH, DEPOSIT_STALE o TXID_REUSED, estado REJECTED, con los recuentos de intentos de la sesión): volver a elegir un método inicia una nueva prueba mientras attempts_remaining sea mayor que 0.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "404": { "description": "Token desconocido, o no existe esa prueba en esta sesión." }, "409": { "description": "código OWNERSHIP_CHANGED (la prueba se cierra con él); una prueba cerrada (REJECTED o EXPIRED), con su estado, el código con el que se cerró y los recuentos de intentos de la sesión: elige de nuevo un método para iniciar una nueva prueba; o una prueba SELF_DECLARATION, que queda verificada al iniciarse.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "410": { "description": "La sesión expiró, o el código WINDOW_EXPIRED cuando se cerró la ventana de la prueba de satoshis.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } } } } }, "/v3/id-verification/wallets/verifications/{request_id}/response/": { "post": { "operationId": "submit_wallet_verification_response", "x-didit-sdk": { "resource": "id_wallets", "method": "submit_verification_response", "auth": "api_key", "server": true }, "description": "Wallets de la Digital Credentials API (Google Wallet): envía lo que la wallet devolvió a tu página o app para una verificación cuyo next_action es request_digital_credential. Didit lo descifra, comprueba la firma del emisor con las raíces de emisores de confianza, cada valor devuelto con su resumen firmado y la firma del dispositivo sobre tu origen y esta solicitud, y después decide la verificación: verified (se factura una vez) o declined con el código de error. De un solo uso: un segundo envío devuelve la verificación ya decidida.", "summary": "Enviar una respuesta de wallet", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "El request_id que devolvió el endpoint de inicio.", "required": true } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletDigitalCredentialResponseRequest" }, "example": { "response": { "protocol": "openid4vp-v1-signed", "data": { "response": "" } } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletDigitalCredentialResponseRequest" }, "example": { "response": { "protocol": "openid4vp-v1-signed", "data": { "response": "" } } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletDigitalCredentialResponseRequest" }, "example": { "response": { "protocol": "openid4vp-v1-signed", "data": { "response": "" } } } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "google_wallet", "name": "Google Wallet", "issuing_authority": "Google Wallet (ID pass) and US state issuers (mobile driving licence)" }, "country": "USA", "status": "Approved", "outcome": "verified", "error": null, "interaction": "digital_credentials", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": null, "identity": { "full_name": "Alex Example", "first_name": "Alex", "last_name": "Example", "date_of_birth": "1990-01-31", "nationality": "USA", "issuing_state": "USA" }, "attributes": { "document_number": "X0000000", "document_expiry_date": "2030-01-31" }, "level_of_assurance": "substantial", "verified_at": "2026-01-01T10:01:00Z", "signature_valid": true, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiClientCredentialsForbiddenErrorMessage" } } }, "description": "Faltan las credenciales (x-api-key o Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error not_found: ninguna verificación de wallet de esta aplicación tiene este request_id." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]})." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error not_a_digital_credentials_wallet: esta verificación no acepta una respuesta de wallet." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede verificar la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/verifications/REQUEST_ID/response/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"response\": {\n \"protocol\": \"openid4vp-v1-signed\",\n \"data\": {\n \"response\": \"\"\n }\n }\n}'" } ] } }, "/v3/id-verification/wallets/google-wallet/": { "post": { "operationId": "start_google_wallet_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_google_wallet", "auth": "api_key", "server": true }, "description": "Inicia un inicio de sesión con Google Wallet (Google Wallet (ID pass) y emisores estatales de EE. UU. (permiso de conducir móvil); USA, GBR, BRA, SGP, TWN) sin ningún flujo de verificación (workflow). Se factura una sola vez y solo cuando se verifica la identidad. La respuesta incluye next_action.type=request_digital_credential con una solicitud que Didit firmó para tu aplicación y que solo se puede usar desde origin. Allí, dentro de un gesto del usuario, pasa next_action.digital_credentials.request a navigator.credentials.get({digital: ...}) (o a Android Credential Manager como GetDigitalCredentialOption requestJson) y, después, envía con POST lo que devuelva la wallet a /v3/id-verification/wallets/verifications/{request_id}/response/. El navegador ofrece su propio código QR cuando la wallet está en otro dispositivo. Las aplicaciones de sandbox reciben una simulación determinista (simulated: true) que nunca contacta con el proveedor.", "summary": "Iniciar verificación con Google Wallet", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clave opcional para reintentos seguros (máximo 255 caracteres). Reintentar con la misma clave, la misma wallet y el mismo cuerpo devuelve la verificación original sin iniciar un segundo inicio de sesión; la misma clave con otra wallet u otro cuerpo devuelve 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGoogleWalletWalletVerificationStartRequest" }, "example": { "country": "USA", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "origin": "https://app.example.com" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGoogleWalletWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGoogleWalletWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "google_wallet", "name": "Google Wallet", "issuing_authority": "Google Wallet (ID pass) and US state issuers (mobile driving licence)" }, "country": "USA", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "digital_credentials", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "request_digital_credential", "digital_credentials": { "protocol": "openid4vp-v1-signed", "request": { "requests": [ { "protocol": "openid4vp-v1-signed", "data": { "request": "" } } ] } } }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errores de validación de campos ({field: [messages]}), o el error return_url_invalid, return_url_not_allowed, origin_invalid, origin_not_allowed, invalid_personal_code, invalid_phone_number o idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Faltan las credenciales ({detail}), o error wallet_unavailable, insufficient_credits o contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error idempotency_key_reused o idempotency_key_in_progress (con Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveedor no pudo iniciarse; no se creó nada." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: este entorno no puede comunicarse con la wallet." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/google-wallet/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"USA\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"origin\": \"https://app.example.com\"\n}'" } ], "x-didit-wallet-id": "google_wallet" } }, "/v3/session/{sessionId}/kyb/documents/": { "post": { "summary": "Subir documentos KYB a una sesión", "description": "Sube uno o varios documentos corporativos (escritura de constitución, registro de accionistas, certificado de constitución, ...) al paso Documentos KYB de una sesión de Verificación de empresas, desde tu propio servidor en lugar de la página alojada. Didit ejecuta el mismo proceso que en la página alojada: compresión, OCR, comprobaciones de manipulación y entre documentos, agrupación de documentos, y avanza la sesión cuando se cumplen los grupos de documentos requeridos. El paso tiene una tarifa única, sin importar cuántos archivos envíes. La sesión debe estar abierta y en el paso Documentos KYB, y la empresa elegida en el paso de registro debe existir. Consulta las personas que mencionan los documentos con `GET /v3/session/{sessionId}/kyb/extracted-parties/`. Requiere `write:businesses`.", "operationId": "post_v3_session_kyb_documents", "x-didit-sdk": { "resource": "sessions", "method": "upload_kyb_documents", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de Verificación de empresas (KYB). Debe pertenecer a la aplicación de la clave de API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nodo del flujo correspondiente al paso KYB. Solo es necesario cuando el flujo tiene más de un nodo KYB; de forma predeterminada, Didit usa el propio nodo de la sesión.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "documents" ], "properties": { "documents": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "Archivos que se van a subir: JPG, JPEG, PNG, TIFF, WEBP, PDF o archivos ZIP que los contengan. PDF de hasta 50 MB y fotos de hasta 6 MB antes de la compresión." }, "document_passwords": { "type": "array", "items": { "type": "string" }, "description": "Una entrada por archivo en `documents`, en el mismo orden: la contraseña de un PDF protegido, vacía para cualquier otro archivo." }, "document_group": { "type": "string", "enum": [ "LEGAL_PRESENCE", "COMPANY_DETAILS", "OWNERSHIP_STRUCTURE", "REPRESENTATIVES_AUTHORIZATION" ], "description": "Grupo de documentos requerido al que responde esta carga." }, "locale": { "type": "string", "maxLength": 10, "description": "Configuración regional usada para traducir la respuesta del siguiente paso." } } } } } }, "responses": { "200": { "description": "Documentos procesados. Cuando se cumplen todos los grupos obligatorios, la sesión avanza y `next_step` indica el siguiente paso; de lo contrario, permanece en el paso Documentos y `document_groups` y `document_answer` indican lo que aún falta.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "next_step": { "type": "string", "nullable": true, "description": "Paso en el que se encuentra la sesión tras la subida." }, "kyb_status": { "type": "string", "description": "Estado de la comprobación de la empresa." }, "document_answer": { "type": "object", "additionalProperties": true, "description": "Resultado por cada documento subido y las subidas restantes." } }, "additionalProperties": true }, "example": { "valid": true, "next_step": "KYB_KEY_PEOPLE", "kyb_status": "In Progress" } } } }, "400": { "description": "Se rechazó un documento (manipulado, ilegible o no admitido) o la sesión aún no tiene una empresa KYB. Vuelve a intentarlo con otro archivo mientras queden intentos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "example": { "message": "No KYB company found. Submit company data first." } } } }, "402": { "description": "La organización no tiene crédito disponible para el paso de documentos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "example": { "detail": "Insufficient credits." } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Este es el único caso que devuelve `401`: una clave ausente, no válida o revocada devuelve `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "summary": "La fecha de caducidad de la clave ya pasó", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallo de autenticación o autorización. Si falta la clave, se devuelve `403`, al igual que con una clave de otra aplicación, una clave con alcance limitado sin el permiso que necesita este endpoint y una solicitud desde fuera de la lista de IP permitidas de la clave; una clave incorrecta, revocada o expirada devuelve `401`. Distínguelos por `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la validación", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clave válida que pertenece a una aplicación distinta de la de la sesión", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clave con alcance limitado le falta decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Solicitud desde fuera de la lista de IP permitidas de la clave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión no existe, se ha eliminado, pertenece a otra aplicación o está fuera de los límites de una clave con alcance restringido; ningún detalle permite distinguir estos casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "La sesión ha finalizado (`kyb_session_not_writable`) o no está en el paso de documentos KYB (`kyb_step_mismatch`, con `next_step` indicando el paso en el que está).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." }, "code": { "type": "string" }, "next_step": { "type": "string" } } }, "example": { "detail": "The session is not on the step this operation completes.", "code": "kyb_step_mismatch", "next_step": "KYB_REGISTRY" } } } }, "429": { "description": "Límite de solicitudes superado: 300 solicitudes de escritura (POST, PATCH, DELETE) por minuto por clave de API. Espera los segundos indicados en `Retry-After` antes de reintentar; los encabezados `X-RateLimit-*` muestran el presupuesto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Rate limited": { "summary": "Presupuesto del minuto actual agotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.upload_kyb_documents(\n \"33333333-4444-5555-6666-777777777777\",\n documents=[open(\"document.pdf\", \"rb\")],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.uploadKybDocuments(\"33333333-4444-5555-6666-777777777777\", {\n documents: [await fileFromPath(\"document.pdf\")],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UploadKYBDocuments(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsUploadKYBDocumentsParams{\n\tDocuments: []didit.File{didit.FileFromPath(\"document.pdf\")},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.SessionsUploadKybDocumentsParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().uploadKybDocuments(\"33333333-4444-5555-6666-777777777777\", SessionsUploadKybDocumentsParams.builder()\n .documents(List.of(Path.of(\"document.pdf\")))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->uploadKybDocuments('33333333-4444-5555-6666-777777777777', [\n 'documents' => [File::fromPath('document.pdf')],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.upload_kyb_documents(\n \"33333333-4444-5555-6666-777777777777\",\n documents: [Pathname(\"document.pdf\")]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UploadKybDocumentsAsync(\"33333333-4444-5555-6666-777777777777\", new SessionsUploadKybDocumentsParams\n{\n Documents = new FileUpload[] { FileUpload.FromPath(\"document.pdf\") },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/kyb/extracted-parties/": { "get": { "summary": "Lista las partes mencionadas en los documentos subidos", "description": "Devuelve los accionistas y directores que nombran los documentos subidos a esta sesión de KYB, agrupados por persona y atribuidos a los documentos que los nombraron. Muéstraselos a tu solicitante para que los confirme y, después, decláralos con los endpoints de borradores de partes. Un rango sigue siendo un rango: `ownership_percent.text` conserva la cifra literal y `min` / `max`, los números leídos de ella. Aquí no se etiqueta a nadie como UBO; eso se decide cuando se envían las partes, a partir de la configuración de roles y los umbrales de propiedad del flujo. La misma lista aparece en la decisión de la sesión como `document_verifications[].extracted_parties`. Requiere `read:businesses` o `read:sessions`.", "operationId": "get_v3_session_kyb_extracted_parties", "x-didit-sdk": { "resource": "sessions", "method": "list_kyb_extracted_parties", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de Verificación de empresas (KYB). Debe pertenecer a la aplicación de la clave de API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nodo del flujo correspondiente al paso KYB. Solo es necesario cuando el flujo tiene más de un nodo KYB; de forma predeterminada, Didit usa el propio nodo de la sesión.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Partes nombradas en los documentos actuales.", "content": { "application/json": { "schema": { "type": "object", "required": [ "parties", "document_count" ], "properties": { "parties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "entity_type": { "type": "string", "enum": [ "person", "company" ] }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "appointment_date": { "type": "string", "nullable": true }, "designation": { "type": "string", "nullable": true }, "roles": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ] }, "ownership_percent": { "type": "object", "properties": { "text": { "type": "string", "nullable": true, "description": "La cifra de propiedad exactamente como la indica el documento, por ejemplo `25-50%`, `>50%` o `NO EXHIBE`." }, "min": { "type": "number", "nullable": true, "description": "Número menor extraído de `text`; null cuando no indica ninguno." }, "max": { "type": "number", "nullable": true, "description": "Número superior extraído de `text`; null cuando no indica ninguno." } } } } } }, "documents": { "type": "array", "description": "Los documentos subidos que mencionaban a esta parte.", "items": { "type": "object", "properties": { "document_uuid": { "type": "string", "format": "uuid" }, "document_type": { "type": "string", "nullable": true }, "document_subtype": { "type": "string", "nullable": true }, "original_filename": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } } } } } }, "description": "Los accionistas y directores que nombran los documentos subidos, agrupados por persona. Aquí no se etiqueta a nadie como UBO: eso se decide cuando se envían las partes." }, "document_count": { "type": "integer", "description": "Número de documentos cargados de los que se leyó la lista." }, "node_id": { "type": "string", "nullable": true } } }, "example": { "parties": [ { "name": "Ana Lopez", "entity_type": "person", "first_name": "Ana", "last_name": "Lopez", "appointment_date": null, "designation": "Administrador unico", "roles": [ { "role": "shareholder", "ownership_percent": { "text": "60%", "min": 60, "max": 60 } } ], "documents": [ { "document_uuid": "0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41", "document_type": "OWNERSHIP_STRUCTURE", "document_subtype": "ARTICLES_OF_INCORPORATION", "original_filename": "acta_constitutiva.pdf", "status": "Approved" } ] } ], "document_count": 1, "node_id": "node_kyb_documents" } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Este es el único caso que devuelve `401`: una clave ausente, no válida o revocada devuelve `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "summary": "La fecha de caducidad de la clave ya pasó", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallo de autenticación o autorización. Si falta la clave, se devuelve `403`, al igual que con una clave de otra aplicación, una clave con alcance limitado sin el permiso que necesita este endpoint y una solicitud desde fuera de la lista de IP permitidas de la clave; una clave incorrecta, revocada o expirada devuelve `401`. Distínguelos por `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la validación", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clave válida que pertenece a una aplicación distinta de la de la sesión", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clave con alcance limitado le falta decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Solicitud desde fuera de la lista de IP permitidas de la clave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión no existe, se ha eliminado, pertenece a otra aplicación o está fuera de los límites de una clave con alcance restringido; ningún detalle permite distinguir estos casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "example": { "detail": "Session not found." } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.list_kyb_extracted_parties(\n \"33333333-4444-5555-6666-777777777777\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.listKybExtractedParties(\"33333333-4444-5555-6666-777777777777\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ListKYBExtractedParties(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsListKYBExtractedPartiesParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().listKybExtractedParties(\"33333333-4444-5555-6666-777777777777\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->listKybExtractedParties('33333333-4444-5555-6666-777777777777');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.list_kyb_extracted_parties(\"33333333-4444-5555-6666-777777777777\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ListKybExtractedPartiesAsync(\"33333333-4444-5555-6666-777777777777\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/kyb/parties/drafts/": { "get": { "summary": "Listar los borradores de partes de KYB", "description": "Lista las partes que estás preparando para esta sesión de KYB, de la más antigua a la más reciente. Un borrador no es una parte declarada: no aparece en la decisión ni en la consola y no crea ninguna sesión de verificación hasta que lo envíes con `POST /v3/session/{sessionId}/kyb/parties/submit/`. Requiere `write:businesses`.", "operationId": "get_v3_session_kyb_party_drafts", "x-didit-sdk": { "resource": "sessions", "method": "list_kyb_party_drafts", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de Verificación de empresas (KYB). Debe pertenecer a la aplicación de la clave de API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nodo del flujo correspondiente al paso KYB. Solo es necesario cuando el flujo tiene más de un nodo KYB; de forma predeterminada, Didit usa el propio nodo de la sesión.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Los borradores almacenados.", "content": { "application/json": { "schema": { "type": "object", "properties": { "parties": { "type": "array", "items": { "type": "object", "required": [ "draft_id", "created_at", "updated_at", "party" ], "properties": { "draft_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "party": { "type": "object", "required": [ "entity_type", "nationality" ], "properties": { "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Si la parte es una persona física o una empresa." }, "full_name": { "type": "string", "maxLength": 255, "description": "Nombre completo de una persona. Envíalo, o bien `first_name` y `last_name`." }, "first_name": { "type": "string", "maxLength": 128 }, "last_name": { "type": "string", "maxLength": 128 }, "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ], "description": "Rol que tiene la parte. Equivalente a `roles`; si se envían ambos, se combinan." }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ] }, "description": "Todos los roles que tiene la parte. Una persona necesita al menos un rol (aquí o en `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Cargo de una persona." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Nombre de una parte que es una empresa. Obligatorio cuando `entity_type` es `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro de una parte que es una empresa." }, "email": { "type": "string", "format": "email", "description": "Destino al que se envía el enlace de verificación. Obligatorio cuando la parte tiene que completar la verificación, lo que depende de la configuración de roles y de los umbrales de propiedad del flujo." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Participación de la empresa que posee la parte." }, "nationality": { "type": "string", "maxLength": 100, "description": "Nacionalidad de una persona o país de constitución de una empresa. Obligatorio para cada parte." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Campos adicionales definidos en el flujo." }, "skip_verification": { "type": "boolean", "default": false, "description": "Solicita omitir la verificación de esta parte. Solo se aplica cuando el rol de la parte permite omitirla en la configuración de Personas clave del flujo." } } } } } }, "node_id": { "type": "string", "nullable": true } } }, "example": { "parties": [ { "draft_id": "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d", "created_at": "2026-10-31T10:00:00Z", "updated_at": "2026-10-31T10:00:00Z", "party": { "entity_type": "person", "first_name": "Ana", "last_name": "Lopez", "roles": [ "ubo", "director" ], "ownership_percent": 60, "nationality": "MEX", "email": "ana.lopez@example.com", "date_of_birth": "1984-06-12" } } ], "node_id": "node_kyb_key_people" } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Este es el único caso que devuelve `401`: una clave ausente, no válida o revocada devuelve `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "summary": "La fecha de caducidad de la clave ya pasó", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallo de autenticación o autorización. Si falta la clave, se devuelve `403`, al igual que con una clave de otra aplicación, una clave con alcance limitado sin el permiso que necesita este endpoint y una solicitud desde fuera de la lista de IP permitidas de la clave; una clave incorrecta, revocada o expirada devuelve `401`. Distínguelos por `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la validación", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clave válida que pertenece a una aplicación distinta de la de la sesión", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clave con alcance limitado le falta decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Solicitud desde fuera de la lista de IP permitidas de la clave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión no existe, se ha eliminado, pertenece a otra aplicación o está fuera de los límites de una clave con alcance restringido; ningún detalle permite distinguir estos casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "example": { "detail": "Session not found." } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.list_kyb_party_drafts(\n \"33333333-4444-5555-6666-777777777777\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.listKybPartyDrafts(\"33333333-4444-5555-6666-777777777777\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ListKYBPartyDrafts(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsListKYBPartyDraftsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().listKybPartyDrafts(\"33333333-4444-5555-6666-777777777777\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->listKybPartyDrafts('33333333-4444-5555-6666-777777777777');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.list_kyb_party_drafts(\"33333333-4444-5555-6666-777777777777\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ListKybPartyDraftsAsync(\"33333333-4444-5555-6666-777777777777\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "post": { "summary": "Crear un borrador de parte KYB", "description": "Añade una parte (una persona o una empresa) a la lista que estás preparando para esta sesión de KYB. Se aplican los mismos campos y reglas que en la pantalla alojada de Personas clave: una persona necesita `full_name` o `first_name` y `last_name`, al menos un rol y una nacionalidad; una empresa necesita `company_name` y el país de constitución en `nationality`. No se declara ni se factura nada hasta `POST /v3/session/{sessionId}/kyb/parties/submit/`. Requiere `write:businesses`.", "operationId": "post_v3_session_kyb_party_drafts", "x-didit-sdk": { "resource": "sessions", "method": "create_kyb_party_draft", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de Verificación de empresas (KYB). Debe pertenecer a la aplicación de la clave de API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nodo del flujo correspondiente al paso KYB. Solo es necesario cuando el flujo tiene más de un nodo KYB; de forma predeterminada, Didit usa el propio nodo de la sesión.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "entity_type", "nationality" ], "properties": { "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Si la parte es una persona física o una empresa." }, "full_name": { "type": "string", "maxLength": 255, "description": "Nombre completo de una persona. Envíalo, o bien `first_name` y `last_name`." }, "first_name": { "type": "string", "maxLength": 128 }, "last_name": { "type": "string", "maxLength": 128 }, "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ], "description": "Rol que tiene la parte. Equivalente a `roles`; si se envían ambos, se combinan." }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ] }, "description": "Todos los roles que tiene la parte. Una persona necesita al menos un rol (aquí o en `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Cargo de una persona." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Nombre de una parte que es una empresa. Obligatorio cuando `entity_type` es `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro de una parte que es una empresa." }, "email": { "type": "string", "format": "email", "description": "Destino al que se envía el enlace de verificación. Obligatorio cuando la parte tiene que completar la verificación, lo que depende de la configuración de roles y de los umbrales de propiedad del flujo." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Participación de la empresa que posee la parte." }, "nationality": { "type": "string", "maxLength": 100, "description": "Nacionalidad de una persona o país de constitución de una empresa. Obligatorio para cada parte." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Campos adicionales definidos en el flujo." }, "skip_verification": { "type": "boolean", "default": false, "description": "Solicita omitir la verificación de esta parte. Solo se aplica cuando el rol de la parte permite omitirla en la configuración de Personas clave del flujo." } } }, "example": { "entity_type": "person", "first_name": "Ana", "last_name": "Lopez", "roles": [ "ubo", "director" ], "ownership_percent": 60, "nationality": "MEX", "email": "ana.lopez@example.com", "date_of_birth": "1984-06-12" } } } }, "responses": { "201": { "description": "Borrador creado.", "content": { "application/json": { "schema": { "type": "object", "required": [ "draft_id", "created_at", "updated_at", "party" ], "properties": { "draft_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "party": { "type": "object", "required": [ "entity_type", "nationality" ], "properties": { "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Si la parte es una persona física o una empresa." }, "full_name": { "type": "string", "maxLength": 255, "description": "Nombre completo de una persona. Envíalo, o bien `first_name` y `last_name`." }, "first_name": { "type": "string", "maxLength": 128 }, "last_name": { "type": "string", "maxLength": 128 }, "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ], "description": "Rol que tiene la parte. Equivalente a `roles`; si se envían ambos, se combinan." }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ] }, "description": "Todos los roles que tiene la parte. Una persona necesita al menos un rol (aquí o en `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Cargo de una persona." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Nombre de una parte que es una empresa. Obligatorio cuando `entity_type` es `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro de una parte que es una empresa." }, "email": { "type": "string", "format": "email", "description": "Destino al que se envía el enlace de verificación. Obligatorio cuando la parte tiene que completar la verificación, lo que depende de la configuración de roles y de los umbrales de propiedad del flujo." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Participación de la empresa que posee la parte." }, "nationality": { "type": "string", "maxLength": 100, "description": "Nacionalidad de una persona o país de constitución de una empresa. Obligatorio para cada parte." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Campos adicionales definidos en el flujo." }, "skip_verification": { "type": "boolean", "default": false, "description": "Solicita omitir la verificación de esta parte. Solo se aplica cuando el rol de la parte permite omitirla en la configuración de Personas clave del flujo." } } } } }, "example": { "draft_id": "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d", "created_at": "2026-10-31T10:00:00Z", "updated_at": "2026-10-31T10:00:00Z", "party": { "entity_type": "person", "first_name": "Ana", "last_name": "Lopez", "roles": [ "ubo", "director" ], "ownership_percent": 60, "nationality": "MEX", "email": "ana.lopez@example.com", "date_of_birth": "1984-06-12" } } } } }, "400": { "description": "Un campo de una parte no es válido o falta uno obligatorio.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "example": { "non_field_errors": [ "Person parties require at least one role." ] } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Este es el único caso que devuelve `401`: una clave ausente, no válida o revocada devuelve `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "summary": "La fecha de caducidad de la clave ya pasó", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallo de autenticación o autorización. Si falta la clave, se devuelve `403`, al igual que con una clave de otra aplicación, una clave con alcance limitado sin el permiso que necesita este endpoint y una solicitud desde fuera de la lista de IP permitidas de la clave; una clave incorrecta, revocada o expirada devuelve `401`. Distínguelos por `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la validación", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clave válida que pertenece a una aplicación distinta de la de la sesión", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clave con alcance limitado le falta decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Solicitud desde fuera de la lista de IP permitidas de la clave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión no existe, se ha eliminado, pertenece a otra aplicación o está fuera de los límites de una clave con alcance restringido; ningún detalle permite distinguir estos casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "La sesión ha finalizado (`kyb_session_not_writable`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." }, "code": { "type": "string" } } }, "example": { "detail": "This verification session is no longer accepting changes.", "code": "kyb_session_not_writable" } } } }, "429": { "description": "Límite de solicitudes superado: 300 solicitudes de escritura (POST, PATCH, DELETE) por minuto por clave de API. Espera los segundos indicados en `Retry-After` antes de reintentar; los encabezados `X-RateLimit-*` muestran el presupuesto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Rate limited": { "summary": "Presupuesto del minuto actual agotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.create_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n entity_type=\"person\",\n first_name=\"Ana\",\n last_name=\"Lopez\",\n roles=[\"ubo\", \"director\"],\n date_of_birth=\"1984-06-12\",\n email=\"ana.lopez@example.com\",\n ownership_percent=60.0,\n nationality=\"MEX\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.createKybPartyDraft(\"33333333-4444-5555-6666-777777777777\", {\n entity_type: \"person\",\n first_name: \"Ana\",\n last_name: \"Lopez\",\n roles: [\"ubo\", \"director\"],\n date_of_birth: \"1984-06-12\",\n email: \"ana.lopez@example.com\",\n ownership_percent: 60.0,\n nationality: \"MEX\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.CreateKYBPartyDraft(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsCreateKYBPartyDraftParams{\n\tEntityType: \"person\",\n\tFirstName: didit.String(\"Ana\"),\n\tLastName: didit.String(\"Lopez\"),\n\tRoles: didit.Some([]didit.SessionsCreateKYBPartyDraftParamsRoles{\"ubo\", \"director\"}),\n\tDateOfBirth: didit.String(\"1984-06-12\"),\n\tEmail: didit.String(\"ana.lopez@example.com\"),\n\tOwnershipPercent: didit.Float(60.0),\n\tNationality: \"MEX\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.SessionsCreateKybPartyDraftParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().createKybPartyDraft(\"33333333-4444-5555-6666-777777777777\", SessionsCreateKybPartyDraftParams.builder()\n .entityType(SessionsCreateKybPartyDraftParams.EntityType.of(\"person\"))\n .firstName(\"Ana\")\n .lastName(\"Lopez\")\n .roles(List.of(SessionsCreateKybPartyDraftParams.Roles.of(\"ubo\"), SessionsCreateKybPartyDraftParams.Roles.of(\"director\")))\n .dateOfBirth(LocalDate.parse(\"1984-06-12\"))\n .email(\"ana.lopez@example.com\")\n .ownershipPercent(60.0)\n .nationality(\"MEX\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->createKybPartyDraft('33333333-4444-5555-6666-777777777777', [\n 'entity_type' => 'person',\n 'first_name' => 'Ana',\n 'last_name' => 'Lopez',\n 'roles' => ['ubo', 'director'],\n 'date_of_birth' => '1984-06-12',\n 'email' => 'ana.lopez@example.com',\n 'ownership_percent' => 60.0,\n 'nationality' => 'MEX',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.create_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n entity_type: \"person\",\n first_name: \"Ana\",\n last_name: \"Lopez\",\n roles: [\"ubo\", \"director\"],\n date_of_birth: \"1984-06-12\",\n email: \"ana.lopez@example.com\",\n ownership_percent: 60.0,\n nationality: \"MEX\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.CreateKybPartyDraftAsync(\"33333333-4444-5555-6666-777777777777\", new SessionsCreateKybPartyDraftParams\n{\n EntityType = \"person\",\n FirstName = \"Ana\",\n LastName = \"Lopez\",\n Roles = new SessionsCreateKybPartyDraftParamsRoles[] { \"ubo\", \"director\" },\n DateOfBirth = \"1984-06-12\",\n Email = \"ana.lopez@example.com\",\n OwnershipPercent = 60.0,\n Nationality = \"MEX\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/kyb/parties/drafts/{draftId}/": { "patch": { "summary": "Editar el borrador de una parte KYB", "description": "Cambia campos del borrador de una parte. La edición se combina con el borrador almacenado y la parte resultante se valida en su conjunto, por lo que se rechaza una edición que dejaría la parte incompleta. Cambiar `first_name` o `last_name` reemplaza el nombre completo almacenado. Requiere `write:businesses`.", "operationId": "patch_v3_session_kyb_party_draft", "x-didit-sdk": { "resource": "sessions", "method": "update_kyb_party_draft", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de Verificación de empresas (KYB). Debe pertenecer a la aplicación de la clave de API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "draftId", "in": "path", "required": true, "description": "UUID del borrador de la parte (el `draft_id` que se devolvió al crearlo).", "schema": { "type": "string", "format": "uuid", "example": "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nodo del flujo correspondiente al paso KYB. Solo es necesario cuando el flujo tiene más de un nodo KYB; de forma predeterminada, Didit usa el propio nodo de la sesión.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Cualquier subconjunto de los campos de la parte. La edición se combina con el borrador almacenado y la parte resultante se valida en su conjunto, de modo que un borrador que podía enviarse antes de una edición sigue pudiendo enviarse después.", "properties": { "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Si la parte es una persona física o una empresa." }, "full_name": { "type": "string", "maxLength": 255, "description": "Nombre completo de una persona. Envíalo, o bien `first_name` y `last_name`." }, "first_name": { "type": "string", "maxLength": 128 }, "last_name": { "type": "string", "maxLength": 128 }, "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ], "description": "Rol que tiene la parte. Equivalente a `roles`; si se envían ambos, se combinan." }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ] }, "description": "Todos los roles que tiene la parte. Una persona necesita al menos un rol (aquí o en `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Cargo de una persona." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Nombre de una parte que es una empresa. Obligatorio cuando `entity_type` es `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro de una parte que es una empresa." }, "email": { "type": "string", "format": "email", "description": "Destino al que se envía el enlace de verificación. Obligatorio cuando la parte tiene que completar la verificación, lo que depende de la configuración de roles y de los umbrales de propiedad del flujo." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Participación de la empresa que posee la parte." }, "nationality": { "type": "string", "maxLength": 100, "description": "Nacionalidad de una persona o país de constitución de una empresa. Obligatorio para cada parte." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Campos adicionales definidos en el flujo." }, "skip_verification": { "type": "boolean", "default": false, "description": "Solicita omitir la verificación de esta parte. Solo se aplica cuando el rol de la parte permite omitirla en la configuración de Personas clave del flujo." } } }, "example": { "ownership_percent": 55 } } } }, "responses": { "200": { "description": "Borrador actualizado.", "content": { "application/json": { "schema": { "type": "object", "required": [ "draft_id", "created_at", "updated_at", "party" ], "properties": { "draft_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "party": { "type": "object", "required": [ "entity_type", "nationality" ], "properties": { "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Si la parte es una persona física o una empresa." }, "full_name": { "type": "string", "maxLength": 255, "description": "Nombre completo de una persona. Envíalo, o bien `first_name` y `last_name`." }, "first_name": { "type": "string", "maxLength": 128 }, "last_name": { "type": "string", "maxLength": 128 }, "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ], "description": "Rol que tiene la parte. Equivalente a `roles`; si se envían ambos, se combinan." }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ] }, "description": "Todos los roles que tiene la parte. Una persona necesita al menos un rol (aquí o en `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Cargo de una persona." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Nombre de una parte que es una empresa. Obligatorio cuando `entity_type` es `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro de una parte que es una empresa." }, "email": { "type": "string", "format": "email", "description": "Destino al que se envía el enlace de verificación. Obligatorio cuando la parte tiene que completar la verificación, lo que depende de la configuración de roles y de los umbrales de propiedad del flujo." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Participación de la empresa que posee la parte." }, "nationality": { "type": "string", "maxLength": 100, "description": "Nacionalidad de una persona o país de constitución de una empresa. Obligatorio para cada parte." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Campos adicionales definidos en el flujo." }, "skip_verification": { "type": "boolean", "default": false, "description": "Solicita omitir la verificación de esta parte. Solo se aplica cuando el rol de la parte permite omitirla en la configuración de Personas clave del flujo." } } } } }, "example": { "draft_id": "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d", "created_at": "2026-10-31T10:00:00Z", "updated_at": "2026-10-31T10:00:00Z", "party": { "entity_type": "person", "first_name": "Ana", "last_name": "Lopez", "roles": [ "ubo", "director" ], "ownership_percent": 55, "nationality": "MEX", "email": "ana.lopez@example.com", "date_of_birth": "1984-06-12" } } } } }, "400": { "description": "La parte fusionada no es válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "example": { "non_field_errors": [ "Person parties require at least one role." ] } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Este es el único caso que devuelve `401`: una clave ausente, no válida o revocada devuelve `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "summary": "La fecha de caducidad de la clave ya pasó", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallo de autenticación o autorización. Si falta la clave, se devuelve `403`, al igual que con una clave de otra aplicación, una clave con alcance limitado sin el permiso que necesita este endpoint y una solicitud desde fuera de la lista de IP permitidas de la clave; una clave incorrecta, revocada o expirada devuelve `401`. Distínguelos por `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la validación", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clave válida que pertenece a una aplicación distinta de la de la sesión", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clave con alcance limitado le falta decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Solicitud desde fuera de la lista de IP permitidas de la clave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión o el borrador no existe, o la sesión está fuera de la aplicación de la clave o de los límites de una clave con alcance restringido.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "La sesión ha finalizado (`kyb_session_not_writable`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." }, "code": { "type": "string" } } }, "example": { "detail": "This verification session is no longer accepting changes.", "code": "kyb_session_not_writable" } } } }, "429": { "description": "Límite de solicitudes superado: 300 solicitudes de escritura (POST, PATCH, DELETE) por minuto por clave de API. Espera los segundos indicados en `Retry-After` antes de reintentar; los encabezados `X-RateLimit-*` muestran el presupuesto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Rate limited": { "summary": "Presupuesto del minuto actual agotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\",\n ownership_percent=55.0,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateKybPartyDraft(\n \"33333333-4444-5555-6666-777777777777\",\n \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\",\n {\n ownership_percent: 55.0,\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateKYBPartyDraft(ctx, \"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\", didit.SessionsUpdateKYBPartyDraftParams{\n\tOwnershipPercent: didit.Float(55.0),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsUpdateKybPartyDraftParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateKybPartyDraft(\"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\", SessionsUpdateKybPartyDraftParams.builder()\n .ownershipPercent(55.0)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateKybPartyDraft('33333333-4444-5555-6666-777777777777', '5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d', [\n 'ownership_percent' => 55.0,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\",\n ownership_percent: 55.0\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateKybPartyDraftAsync(\"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\", new SessionsUpdateKybPartyDraftParams\n{\n OwnershipPercent = 55.0,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "summary": "Eliminar un borrador de parte KYB", "description": "Descarta un borrador de parte. Las partes declaradas no se ven afectadas. Requiere `write:businesses`.", "operationId": "delete_v3_session_kyb_party_draft", "x-didit-sdk": { "resource": "sessions", "method": "delete_kyb_party_draft", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de Verificación de empresas (KYB). Debe pertenecer a la aplicación de la clave de API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "draftId", "in": "path", "required": true, "description": "UUID del borrador de la parte (el `draft_id` que se devolvió al crearlo).", "schema": { "type": "string", "format": "uuid", "example": "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nodo del flujo correspondiente al paso KYB. Solo es necesario cuando el flujo tiene más de un nodo KYB; de forma predeterminada, Didit usa el propio nodo de la sesión.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Borrador eliminado. Sin cuerpo." }, "401": { "description": "La clave de API con alcance limitado ha expirado. Este es el único caso que devuelve `401`: una clave ausente, no válida o revocada devuelve `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "summary": "La fecha de caducidad de la clave ya pasó", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallo de autenticación o autorización. Si falta la clave, se devuelve `403`, al igual que con una clave de otra aplicación, una clave con alcance limitado sin el permiso que necesita este endpoint y una solicitud desde fuera de la lista de IP permitidas de la clave; una clave incorrecta, revocada o expirada devuelve `401`. Distínguelos por `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la validación", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clave válida que pertenece a una aplicación distinta de la de la sesión", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clave con alcance limitado le falta decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Solicitud desde fuera de la lista de IP permitidas de la clave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión o el borrador no existe, o la sesión está fuera de la aplicación de la clave o de los límites de una clave con alcance restringido.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "La sesión ha finalizado (`kyb_session_not_writable`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." }, "code": { "type": "string" } } }, "example": { "detail": "This verification session is no longer accepting changes.", "code": "kyb_session_not_writable" } } } }, "429": { "description": "Límite de solicitudes superado: 300 solicitudes de escritura (POST, PATCH, DELETE) por minuto por clave de API. Espera los segundos indicados en `Retry-After` antes de reintentar; los encabezados `X-RateLimit-*` muestran el presupuesto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Rate limited": { "summary": "Presupuesto del minuto actual agotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.sessions.delete_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.sessions.deleteKybPartyDraft(\n \"33333333-4444-5555-6666-777777777777\",\n \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\",\n);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Sessions.DeleteKYBPartyDraft(ctx, \"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\", didit.SessionsDeleteKYBPartyDraftParams{}); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.sessions().deleteKybPartyDraft(\"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\");" }, { "lang": "php", "label": "PHP", "source": "sessions->deleteKybPartyDraft('33333333-4444-5555-6666-777777777777', '5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.delete_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\"\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Sessions.DeleteKybPartyDraftAsync(\"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\");" } ] } }, "/v3/session/{sessionId}/kyb/parties/submit/": { "post": { "summary": "Enviar los borradores de las partes KYB", "description": "Declara los borradores almacenados como las personas clave de la empresa. Es el paso alojado de personas clave, ejecutado con tu clave de API: Didit decide, a partir de la configuración de roles y los umbrales de propiedad del flujo de verificación (workflow), qué partes deben verificarse, crea una sesión de KYC individual (o una subsesión de KYB para un propietario corporativo) para cada una de ellas, envía los correos electrónicos que pide el flujo y hace avanzar la sesión. Cada sesión hija se factura igual que en el flujo alojado. Los borradores se consumen. Repetir la llamada después de un envío correcto no cambia nada y responde `200` con `already_submitted: true` y las partes que ya existen. La sesión debe estar en el paso de personas clave. Envía a cada persona su `kyc_session_url` o incrústala. Requiere `write:businesses`.", "operationId": "post_v3_session_kyb_parties_submit", "x-didit-sdk": { "resource": "sessions", "method": "submit_kyb_parties", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de Verificación de empresas (KYB). Debe pertenecer a la aplicación de la clave de API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nodo del flujo correspondiente al paso KYB. Solo es necesario cuando el flujo tiene más de un nodo KYB; de forma predeterminada, Didit usa el propio nodo de la sesión.", "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "locale": { "type": "string", "maxLength": 10, "description": "Configuración regional usada para traducir la respuesta del paso al que avanza la sesión." } } }, "example": { "locale": "es" } } } }, "responses": { "200": { "description": "Partes declaradas (o ya declaradas).", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "next_step": { "type": "string", "nullable": true, "description": "Paso en el que se encuentra la sesión." }, "status": { "type": "string", "description": "Estado de la sesión de empresa." }, "advanced": { "type": "boolean", "description": "`true` cuando esta llamada declaró las partes e hizo avanzar la sesión." }, "already_submitted": { "type": "boolean", "description": "`true` cuando las partes ya se habían declarado en una llamada anterior." }, "kyb_key_people_status": { "type": "string" }, "parties": { "type": "array", "items": { "$ref": "#/components/schemas/KYBKeyPeopleParty" } } } }, "example": { "valid": true, "next_step": "FINISHED", "status": "In Progress", "advanced": true, "already_submitted": false, "kyb_key_people_status": "In Progress", "parties": [] } } } }, "402": { "description": "La organización no tiene crédito disponible para las sesiones de verificación secundarias.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "example": { "detail": "Insufficient credits." } } } }, "401": { "description": "La clave de API con alcance limitado ha expirado. Este es el único caso que devuelve `401`: una clave ausente, no válida o revocada devuelve `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Expired key": { "summary": "La fecha de caducidad de la clave ya pasó", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallo de autenticación o autorización. Si falta la clave, se devuelve `403`, al igual que con una clave de otra aplicación, una clave con alcance limitado sin el permiso que necesita este endpoint y una solicitud desde fuera de la lista de IP permitidas de la clave; una clave incorrecta, revocada o expirada devuelve `401`. Distínguelos por `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta el encabezado x-api-key, o la clave no superó la validación", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clave válida que pertenece a una aplicación distinta de la de la sesión", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clave con alcance limitado le falta decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Solicitud desde fuera de la lista de IP permitidas de la clave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sesión no existe, se ha eliminado, pertenece a otra aplicación o está fuera de los límites de una clave con alcance restringido; ningún detalle permite distinguir estos casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "`kyb_no_party_drafts`: no hay nada que enviar. `kyb_parties_already_submitted`: se añadieron borradores después de declarar las partes. `kyb_step_mismatch`: la sesión no está en el paso de Personas clave (`next_step` indica su paso). `kyb_session_not_writable`: la sesión ha finalizado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." }, "code": { "type": "string" }, "next_step": { "type": "string" } } }, "example": { "detail": "There are no draft parties to submit.", "code": "kyb_no_party_drafts" } } } }, "429": { "description": "Límite de solicitudes superado: 300 solicitudes de escritura (POST, PATCH, DELETE) por minuto por clave de API. Espera los segundos indicados en `Retry-After` antes de reintentar; los encabezados `X-RateLimit-*` muestran el presupuesto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje de error legible." } } }, "examples": { "Rate limited": { "summary": "Presupuesto del minuto actual agotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos que hay que esperar antes de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.submit_kyb_parties(\n \"33333333-4444-5555-6666-777777777777\",\n locale=\"es\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.submitKybParties(\"33333333-4444-5555-6666-777777777777\", {\n locale: \"es\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.SubmitKYBParties(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsSubmitKYBPartiesParams{\n\tLocale: didit.String(\"es\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsSubmitKybPartiesParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().submitKybParties(\"33333333-4444-5555-6666-777777777777\", SessionsSubmitKybPartiesParams.builder()\n .locale(\"es\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->submitKybParties('33333333-4444-5555-6666-777777777777', [\n 'locale' => 'es',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.submit_kyb_parties(\n \"33333333-4444-5555-6666-777777777777\",\n locale: \"es\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.SubmitKybPartiesAsync(\"33333333-4444-5555-6666-777777777777\", new SessionsSubmitKybPartiesParams\n{\n Locale = \"es\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/files-export/": { "post": { "summary": "Exportar todos los archivos de una sesión", "description": "Empieza a preparar un ZIP con todas las imágenes, videos y documentos de una sesión de Verificación de usuarios (KYC) o Verificación de empresas (KYB), en calidad original: los archivos se guardan en el ZIP tal como se capturaron y nunca se vuelven a comprimir. Responde `202` con la exportación; consúltala con `GET /v3/session/{sessionId}/files-export/{exportId}/` hasta que `status` sea `READY` y, después, descarga `download_url`. Mientras una exportación de la misma sesión todavía se está preparando, se devuelve esa exportación en lugar de una nueva.\n\nEl ZIP se elimina 24 horas después de estar listo, y de inmediato cuando se elimina la sesión. Una sesión eliminada no se puede exportar. Cada exportación y cada enlace de descarga entregado se anota en el registro de auditoría de la sesión. Una clave de API con permisos limitados necesita `media: read` y `decisions: read`; un usuario de la consola necesita el privilegio para leer sesiones.", "operationId": "post_v3_session_files_export", "x-didit-sdk": { "resource": "sessions", "method": "export_files", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de verificación (el `session_id` que devuelve `POST /v3/session/`). Acepta ID de sesión tanto de Verificación de usuarios (KYC) como de Verificación de empresas (KYB). Una sesión eliminada devuelve `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/files-export/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.export_files(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.exportFiles(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ExportFiles(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().exportFiles(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->exportFiles('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.export_files(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ExportFilesAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "202": { "description": "La exportación, en preparación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionFilesExport" }, "example": { "export_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "session_id": "11111111-2222-3333-4444-555555555555", "status": "PENDING", "file_count": null, "size_bytes": null, "download_url": null, "expires_at": null, "error": null, "created_at": "2026-10-29T12:00:03Z", "completed_at": null } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/files-export/{exportId}/": { "get": { "summary": "Obtener una exportación de archivos de sesión", "description": "Progreso de una exportación iniciada con `POST /v3/session/{sessionId}/files-export/`. Cuando `status` es `READY`, `download_url` es una URL firmada del ZIP que es válida durante poco tiempo; vuelve a consultar la exportación para obtener una nueva hasta `expires_at`. Cada consulta que entrega un enlace de descarga se registra en el registro de auditoría de la sesión. La exportación de una sesión eliminada devuelve `404`.", "operationId": "get_v3_session_files_export", "x-didit-sdk": { "resource": "sessions", "method": "get_files_export", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID de la sesión de verificación (el `session_id` que devuelve `POST /v3/session/`). Acepta ID de sesión tanto de Verificación de usuarios (KYC) como de Verificación de empresas (KYB). Una sesión eliminada devuelve `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "exportId", "in": "path", "required": true, "description": "El `export_id` que devuelve `POST /v3/session/{sessionId}/files-export/`.", "schema": { "type": "string", "format": "uuid", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/files-export/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.get_files_export(\n \"11111111-2222-3333-4444-555555555555\",\n \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.getFilesExport(\n \"11111111-2222-3333-4444-555555555555\",\n \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.GetFilesExport(ctx, \"11111111-2222-3333-4444-555555555555\", \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().getFilesExport(\"11111111-2222-3333-4444-555555555555\", \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->getFilesExport('11111111-2222-3333-4444-555555555555', 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.get_files_export(\n \"11111111-2222-3333-4444-555555555555\",\n \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.GetFilesExportAsync(\"11111111-2222-3333-4444-555555555555\", \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "La exportación.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionFilesExport" }, "example": { "export_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "session_id": "11111111-2222-3333-4444-555555555555", "status": "READY", "file_count": 9, "size_bytes": 18734120, "download_url": "https://storage.example.com/session/11111111-2222-3333-4444-555555555555/files-export/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/session-42-files.zip?X-Amz-Signature=...", "expires_at": "2026-10-30T12:00:41Z", "error": null, "created_at": "2026-10-29T12:00:03Z", "completed_at": "2026-10-29T12:00:41Z" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/travel-rule/unmatched/": { "get": { "summary": "Listar depósitos de Travel Rule sin coincidencia", "description": "Depósitos entrantes que siguen esperando los datos de Travel Rule del VASP ordenante: su transferencia está en `AWAITING_COUNTERPARTY`, `NOT_ENOUGH_COUNTERPARTY_DATA` o `COUNTERPARTY_VASP_NOT_FOUND`, no tienen ningún mensaje recibido emparejado y nadie los ha emparejado manualmente. Las filas y los filtros son los mismos que en `GET /v3/travel-rule/transfers/`, del más reciente al más antiguo, paginados con `limit` (50 de forma predeterminada) y `offset`. Empareja un depósito con el mensaje que envió el VASP ordenante mediante `POST /v3/travel-rule/unmatched/{transaction_uuid}/match/`.", "operationId": "listUnmatchedTravelRuleDeposits", "x-didit-sdk": { "resource": "travel_rule.unmatched_deposits", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "direction", "in": "query", "required": false, "schema": { "type": "string" }, "description": "INBOUND, OUTBOUND o ambos separados por comas. Distingue mayúsculas y minúsculas." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Uno o más estados de transferencia, separados por comas." }, { "name": "rail", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Uno o más de INTERNAL, TRP, GTR, TRUST, VERIFYVASP, SYGNA, EMAIL, TEST_VASP, separados por comas." }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string" }, "description": "withdrawal, deposit o message, separados por comas." }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" }, "description": "La moneda de la transacción, sin distinguir mayúsculas de minúsculas." }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Transferencias creadas en este día (UTC) o después, YYYY-MM-DD." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Transferencias creadas en este día (UTC) o antes, YYYY-MM-DD." }, { "name": "counterparty", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "El `id` de una entrada del directorio o de un miembro de la red de Didit de GET /v3/travel-rule/vasps/: tus transferencias con esa contraparte. Un valor que no es un id válido responde 400." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000000 }, "description": "Tamaño de página; 50 de forma predeterminada." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000000 }, "description": "Filas que se omiten." } ], "responses": { "200": { "description": "Una página de depósitos sin asociar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleTransferRow" } } } }, "example": { "count": 1, "next": null, "previous": null, "results": [ { "id": "7d3a1c55-0b9e-4d52-8a3c-1f6e2b9d4a08", "transaction_id": "c41f9b2e-5a8d-4e0c-9f17-3b6d8a2e5c91", "txn_id": "dep-2026-10-20-0007", "txn_date": "2026-10-19T08:41:12Z", "kind": "deposit", "direction": "INBOUND", "status": "AWAITING_COUNTERPARTY", "rail": "TRP", "asset": "ETH", "amount": "1.25", "originator_vasp": "", "beneficiary_vasp": "Example Counterparty VASP", "originator_wallet": "0x77ccff0cc624a53cd8b8d8703ced826710211ec7", "beneficiary_wallet": "0xede2d7e4f5b097e6391ab6bbcf2f47a53f4778cb", "originator_memo": "", "beneficiary_memo": "", "originator_wallet_type": "vasp", "beneficiary_wallet_type": "vasp", "matched_transaction_id": null, "deadline_at": null, "created_at": "2026-10-19T08:41:13Z" } ] } } } }, "400": { "description": "Un valor de filtro no es válido.", "content": { "application/json": { "example": { "start_date": [ "Use the YYYY-MM-DD format." ] } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.travel_rule.unmatched_deposits.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.travelRule.unmatchedDeposits.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.TravelRule.UnmatchedDeposits.ListAutoPaging(ctx, didit.TravelRuleUnmatchedDepositsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.travelRule().unmatchedDeposits().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "travelRule->unmatchedDeposits->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.unmatched_deposits.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.TravelRule.UnmatchedDeposits.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/travel-rule/unmatched/{transaction_uuid}/match/": { "post": { "summary": "Vincular un depósito de Travel Rule con un mensaje recibido", "operationId": "matchUnmatchedTravelRuleDeposit", "x-didit-sdk": { "resource": "travel_rule.unmatched_deposits", "method": "match", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Empareja un depósito entrante que aún espera los datos del ordenante con el mensaje de Travel Rule que el VASP ordenante envió para él. El depósito adopta los datos del ordenante, el VASP de la contraparte y el canal del mensaje, y ambas transferencias registran el emparejamiento en sus cronologías. `transaction_uuid` es el `transaction_id` del depósito obtenido de `GET /v3/travel-rule/unmatched/`. `transaction_id` en el cuerpo es el `transaction_id` del mensaje recibido, tomado de una fila de `GET /v3/travel-rule/transfers/?kind=message`; con el `id` propio de la transferencia no se encuentra. El mensaje debe corresponder al mismo activo que el depósito. Un depósito o mensaje eliminado desde la Console responde `404`; uno que ya ha avanzado (emparejado o que ya no está en espera) responde `409`.", "parameters": [ { "name": "transaction_uuid", "in": "path", "required": true, "description": "El `transaction_id` del depósito no conciliado.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleManualMatchRequest" }, "example": { "transaction_id": "e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24" } } } }, "responses": { "200": { "description": "Ambas transferencias después de la coincidencia.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleManualMatchResponse" }, "example": { "deposit": { "id": "7d3a1c55-0b9e-4d52-8a3c-1f6e2b9d4a08", "transaction_id": "c41f9b2e-5a8d-4e0c-9f17-3b6d8a2e5c91", "txn_id": "dep-2026-10-20-0007", "txn_date": "2026-10-19T08:41:12Z", "kind": "deposit", "direction": "INBOUND", "status": "AWAITING_COUNTERPARTY", "rail": "TRP", "asset": "ETH", "amount": "1.25", "originator_vasp": "Example Counterparty VASP", "beneficiary_vasp": "Example Counterparty VASP", "originator_wallet": "0x77ccff0cc624a53cd8b8d8703ced826710211ec7", "beneficiary_wallet": "0xede2d7e4f5b097e6391ab6bbcf2f47a53f4778cb", "originator_memo": "", "beneficiary_memo": "", "originator_wallet_type": "vasp", "beneficiary_wallet_type": "vasp", "matched_transaction_id": "e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24", "deadline_at": null, "created_at": "2026-10-19T08:41:13Z" }, "message": { "id": "2b8e6f10-9c3a-47d1-b5e2-0a4c7d9f3e66", "transaction_id": "e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24", "txn_id": "msg-2026-10-20-0003", "txn_date": "2026-10-19T08:41:12Z", "kind": "message", "direction": "INBOUND", "status": "COMPLETED", "rail": "TRP", "asset": "ETH", "amount": "1.25", "originator_vasp": "Origin CASP SL", "beneficiary_vasp": "Example Counterparty VASP", "originator_wallet": "0x77ccff0cc624a53cd8b8d8703ced826710211ec7", "beneficiary_wallet": "0xede2d7e4f5b097e6391ab6bbcf2f47a53f4778cb", "originator_memo": "", "beneficiary_memo": "", "originator_wallet_type": "vasp", "beneficiary_wallet_type": "vasp", "matched_transaction_id": null, "deadline_at": "2026-10-21T08:41:13Z", "created_at": "2026-10-19T08:41:13Z" } } } } }, "400": { "description": "Error de validación: falta `transaction_id`, es el propio depósito, no es un mensaje de Travel Rule recibido o corresponde a un activo distinto del depósito; o la transacción indicada en la ruta no es un depósito entrante.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Error": { "value": { "transaction_id": [ "The travel rule message is for a different asset than the deposit." ] } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "description": "Depósito o mensaje desconocido, o uno de ellos se eliminó.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No TravelRuleTransfer matches the given query." } } } }, "409": { "description": "El depósito ya no está esperando los datos del ordenante, o el mensaje ya está asociado a un depósito.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Error": { "value": { "detail": "This deposit is no longer waiting for originator data." } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.unmatched_deposits.match(\n \"11111111-2222-3333-4444-555555555555\",\n transaction_id=\"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.unmatchedDeposits.match(\"11111111-2222-3333-4444-555555555555\", {\n transaction_id: \"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.UnmatchedDeposits.Match(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleManualMatchRequest{\n\tTransactionID: \"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleManualMatchRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().unmatchedDeposits().match(\"11111111-2222-3333-4444-555555555555\", TravelRuleManualMatchRequest.builder()\n .transactionId(\"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->unmatchedDeposits->match('11111111-2222-3333-4444-555555555555', [\n 'transaction_id' => 'e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.unmatched_deposits.match(\n \"11111111-2222-3333-4444-555555555555\",\n transaction_id: \"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.UnmatchedDeposits.MatchAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleManualMatchRequest\n{\n TransactionId = \"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } } }, "components": { "schemas": { "DocumentAIDetectedCode": { "type": "object", "required": [ "type", "page_number", "position", "x", "y", "width", "height", "page_width", "page_height", "raw_payload", "parsed_payload" ], "properties": { "type": { "type": "string", "description": "Simbología detectada, por ejemplo `QR_CODE`, `CODE_128`, `EAN_13`, `DATA_MATRIX` o `PDF_417`." }, "page_number": { "type": "integer", "minimum": 1, "description": "Número de página, empezando en 1." }, "position": { "type": "array", "nullable": true, "description": "Polígono detectado en coordenadas de píxeles de la página renderizada. Es `null` cuando no hay una ubicación fiable disponible.", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "integer" } } }, "x": { "type": "integer", "nullable": true, "description": "Borde izquierdo del cuadro delimitador, en píxeles de la página renderizada." }, "y": { "type": "integer", "nullable": true, "description": "Borde superior del cuadro delimitador, en píxeles de la página renderizada." }, "width": { "type": "integer", "nullable": true, "description": "Ancho del cuadro delimitador en píxeles de la página renderizada." }, "height": { "type": "integer", "nullable": true, "description": "Altura del cuadro delimitador en píxeles de la página renderizada." }, "page_width": { "type": "integer", "description": "Ancho de la página renderizada en píxeles." }, "page_height": { "type": "integer", "description": "Altura de la página renderizada en píxeles." }, "raw_payload": { "type": "string", "description": "Payload del decodificador sin procesar como cadena base64 cuando está disponible; en caso contrario, una cadena vacía." }, "parsed_payload": { "nullable": true, "description": "Cadena decodificada o valor estructurado. `null` cuando el código se localizó pero no se pudo decodificar." } } }, "SessionImportJob": { "type": "object", "required": [ "uuid", "status", "import_type", "source_format", "source_filename", "total_rows", "processed_rows", "created_count", "updated_count", "skipped_count", "failed_count" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Id del trabajo de importación. Usa este valor para consultar el progreso y obtener los errores de las filas." }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED", "PAUSED", "CANCELLED", "READY" ] }, "import_type": { "type": "string", "enum": [ "user_verification", "business_verification", "status_rules", "transactions" ] }, "source_format": { "type": "string", "enum": [ "csv", "ndjson" ] }, "source_filename": { "type": "string" }, "total_rows": { "type": "integer", "format": "int64" }, "processed_rows": { "type": "integer", "format": "int64" }, "checkpoint_row": { "type": "integer", "format": "int64" }, "created_count": { "type": "integer", "format": "int64" }, "updated_count": { "type": "integer", "format": "int64" }, "skipped_count": { "type": "integer", "format": "int64" }, "failed_count": { "type": "integer", "format": "int64" }, "total_media_bytes": { "type": "integer", "format": "int64" }, "last_error": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "started_at": { "type": "string", "format": "date-time", "nullable": true }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "state": { "type": "string", "enum": [ "ready", "queued", "running", "paused", "completed", "errors", "failed", "cancelled" ], "description": "El estado del trabajo tal como lo muestra la consola; `errors` es un trabajo completado con filas rechazadas." }, "source": { "type": "string", "enum": [ "file", "api", "provider" ] }, "provider": { "type": "string", "description": "Origen de la migración; vacío en una importación desde archivo o API." }, "provider_options": { "type": "object" }, "credential_hint": { "type": "string", "description": "Los primeros caracteres de la clave que contiene la migración. La clave en sí nunca se devuelve." }, "credentials_expires_at": { "type": "string", "format": "date-time", "nullable": true }, "resumes_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se reanuda por sí solo un trabajo pausado por el límite de solicitudes del proveedor." }, "status_mapping": { "type": "object", "additionalProperties": { "type": "string" } }, "is_dry_run": { "type": "boolean" }, "dry_run_summary": { "type": "object", "description": "Qué encontró una ejecución de prueba: `total`, `by_status`, `already_in_didit`, `same_person`, `not_finished`, `failed`, `unmapped_statuses`." }, "face_templates_enabled": { "type": "boolean" }, "lawful_basis_confirmed_at": { "type": "string", "format": "date-time", "nullable": true }, "not_finished_count": { "type": "integer", "format": "int64" }, "same_person_count": { "type": "integer", "format": "int64" }, "face_templates_count": { "type": "integer", "format": "int64" }, "face_duplicates_count": { "type": "integer", "format": "int64" }, "face_blocklist_hits_count": { "type": "integer", "format": "int64" }, "created_by_name": { "type": "string", "nullable": true }, "created_by_email": { "type": "string", "nullable": true } } }, "SessionImportError": { "type": "object", "required": [ "uuid", "row_number", "error", "raw_row" ], "properties": { "uuid": { "type": "string", "format": "uuid" }, "row_number": { "type": "integer", "format": "int64" }, "external_id": { "type": "string", "nullable": true }, "error": { "type": "string" }, "raw_row": { "type": "object", "additionalProperties": true }, "created_at": { "type": "string", "format": "date-time" } } }, "BrandingCustomizationUpdate": { "type": "object", "description": "Cuerpo de actualización parcial de la marca. Indica solo los campos que quieras cambiar. Los colores hexadecimales aceptan `#RRGGBB` o `#RRGGBBAA`. El dominio personalizado y el correo electrónico de marca blanca no se aceptan aquí.", "properties": { "color_primary": { "type": "string", "description": "Color de los encabezados y del texto principal." }, "color_secondary": { "type": "string", "description": "Color del texto de párrafo / secundario." }, "color_background": { "type": "string", "description": "Color de fondo de la página." }, "color_panel": { "type": "string", "description": "Color del panel / de acento." }, "color_panel_10": { "type": "string", "description": "Color del panel con un 10% de opacidad." }, "color_on_panel_1": { "type": "string", "description": "Color del texto de apoyo en los paneles." }, "color_on_panel_2": { "type": "string", "description": "Color de la etiqueta o insignia en los paneles." }, "color_on_background": { "type": "string", "description": "Color del texto sobre el fondo." }, "color_button_1": { "type": "string", "description": "Color del botón principal." }, "color_button_2": { "type": "string", "description": "Color del botón secundario." }, "color_button_text_1": { "type": "string", "description": "Color del texto del botón principal." }, "color_button_text_2": { "type": "string", "description": "Color del texto del botón secundario." }, "color_pill_text": { "type": "string", "description": "Color del texto para píldoras, campos de entrada y selectores." }, "border_radius_panel": { "type": "integer", "minimum": 0, "description": "Radio de las esquinas del panel en píxeles." }, "border_radius_buttons": { "type": "integer", "minimum": 0, "description": "Radio de las esquinas del botón en píxeles." }, "font_family": { "type": "string", "description": "Nombre de la familia tipográfica de Google Fonts (p. ej., `Inter`, `AR One Sans`)." }, "font_weight": { "type": "string", "description": "Grosor de fuente disponible para la familia seleccionada (p. ej., `regular`, `500`, `700`)." }, "app_public_name": { "type": "string", "nullable": true, "description": "Nombre público que se muestra en el flujo de verificación." }, "privacy_policy_url": { "type": "string", "nullable": true, "description": "URL de la política de privacidad que se muestra al usuario final." }, "skip_welcome_screen": { "type": "boolean", "description": "Omite la pantalla de bienvenida inicial." }, "disable_login_with_didit": { "type": "boolean", "description": "Continuar como invitado en lugar de mostrar la pantalla de inicio de sesión con Didit. No se puede volver a establecer en `false` mientras haya un dominio personalizado configurado (400)." }, "hide_progress_bar": { "type": "boolean", "description": "Oculta la barra de progreso durante el flujo." }, "callback_seconds": { "type": "integer", "minimum": 0, "description": "Retraso (en segundos) antes de redirigir a la URL de callback." }, "delete_logo_square": { "type": "boolean", "description": "Si es `true`, elimina el logotipo cuadrado actual." }, "delete_logo_rectangular": { "type": "boolean", "description": "Si es `true`, elimina el logotipo rectangular actual." }, "delete_logo_rectangular_dark": { "type": "boolean", "description": "Si es `true`, elimina el logotipo actual del modo oscuro y `logo_rectangular_dark` pasa a ser `null`. Si la misma solicitud multipart también sube `image_rectangular_dark`, prevalece la subida." }, "delete_favicon": { "type": "boolean", "description": "Si es `true`, elimina el favicon actual." } } }, "BrandingCustomization": { "type": "object", "description": "Personalización de marca blanca de una aplicación: colores, fuentes, radios, URL de logotipos y opciones de UI/UX. Las URL de logotipos son de solo lectura (se definen subiendo imágenes). No se incluyen el dominio personalizado ni el correo electrónico de marca blanca.", "properties": { "color_primary": { "type": "string" }, "color_secondary": { "type": "string" }, "color_background": { "type": "string" }, "color_panel": { "type": "string" }, "color_panel_10": { "type": "string" }, "color_on_panel_1": { "type": "string" }, "color_on_panel_2": { "type": "string" }, "color_on_background": { "type": "string" }, "color_button_1": { "type": "string" }, "color_button_2": { "type": "string" }, "color_button_text_1": { "type": "string" }, "color_button_text_2": { "type": "string" }, "color_pill_text": { "type": "string" }, "border_radius_panel": { "type": "integer" }, "border_radius_buttons": { "type": "integer" }, "font_family": { "type": "string" }, "font_weight": { "type": "string" }, "font_url": { "type": "string", "nullable": true, "description": "Solo lectura. URL resuelta de la hoja de estilos de Google Fonts para la familia seleccionada." }, "logo_square": { "type": "string", "nullable": true, "description": "URL de solo lectura del logotipo cuadrado. Súbelo mediante `image_square`." }, "logo_rectangular": { "type": "string", "nullable": true, "description": "URL de solo lectura del logotipo rectangular. Súbelo mediante `image_rectangular`." }, "logo_rectangular_dark": { "type": "string", "format": "uri", "nullable": true, "description": "Solo lectura. URL firmada temporal del logotipo rectangular para el modo oscuro, que se muestra sobre un fondo oscuro. Es `null` cuando no hay ningún logotipo oscuro configurado o cuando los logotipos rectangulares no se muestran en tu cuenta. Súbelo con `image_rectangular_dark`." }, "favicon": { "type": "string", "nullable": true, "description": "URL de solo lectura del favicon. Súbelo mediante `image_favicon`." }, "app_public_name": { "type": "string", "nullable": true }, "privacy_policy_url": { "type": "string", "nullable": true }, "skip_welcome_screen": { "type": "boolean" }, "disable_login_with_didit": { "type": "boolean" }, "hide_progress_bar": { "type": "boolean" }, "callback_seconds": { "type": "integer" } } }, "WebhookEvent": { "type": "string", "description": "Nombre de evento de webhook admitido. Usa exactamente estas cadenas en `subscribed_events`; los valores no admitidos se rechazan.", "enum": [ "status.updated", "data.updated", "user.status.updated", "user.data.updated", "business.status.updated", "business.data.updated", "activity.created", "transaction.created", "transaction.status.updated", "travel_rule.status.updated", "workflow.compliance_changed", "transaction_rule_suggestions.created", "auth.signup", "auth.login", "auth.login_failed", "auth.password_reset_requested", "auth.password_reset_completed", "auth.mfa_changed", "auth.new_device", "auth.account_locked", "investigator.report.ready", "investigator.decision.automated", "investigator.decision.overridden", "investigator.decision.contested", "investigator.question.raised", "investigator.automation.paused", "investigator.rfi.answered", "investigator.rfi.overdue", "investigator.drift.detected", "investigator.sla.breached", "investigator.qa.failed", "investigator.external.report.ready" ] }, "WebhookSubscribedEvents": { "type": "array", "description": "Filtro de eventos de este destino de webhook. Didit entrega solo los webhooks cuyo tipo de evento coincide exactamente con uno de estos valores: no existe una suscripción comodín. Si se envía, la lista debe contener al menos un evento válido (un `[]` explícito se rechaza con 400). Un destino con la lista vacía (campo omitido al crearlo) no recibe nada. Al actualizar, la lista se reemplaza por completo y nunca se combina.", "minItems": 1, "uniqueItems": true, "items": { "$ref": "#/components/schemas/WebhookEvent" }, "example": [ "status.updated", "data.updated" ] }, "PhoneVerificationSendResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de sesión de la verificación. Un envío `Retry` devuelve el mismo `request_id` que el envío original. Este ID aparece en la Business Console, lo vuelve a devolver un `POST /v3/phone/check/` finalizado y se puede pasar a `GET /v3/session/{sessionId}/decision/`." }, "status": { "type": "string", "enum": [ "Success", "Retry", "Blocked" ], "description": "`Success`: OTP enviado a una nueva verificación. `Retry`: OTP reenviado para la verificación pendiente creada por un envío anterior. `Blocked`: la capa antifraude se negó a enviarlo; la verificación se finaliza de inmediato como `Declined` y no se factura nada." }, "reason": { "type": "string", "nullable": true, "description": "Por qué un envío quedó en `Blocked` (por ejemplo, `repeated_attempts`, `suspicious`, `spam`). `null` en `Success` y `Retry`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` almacenado en la sesión (del primer envío)." }, "metadata": { "type": "object", "nullable": true, "description": "Devuelve el `metadata` almacenado en la sesión (del primer envío)." } } }, "PhoneVerificationCheckResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Con `Approved`/`Declined`: el id de sesión de la verificación coincidente, idéntico al `request_id` que devuelve `POST /v3/phone/send/`. Con `Failed` y `Expired or Not Found`: un UUID aleatorio de un solo uso que no se puede consultar después." }, "status": { "type": "string", "enum": [ "Approved", "Declined", "Failed", "Expired or Not Found" ], "description": "`Approved`: código correcto, sin ningún riesgo que provoque rechazo. `Declined`: estado final; coincidió un riesgo que provoca rechazo o se agotó el número de intentos (3). `Failed`: código incorrecto, quedan intentos. `Expired or Not Found`: no hay ninguna verificación pendiente para este número en los últimos 5 minutos." }, "message": { "type": "string", "description": "Explicación legible del resultado, incluido el número de intentos restantes tras un código incorrecto." }, "phone": { "type": "object", "nullable": true, "description": "Informe completo del teléfono. Presente (no nulo) solo en resultados finalizados (`Approved`/`Declined`); `null` en `Failed` y ausente en `Expired or Not Found`.", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Not Finished", "Expired" ], "description": "Estado final de la verificación de teléfono. Coincide con el `status` de nivel superior en las comprobaciones finalizadas." }, "phone_number_prefix": { "type": "string", "description": "Código telefónico del país con `+` inicial (por ejemplo, `+1`).", "example": "+1" }, "phone_number": { "type": "string", "description": "Número nacional sin el prefijo telefónico del país.", "example": "4155552671" }, "full_number": { "type": "string", "description": "Número completo en formato E.164.", "example": "+14155552671" }, "country_code": { "type": "string", "nullable": true, "description": "País ISO 3166-1 alpha-2 del número.", "example": "US" }, "country_name": { "type": "string", "description": "Nombre completo del país derivado de `country_code`.", "example": "United States" }, "carrier": { "type": "object", "description": "Red actual que da servicio al número, según la consulta al operador realizada en la finalización.", "properties": { "name": { "type": "string", "description": "Nombre del operador. Cadena vacía cuando la consulta no pudo identificarlo." }, "type": { "type": "string", "description": "Tipo de línea que devuelve la consulta: `mobile`, `fixed_line`, `voip`, `isp`, `vpn`, `toll_free`, `premium_rate`, `pager`, `payphone`, `satellite`, `service`, `shared_cost`, `short_codes_commercial`, `calling_cards`, `local_rate`, `universal_access`, `voice_mail`, `other` o `unknown`." } } }, "is_disposable": { "type": "boolean", "description": "`true` cuando el número pertenece a un servicio de números temporales o desechables." }, "is_virtual": { "type": "boolean", "description": "`true` cuando el tipo de línea es virtual (`voip`, `isp` o `vpn`)." }, "verification_method": { "type": "string", "description": "Canal que realmente entregó el OTP una vez confirmada la entrega (p. ej., `whatsapp`, `sms`); hasta entonces, el canal solicitado." }, "verification_attempts": { "type": "integer", "description": "Número de envíos de OTP para esta verificación (1, o 2 tras un reintento)." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se introdujo el código correcto. `null` si la verificación nunca se aprobó." }, "warnings": { "type": "array", "description": "Advertencias de riesgo registradas durante la verificación (duplicado, desechable, VoIP, intentos superados, lista de bloqueo, etc.). Array vacío cuando no hay ninguna.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Función que generó la advertencia. Aquí siempre es `PHONE`." }, "risk": { "type": "string", "description": "Código de riesgo legible por máquina." }, "additional_data": { "type": "object", "nullable": true, "description": "Contexto específico del riesgo (p. ej., el id de la sesión duplicada en los riesgos de duplicado). `null` cuando el riesgo no incluye datos adicionales." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravedad. Los riesgos `error` rechazan la verificación, `warning` la marca para revisión e `information` se registra sin afectar al estado." }, "short_description": { "type": "string", "description": "Resumen legible del riesgo en una línea." }, "long_description": { "type": "string", "description": "Explicación legible del riesgo." } } } }, "lifecycle": { "type": "array", "description": "Registro de auditoría cronológico de la verificación. El `type` del evento es uno de `PHONE_VERIFICATION_MESSAGE_SENT`, `PHONE_VERIFICATION_RETRY_MESSAGE_SENT`, `PHONE_VERIFICATION_BLOCKED`, `PHONE_DELIVERY_DELIVERED`, `PHONE_DELIVERY_UNDELIVERABLE`, `VALID_CODE_ENTERED`, `INVALID_CODE_ENTERED`, `PHONE_VERIFICATION_APPROVED`, `PHONE_VERIFICATION_DECLINED`, `PHONE_VERIFICATION_IN_REVIEW`, `PHONE_VERIFICATION_EXPIRED`.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Tipo de evento." }, "timestamp": { "type": "string", "format": "date-time", "description": "Cuándo ocurrió el evento." }, "details": { "type": "object", "nullable": true, "description": "Payload específico del evento. Eventos de envío: `{status, reason, channel, actual_channel}` (`actual_channel` se completa cuando se confirma la entrega). Eventos de entrega: `{channel, status}`. Eventos de introducción del código: `{code_tried, status}`. Eventos de estado final: `null`, o `{reason}` cuando está rechazado o en revisión." }, "fee": { "type": "number", "description": "Importe en USD facturado por este evento. Distinto de cero solo en los eventos de envío (el precio de la entrega); 0 en las introducciones de código, las confirmaciones de entrega y los eventos de estado." } } } }, "matches": { "type": "array", "description": "Otras sesiones de tu aplicación (KYC, KYB o API) en las que un usuario distinto (con un `vendor_data` diferente) usó el mismo número de teléfono. Hasta 5 entradas; si existe, primero aparece una coincidencia sintética con una entrada de la lista de bloqueo (las coincidencias derivadas de sesiones conservan el orden de la consulta). Array vacío cuando no hay coincidencias.", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID de sesión de la otra verificación que usó este número de teléfono." }, "session_number": { "type": "integer", "description": "Número secuencial legible de esa sesión." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` de esa sesión." }, "verification_date": { "type": "string", "description": "Cuándo se creó esa sesión (`YYYY-MM-DDTHH:MM:SSZ`)." }, "phone_number": { "type": "string", "description": "El número de teléfono que coincidió." }, "status": { "type": "string", "description": "Estado de esa sesión (p. ej., `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Si el número de teléfono está en la lista de bloqueo de tu aplicación." }, "api_service": { "type": "string", "nullable": true, "description": "En las sesiones de tipo API, la API independiente que la creó (p. ej., `PHONE_VERIFICATION`); `null` en las sesiones de verificación normales." }, "source": { "type": "string", "description": "Dónde se encontró la coincidencia. Normalmente `session`; una coincidencia en la lista de bloqueo a través de una entrada de lista de la organización antepone una coincidencia sintética con `source: \"list_entry\"` y `session_id`/`session_number` nulos." } } } }, "phone_social": { "$ref": "#/components/schemas/PhoneSocialFootprint" }, "phone_intelligence": { "allOf": [ { "$ref": "#/components/schemas/PhoneIntelligence" } ], "description": "Señales de inteligencia telefónica. Solo aparecen cuando `enable_enrichment` era `true` en la comprobación." } } }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` de la sesión de la verificación coincidente. `null` en `Expired or Not Found`." }, "metadata": { "type": "object", "nullable": true, "description": "`metadata` de la sesión de la verificación coincidente. `null` en `Expired or Not Found`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de tiempo de esta respuesta de comprobación." } } }, "EmailVerificationSendResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de sesión de la verificación. Un envío `Retry` devuelve el mismo `request_id` que el envío original. Este ID aparece en la Business Console, lo vuelve a devolver un `POST /v3/email/check/` finalizado y se puede pasar a `GET /v3/session/{sessionId}/decision/`." }, "status": { "type": "string", "enum": [ "Success", "Retry", "Undeliverable" ], "description": "`Success`: OTP enviado por correo electrónico a una nueva verificación (se factura). `Retry`: nuevo OTP enviado por correo electrónico para la verificación pendiente creada por un envío anterior (gratis). `Undeliverable`: la dirección no superó la validación de entregabilidad o no se pudo enviar el mensaje; la verificación se finaliza de inmediato como `Declined` y no se factura nada." }, "reason": { "type": "string", "nullable": true, "enum": [ "email_can_not_be_delivered", null ], "description": "`email_can_not_be_delivered` cuando `status` es `Undeliverable`; `null` en caso contrario." }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` almacenado en la sesión (del primer envío)." }, "metadata": { "type": "object", "nullable": true, "description": "Devuelve el `metadata` almacenado en la sesión (del primer envío)." } } }, "EmailVerificationCheckResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Con `Approved`/`Declined`: el id de sesión de la verificación coincidente, idéntico al `request_id` que devuelve `POST /v3/email/send/`. Con `Failed` y `Expired or Not Found`: un UUID aleatorio de un solo uso que no se puede consultar después." }, "status": { "type": "string", "enum": [ "Approved", "Declined", "Failed", "Expired or Not Found" ], "description": "`Approved`: código correcto, sin ningún riesgo que provoque rechazo. `Declined`: estado final; coincidió un riesgo que provoca rechazo o se agotó el número de intentos (3). `Failed`: código incorrecto, quedan intentos. `Expired or Not Found`: no hay ninguna verificación pendiente para esta dirección en los últimos 5 minutos." }, "message": { "type": "string", "description": "Explicación legible del resultado, incluido el número de intentos restantes tras un código incorrecto." }, "email": { "type": "object", "nullable": true, "description": "Informe de correo electrónico completo. Presente (no null) solo en los resultados finalizados (`Approved`/`Declined`); `null` en `Failed` y ausente en `Expired or Not Found`.", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Not Finished", "Expired" ], "description": "Estado final de la verificación de correo electrónico. Coincide con el `status` de nivel superior en las comprobaciones finalizadas." }, "email": { "type": "string", "format": "email", "description": "La dirección de correo electrónico verificada.", "example": "alice@example.com" }, "is_breached": { "type": "boolean", "description": "`true` cuando la dirección aparece en filtraciones de datos conocidas (consulta de inteligencia de filtraciones realizada al finalizar)." }, "breaches": { "type": "array", "description": "Hasta 5 de las filtraciones conocidas más recientes que contienen esta dirección. Array vacío (u omitido) cuando `is_breached` es `false`.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Identificador de la filtración." }, "domain": { "type": "string", "description": "Dominio del servicio filtrado." }, "breach_date": { "type": "string", "format": "date", "description": "Fecha en que se produjo la filtración." }, "breach_emails_count": { "type": "integer", "description": "Número total de cuentas expuestas en la filtración." }, "description": { "type": "string", "description": "Descripción legible de la brecha (puede contener marcado HTML)." }, "logo_path": { "type": "string", "description": "URL del logotipo del servicio afectado por la filtración." }, "data_classes": { "type": "array", "items": { "type": "string" }, "description": "Categorías de datos expuestos, en snake_case (p. ej., `email_addresses`, `passwords`)." }, "is_verified": { "type": "boolean", "description": "Si la filtración se ha verificado como legítima." } } } }, "is_disposable": { "type": "boolean", "description": "`true` cuando el dominio pertenece a un proveedor conocido de correo desechable o temporal." }, "is_undeliverable": { "type": "boolean", "description": "`true` cuando la dirección no puede recibir correo (falló la validación de sintaxis o de DNS/MX, o el mensaje rebotó)." }, "verification_attempts": { "type": "integer", "description": "Número de envíos de OTP para esta verificación (1, o 2 tras un reintento)." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se introdujo el código correcto. `null` si la verificación nunca se aprobó." }, "warnings": { "type": "array", "description": "Advertencias de riesgo registradas durante la verificación (duplicado, filtrado, desechable, no entregable, intentos superados, lista de bloqueo, etc.). Array vacío cuando no hay ninguna.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Función que generó la advertencia. Aquí siempre es `EMAIL`." }, "risk": { "type": "string", "description": "Código de riesgo legible por máquina." }, "additional_data": { "type": "object", "nullable": true, "description": "Contexto específico del riesgo (p. ej., el id de la sesión duplicada en los riesgos de duplicado). `null` cuando el riesgo no incluye datos adicionales." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravedad. Los riesgos `error` rechazan la verificación, `warning` la marca para revisión e `information` se registra sin afectar al estado." }, "short_description": { "type": "string", "description": "Resumen legible del riesgo en una línea." }, "long_description": { "type": "string", "description": "Explicación legible del riesgo." } } } }, "lifecycle": { "type": "array", "description": "Registro de auditoría cronológico de la verificación. El `type` del evento es uno de `EMAIL_VERIFICATION_MESSAGE_SENT`, `EMAIL_VERIFICATION_RETRY_MESSAGE_SENT`, `VALID_CODE_ENTERED`, `INVALID_CODE_ENTERED`, `EMAIL_VERIFICATION_APPROVED`, `EMAIL_VERIFICATION_DECLINED`, `EMAIL_VERIFICATION_IN_REVIEW`, `EMAIL_VERIFICATION_EXPIRED`.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Tipo de evento." }, "timestamp": { "type": "string", "format": "date-time", "description": "Cuándo ocurrió el evento." }, "details": { "type": "object", "nullable": true, "description": "Payload específico del evento. Eventos de envío: `{status, reason}`. Eventos de introducción del código: `{code_tried, status}`. Eventos de estado final: `null`, o `{reason}` cuando está rechazado o en revisión." }, "fee": { "type": "number", "description": "Importe en USD facturado por este evento. Distinto de cero solo en el primer envío correcto; 0 en los reintentos, las introducciones de código y los eventos de estado." } } } }, "matches": { "type": "array", "description": "Otras sesiones de tu aplicación (KYC, KYB o API) en las que un usuario distinto (con un `vendor_data` distinto) usó la misma dirección de correo electrónico. Hasta 5 entradas; cuando existe, se antepone una coincidencia sintética de entrada de la lista de bloqueo (y solo si no existe ningún correo electrónico bloqueado derivado de una sesión); las coincidencias derivadas de sesiones mantienen el orden de created_at. Array vacío cuando no hay coincidencias.", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID de sesión de la otra verificación que usó esta dirección de correo electrónico." }, "session_number": { "type": "integer", "description": "Número secuencial legible de esa sesión." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` de esa sesión." }, "verification_date": { "type": "string", "description": "Cuándo se creó esa sesión (`YYYY-MM-DDTHH:MM:SSZ`)." }, "email": { "type": "string", "description": "La dirección de correo electrónico que coincidió." }, "status": { "type": "string", "description": "Estado de esa sesión (p. ej., `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Si la dirección de correo electrónico está en la lista de bloqueo de tu aplicación." }, "api_service": { "type": "string", "nullable": true, "description": "En las sesiones de tipo API, la API independiente que la creó (p. ej., `PHONE_VERIFICATION`); `null` en las sesiones de verificación normales." }, "source": { "type": "string", "description": "Dónde se encontró la coincidencia. Normalmente `session`; una coincidencia en la lista de bloqueo a través de una entrada de lista de la organización antepone una coincidencia sintética con `source: \"list_entry\"` y `session_id`/`session_number` nulos." } } } }, "email_social": { "$ref": "#/components/schemas/EmailSocialFootprint" }, "email_intelligence": { "allOf": [ { "$ref": "#/components/schemas/EmailIntelligence" } ], "description": "Señales de inteligencia de correo electrónico. Solo están presentes cuando `enable_enrichment` era `true` en la comprobación." } } }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` de la sesión de la verificación coincidente. `null` en `Expired or Not Found`." }, "metadata": { "type": "object", "nullable": true, "description": "`metadata` de la sesión de la verificación coincidente. `null` en `Expired or Not Found`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de tiempo de esta respuesta de comprobación." } } }, "WorkflowListItem": { "type": "object", "description": "Una versión de flujo en la vista de lista.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID por versión. Úsalo como `{settings_uuid}` para obtener, actualizar o eliminar, y como `workflow_id` al crear sesiones." }, "workflow_id": { "type": "string", "format": "uuid", "description": "ID de grupo estable compartido por todas las versiones del mismo flujo. Es igual a `uuid` en la versión 1." }, "workflow_label": { "type": "string", "description": "Nombre visible del flujo de verificación." }, "workflow_type": { "type": "string", "nullable": true, "description": "Tipo base para flujos simples: `kyc`, `kyb`, `adaptive_age_verification`, `biometric_authentication`, etc. `null` para flujos basados en grafos sin una función de KYB." }, "is_default": { "type": "boolean", "description": "Si este es el flujo predeterminado para las sesiones nuevas." }, "is_archived": { "type": "boolean" }, "is_white_label_enabled": { "type": "boolean", "description": "Indica si la personalización de marca blanca se aplica a las sesiones creadas con este flujo." }, "total_price": { "type": "number", "description": "Precio fijo por verificación en USD (número JSON; excluye funciones de precio variable como DATABASE_VALIDATION y PHONE_VERIFICATION)." }, "min_price": { "type": "number", "description": "Precio fijo más bajo entre las rutas del grafo del flujo, en USD." }, "max_price": { "type": "number", "description": "Precio fijo más alto entre las rutas del grafo del flujo, en USD." }, "features": { "type": "string", "description": "Funciones habilitadas como una única cadena unida con `\" + \"`, por ejemplo `\"OCR + LIVENESS + FACE_MATCH\"`. Divide por `\" + \"` para obtener una lista." }, "is_simple_workflow": { "type": "boolean", "description": "True cuando el flujo no tiene un grafo de flujo personalizado." }, "is_editable": { "type": "boolean", "description": "True cuando esta versión es un `draft` (los borradores se pueden editar directamente; las versiones publicadas son inmutables en la Console)." }, "workflow_url": { "type": "string", "format": "uri", "description": "URL de verificación pública y compartible de este flujo (`https://verify.didit.me/u/`)." }, "max_retry_attempts": { "type": "integer", "description": "Número máximo de reintentos permitidos tras una verificación rechazada (0-10)." }, "retry_window_days": { "type": "integer", "nullable": true, "description": "Ventana móvil en días que se usa para contar los reintentos (1-365). `null` = límite sobre todo el historial." }, "session_expiration_time": { "type": "integer", "description": "Segundos antes de que expire una sesión sin finalizar (3600-2419200)." }, "version": { "type": "integer", "description": "Número de versión dentro del grupo `workflow_id`, empezando por 1." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Estado de la versión. Las nuevas sesiones usan la última versión `published` de un grupo." }, "has_draft": { "type": "boolean", "description": "True cuando alguna versión de este grupo `workflow_id` es actualmente un borrador." }, "created_by": { "type": "object", "nullable": true, "description": "Quién creó esta versión: `{name, email, type}`, donde `type` es `user` (usuario de la consola, con `email` definido) o `api_key` (`name` es el ID de cliente y `email` es null). `null` cuando no se registró ningún creador.", "properties": { "name": { "type": "string" }, "email": { "type": "string", "nullable": true }, "type": { "type": "string", "enum": [ "user", "api_key" ] } } }, "updated_at": { "type": "string", "format": "date-time" } } }, "SimpleWorkflowRequest": { "type": "object", "description": "Crea un flujo de verificación (workflow) lineal simple. La API convierte internamente esta lista de funciones en un grafo de flujo basado en nodos. Lista ESTRICTA de campos permitidos: cualquier clave que no figure aquí (incluida `workflow_type`) se rechaza con un 400.", "required": [ "features" ], "properties": { "workflow_label": { "type": "string", "maxLength": 50, "default": "ID Verification", "description": "Nombre visible del flujo de verificación (máx. 50 caracteres). Si se omite, el valor predeterminado es `\"ID Verification\"`: defínelo siempre para que los flujos se puedan distinguir.", "example": "Standard KYC" }, "is_default": { "type": "boolean", "description": "Establece este flujo de verificación (workflow) como predeterminado para las nuevas sesiones." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Omite este campo para crear un flujo publicado y listo para sesiones. Usa `draft` solo cuando quieras guardarlo sin publicarlo." }, "features": { "type": "array", "minItems": 1, "description": "Funciones de verificación en orden de ejecución. La API enlaza cada elemento con el siguiente y añade automáticamente un nodo de estado final.", "items": { "$ref": "#/components/schemas/SimpleWorkflowFeature" } }, "is_white_label_enabled": { "type": "boolean", "description": "Activa la personalización de marca blanca para las sesiones creadas con este flujo de verificación (workflow).", "default": false }, "is_desktop_allowed": { "type": "boolean", "description": "Permite que el flujo de verificación se ejecute en navegadores de escritorio.", "default": false }, "max_retry_attempts": { "type": "integer", "minimum": 0, "maximum": 10, "default": 3, "description": "Número máximo de reintentos permitidos tras una verificación rechazada. `0` bloquea al usuario tras el primer rechazo." }, "retry_window_days": { "type": "integer", "minimum": 1, "maximum": 365, "nullable": true, "default": 7, "description": "Ventana móvil en días que se usa para contar los reintentos. `null` aplica un límite sobre todo el historial." }, "face_liveness_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "default": 3, "description": "Número máximo de envíos de prueba de vida por sesión. Valor predeterminado: 3 (un intento inicial más dos reintentos). Este valor también se copia en los nodos de prueba de vida y de estimación de edad generados en el flujo, salvo que la configuración a nivel de función lo sobrescriba." }, "face_match_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "default": 3, "description": "Número máximo de envíos de coincidencia facial por sesión. Valor predeterminado: 3 (un intento inicial más dos reintentos). Este valor también se copia en los nodos de coincidencia facial generados en el flujo, salvo que la configuración a nivel de función lo sobrescriba." }, "session_expiration_time": { "type": "integer", "minimum": 3600, "maximum": 2419200, "default": 604800, "description": "Segundos antes de que expire una sesión sin finalizar. Mínimo 1 hora (3600), máximo 4 semanas (2419200)." } } }, "SimpleWorkflowUpdateRequest": { "type": "object", "description": "Actualiza los metadatos del flujo o reemplaza la lista lineal completa de funciones. Lista ESTRICTA de campos permitidos: cualquier clave que no figure aquí se rechaza con un 400.", "properties": { "workflow_label": { "type": "string", "maxLength": 50, "description": "Nombre visible del flujo de verificación (máx. 50 caracteres)." }, "is_default": { "type": "boolean", "description": "Establece este flujo de verificación (workflow) como predeterminado para las nuevas sesiones." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Controla el versionado. Omítelo para actualizar la versión actual sin crear una nueva (los borradores se publican automáticamente). `published` en una versión ya publicada crea y devuelve una versión NUEVA. `draft` solo es válido mientras la versión siga siendo un borrador." }, "features": { "type": "array", "minItems": 1, "description": "Si se proporciona, sustituye por completo el orden y la configuración de las funciones.", "items": { "$ref": "#/components/schemas/SimpleWorkflowFeature" } }, "is_white_label_enabled": { "type": "boolean", "description": "Activa la personalización de marca blanca para las sesiones creadas con este flujo de verificación (workflow)." }, "is_desktop_allowed": { "type": "boolean", "description": "Permite que el flujo de verificación se ejecute en navegadores de escritorio." }, "max_retry_attempts": { "type": "integer", "minimum": 0, "maximum": 10, "description": "Número máximo de reintentos permitidos tras una verificación rechazada. `0` bloquea al usuario tras el primer rechazo." }, "retry_window_days": { "type": "integer", "minimum": 1, "maximum": 365, "nullable": true, "description": "Ventana móvil en días que se usa para contar los reintentos. `null` aplica un límite sobre todo el historial." }, "face_liveness_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "description": "Número máximo de envíos de prueba de vida por sesión. Este valor también se copia en los nodos de prueba de vida y de estimación de edad generados en el flujo, salvo que la configuración a nivel de función lo sobrescriba." }, "face_match_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "description": "Número máximo de envíos de coincidencia facial por sesión. Este valor también se copia en los nodos de coincidencia facial generados en el flujo, salvo que la configuración a nivel de función lo sobrescriba." }, "session_expiration_time": { "type": "integer", "minimum": 3600, "maximum": 2419200, "description": "Segundos antes de que expire una sesión sin finalizar. Mínimo 1 hora (3600), máximo 4 semanas (2419200)." } } }, "SimpleWorkflowFeature": { "type": "object", "required": [ "feature" ], "properties": { "feature": { "type": "string", "description": "Función que se va a ejecutar. Usa los valores en mayúsculas que se muestran aquí.", "enum": [ "OCR", "NFC", "LIVENESS", "FACE_MATCH", "PROOF_OF_ADDRESS", "QUESTIONNAIRE", "DOCUMENT_AI", "PHONE_VERIFICATION", "EMAIL_VERIFICATION", "DATABASE_VALIDATION", "AML", "IP_ANALYSIS", "AGE_ESTIMATION", "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE", "SIGNATURE" ] }, "config": { "type": "object", "description": "Configuración específica de la función. Para `QUESTIONNAIRE`, incluye `questionnaire_uuid` con el `questionnaire_id` que devuelve el endpoint de creación de cuestionarios. Para `SIGNATURE`, un flujo que pasa a producción necesita un documento para firmar: establece `signature_documents_source` en `session` o `both` para que cada sesión pueda aportar el suyo, o envía `status: \"draft\"` y añade los documentos antes de publicar. `signature_level: \"aes\"` se rechaza con `aes_not_available` mientras `signature_availability.aes` sea `false` en el flujo. Para `OCR`, `methods` selecciona qué métodos de verificación de identidad puede usar cada país (captura de documento, consulta sin documento contra una fuente gubernamental u otra fuente oficial, y wallets de identidad digital); si lo omites, todos los países usan solo captura de documento. Para `SIGNATURE`, consulta la [configuración de firma electrónica](/es/management-api/workflows/feature-configs#firma-electrónica): por ahora `signature_level` acepta `simple` (el valor predeterminado, sin necesidad de verificación de identidad, correo electrónico ni teléfono) y `aes`, y los documentos del flujo y sus campos se gestionan en la consola, así que a través de la API envía los documentos y campos por sesión con `signature_documents_source: \"session\"`.", "additionalProperties": true }, "label": { "type": "string", "description": "Etiqueta interna opcional para este nodo del flujo." } } }, "ReviewItem": { "type": "object", "description": "Una entrada del feed de revisión / actividad de una sesión. Los cambios de estado incluyen `previous_status`, `new_status`, `previous_value`, `new_value` y `changed_fields`; los comentarios incluyen `comment` y (en los comentarios de la Console) `mentioned_emails`; los demás campos son `null` o están vacíos cuando no se aplican al tipo de actividad.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador único de esta entrada del feed.", "example": "de0561bc-5583-4409-9171-1a31a4c8a5f4" }, "activity_type": { "type": "string", "enum": [ "COMMENT", "STATUS_UPDATED", "KYC_DATA_UPDATED", "POA_DATA_UPDATED", "FILE_ADDED", "FILE_REMOVED", "AML_ONGOING_MATCH", "AML_STATUS_UPDATED", "AML_HIT_STATUS_UPDATED", "KYB_DATA_UPDATED", "KYB_DOCUMENT_UPLOADED", "TAG_ADDED", "TAG_REMOVED", "FEATURE_OVERRIDE_PENDING", "FEATURE_OVERRIDE_APPLIED", "FEATURE_OVERRIDE_CANCELLED" ], "description": "Qué tipo de actividad registra esta entrada. Las filas `STATUS_UPDATED` provienen de decisiones manuales (`PATCH /v3/session/{session_id}/update-status/`) y de entradas añadidas mediante `POST …/reviews/` (que usan este tipo por defecto incluso cuando no se registra ningún estado). Las filas `COMMENT` provienen de revisores de la Console; las vistas de la página de detalle de la Console también se almacenan como filas `COMMENT` marcadas con `metadata.system_event = \"DETAIL_VIEWED\"`. Los tipos restantes registran ediciones de datos, cambios de archivos, etiquetas y actividad de monitorización AML. Las filas STATUS_UPDATED también las escriben actores del sistema (p. ej., la monitorización AML continua con actor_type SYSTEM y las actualizaciones automáticas del estado de funciones), no solo el endpoint update-status y las solicitudes POST de revisión manual. `FEATURE_OVERRIDE_PENDING`, `FEATURE_OVERRIDE_APPLIED` y `FEATURE_OVERRIDE_CANCELLED` registran una anulación del estado de una comprobación (`PATCH /v3/session/{session_id}/features/{node_id}/update-status/`): solicitada para esperar a que termine el flujo, aplicada o cancelada. Llevan el estado de la comprobación en `previous_value` / `new_value` (`{\"status\": ...}`), dejan `previous_status` y `new_status` en `null` e identifican la anulación en `metadata` (`feature_override_id`, `node_id`, `feature_model`, `forced`, `state`, `cancel_reason`). La entrada de la solicitud incluye el `comment` del revisor; una anulación aplicada cuando termina el flujo se registra con `actor_type` `SYSTEM`.", "example": "STATUS_UPDATED" }, "actor_display": { "type": "string", "description": "Etiqueta legible del autor, resuelta en este orden: nombre completo del actor → identificador de la cuenta de Console → parte local de `actor_email` → `\"API Client\"` (para actores `API_KEY`) → `\"System\"` (para actores `SYSTEM`) → `\"Unknown\"`. Las entradas creadas mediante `POST …/reviews/` siempre muestran `\"Unknown\"` porque ese endpoint no registra la atribución del actor.", "example": "API Client" }, "actor_email": { "type": "string", "nullable": true, "description": "Correo electrónico del usuario de la consola que realizó la acción. `null` para actores de clave de API y del sistema.", "example": null }, "actor_type": { "type": "string", "enum": [ "API_KEY", "CONSOLE_USER", "SYSTEM" ], "description": "Quién realizó la acción: una clave de API, un usuario de la consola o la propia Didit (`SYSTEM`, p. ej., la monitorización AML continua). Las entradas creadas mediante `POST …/reviews/` llevan el valor predeterminado `CONSOLE_USER`, sea quien sea quien hace la llamada.", "example": "API_KEY" }, "new_status": { "type": "string", "nullable": true, "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Estado de la sesión registrado por esta entrada (en las actualizaciones de estado). `null` en los comentarios y en las entradas de cambio de datos.", "example": "Approved" }, "previous_status": { "type": "string", "nullable": true, "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Estado que tenía la sesión antes del cambio. Se rellena en las entradas `STATUS_UPDATED` escritas por el endpoint de actualización de estado; `null` en las entradas añadidas mediante `POST …/reviews/`. También se rellena en las filas STATUS_UPDATED escritas por el sistema.", "example": "In Review" }, "comment": { "type": "string", "nullable": true, "description": "Nota en texto libre asociada a la entrada, o `null`.", "example": "Document re-checked manually; address matches." }, "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Usuarios de la consola mencionados con `@email` en el comentario. Siempre vacío para las entradas creadas mediante esta API: el procesamiento de menciones es una función exclusiva de la consola.", "example": [] }, "previous_value": { "type": "object", "nullable": true, "description": "Instantánea de los datos modificados antes de la acción, p. ej. `{\"status\": \"In Review\"}` en un cambio de estado. `null` cuando no se modificó nada.", "example": { "status": "In Review" } }, "new_value": { "type": "object", "nullable": true, "description": "Instantánea de los datos modificados después de la acción, p. ej., `{\"status\": \"Approved\"}`. `null` cuando no se modificó nada.", "example": { "status": "Approved" } }, "changed_fields": { "type": "array", "items": { "type": "string" }, "description": "Nombres de los campos modificados por esta actividad (p. ej., `[\"status\"]`). Vacío para los comentarios y para las entradas añadidas mediante `POST …/reviews/`.", "example": [ "status" ] }, "metadata": { "type": "object", "nullable": true, "description": "Contexto adicional para las entradas generadas por el sistema. Las visualizaciones de páginas de detalle en la consola incluyen `{\"system_event\": \"DETAIL_VIEWED\", \"detail_type\": \"verification\"}` para que puedan excluirse de la lógica de notificaciones. `null` para las entradas normales.", "example": null }, "created_at": { "type": "string", "format": "date-time", "description": "Cuándo se escribió la entrada, en ISO 8601 UTC.", "example": "2026-06-12T00:19:31.918735Z" } } }, "QuestionnaireListItem": { "type": "object", "description": "Una versión de un cuestionario en la vista de lista.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID por versión. Úsalo como `{questionnaire_uuid}` para obtener, actualizar o eliminar, y como `questionnaire_uuid` en la configuración de la función QUESTIONNAIRE de un flujo." }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "languages": { "type": "array", "items": { "type": "string" } }, "default_language": { "type": "string" }, "is_active": { "type": "boolean" }, "is_simple_questionnaire": { "type": "boolean", "description": "True para los cuestionarios lineales creados mediante esta API; false para los cuestionarios basados en grafos creados en la Console." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "question_types": { "type": "array", "items": { "type": "string" }, "description": "Tipos de elemento, en mayúsculas, de las preguntas que admiten respuesta, en orden de creación (p. ej., `SHORT_TEXT`, `MULTIPLE_CHOICE`, `FILE_UPLOAD`). Se excluyen los elementos estructurales `SECTION_HEADER` y `SEPARATOR`. Hay una entrada por pregunta, por lo que los valores pueden repetirse." }, "workflow_names": { "type": "array", "items": { "type": "string" }, "description": "Nombres de los flujos que usan este cuestionario. Actualmente siempre es `[]` en este endpoint (solo se rellena en el listado de la Console)." }, "questionnaire_group_id": { "type": "string", "format": "uuid", "description": "Identificador estable que agrupa todas las versiones del mismo cuestionario." }, "version": { "type": "integer", "description": "Número de versión dentro del grupo, empezando por 1." }, "status": { "type": "string", "enum": [ "draft", "published" ] }, "published_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se publicó esta versión. `null` para los borradores." }, "is_editable": { "type": "boolean", "description": "True cuando esta versión es un `draft`." } } }, "SimpleQuestionnaireRequest": { "type": "object", "description": "Crea un cuestionario lineal simple. La API convierte `form_elements` en el grafo interno del cuestionario.", "required": [ "title", "languages", "form_elements" ], "properties": { "title": { "type": "string", "description": "Nombre interno del cuestionario." }, "description": { "type": "string", "nullable": true }, "languages": { "type": "array", "description": "Idiomas incluidos en cada etiqueta. Debe incluir `en`.", "items": { "type": "string" }, "example": [ "en" ] }, "default_language": { "type": "string", "description": "Idioma predeterminado. Debe estar incluido en `languages`.", "example": "en" }, "is_active": { "type": "boolean", "default": true }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Omite este campo para crear un cuestionario publicado y listo para usarse en flujos." }, "form_elements": { "type": "array", "minItems": 1, "description": "Preguntas en el orden exacto en que los usuarios deben verlas. No se admiten ramificaciones ni campos condicionales.", "items": { "$ref": "#/components/schemas/SimpleQuestionnaireElement" } } } }, "SimpleQuestionnaireUpdateRequest": { "type": "object", "description": "Actualiza los metadatos del cuestionario o reemplaza la lista lineal completa de `form_elements`.", "properties": { "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "languages": { "type": "array", "items": { "type": "string" } }, "default_language": { "type": "string" }, "is_active": { "type": "boolean" }, "status": { "type": "string", "enum": [ "draft", "published" ] }, "form_elements": { "type": "array", "minItems": 1, "description": "Si se proporciona, sustituye por completo la lista lineal de preguntas.", "items": { "$ref": "#/components/schemas/SimpleQuestionnaireElement" } } } }, "SimpleQuestionnaireElement": { "type": "object", "required": [ "element_type", "label" ], "properties": { "id": { "type": "string", "description": "ID de pregunta estable y opcional. Si se omite, la API genera `q1`, `q2`, etc. Usa letras minúsculas, números y guiones bajos para facilitar la lectura.", "example": "source_of_funds" }, "element_type": { "type": "string", "description": "Tipo de pregunta. La API acepta estos valores en minúsculas y sus equivalentes en mayúsculas.", "enum": [ "short_text", "long_text", "dropdown", "single_choice", "multiple_choice", "number", "image", "file_upload", "time", "email", "address", "phone", "country", "date_picker", "consent", "section_header", "separator", "heading", "paragraph" ] }, "label": { "type": "object", "description": "Etiqueta de la pregunta por código de idioma, por ejemplo `{ \"en\": \"Source of funds\" }`.", "additionalProperties": { "type": "string" } }, "description": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" } }, "placeholder": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" } }, "is_required": { "type": "boolean", "default": false }, "options": { "type": "array", "description": "Úsalo para `dropdown`, `single_choice` y `multiple_choice`. Si se omite `value`, la API genera uno a partir de la etiqueta de la opción.", "items": { "type": "object", "required": [ "label" ], "properties": { "value": { "type": "string" }, "label": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "max_files": { "type": "integer", "minimum": 1, "maximum": 5, "description": "Úsalo con `file_upload` o `image`." }, "validation": { "type": "object", "nullable": true, "description": "Validación de formato opcional para `short_text`, `long_text` o `number`. Se aplica mientras el usuario rellena el campo (no puede continuar hasta que la supere) y la API la vuelve a comprobar al enviarlo.", "properties": { "pattern": { "type": "string", "description": "Expresión regular (subconjunto de ECMA-262) con la que el valor debe coincidir por completo. Para `short_text` y `long_text`. No añadas los anclajes ^/$; se compara el valor completo." }, "min_length": { "type": "integer", "minimum": 0, "description": "Número mínimo de caracteres. Para `short_text` y `long_text`." }, "max_length": { "type": "integer", "minimum": 0, "description": "Número máximo de caracteres. Para `short_text` y `long_text`." }, "min": { "type": "number", "description": "Valor numérico mínimo. Para `number`." }, "max": { "type": "number", "description": "Valor numérico máximo. Para `number`." }, "error_message": { "type": "object", "description": "Mensaje traducido que se muestra cuando falla la validación, indexado por código de idioma.", "additionalProperties": { "type": "string" } } } } } }, "QuestionnaireDetail": { "type": "object", "description": "Detalle completo del cuestionario que devuelven los endpoints GET, POST (crear) y PATCH (actualizar).", "properties": { "questionnaire_id": { "type": "string", "format": "uuid", "description": "Identificador único del cuestionario. Usa este id para hacer referencia al cuestionario desde un flujo o en solicitudes posteriores de actualización o eliminación." }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "languages": { "type": "array", "items": { "type": "string" } }, "default_language": { "type": "string" }, "is_active": { "type": "boolean" }, "is_simple_questionnaire": { "type": "boolean" }, "graph": { "type": "object", "description": "Estructura de grafo con start_node y un mapa de nodos." }, "sections": { "type": "array", "description": "Contenido del cuestionario agrupado en secciones (derivado del grafo).", "items": { "type": "object" } }, "questionnaire_group_id": { "type": "string", "format": "uuid", "description": "Identificador estable que agrupa todas las versiones del mismo cuestionario." }, "version": { "type": "integer" }, "status": { "type": "string", "enum": [ "draft", "published" ] }, "published_at": { "type": "string", "format": "date-time", "nullable": true }, "is_editable": { "type": "boolean", "description": "True cuando el cuestionario aún puede editarse directamente (versiones en borrador)." } } }, "UserListItem": { "type": "object", "description": "Un usuario verificado.", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "UUID interno estable de Didit para este usuario." }, "vendor_data": { "type": "string", "nullable": true, "description": "Tu identificador único de este usuario (el que se envía al crear sesiones). Puede ser null si no se proporcionó ningún identificador propio." }, "display_name": { "type": "string", "nullable": true, "description": "Nombre visible personalizado que has definido" }, "full_name": { "type": "string", "nullable": true, "description": "Nombre completo extraído de los documentos verificados" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "effective_name": { "type": "string", "nullable": true, "description": "Mejor nombre disponible: display_name si está definido; si no, full_name" }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Estado del ciclo de vida del registro del usuario (NO es un estado de sesión). `ACTIVE` es el valor predeterminado, `FLAGGED` marca al usuario para atención manual y `BLOCKED` impide nuevas sesiones para este `vendor_data`." }, "portrait_image_url": { "type": "string", "nullable": true, "description": "URL prefirmada de la foto de retrato del usuario (caduca al cabo de unas horas)" }, "session_count": { "type": "integer", "description": "Número total de sesiones de verificación de este usuario" }, "approved_count": { "type": "integer", "description": "Número de sesiones aprobadas" }, "declined_count": { "type": "integer", "description": "Número de sesiones rechazadas" }, "in_review_count": { "type": "integer", "description": "Número de sesiones en revisión" }, "issuing_states": { "type": "array", "items": { "type": "string" }, "description": "Códigos ISO 3166-1 alpha-3 de los países emisores que figuran en los documentos de identidad aprobados de este usuario, p. ej., `[\"USA\", \"ESP\"]`. Array vacío si no hay ninguno." }, "approved_emails": { "type": "array", "items": { "type": "string" }, "description": "Direcciones de correo electrónico verificadas obtenidas de las sesiones aprobadas de este usuario, p. ej., `[\"john@example.com\"]`." }, "approved_phones": { "type": "array", "items": { "type": "string" }, "description": "Números de teléfono verificados obtenidos de las sesiones aprobadas de este usuario, p. ej., `[\"+14155551234\"]`." }, "features": { "type": "object", "description": "Estado agregado por función de todas las sesiones de este usuario. Claves posibles: `ID_VERIFICATION`, `NFC`, `LIVENESS`, `FACE_MATCH`, `POA`, `QUESTIONNAIRE`, `EMAIL_VERIFICATION`, `PHONE`, `AML`, `IP_ANALYSIS`, `AGE_ESTIMATION`, `DATABASE_VALIDATION`. Valores posibles: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub Requested`." }, "features_list": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string" }, "status": { "type": "string" } } }, "description": "Los mismos datos que `features`, como un array ordenado de objetos `{feature, status}`." }, "last_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de tiempo de la sesión más reciente" }, "first_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de tiempo de la primera sesión" }, "last_activity_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de tiempo de la actividad más reciente de este usuario (sesión, transacción, cambio de estado, edición de datos, etc.)." }, "tags": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string" } } }, "description": "Etiquetas asignadas a este usuario" }, "created_at": { "type": "string", "format": "date-time" } } }, "BlocklistItem": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "face", "document", "phone", "email" ] }, "session_id": { "type": "string", "format": "uuid" }, "session_number": { "type": "integer" }, "blocklisted_at": { "type": "string", "format": "date-time" }, "face_image": { "type": "string", "nullable": true }, "document_type": { "type": "string", "nullable": true }, "document_number": { "type": "string", "nullable": true }, "phone_number": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } } }, "UserDetailItem": { "type": "object", "description": "Detalle completo del usuario. Amplía UserListItem con metadatos, comentarios y updated_at.", "allOf": [ { "$ref": "#/components/schemas/UserListItem" }, { "type": "object", "properties": { "metadata": { "type": "object", "description": "JSON de metadatos personalizados que adjuntaste a este usuario. Valor predeterminado: `{}`." }, "tags": { "type": "array", "description": "Asignaciones de etiquetas. NOTA: en las respuestas de detalle, cada entrada es un objeto de *vínculo* de etiqueta (`{uuid, tag: {...}, added_by_email, added_by_name, created_at}`), a diferencia de la forma plana `{uuid, name, color}` que se usa en las respuestas de listado.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID de la asignación de etiqueta (no de la etiqueta en sí)." }, "tag": { "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" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "added_by_email": { "type": "string", "nullable": true }, "added_by_name": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" } } } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "comment_type": { "type": "string", "enum": [ "COMMENT", "STATUS_CHANGED", "METADATA_UPDATED", "TAG_ADDED", "TAG_REMOVED", "PROFILE_UPDATED" ] }, "comment": { "type": "string", "nullable": true }, "actor_email": { "type": "string", "nullable": true }, "actor_name": { "type": "string", "nullable": true }, "previous_status": { "type": "string", "nullable": true, "enum": [ "ACTIVE", "FLAGGED", "BLOCKED", null ] }, "new_status": { "type": "string", "nullable": true, "enum": [ "ACTIVE", "FLAGGED", "BLOCKED", null ] }, "previous_value": { "type": "object", "nullable": true, "description": "Valores anteriores de los campos en las entradas PROFILE_UPDATED." }, "new_value": { "type": "object", "nullable": true, "description": "Nuevos valores de campo para las entradas PROFILE_UPDATED." }, "changed_fields": { "type": "array", "items": { "type": "string" }, "description": "Nombres de los campos modificados por una entrada PROFILE_UPDATED." }, "metadata": { "type": "object", "nullable": true }, "mentioned_emails": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" } } }, "description": "Registro de actividad y comentarios de este usuario (cambios de estado, ediciones del perfil, notas manuales)." }, "updated_at": { "type": "string", "format": "date-time" } } } ] }, "BusinessListItem": { "type": "object", "description": "Una empresa verificada.", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "UUID interno estable de Didit para esta empresa." }, "vendor_data": { "type": "string", "nullable": true, "description": "Tu identificador único de esta empresa (el que se envía al crear sesiones). Puede ser null si no se proporcionó ningún identificador propio." }, "display_name": { "type": "string", "nullable": true, "description": "Nombre visible personalizado que has definido" }, "legal_name": { "type": "string", "nullable": true, "description": "Razón social oficial obtenida del registro o introducida manualmente" }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registro o de constitución de la empresa" }, "country_code": { "type": "string", "nullable": true, "description": "País de constitución (ISO 3166-1 alfa-2, p. ej., `GB`, `US`)." }, "effective_name": { "type": "string", "nullable": true, "description": "Mejor nombre disponible: display_name si está definido; si no, legal_name" }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Estado del ciclo de vida del registro de la empresa (NO es un estado de sesión). `ACTIVE` es el valor predeterminado, `FLAGGED` lo marca para atención manual y `BLOCKED` impide nuevas sesiones para este `vendor_data`." }, "session_count": { "type": "integer", "description": "Número total de sesiones de verificación de esta empresa" }, "approved_count": { "type": "integer", "description": "Número de sesiones aprobadas" }, "declined_count": { "type": "integer", "description": "Número de sesiones rechazadas" }, "in_review_count": { "type": "integer", "description": "Número de sesiones en revisión" }, "features": { "type": "object", "description": "Estado agregado por función de todas las sesiones KYB de esta empresa. Actualmente la única clave es `KYB` (el estado de la comprobación de la empresa en el registro). Valores posibles: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub Requested`." }, "features_list": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string" }, "status": { "type": "string" } } }, "description": "Los mismos datos que `features`, como un array ordenado de objetos `{feature, status}`." }, "last_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de tiempo de la sesión más reciente" }, "first_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de tiempo de la primera sesión" }, "last_activity_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de tiempo de la actividad más reciente (cambio de estado, actualización de la sesión, etc.)" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string" } } }, "description": "Etiquetas asignadas a esta empresa" }, "created_at": { "type": "string", "format": "date-time" } } }, "BusinessDetailItem": { "type": "object", "description": "Detalle completo de la empresa. Amplía BusinessListItem con los metadatos y updated_at.", "allOf": [ { "$ref": "#/components/schemas/BusinessListItem" }, { "type": "object", "properties": { "metadata": { "type": "object", "description": "JSON de metadatos personalizados que adjuntaste a esta empresa. Valor predeterminado: `{}`." }, "updated_at": { "type": "string", "format": "date-time" } } } ] }, "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." } } }, "TravelRuleSettingsDetail": { "type": "object", "properties": { "is_enabled": { "type": "boolean", "description": "Si el flujo gestionado de negociación de Travel Rule está activo para las transacciones `travelRule` salientes de esta aplicación." }, "jurisdiction": { "type": "string", "maxLength": 8, "description": "Código de la jurisdicción en la que opera tu VASP. Valor predeterminado: `\"EU\"`. Didit lo asigna al régimen que registra en tus transacciones de Travel Rule como `travel_rule_regime` (por ejemplo, `EU` o el código de un Estado miembro de la UE se convierte en `eu`), en el que pueden basarse las reglas de transacción. Los demás clientes de Didit lo ven como tu jurisdicción en el directorio de VASP una vez que la red de Didit incluye tu perfil." }, "name_matching_strictness": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Con qué rigor deben coincidir los nombres de los beneficiarios antes de que una transferencia pueda llegar a COMPLETED. `CONTAINS` acepta un nombre cuyas palabras aparezcan todas en el otro." }, "confirmation_timeout_hours": { "type": "integer", "minimum": 1, "description": "Horas que una transferencia AWAITING_COUNTERPARTY puede permanecer sin confirmar antes de que el proceso de limpieza periódico la expire. Valor predeterminado: 48." }, "timeout_outcome": { "type": "string", "enum": [ "HOLD", "REJECT", "PROCEED" ], "description": "Qué ocurre con la transacción subyacente cuando una transferencia expira. Valor predeterminado: HOLD. sunrise_policy y non_responsive_policy tienen prioridad cuando son aplicables y están configuradas." }, "threshold_amount": { "type": "string", "description": "Cadena decimal, en la moneda predeterminada de tu aplicación. Importe mínimo de transferencia que dispara un intercambio gestionado; las transferencias inferiores se resuelven directamente como NOT_APPLICABLE. Didit compara el importe de la transacción convertido a tu moneda predeterminada, o el `amount_in_default_currency` que envíes; cuando no hay un importe convertido disponible, el umbral no se aplica. Valor predeterminado: \"0.00\" (el TFR de la UE no aplica ningún importe mínimo)." }, "ownership_validation_mode": { "type": "string", "enum": [ "FULL", "SIMPLIFIED", "AUTOMATED" ], "description": "Cuánta prueba requiere la propiedad de una wallet. `FULL` siempre necesita una prueba (mensaje firmado, depósito de prueba o captura de pantalla revisada), nunca la palabra del usuario final. `SIMPLIFIED` acepta una autodeclaración por debajo de `simplified_validation_threshold` y una prueba por encima. `AUTOMATED` permite que la libreta de direcciones y las pruebas anteriores respondan por sí solas, incluidas las autodeclaraciones mientras `allow_self_declaration` sea true. Valor predeterminado: `AUTOMATED`." }, "simplified_validation_threshold": { "type": "string", "description": "Cadena decimal, valor predeterminado \"0.00\". En el modo `SIMPLIFIED`, una transferencia inferior a este importe (en la moneda del umbral) acepta una autodeclaración. Una transferencia sin importe en esa moneda se considera superior a él." }, "data_sharing_fields": { "$ref": "#/components/schemas/TravelRuleDataSharingFields" }, "matching_rules": { "$ref": "#/components/schemas/TravelRuleMatchingRules" }, "legal_name": { "type": "string", "description": "Nombre legal de tu VASP. Es obligatorio (no puede estar vacío) para establecer is_enabled en true." }, "lei": { "type": "string", "description": "Tu identificador de entidad jurídica (LEI), que se muestra en el directorio de VASP." }, "compliance_email": { "type": "string", "format": "email", "description": "Correo electrónico de contacto de cumplimiento de tu perfil de VASP. La red de Didit solo publica tu perfil cuando se confirma esta dirección mediante un enlace enviado por correo electrónico (POST /v3/travel-rule/settings/compliance-email/confirmation/). Si la cambias, necesitas una nueva confirmación." }, "is_discoverable": { "type": "boolean", "description": "Indica si tu perfil de VASP puede figurar en la red de Didit: otros clientes de Didit lo encuentran en GET /v3/travel-rule/vasps/ y pueden contactarlo por la vía INTERNAL. Para figurar también se necesita una aplicación en producción, Travel Rule activado, una razón social y un correo electrónico de cumplimiento confirmado; didit_network indica cuáles faltan. Valor predeterminado: true." }, "inbound_auto_accept": { "type": "boolean", "description": "Si es true, una consulta TRP entrante cuya wallet beneficiaria es una entrada verificada de la libreta de direcciones con un nombre coincidente se aprueba automáticamente. Si es false, esa consulta espera en ON_HOLD hasta que la apruebes o la deniegues con el endpoint de propiedad. Las transferencias por el rail INTERNAL y las posteriores al depósito no se ven afectadas. Valor predeterminado: true." }, "allow_self_declaration": { "type": "boolean", "description": "Si es true, el widget de propiedad de wallet ofrece la autodeclaración como método de prueba alternativo. Valor predeterminado: true." }, "allow_screenshot_proof": { "type": "boolean", "description": "Si es true, el widget de propiedad de wallet ofrece la carga de capturas de pantalla como método de evidencia de propiedad. Valor predeterminado: true." }, "auto_wallet_verification": { "type": "boolean", "description": "Si es true, al enviar una transferencia saliente de Travel Rule que requiere que el usuario final demuestre el control de la wallet, se crea automáticamente una sesión del widget de propiedad de wallet vinculada a la transacción y se expone en el bloque action_required de la transacción. Valor predeterminado: true." }, "vasp_attribution_enabled": { "type": "boolean", "description": "Si es true, una transferencia saliente de Travel Rule que ningún rail puede enrutar se atribuye mediante análisis de blockchain: la wallet de destino se asocia al VASP que la posee, la entidad se registra en la transferencia y en el directorio de VASP, y los rails se vuelven a ejecutar una vez con el nombre atribuido. Valor predeterminado: true." }, "counterparty_screening_enabled": { "type": "boolean", "description": "Análisis opcional de sanciones y medios adversos de los VASP contraparte, facturado por análisis al precio del Análisis AML de empresas. Cuando está activado, Didit analiza la contraparte a la que llega un intercambio saliente (reutilizando un análisis de menos de 30 días) y puedes analizar una con POST /v3/travel-rule/vasps/{vasp_id}/screening/. Valor predeterminado false: no se analiza ni se factura nada." }, "sunrise_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "Qué efecto tiene una transferencia expirada en su transacción cuando la contraparte es una entrada del directorio en una jurisdicción incluida en sunrise_jurisdictions, que aún no aplica la Travel Rule: HOLD la envía a revisión, REJECT la rechaza y PROCEED deja su estado sin cambios. Vacío (el valor por defecto) sigue timeout_outcome. Se aplica antes que non_responsive_policy." }, "sunrise_jurisdictions": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Solo lectura. Los países (ISO 3166 alfa-2) que Didit considera en periodo de transición (sunrise) de la Travel Rule, donde se aplica sunrise_policy. Actualmente, CO, KH y VN. Cualquier otra jurisdicción, así como una vacía o desconocida, sigue timeout_outcome." }, "non_responsive_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "Qué efecto tiene una transferencia expirada en su transacción cuando la contraparte es una entrada del directorio cuya capacidad de respuesta es UNRESPONSIVE: HOLD, REJECT o PROCEED, igual que en timeout_outcome. Vacío (el valor por defecto) sigue timeout_outcome. sunrise_policy se aplica primero cuando ambas corresponden." }, "travel_address": { "type": "string", "description": "Solo lectura. La travel address propia de tu VASP: el endpoint codificado de consultas TRP entrantes que otros VASP usan para contactarte. Está vacía mientras `is_enabled` sea false." }, "disabled_networks": { "type": "array", "items": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA" ] }, "description": "Redes excluidas de la membresía de la plataforma. No desactiva tus propias membresías conectadas ni habilita redes no disponibles.", "default": [] }, "networks": { "type": "object", "readOnly": true, "description": "Por cada red, cómo enviaría esta aplicación y por qué no puede hacerlo. Ninguna red, incluida GTR, se incluye de forma predeterminada: una red es accesible a través de tu propia membresía conectada, o a través de la membresía de Didit una vez que la membresía de Didit en esa red esté activa y tu propio participante en ella esté activo. No es una comprobación en tiempo real del estado ni de la entrega.", "properties": { "gtr": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "trust": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "verifyvasp": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "sygna": { "$ref": "#/components/schemas/TravelRuleNetworkState" } } }, "didit_network": { "type": "object", "readOnly": true, "description": "Si la red de Didit incluye tu perfil de VASP, de modo que otros clientes de Didit lo encuentren en el directorio y lo contacten por la vía INTERNAL, y cada condición que aún no cumple.", "properties": { "listed": { "type": "boolean" }, "missing": { "type": "array", "items": { "type": "string", "enum": [ "travel_rule_off", "sandbox_application", "not_discoverable", "legal_name_missing", "compliance_email_missing", "compliance_email_unconfirmed", "excluded_by_staff", "internal_organization" ] }, "description": "Vacío cuando el perfil está listado. compliance_email_unconfirmed: envía la confirmación con POST /v3/travel-rule/settings/compliance-email/confirmation/ y abre el enlace recibido por correo. excluded_by_staff: Didit marcó la aplicación como de prueba, de demostración o interna." }, "compliance_email_confirmed": { "type": "boolean", "description": "Si el compliance_email actual se confirmó mediante el enlace enviado por correo electrónico." } } } } }, "TravelRuleSettingsUpdate": { "type": "object", "properties": { "is_enabled": { "type": "boolean" }, "legal_name": { "type": "string", "maxLength": 255 }, "lei": { "type": "string", "maxLength": 20 }, "jurisdiction": { "type": "string", "maxLength": 8 }, "name_matching_strictness": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "`CONTAINS` acepta un nombre cuyas palabras aparecen todas en el otro." }, "confirmation_timeout_hours": { "type": "integer", "minimum": 1 }, "timeout_outcome": { "type": "string", "enum": [ "HOLD", "REJECT", "PROCEED" ] }, "compliance_email": { "type": "string", "format": "email", "description": "Correo electrónico de contacto de cumplimiento de tu perfil de VASP. La red de Didit solo publica tu perfil cuando se confirma esta dirección mediante un enlace enviado por correo electrónico (POST /v3/travel-rule/settings/compliance-email/confirmation/). Si la cambias, necesitas una nueva confirmación." }, "is_discoverable": { "type": "boolean", "description": "Indica si tu perfil de VASP puede figurar en la red de Didit: otros clientes de Didit lo encuentran en GET /v3/travel-rule/vasps/ y pueden contactarlo por la vía INTERNAL. Para figurar también se necesita una aplicación en producción, Travel Rule activado, una razón social y un correo electrónico de cumplimiento confirmado; didit_network indica cuáles faltan. Valor predeterminado: true." }, "threshold_amount": { "type": "string", "description": "Cadena decimal, cero o mayor, en la moneda predeterminada de tu aplicación. Importe mínimo de transferencia que dispara un intercambio gestionado." }, "ownership_validation_mode": { "type": "string", "enum": [ "FULL", "SIMPLIFIED", "AUTOMATED" ], "description": "Consulta el campo de la respuesta con el mismo nombre." }, "simplified_validation_threshold": { "type": "string", "description": "Cadena decimal, 0 o mayor." }, "data_sharing_fields": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleDataSharingFields" } ], "description": "Se combina por tipo de entidad: un tipo de entidad que omitas conserva su elección actual. Una elección que no pueda cumplir las obligaciones del ordenante del régimen de tu `jurisdiction` (TFR de la UE o Recomendación 16 del GAFI), incluida una lista vacía, se rechaza con `400`." }, "matching_rules": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleMatchingRules" } ], "description": "Se combina por tipo de entidad y, dentro de cada uno, por campo. Un campo que ese tipo de entidad no compara (por ejemplo, `date_of_birth` para `company`) se rechaza con `400`." }, "inbound_auto_accept": { "type": "boolean" }, "allow_self_declaration": { "type": "boolean" }, "allow_screenshot_proof": { "type": "boolean", "description": "Si es true, el widget de propiedad de wallet ofrece la carga de capturas de pantalla como método de evidencia de propiedad. Valor predeterminado: true." }, "auto_wallet_verification": { "type": "boolean" }, "vasp_attribution_enabled": { "type": "boolean" }, "counterparty_screening_enabled": { "type": "boolean", "description": "Análisis opcional de sanciones y medios adversos de los VASP contraparte, facturado por análisis al precio del Análisis AML de empresas. Cuando está activado, Didit analiza la contraparte a la que llega un intercambio saliente (reutilizando un análisis de menos de 30 días) y puedes analizar una con POST /v3/travel-rule/vasps/{vasp_id}/screening/. Valor predeterminado false: no se analiza ni se factura nada." }, "sunrise_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "HOLD, REJECT, PROCEED o vacío para seguir timeout_outcome. Consulta el campo de respuesta con el mismo nombre." }, "non_responsive_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "HOLD, REJECT, PROCEED o vacío para seguir timeout_outcome. Consulta el campo de respuesta con el mismo nombre." }, "disabled_networks": { "type": "array", "items": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA" ] }, "description": "Redes excluidas de la membresía de la plataforma. No desactiva tus propias membresías conectadas ni habilita redes no disponibles.", "default": [] } }, "description": "Todos los campos son opcionales; PUT aplica una actualización parcial." }, "WalletAddressEntry": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "address": { "type": "string", "description": "La dirección de la wallet; `\"\"` para una entrada importada solo por su hash. Única por aplicación, cadena y memo, comparando la dirección sin distinguir mayúsculas de minúsculas. Después de eliminar una entrada, puedes registrar de nuevo la misma dirección." }, "chain": { "type": "string", "description": "Token de cadena de la dirección, por ejemplo `ETH` o `BTC`. Cuando Didit enruta o registra una transferencia, busca coincidencias en las entradas de la libreta de direcciones por la dirección de la wallet y, cuando la transferencia incluye una cadena, también por este valor, sin distinguir mayúsculas y minúsculas. La cadena de una transferencia es `beneficiary_data.chain`, que se rellena a partir de la cadena cripto o del símbolo de la moneda de la transacción (por ejemplo `ETH`) cuando no la envías, o la `chain` de un registro posterior al depósito, así que usa el mismo token en todas partes. Una entrada con la cadena vacía coincide con cualquier cadena. Un beneficiario de Lightning (un id de nodo o una Lightning Address) registrado en bitcoin se almacena en minúsculas en `LIGHTNING`, donde se buscan coincidencias para las transferencias de Lightning. Las cadenas conocidas se almacenan con un único identificador canónico, sea cual sea la grafía que envíes: \"ethereum\", \"Ethereum\" y \"ERC20\" se almacenan como ETH, \"BNB Smart Chain\" y \"BEP20\" como BNB, y \"tron\" como TRX. Un nombre de cadena desconocido se conserva tal como se envió." }, "holder_vendor_data": { "type": "string", "description": "Tu identificador interno del titular." }, "holder_name": { "type": "string", "description": "Nombre del titular de la wallet, que se usa para la coincidencia del nombre del beneficiario." }, "entity_type": { "type": "string", "description": "Texto libre; por defecto, \"individual\"." }, "is_ownership_verified": { "type": "boolean", "description": "Solo lectura. Indica si se ha demostrado la propiedad de esta dirección." }, "created_at": { "type": "string", "format": "date-time" }, "travel_address": { "type": "string", "description": "La dirección de viaje (travel address) del VASP de la contraparte para esta wallet, si se conoce. Permite a Didit enrutar las transferencias de este beneficiario por el canal TRP, para los activos que admite TRP (BTC, ETH y USDC en una red concreta)." }, "address_hash": { "type": "string", "description": "Solo lectura. SHA-256 de la dirección en minúsculas, en hexadecimal en minúsculas. Una entrada importada solo por su hash se compara con este valor." }, "memo": { "type": "string", "description": "La etiqueta de destino o memo que forma parte de la wallet en una red con memo (XRP, XLM, EOS, ATOM, HBAR); `\"\"` para la dirección completa. Una entrada con memo solo coincide con transferencias que indican ese memo; una sin memo coincide con toda la dirección." }, "receiving_travel_address": { "type": "string", "readOnly": true, "description": "Tu dirección de viaje específica para esta wallet: dásela al VASP emisor para que su consulta TRP identifique esta wallet. Vacía para una wallet registrada como de otro VASP, mientras Travel Rule está desactivada y antes de que se guarde tu perfil de VASP." } } }, "WalletAddressEntryCreate": { "type": "object", "required": [ "address" ], "properties": { "address": { "type": "string", "maxLength": 128, "description": "La dirección de la wallet. Una X-address de XRP se almacena como su dirección clásica y su tag, por lo que coincide con las transferencias que indiquen cualquiera de las dos formas." }, "chain": { "type": "string", "maxLength": 32, "description": "Token de cadena de la dirección, por ejemplo `ETH` o `BTC`. Cuando Didit enruta o registra una transferencia, busca coincidencias en las entradas de la libreta de direcciones por la dirección de la wallet y, cuando la transferencia incluye una cadena, también por este valor, sin distinguir mayúsculas de minúsculas. La cadena de una transferencia es `beneficiary_data.chain`, que se rellena a partir de la cadena cripto o del símbolo de la moneda de la transacción (por ejemplo `ETH`) cuando no la envías, o el `chain` de un registro posterior al depósito, así que usa el mismo token en todas partes. Una entrada con la cadena vacía coincide con cualquier cadena. Las cadenas conocidas se almacenan con un único identificador canónico, sea cual sea la grafía que envíes: \"ethereum\", \"Ethereum\" y \"ERC20\" se almacenan como ETH, \"BNB Smart Chain\" y \"BEP20\" como BNB, y \"tron\" como TRX. Un nombre de cadena desconocido se conserva tal como se envía." }, "holder_vendor_data": { "type": "string", "maxLength": 255 }, "holder_name": { "type": "string", "maxLength": 255 }, "entity_type": { "type": "string", "default": "individual", "maxLength": 16 }, "self_declared": { "type": "boolean", "default": false, "description": "Solo escritura. Si es true, la entrada se crea con la propiedad ya verificada mediante una prueba SELF_DECLARATION. Devuelve 400 cuando `allow_self_declaration` está desactivado en tu configuración de Travel Rule." }, "travel_address": { "type": "string", "description": "Opcional. La travel address del VASP de la contraparte para esta wallet, que habilita el enrutamiento TRP para los activos que admite TRP (BTC, ETH y USDC en una red concreta). Una travel address no válida devuelve 400.", "maxLength": 512 }, "memo": { "type": "string", "maxLength": 256, "description": "Opcional. La etiqueta de destino o memo que forma parte de la wallet. 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 envía uno, la respuesta es `400`. Alias: `destinationTag` o `destination_tag`." } } }, "WalletAddressEntryUpdate": { "type": "object", "properties": { "holder_name": { "type": "string", "maxLength": 255 }, "holder_vendor_data": { "type": "string", "maxLength": 255 }, "entity_type": { "type": "string", "maxLength": 16 }, "travel_address": { "type": "string", "maxLength": 512 } }, "description": "PATCH es una actualización parcial; la respuesta solo devuelve holder_name, holder_vendor_data, entity_type, travel_address, receiving_travel_address, label y owner_type." }, "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" } } }, "TravelRuleOwnershipConfirmRequest": { "type": "object", "required": [ "confirmed" ], "properties": { "confirmed": { "type": "boolean", "description": "true para confirmar la propiedad, false para negarla." }, "wallet_address": { "type": "string", "default": "", "description": "Transferencias TRP entrantes: la dirección de pago que Didit devuelve al VASP ordenante cuando apruebas. De forma predeterminada es la dirección de la entrada coincidente de la libreta de direcciones y, si no la hay, beneficiary_data.wallet_address. En una transferencia declarada a una wallet sin custodia que no indica ninguna wallet de la contraparte, es la wallet cuya propiedad verificaste; sin ella, la solicitud se rechaza con 400. Se ignora en las demás transferencias." } } }, "TravelRuleTransferPatchRequest": { "type": "object", "description": "Proporciona exactamente uno de estos: payment_txn_id (finalizar), action=cancel, action=resend, action=update_compliance_email con compliance_email, action=update_originator_wallet con wallet_address, o action=beneficiary_vasp con beneficiary_vasp.", "properties": { "payment_txn_id": { "type": "string", "description": "El hash de la transacción on-chain. Requiere que la transferencia sea saliente y esté en estado COMPLETED." }, "action": { "type": "string", "enum": [ "cancel", "resend", "update_compliance_email", "update_originator_wallet", "beneficiary_vasp" ], "description": "\"cancel\" cancela una transferencia que aún no está en un estado final. \"resend\" vuelve a ejecutar el enrutamiento de una transferencia saliente bloqueada en COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE o NOT_ENOUGH_COUNTERPARTY_DATA. \"update_compliance_email\" sustituye el correo electrónico de cumplimiento al que se envía la solicitud, en una transferencia saliente que esté en uno de esos tres estados; envía \"resend\" después. \"update_originator_wallet\" registra la wallet desde la que realmente salieron los fondos (`wallet_address`, `memo`). \"beneficiary_vasp\" te permite indicar tú mismo el VASP de la contraparte (requiere `beneficiary_vasp`) para una transferencia saliente que esté en uno de esos estados: se enruta a ese VASP y se vuelve a enviar." }, "compliance_email": { "type": "string", "format": "email", "maxLength": 254, "description": "Obligatorio con `action: update_compliance_email`. Se guarda como `beneficiary_data.counterparty_vasp_email` de esta transferencia: pertenece solo a esta transferencia y no se añade a ninguna entrada del directorio ni a ninguna lista de contactos." }, "wallet_address": { "type": "string", "maxLength": 128, "description": "Con `action: update_originator_wallet`: la wallet de la que salieron los fondos. Cuando se conocen las entradas UTXO de la transferencia, debe ser una de ellas." }, "memo": { "type": "string", "maxLength": 256, "description": "Con `action: update_originator_wallet`: el memo o la etiqueta de la wallet en una red con memo. Opcional." }, "beneficiary_vasp": { "type": "string", "format": "uuid", "description": "Obligatorio con action=beneficiary_vasp: el `id` de un VASP del directorio, obtenido de `GET /v3/travel-rule/vasps/`. Tu elección prevalece sobre todos los pasos de descubrimiento automático, que nunca la anulan." } } }, "VaspDirectoryEntry": { "type": "object", "description": "Un VASP del directorio o un miembro de la red de Didit, con las rutas que tu aplicación tiene hacia él. Un cliente es miembro de la red de Didit solo mientras su aplicación esté en producción, su Travel Rule esté activada, su perfil sea localizable, tenga una razón social y un correo de cumplimiento confirmado, y Didit no haya marcado la aplicación como de prueba, demostración o interna. Cada fila incluye también la evaluación de diligencia debida compartida (dd_score, risk_level, responsiveness, essential_checks) y la propia decisión, el análisis de la entidad y los cuestionarios de tu aplicación, que ningún otro cliente ve.", "properties": { "id": { "type": "string", "format": "uuid", "description": "El id de la entrada, para GET /v3/travel-rule/vasps/{vasp_id}/." }, "kind": { "type": "string", "enum": [ "directory", "didit" ], "description": "directory para una entrada del directorio compartido; didit para un miembro de la red de Didit." }, "name": { "type": "string" }, "lei": { "type": "string" }, "jurisdiction": { "type": "string", "description": "Código de país ISO 3166, tal como lo proporciona la fuente." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Los dominios web del VASP. Siempre vacío para los miembros de la red de Didit." }, "reachable": { "type": "boolean", "description": "Indica si tu aplicación tiene una ruta disponible hacia este VASP o, en el caso de una marca, hacia una de sus entidades. Siempre es true para un miembro de la red de Didit, salvo en una aplicación de sandbox, donde todas las filas son false." }, "aliases": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "kind": { "type": "string", "enum": [ "trading_name", "other_legal_name", "network_name", "attribution", "merged", "staff" ], "description": "trading_name, other_legal_name (del registro global de LEI), network_name (el nombre en una red de Travel Rule), attribution (el nombre de entidad que el análisis de blockchain asigna a las wallets del VASP), merged (el nombre de una entrada duplicada fusionada con esta) o staff." } } }, "description": "Otros nombres por los que se conoce al VASP." }, "networks": { "type": "array", "items": { "type": "object", "description": "Un registro vigente de este VASP en el directorio de miembros de una red de Travel Rule. Un registro en TRISA indica quién es el VASP en TRISA; Didit no tiene canal TRISA, así que nunca es una ruta.", "properties": { "network": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA", "TRISA" ] }, "code": { "type": "string", "description": "El identificador del VASP en esa red." }, "listed_name": { "type": "string", "description": "El nombre con el que la red registra al VASP." }, "country": { "type": "string", "description": "El país que indica la red, cuando lo proporciona." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo verificó el personal de Didit el listado. Es null en los listados leídos de un directorio público." }, "last_seen_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que la fuente mostró la entrada por última vez. Una entrada que la fuente no ha mostrado durante tres semanas se elimina." }, "source": { "type": "string", "enum": [ "trisa_directory", "staff" ], "description": "Origen del registro: el directorio público de TRISA o el personal de Didit." } } } }, "routes": { "type": "array", "items": { "type": "object", "description": "Una de las formas en que tu aplicación puede entregar datos de Travel Rule a este VASP, en el orden en que el envío las intenta. Una ruta de red necesita una membresía en esa red: la tuya (conectada en el Marketplace) o la de Didit cuando Didit tenga una. Sin ella, la ruta aparece como no disponible junto con el motivo, nunca como una forma de llegar al VASP.", "properties": { "rail": { "type": "string", "enum": [ "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL" ] }, "status": { "type": "string", "enum": [ "available", "unavailable" ] }, "reason": { "type": "string", "enum": [ "", "no_membership", "network_switched_off", "sandbox_application" ], "description": "Por qué no se puede usar una ruta no disponible: no_membership (ni tú ni Didit tienen membresía en esa red), network_switched_off (desactivaste esa red en tu configuración) o sandbox_application (una aplicación de sandbox solo envía al Didit Test VASP, así que no tiene ninguna ruta disponible). Vacío cuando la ruta está disponible." }, "via": { "type": "string", "enum": [ "", "own_membership", "didit_membership", "directory", "contact", "didit_network" ], "description": "Cómo se accede a una ruta disponible: own_membership o didit_membership para un canal de red, directory para un endpoint TRP que verificó el directorio, contact para el canal EMAIL, didit_network para un miembro de la red de Didit. Vacío cuando la ruta no está disponible." } } } }, "umbrella": { "type": "object", "nullable": true, "description": "La marca de la que esta entrada es una entidad regulada. Null cuando no forma parte de ninguna.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "entities": { "type": "array", "items": { "type": "object", "description": "Una entidad regulada de una marca: la entidad jurídica que recibe una transferencia.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "lei": { "type": "string" }, "jurisdiction": { "type": "string" }, "reachable": { "type": "boolean", "description": "Indica si tu aplicación tiene una ruta disponible hacia él." } } }, "description": "En una marca, las entidades reguladas que reciben sus transferencias. Una transferencia que indica la marca va a la entidad accesible en la jurisdicción que declara (beneficiary_data.counterparty_vasp_jurisdiction); si no, a la entidad que la atribución de análisis de blockchain vinculó a la wallet de destino; si no, a la única entidad accesible cuando no se declara jurisdicción. Nunca se elige por suposición entre dos entidades que encajan por igual." }, "contacts": { "type": "array", "items": { "type": "object", "description": "Un contacto de cumplimiento al que puede escribir el canal EMAIL.", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" }, "source": { "type": "string", "enum": [ "staff", "application", "learned" ], "description": "staff: seleccionada por Didit; application: añadida por tu aplicación; learned: una dirección que respondió a una solicitud de Travel Rule mediante su enlace de respuesta." }, "scope": { "type": "string", "enum": [ "platform", "application" ], "description": "Los contactos platform se usan en las transferencias de todos los clientes de Didit; los contactos application son privados de tu aplicación, que solo ve los suyos." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo alguien en esta dirección respondió a una solicitud. Nulo si aún no lo ha hecho." } } }, "description": "Los contactos de la plataforma para este VASP y los de tu propia aplicación." }, "dd_status": { "type": "string", "enum": [ "NOT_STARTED", "IN_PROGRESS", "COMPLETED", "REJECTED" ], "description": "Estado de verificación de la entrada según Didit, puntuado por el componente de verificación de dd_score. Siempre es COMPLETED para un miembro de la red de Didit." }, "dd_score": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 100, "description": "La puntuación compartida de diligencia debida de una entrada del directorio, de 0 a 100, donde un valor más alto es más seguro (consulta dd_score_semantic): la suma de los puntos de dd_score_breakdown. Es null para un miembro de la red de Didit, que no se puntúa. Una entrada aún no evaluada (dd_assessed_at null) muestra 0 con un risk_level vacío, así que lee risk_level en lugar de la puntuación sin procesar." }, "reachable_rails": { "type": "array", "items": { "type": "string", "enum": [ "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL" ] }, "description": "Canales registrados en la entrada. Consulta las rutas para ver qué puede usar tu aplicación hoy." }, "is_didit_customer": { "type": "boolean", "description": "true para un miembro de la red de Didit (en estos, dd_status es siempre COMPLETED, dd_score es null y risk_level está vacío) y para una entrada del directorio vinculada a un cliente de Didit." }, "dd_score_breakdown": { "type": "object", "description": "Un objeto por cada componente de dd_score. Componentes, su peso (máximo) y sus códigos de motivo: jurisdiction, 25 (jurisdiction_not_high_risk, jurisdiction_high_risk, jurisdiction_unknown); verification, 15 (dd_status_completed, dd_status_in_progress, dd_status_not_started, dd_status_rejected); protocol, 15 (native_rail, email_only, no_rail); lei, 10 (lei_valid, lei_missing); history, 10 (history, no_history); essentials, 15 (essential_checks, no_essential_checks); responsiveness, 10 (responsive, unresponsive, responsiveness_unknown). Vacío para un miembro de la red de Didit.", "additionalProperties": { "type": "object", "properties": { "points": { "type": "number", "description": "Puntos que aporta el componente, redondeados a un decimal." }, "max": { "type": "integer", "description": "El peso del componente: los puntos que aporta como máximo." }, "reason": { "type": "string", "description": "Código legible por máquina del veredicto del componente." }, "detail": { "type": "string", "description": "Explicación de una línea en inglés." } } } }, "dd_assessed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se calcularon por última vez dd_score, risk_level y responsiveness: cuando un intercambio con la entrada se completa, finaliza, expira, no coincide o se rechaza, cuando Didit actualiza o revisa la entrada, y en la actualización semanal del directorio. Nulo para un miembro de la red de Didit." }, "dd_score_semantic": { "type": "string", "enum": [ "higher_is_safer" ], "description": "Hacia dónde apunta dd_score: siempre higher_is_safer." }, "risk_level": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH", "" ], "description": "La banda en la que se encuentra dd_score: LOW (70 o más), MEDIUM (de 40 a 69) o HIGH (menos de 40). Vacío para un miembro de la red de Didit y para una entrada aún no evaluada. Filtra por este valor con risk. Tu propio análisis marcado nunca cambia este valor compartido: en su lugar, hace que counterparty_risk_level sea HIGH en tus reglas." }, "responsiveness": { "type": "object", "description": "Si el VASP responde a las solicitudes de Travel Rule: la proporción de las solicitudes que los clientes de Didit le enviaron en los últimos 90 días y que respondió. Solo cuentan las solicitudes enviadas por una vía de red o de protocolo, o por correo electrónico a una dirección compartida (la dirección de cumplimiento de la entrada o un contacto de la plataforma); una solicitud enviada a una dirección que escribió un cliente, o al contacto privado de un cliente, nunca cuenta. Una solicitud expirada cuenta como no respondida; un intercambio completado, un rechazo o una discrepancia de datos cuentan como respuesta; una solicitud cancelada o una vía inaccesible no cuentan ni como una cosa ni como la otra. Siempre es UNKNOWN con recuentos en cero para un miembro de la red de Didit.", "properties": { "status": { "type": "string", "enum": [ "RESPONSIVE", "UNRESPONSIVE", "UNKNOWN" ], "description": "UNKNOWN cuando hay menos de 5 solicitudes decididas en la ventana; UNRESPONSIVE cuando se respondió menos del 10 por ciento de ellas; RESPONSIVE en caso contrario." }, "answered": { "type": "integer", "description": "Solicitudes con decisión en la ventana a las que el VASP respondió." }, "total": { "type": "integer", "description": "Solicitudes con decisión en la ventana: respondidas más expiradas." }, "computed_at": { "type": "string", "format": "date-time", "nullable": true } } }, "essential_checks": { "type": "object", "description": "El informe de comprobaciones esenciales de una entrada del directorio, elaborado solo a partir de las fuentes verificadas de la plataforma: registration (un registro oficial incluye al VASP: el registro provisional MiCA de la UE, el directorio público de TRISA o el registro global de LEI), licence (consta una autorización MiCA y está vigente), domain (el dominio de la entrada coincide con su endpoint TRP o con el sitio web que indica su registro) y lei (su registro LEI está activo, emitido y es coherente con los nombres y el país de la entrada). El componente de comprobaciones esenciales de dd_score es la proporción de comprobaciones resueltas que se superan. Está vacío hasta que la actualización semanal del directorio comprueba la entrada por primera vez, y siempre está vacío para un miembro de la red de Didit.", "properties": { "level": { "type": "string", "enum": [ "essential" ] }, "checked_at": { "type": "string", "format": "date-time" }, "checks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "registration", "licence", "domain", "lei" ] }, "status": { "type": "string", "enum": [ "pass", "fail", "unknown" ], "description": "unknown cuando ninguna fuente registrada puede resolver la comprobación." }, "reason": { "type": "string", "description": "Código legible por máquina del veredicto." }, "detail": { "type": "string", "description": "Explicación de una línea en inglés." } } } }, "passed": { "type": "integer" }, "failed": { "type": "integer" }, "unknown": { "type": "integer" }, "total": { "type": "integer" } } }, "decision": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyDecision" } ], "nullable": true, "description": "La decisión de tu aplicación sobre este VASP o, en el caso de una entidad sin decisión propia, la de su marca (inherited_from indica la marca). Es null cuando no hay ninguna. Es privada de tu aplicación." }, "entity_screening": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyScreening" } ], "nullable": true, "description": "El análisis más reciente de sanciones y medios adversos que tu aplicación hizo de este VASP. Es null si nunca lo analizaste. Es privado de tu aplicación." }, "questionnaires": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleCounterpartyQuestionnaire" }, "description": "Los cuestionarios de diligencia debida de tu aplicación con este VASP, del más reciente al más antiguo. Son privados de tu aplicación." } }, "example": { "id": "0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91", "kind": "directory", "name": "Example Counterparty VASP", "lei": "529900EXAMPLECPTY001", "jurisdiction": "DE", "domains": [ "counterparty.example" ], "reachable": true, "aliases": [ { "name": "Example Counterparty", "kind": "trading_name" } ], "networks": [ { "network": "GTR", "code": "EXAMPLE01", "listed_name": "Example Counterparty VASP", "country": "DE", "verified_at": "2026-10-12T09:30:00Z", "last_seen_at": "2026-10-12T09:30:00Z", "source": "staff" } ], "routes": [ { "rail": "GTR", "status": "unavailable", "reason": "no_membership", "via": "" }, { "rail": "EMAIL", "status": "available", "reason": "", "via": "contact" } ], "umbrella": null, "entities": [], "contacts": [ { "id": "6c1f9b8e-2d4a-4f7e-8b3c-5a9d0e1f2a3b", "email": "travelrule@counterparty.example", "name": "Travel Rule desk", "source": "staff", "scope": "platform", "verified_at": null } ], "dd_status": "NOT_STARTED", "dd_score": 62, "dd_score_breakdown": { "jurisdiction": { "points": 25.0, "max": 25, "reason": "jurisdiction_not_high_risk", "detail": "DEU is not on the high-risk jurisdiction list" }, "verification": { "points": 3.8, "max": 15, "reason": "dd_status_not_started", "detail": "due diligence status NOT_STARTED" }, "protocol": { "points": 6.0, "max": 15, "reason": "email_only", "detail": "reachable over the email fallback only" }, "lei": { "points": 10.0, "max": 10, "reason": "lei_valid", "detail": "valid LEI on record" }, "history": { "points": 5.0, "max": 10, "reason": "no_history", "detail": "no exchange history" }, "essentials": { "points": 7.5, "max": 15, "reason": "no_essential_checks", "detail": "no decided essential check yet" }, "responsiveness": { "points": 5.0, "max": 10, "reason": "responsiveness_unknown", "detail": "0 decided recent requests, too few to judge" } }, "dd_assessed_at": "2026-10-12T09:30:00Z", "dd_score_semantic": "higher_is_safer", "risk_level": "MEDIUM", "responsiveness": { "status": "UNKNOWN", "answered": 0, "total": 0, "computed_at": "2026-10-12T09:30:00Z" }, "essential_checks": {}, "reachable_rails": [ "GTR", "EMAIL" ], "is_didit_customer": false, "decision": { "decision": "APPROVED", "reason": "Licensed in DE, questionnaire reviewed", "decided_by": "", "updated_at": "2026-10-14T10:05:00Z", "inherited_from": null }, "entity_screening": { "id": "7a1d2c3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d", "status": "Approved", "total_hits": 0, "score": null, "screened_at": "2026-10-14T09:58:00Z", "fresh": true, "flagged": false }, "questionnaires": [ { "id": "8b7a6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d", "status": "ANSWERED", "form_version": "1", "sent_to": "travelrule@counterparty.example", "sent_at": "2026-09-02T08:00:00Z", "expires_at": "2026-10-02T08:00:00Z", "answered_at": "2026-09-04T15:20:00Z", "valid_until": "2027-09-04T15:20:00Z", "current": true, "answers": { "legal_name": "Example Counterparty VASP, incorporated in the example jurisdiction.", "licensing": "Crypto-asset service provider authorised under MiCA by its national regulator, licence active.", "jurisdictions": "EU and EEA. We do not serve the United States.", "aml_program": "Written AML/CFT policy, annual independent review, last completed in March 2026.", "compliance_officer": "Head of Compliance, reachable at compliance@counterparty.example.", "sanctions_screening": "Customers at onboarding and daily; counterparties on every transfer.", "transaction_monitoring": "Rule-based monitoring with analyst review; suspicious activity reports filed with the FIU.", "travel_rule": "TRP and email; we answer requests within one business day.", "custody": "Segregated customer wallets held with a qualified custodian, insured.", "ownership": "No shareholder holds 25 percent or more; parent company Example Holding Group.", "record_keeping": "Five-year record-keeping for Travel Rule and transaction data, as our regulator requires.", "data_protection": "Encrypted at rest and in transit, stored in the EU." } } ] } }, "TravelRuleCounterpartyDecision": { "type": "object", "description": "La decisión de tu aplicación sobre un VASP contraparte. Es privada de tu aplicación: nunca modifica la entrada compartida del directorio y ningún otro cliente la ve. Solo actúa a través de tus reglas de transacción (el campo de regla counterparty_dd_status y las reglas predefinidas travel-rule-counterparty-blocked y travel-rule-counterparty-restricted); nunca cambia cómo se enruta una transferencia.", "properties": { "decision": { "type": "string", "enum": [ "APPROVED", "RESTRICTED", "BLOCKED" ], "description": "APPROVED: tu equipo aprobó la contraparte. RESTRICTED: las transferencias a ella pueden realizarse tras una revisión. BLOCKED: tu equipo la rechazó." }, "reason": { "type": "string", "maxLength": 255, "description": "Motivo en texto libre que indicaste, vacío si no indicaste ninguno." }, "decided_by": { "type": "string", "description": "El usuario de la consola que tomó la decisión o la modificó por última vez. Vacío cuando la tomó una clave de API." }, "updated_at": { "type": "string", "format": "date-time" }, "inherited_from": { "type": "object", "nullable": true, "description": "La marca cuya decisión sigue esta entidad porque no tomaste ninguna sobre la propia entidad. Null cuando la decisión es de la propia contraparte.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } } } }, "TravelRuleCounterpartyDecisionResponse": { "type": "object", "properties": { "decision": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyDecision" } ], "nullable": true, "description": "La decisión que se aplica a la contraparte para tu aplicación: la suya propia o, en su defecto (para una entidad de una marca), la de la marca. Null cuando no hay ninguna." } } }, "TravelRuleCounterpartyDecisionRequest": { "type": "object", "required": [ "decision" ], "properties": { "decision": { "type": "string", "enum": [ "APPROVED", "RESTRICTED", "BLOCKED" ] }, "reason": { "type": "string", "maxLength": 255, "description": "Opcional. Sustituye el motivo anterior; omítelo para borrarlo." } } }, "TravelRuleCounterpartyScreening": { "type": "object", "description": "Un análisis de sanciones y medios adversos de la entidad contraparte, ejecutado para tu aplicación y facturado a ella. Privado para tu aplicación: ningún otro cliente lo ve.", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Aprobado: ninguna posible coincidencia requiere atención. En revisión o Rechazado: una posible coincidencia con sanciones o medios adversos." }, "total_hits": { "type": "integer", "description": "Cuántas posibles coincidencias devolvió el análisis." }, "score": { "type": "number", "nullable": true, "description": "La puntuación de riesgo más alta entre las posibles coincidencias. Null cuando no hubo ninguna coincidencia." }, "screened_at": { "type": "string", "format": "date-time" }, "fresh": { "type": "boolean", "description": "Si el análisis tiene menos antigüedad que fresh_days (30 días). Un análisis reciente se reutiliza en lugar de volver a facturarse." }, "flagged": { "type": "boolean", "description": "true mientras el análisis sea reciente y su estado sea In Review o Declined. Mientras tu análisis más reciente esté marcado y el análisis de contrapartes siga activado, counterparty_risk_level es HIGH en tus reglas." } } }, "TravelRuleCounterpartyScreeningStatus": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Tu configuración de Travel Rule counterparty_screening_enabled. Está desactivada de forma predeterminada; mientras esté desactivada, no se analiza ni se factura nada." }, "price": { "type": "string", "description": "Cadena decimal, en USD: lo que cuesta un análisis a tu organización, el precio del Análisis AML de empresas." }, "fresh_days": { "type": "integer", "description": "Cuántos días se considera vigente un análisis y se reutiliza." }, "screening": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyScreening" } ], "nullable": true, "description": "Tu análisis más reciente de la contraparte. Null si nunca la analizaste." } } }, "TravelRuleCounterpartyScreeningRequest": { "type": "object", "properties": { "refresh": { "type": "boolean", "default": false, "description": "true vuelve a analizar (y vuelve a facturar) incluso cuando existe un análisis reciente." } } }, "TravelRuleCounterpartyScreeningResult": { "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "screened", "reused" ], "description": "screened: se ejecutó un nuevo análisis y se facturó (201). reused: se devolvió un análisis reciente y no se facturó nada (200)." }, "screening": { "$ref": "#/components/schemas/TravelRuleCounterpartyScreening" } } }, "TravelRuleCounterpartyQuestionnaire": { "type": "object", "description": "Un cuestionario de diligencia debida que tu aplicación envió a la contraparte: el cuestionario estándar de Didit, enviado por correo electrónico a una dirección de cumplimiento registrada, con un enlace de respuesta de un solo uso. Privado para tu aplicación.", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "SENT", "ANSWERED", "EXPIRED" ], "description": "SENT: a la espera de respuestas. ANSWERED: la contraparte respondió todas las preguntas. EXPIRED: el enlace de respuesta se cerró sin respuesta (venció su plazo o un cuestionario más reciente lo reemplazó), o las respuestas superaron valid_until." }, "form_version": { "type": "string", "description": "Versión del cuestionario estándar de Didit a la que pertenecen las respuestas. Actualmente, 1." }, "sent_to": { "type": "string", "format": "email" }, "sent_at": { "type": "string", "format": "date-time", "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "La fecha límite de respuesta, 30 días después del envío. El enlace deja de funcionar después de esa fecha." }, "answered_at": { "type": "string", "format": "date-time", "nullable": true }, "valid_until": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuánto tiempo siguen vigentes las respuestas: 365 días después de responder. Null hasta que se responde." }, "current": { "type": "boolean", "description": "true mientras el cuestionario esté en ANSWERED y valid_until no haya pasado." }, "answers": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Las respuestas indexadas por id de pregunta: legal_name, licensing, jurisdictions, aml_program, compliance_officer, sanctions_screening, transaction_monitoring, travel_rule, custody, ownership, record_keeping, data_protection. Cada respuesta tiene un máximo de 2000 caracteres. Está vacío hasta que se responde." } } }, "TravelRuleCounterpartyQuestionnaireRequest": { "type": "object", "properties": { "sent_to": { "type": "string", "format": "email", "description": "Opcional. Una dirección de cumplimiento registrada para la contraparte: para una entrada del directorio, su dirección de cumplimiento o un contacto que ve tu aplicación; para un miembro de la red de Didit, su correo electrónico de cumplimiento confirmado. Valor predeterminado: la dirección a la que se envía un correo electrónico de Travel Rule a la contraparte (primero tu propio contacto, luego un contacto de la plataforma y después la dirección de cumplimiento de la entrada)." } } }, "TravelRuleCounterpartyQuestionnaireList": { "type": "object", "properties": { "questionnaires": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleCounterpartyQuestionnaire" }, "description": "Primero los más recientes." } } }, "TravelRulePickupInfo": { "type": "object", "description": "El intercambio pendiente asociado a un enlace de recogida enviado por correo electrónico, tal como lo muestra la página de respuesta de la contraparte.", "properties": { "reference": { "type": "string", "format": "uuid", "description": "El uuid de la transferencia, tal como lo muestra la consola del VASP emisor." }, "requested_at": { "type": "string", "format": "date-time" }, "originator_vasp_name": { "type": "string" }, "originator_vasp_lei": { "type": "string" }, "recipient_vasp_name": { "type": "string", "description": "El VASP de la contraparte al que va dirigida la solicitud." }, "language": { "type": "string", "description": "El idioma del correo de solicitud y de la página de respuesta, según la jurisdicción de la contraparte." }, "amount": { "type": "string" }, "currency": { "type": "string" }, "fiat_amount": { "type": "string", "description": "El valor convertido que indicó el remitente, o vacío." }, "fiat_currency": { "type": "string" }, "chain": { "type": "string" }, "beneficiary_wallet": { "type": "string" }, "status": { "type": "string" }, "ivms_version": { "type": "string" }, "deadline_at": { "type": "string", "format": "date-time", "description": "Fecha y hora en que el enlace deja de responder." }, "reminders_sent": { "type": "integer" }, "contact": { "type": "string", "description": "El valor `?contact=` del enlace, devuelto tal cual; vacío cuando el enlace no tiene ninguno." }, "decline_reasons": { "type": "array", "items": { "type": "string", "enum": [ "data_mismatch", "not_our_customer", "wallet_not_hosted", "sanctions", "risk_appetite", "jurisdiction", "insufficient_data", "other" ] }, "description": "Los valores que acepta `decline_reason`." }, "join_invitation": { "type": "object", "description": "Si la contraparte tiene una invitación vigente para unirse a Didit de forma gratuita. El enlace de invitación solo se envía en el correo electrónico a la dirección invitada, por lo que `url` está vacío aquí.", "properties": { "eligible": { "type": "boolean" }, "url": { "type": "string" } } }, "originator_data": { "type": "object", "description": "Los campos del ordenante que comparte el VASP emisor (`data_sharing_fields`). El nombre y la wallet siempre se incluyen." }, "beneficiary_data": { "type": "object" }, "ivms_request": { "type": "object", "description": "La misma solicitud como objeto IVMS 101. Se omite mientras `data_masked` sea true." }, "data_masked": { "type": "boolean", "description": "Siempre false en este endpoint: una solicitud por correo electrónico es saliente y el usuario propio del remitente nunca se enmascara." } } }, "TravelRulePickupRespondRequest": { "type": "object", "required": [ "decision" ], "properties": { "decision": { "type": "string", "enum": [ "accept", "decline" ] }, "beneficiary_name": { "type": "string", "description": "El nombre del beneficiario tal como figura en tus registros, evaluado con la regla de nombres del VASP emisor. `ivms_response` tiene prioridad cuando indica el nombre del beneficiario.", "maxLength": 255 }, "decline_reason": { "type": "string", "enum": [ "", "data_mismatch", "not_our_customer", "wallet_not_hosted", "sanctions", "risk_appetite", "jurisdiction", "insufficient_data", "other" ], "description": "Por qué rechazas. Se registra en la cronología de la transferencia del VASP emisor. Vacío (el valor predeterminado) cuando no indicas ningún motivo." }, "decline_detail": { "type": "string", "maxLength": 512, "description": "Texto libre; obligatorio cuando `decision` es `decline` y `decline_reason` es `other`." }, "ivms_response": { "type": "object", "description": "Tu respuesta IVMS 101 completa. Su nombre de beneficiario prevalece sobre `beneficiary_name`." }, "contact": { "type": "string", "format": "uuid", "description": "El contacto al que se envió el enlace, tomado del valor `?contact=` del enlace. Si el cuerpo no lo incluye, se usa el parámetro de consulta `contact`." } } }, "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" } } }, "TravelRuleTestVaspInboundRequest": { "type": "object", "required": [ "beneficiary_wallet_address" ], "properties": { "beneficiary_wallet_address": { "type": "string", "description": "La dirección de la wallet de destino. El Didit Test VASP envía a ella, y se compara con tu libreta de direcciones de wallets en la cadena del activo. Una wallet sin entrada coincidente se acepta y la transacción entrante se registra como ON_HOLD." }, "scenario": { "type": "string", "enum": [ "accept", "name_mismatch" ], "default": "accept", "description": "Lo que el Didit Test VASP declara como beneficiario. `accept` declara el nombre del propio titular; `name_mismatch` declara un nombre que no coincide con ningún titular. La decisión siempre es tuya." }, "chain": { "type": "string", "default": "ETH", "description": "Cadena del activo." }, "amount": { "type": "string", "default": "1", "description": "Importe como cadena decimal." }, "currency": { "type": "string", "default": "ETH", "description": "Código del activo." }, "reference": { "type": "string", "description": "Clave de idempotencia opcional. Una repetición con el mismo valor devuelve la transferencia que registró la primera llamada." } } }, "TravelRuleTestVaspInboundResponse": { "type": "object", "properties": { "transaction_id": { "type": "string", "format": "uuid", "description": "UUID de transacción de Didit de la transferencia entrante." }, "txn_id": { "type": "string", "description": "txn_id generado por Didit." }, "scenario": { "type": "string", "description": "El escenario que se ejecutó." }, "travel_rule_status": { "type": "string", "description": "El estado en el que se resolvió la decisión propia de tu aplicación." }, "detail": { "type": "string", "description": "Por qué la transferencia se resolvió con ese estado." }, "test_vasp": { "type": "boolean", "description": "Siempre true: el remitente fue el Didit Test VASP." }, "travel_rule": { "$ref": "#/components/schemas/TravelRuleTransferDetail" } } }, "TravelRuleWidgetSessionCreate": { "type": "object", "properties": { "wallet_address": { "type": "string", "description": "La dirección de la wallet que se va a verificar. Opcional; si está vacía, la dirección debe proporcionarse al iniciar una prueba.", "maxLength": 128 }, "chain": { "type": "string", "description": "Token de cadena de la dirección, por ejemplo `ETH`, `BTC` o `SOL`. Usa el mismo token que en tu libreta de direcciones de wallets. La firma de mensajes y la prueba de Satoshi solo se ofrecen para una cadena compatible. La entrada de la libreta de direcciones que verifica la prueba lo almacena con su identificador canónico (ETH, BTC, SOL, TRX).", "maxLength": 32 }, "holder_name": { "type": "string", "description": "Nombre del titular de la wallet, que se usa para la coincidencia del nombre del beneficiario.", "maxLength": 255 }, "vendor_data": { "type": "string", "description": "Tu identificador interno del titular, que se traslada a la entrada de la libreta de direcciones creada.", "maxLength": 255 }, "transaction_id": { "type": "string", "format": "uuid", "description": "Opcional. UUID de transacción de Didit de una transferencia de Travel Rule que se hace avanzar cuando se verifica la prueba.", "nullable": true }, "satoshi_deposit_address": { "type": "string", "description": "Opcional. Una dirección de depósito que controlas; al proporcionarla se habilita el método de prueba SATOSHI_TEST.", "maxLength": 128 }, "callback_url": { "type": "string", "description": "Opcional. URL absoluta http(s) a la que el widget devuelve al cliente después de completar el proceso.", "maxLength": 512 }, "expires_in_minutes": { "type": "integer", "description": "Opcional. Vigencia del enlace generado, en minutos. Se amplía automáticamente para cubrir la ventana de la prueba Satoshi cuando se ofrece SATOSHI_TEST.", "default": 60, "minimum": 5, "maximum": 10080 } } }, "TravelRuleWidgetSessionResponse": { "type": "object", "properties": { "widget_session_id": { "type": "string", "format": "uuid" }, "token": { "type": "string", "description": "Token de sesión opaco incrustado en la URL del widget." }, "url": { "type": "string", "description": "La URL del widget alojado de propiedad de la wallet. Ábrela tal cual en el navegador del sistema (nunca dentro de un webview de un SDK móvil)." }, "expires_at": { "type": "string", "format": "date-time" } } }, "TravelRuleWidgetContext": { "type": "object", "properties": { "vasp_name": { "type": "string", "description": "Nombre legal de tu perfil de VASP, que se muestra al cliente en el widget. Vacío si no existe ningún perfil." }, "wallet_address": { "type": "string" }, "chain": { "type": "string", "description": "La cadena con la que se creó la sesión, tal como la enviaste." }, "chain_family": { "type": "string", "nullable": true, "enum": [ "EVM", "BTC", "SOL", "TRON", null ], "description": "La familia de claves que corresponde a chain: EVM (Ethereum, BNB Chain, Polygon, Arbitrum, Base, Optimism, Avalanche, Linea y las demás cadenas EVM), BTC, SOL o TRON. Una misma clave EVM controla la misma dirección en todas las cadenas EVM. Es nulo cuando no se puede verificar ninguna firma en la cadena." }, "holder_name": { "type": "string" }, "allowed_methods": { "type": "array", "items": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SCREENSHOT", "SATOSHI_TEST", "SELF_DECLARATION" ] }, "description": "Métodos de prueba disponibles para esta sesión. MESSAGE_SIGNING requiere una cadena con chain_family, SATOSHI_TEST requiere un satoshi_deposit_address en la sesión y una cadena cuyos depósitos Didit pueda leer, SCREENSHOT requiere la configuración allow_screenshot_proof y SELF_DECLARATION requiere la configuración allow_self_declaration." }, "transfer_status": { "type": "string", "nullable": true, "description": "Estado de la transferencia de Travel Rule vinculada. Null cuando la sesión se creó sin transaction_id." }, "callback_url": { "type": "string", "description": "Adónde devuelve el widget al cliente al finalizar. Vacío si no se ha configurado." }, "expires_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "No es nulo una vez que se ha verificado una prueba." }, "proofs": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleWidgetProofSummary" } }, "max_attempts": { "type": "integer", "description": "Pruebas de wallet rechazadas que permite esta sesión." }, "attempts_used": { "type": "integer", "description": "Pruebas rechazadas hasta el momento." }, "attempts_remaining": { "type": "integer", "description": "Cuando es 0, iniciar otra prueba responde 409 y tienes que generar una nueva sesión del widget." }, "customization": { "type": "object", "nullable": true, "description": "La personalización de marca blanca de la aplicación (colores, logotipo, familia tipográfica) cuando la marca blanca está habilitada: el widget se muestra con la misma imagen de marca que el flujo de verificación. Null en caso contrario." } } }, "TravelRuleWidgetProofSummary": { "type": "object", "properties": { "proof_id": { "type": "string", "format": "uuid" }, "method": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SATOSHI_TEST", "SCREENSHOT", "SELF_DECLARATION" ] }, "status": { "type": "string", "enum": [ "PENDING", "VERIFIED", "REJECTED", "EXPIRED" ], "description": "PENDING: el usuario final eligió este método y la prueba aún no se ha decidido. Una firma fallida o un depósito de prueba que todavía no se puede leer o no está confirmado mantiene la prueba en PENDING con un failure_reason, para que el usuario final pueda volver a intentarlo; un depósito SATOSHI_TEST enviado se vuelve a comprobar automáticamente hasta que se cierra su ventana, y una SCREENSHOT enviada queda a la espera de tu revisión. VERIFIED: la propiedad está demostrada. REJECTED: el depósito de prueba es realmente incorrecto (otro remitente, un importe distinto del esperado a la dirección de depósito, anterior al desafío o una transacción que ya demostró otra wallet) o tu revisor rechazó la captura de pantalla; failure_reason indica el motivo. Una prueba rechazada es definitiva y consume uno de los intentos de la sesión. EXPIRED: la prueba ya no se puede decidir (su ventana se cerró, el usuario final cambió de método, la sesión del widget caducó o cambió el titular de la wallet); failure_reason indica el motivo." }, "wallet_address": { "type": "string" }, "chain": { "type": "string", "description": "Identificador canónico de la cadena de la entrada de la libreta de direcciones a la que corresponde la prueba, p. ej., ETH, BTC, SOL, TRX." }, "deposit_address": { "type": "string", "nullable": true, "description": "Dirección de depósito a la que el cliente debe enviar el importe de la prueba Satoshi. Solo está presente en una prueba SATOSHI_TEST." }, "expected_amount": { "type": "string", "nullable": true, "description": "Importe on-chain exacto, en la moneda nativa del depósito, con el que debe coincidir el depósito de prueba de Satoshi. Solo está presente en una prueba SATOSHI_TEST." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha límite de la ventana de prueba Satoshi propia de esta prueba. Solo está presente en una prueba SATOSHI_TEST; el expires_at propio de la sesión del widget se amplía para cubrirla cuando se ofrece SATOSHI_TEST." }, "challenge": { "type": "string", "nullable": true, "description": "Mensaje emitido por Didit que el cliente firma con su wallet. Solo está presente en una prueba MESSAGE_SIGNING." }, "rejection_reason": { "type": "string", "description": "Por qué se rechazó la prueba, como una frase en inglés para el usuario final. Solo está presente cuando `status` es REJECTED; vacío cuando tu revisor rechazó una captura de pantalla (tu nota se queda contigo)." }, "created_at": { "type": "string", "format": "date-time" }, "attempts": { "type": "integer", "description": "Cuántas veces se envió evidencia para esta prueba (firmas, ids de transacción, archivos subidos)." }, "failure_reason": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "Por qué el último intento no fue suficiente, o por qué se cerró la prueba. Vacío cuando nada falló." } } }, "CaseSubject": { "type": "object", "nullable": true, "description": "El único usuario o empresa al que está vinculado el caso.", "properties": { "type": { "type": "string", "enum": [ "user", "business" ] }, "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "external_id": { "type": "string", "nullable": true, "description": "El vendor_data del sujeto." }, "country": { "type": "string", "nullable": true, "description": "Código de país de tres letras del sujeto (ISO 3166-1 alfa-3), o null cuando no se conoce. Para una empresa, su país de constitución. Para una persona, el país emisor de un documento de identidad de sus verificaciones; una persona con documentos de varios países muestra uno de ellos, y pueden aparecer códigos de documento OACI como `XXA`.", "example": "ESP" }, "portrait": { "type": "string", "format": "uri", "nullable": true, "description": "URL firmada de corta duración de la imagen del retrato de la persona. Siempre es null para una empresa, y null para una persona sin retrato. La URL caduca, así que descarga la imagen cuando leas el caso en lugar de guardar la URL." } } }, "CaseAssignee": { "type": "object", "nullable": true, "properties": { "uuid": { "type": "string", "format": "uuid" }, "full_name": { "type": "string" }, "email": { "type": "string", "format": "email" } } }, "CaseBlueprintSummary": { "type": "object", "nullable": true, "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 24 } } }, "CaseContentConfig": { "type": "object", "description": "Las seis secciones activables que determinan qué pestañas y campos aparecen en la página del caso. Se rechazan las secciones o claves desconocidas.", "properties": { "checklist": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "optional": { "type": "boolean", "description": "Si es true, un caso puede resolverse con elementos de la lista de comprobación incompletos." }, "items": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 255 }, "order": { "type": "integer" } } } } } }, "aml_control": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "financial": { "type": "boolean" }, "identity": { "type": "boolean" } } }, "identity": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "personal_information": { "type": "boolean" }, "applicant_tags": { "type": "boolean" }, "contact_information": { "type": "boolean" }, "risk_overview": { "type": "boolean" }, "poi_documents": { "type": "boolean" }, "poa_documents": { "type": "boolean" } } }, "verifications": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "summary": { "type": "boolean" } } }, "reporting": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "fiu_reports": { "type": "boolean" } } }, "financial": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "payment_methods": { "type": "boolean" }, "transactions": { "type": "boolean" } } } } }, "CaseNote": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "comment": { "type": "string" }, "actor_email": { "type": "string", "format": "email", "nullable": true }, "actor_name": { "type": "string", "nullable": true }, "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email" } }, "is_internal": { "type": "boolean" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "s3_key": { "type": "string" }, "filename": { "type": "string" }, "file_size": { "type": "integer" }, "url": { "type": "string", "format": "uri" } } } }, "tags": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" } } }, "CaseEvent": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "enum": [ "CREATED", "STATUS_CHANGED", "ASSIGNED", "UNASSIGNED", "RESOLVED", "REOPENED", "LINK_ADDED", "LINK_REMOVED", "NOTE_ADDED", "NOTE_PINNED", "NOTE_UNPINNED", "PRIORITY_CHANGED", "DUE_DATE_CHANGED", "TAG_ADDED", "TAG_REMOVED", "ESCALATED", "TRANSFERRED", "CHECKLIST_COMPLETED", "REPORT_CREATED", "REPORT_FINALIZED", "SUBMITTED_FOR_APPROVAL", "APPROVAL_GRANTED", "APPROVAL_REJECTED", "ENTITY_ACTION", "APPROVAL_INVALIDATED", "CUSTOMER_REQUEST", "STAGE_CHANGED", "TEAM_CHANGED", "CHECKER_ASSIGNED", "CHECKER_UNASSIGNED" ] }, "actor_email": { "type": "string", "format": "email", "nullable": true }, "actor_name": { "type": "string", "nullable": true }, "previous_status": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ], "nullable": true }, "new_status": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ], "nullable": true }, "metadata": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" } } }, "CaseLink": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "linked_entity_type": { "type": "string", "enum": [ "session", "business_session", "transaction" ], "nullable": true }, "linked_entity_uuid": { "type": "string", "format": "uuid", "nullable": true }, "linked_entity_summary": { "type": "object", "nullable": true, "description": "session_id/session_number/status para enlaces de session y business_session; uuid/txn_id/status para enlaces de transacción." }, "created_at": { "type": "string", "format": "date-time" } } }, "CaseChecklistItem": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "label": { "type": "string", "maxLength": 255 }, "is_completed": { "type": "boolean" }, "completed_by": { "type": "string", "format": "email", "nullable": true }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "order": { "type": "integer" } } }, "CaseBlueprintListItem": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 24 }, "description": { "type": "string", "nullable": true }, "assignment_method": { "type": "string", "enum": [ "MANUAL", "AUTOMATIC" ] }, "assignee_pool": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "max_active_cases": { "type": "integer", "nullable": true }, "escalation_enabled": { "type": "boolean" }, "transfer_enabled": { "type": "boolean" }, "require_resolution_note": { "type": "boolean" }, "is_active": { "type": "boolean" }, "preset_key": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "version": { "type": "integer", "readOnly": true }, "default_deadline_hours": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 8760 } } }, "CaseBlueprintDetail": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 24 }, "description": { "type": "string", "nullable": true }, "assignment_method": { "type": "string", "enum": [ "MANUAL", "AUTOMATIC" ] }, "assignee_pool": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "max_active_cases": { "type": "integer", "nullable": true }, "escalation_enabled": { "type": "boolean" }, "transfer_enabled": { "type": "boolean" }, "require_resolution_note": { "type": "boolean" }, "is_active": { "type": "boolean" }, "preset_key": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "escalation_blueprint": { "type": "string", "format": "uuid", "nullable": true }, "escalation_blueprint_name": { "type": "string", "nullable": true }, "four_eyes_checker_blueprint": { "type": "string", "format": "uuid", "nullable": true }, "four_eyes_checker_blueprint_name": { "type": "string", "nullable": true }, "content_config": { "type": "object", "description": "Las seis secciones activables que determinan qué pestañas y campos aparecen en la página del caso. Se rechazan las secciones o claves desconocidas.", "properties": { "checklist": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "optional": { "type": "boolean", "description": "Si es true, un caso puede resolverse con elementos de la lista de comprobación incompletos." }, "items": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 255 }, "order": { "type": "integer" } } } } } }, "aml_control": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "financial": { "type": "boolean" }, "identity": { "type": "boolean" } } }, "identity": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "personal_information": { "type": "boolean" }, "applicant_tags": { "type": "boolean" }, "contact_information": { "type": "boolean" }, "risk_overview": { "type": "boolean" }, "poi_documents": { "type": "boolean" }, "poa_documents": { "type": "boolean" } } }, "verifications": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "summary": { "type": "boolean" } } }, "reporting": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "fiu_reports": { "type": "boolean" } } }, "financial": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "payment_methods": { "type": "boolean" }, "transactions": { "type": "boolean" } } } } }, "creation_sources": { "type": "array", "description": "Conectores que actualmente dirigen casos nuevos a este blueprint.", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aml", "rule", "workflow" ] }, "id": { "type": "string" }, "name": { "type": "string" } } } }, "receives_escalation_from": { "type": "array", "description": "Otros blueprints cuyo destino de escalado apunta a este.", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } }, "updated_at": { "type": "string", "format": "date-time" }, "version": { "type": "integer", "readOnly": true }, "default_deadline_hours": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 8760 } } }, "CaseListItem": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "case_number": { "type": "string", "nullable": true, "description": "Se asigna automáticamente, p. ej., CS-0001." }, "title": { "type": "string" }, "status": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ] }, "resolution": { "type": "string", "enum": [ "FALSE_POSITIVE", "VALID_THREAT", "INCONCLUSIVE", "REQUIREMENTS_NOT_MET", "REQUIREMENTS_SATISFIED" ], "nullable": true }, "pending_resolution": { "type": "object", "nullable": true, "description": "Se establece solo mientras una resolución de doble validación (4-eyes) está preparada en el blueprint del verificador, a la espera de su aprobación o del rechazo de la aprobación.", "properties": { "resolution": { "type": "string", "enum": [ "FALSE_POSITIVE", "VALID_THREAT", "INCONCLUSIVE", "REQUIREMENTS_NOT_MET", "REQUIREMENTS_SATISFIED" ] }, "resolution_notes": { "type": "string", "nullable": true }, "maker_email": { "type": "string", "format": "email", "nullable": true, "description": "Correo electrónico del responsable que envió la resolución. Null cuando la envió una clave de API: esa resolución no tiene un autor registrado, por lo que aprobar y rechazar la aprobación devuelven 403 para cualquier solicitante." }, "maker_name": { "type": "string", "nullable": true }, "maker_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID de usuario del miembro responsable que envió la resolución. Es null cuando la envió una clave de API. Ese miembro no puede figurar como `checker`." }, "maker_blueprint_id": { "type": "string", "format": "uuid" }, "staged_at": { "type": "string", "format": "date-time" } } }, "checker": { "$ref": "#/components/schemas/CaseChecker" }, "priority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "source": { "type": "string", "enum": [ "MANUAL", "AML_SCREENING", "TRANSACTION_RULE", "WORKFLOW_BUILDER" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "subject": { "$ref": "#/components/schemas/CaseSubject" }, "assigned_to": { "$ref": "#/components/schemas/CaseAssignee" }, "assigned_at": { "type": "string", "format": "date-time", "nullable": true }, "team": { "$ref": "#/components/schemas/CaseTeamSummary" }, "due_at": { "type": "string", "format": "date-time", "nullable": true }, "resolved_at": { "type": "string", "format": "date-time", "nullable": true }, "created_by_email": { "type": "string", "nullable": true }, "created_by_name": { "type": "string", "nullable": true }, "blueprint": { "$ref": "#/components/schemas/CaseBlueprintSummary" }, "links_count": { "type": "integer" }, "notes_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "application_id": { "type": "string", "format": "uuid" }, "application_name": { "type": "string" }, "organization_id": { "type": "string", "format": "uuid" }, "organization_name": { "type": "string" } } }, "CaseDetail": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "case_number": { "type": "string", "nullable": true }, "title": { "type": "string" }, "status": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ] }, "resolution": { "type": "string", "enum": [ "FALSE_POSITIVE", "VALID_THREAT", "INCONCLUSIVE", "REQUIREMENTS_NOT_MET", "REQUIREMENTS_SATISFIED" ], "nullable": true }, "resolution_notes": { "type": "string", "nullable": true }, "priority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "source": { "type": "string", "enum": [ "MANUAL", "AML_SCREENING", "TRANSACTION_RULE", "WORKFLOW_BUILDER" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "subject": { "$ref": "#/components/schemas/CaseSubject" }, "assigned_to": { "$ref": "#/components/schemas/CaseAssignee" }, "assigned_at": { "type": "string", "format": "date-time", "nullable": true }, "team": { "$ref": "#/components/schemas/CaseTeamSummary" }, "due_at": { "type": "string", "format": "date-time", "nullable": true }, "resolved_at": { "type": "string", "format": "date-time", "nullable": true }, "resolved_by_email": { "type": "string", "nullable": true }, "pending_resolution": { "type": "object", "nullable": true, "description": "Se establece solo mientras una resolución de doble validación (4-eyes) está preparada en el blueprint del verificador, a la espera de su aprobación o del rechazo de la aprobación.", "properties": { "resolution": { "type": "string", "enum": [ "FALSE_POSITIVE", "VALID_THREAT", "INCONCLUSIVE", "REQUIREMENTS_NOT_MET", "REQUIREMENTS_SATISFIED" ] }, "resolution_notes": { "type": "string", "nullable": true }, "maker_email": { "type": "string", "format": "email", "nullable": true, "description": "Correo electrónico del responsable que envió la resolución. Null cuando la envió una clave de API: esa resolución no tiene un autor registrado, por lo que aprobar y rechazar la aprobación devuelven 403 para cualquier solicitante." }, "maker_name": { "type": "string", "nullable": true }, "maker_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID de usuario del miembro responsable que envió la resolución. Es null cuando la envió una clave de API. Ese miembro no puede figurar como `checker`." }, "maker_blueprint_id": { "type": "string", "format": "uuid" }, "staged_at": { "type": "string", "format": "date-time" } } }, "checker": { "$ref": "#/components/schemas/CaseChecker" }, "metadata": { "type": "object" }, "blueprint": { "$ref": "#/components/schemas/CaseBlueprintDetail" }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/CaseNote" }, "description": "Las 50 notas más recientes." }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/CaseEvent" }, "description": "Los 100 eventos más recientes." }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/CaseLink" } }, "links_count": { "type": "integer" }, "notes_count": { "type": "integer" }, "checklist_items": { "type": "array", "items": { "$ref": "#/components/schemas/CaseChecklistItem" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "ReportTemplateDetail": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Código de país ISO 3166-1 alfa-2." }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "report_type_display": { "type": "string" }, "field_config": { "type": "object", "description": "Valores predeterminados reutilizables del encabezado de goAML. Campos obligatorios a nivel de plantilla: rentity_id, submission_code y currency_code_local (3 letras). Opcionales: enabled_fields (qué bloques opcionales del informe incluir), además de los valores predeterminados de reporting_person, location, reason y action. Los campos del encabezado de cada declaración (action, submission_date, transactions, jurisdiction) se exigen cuando el informe se valida o se finaliza, no en la plantilla." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "RegulatoryReportDetail": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "case_uuid": { "type": "string", "format": "uuid" }, "case_number": { "type": "string", "nullable": true }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "report_type_display": { "type": "string" }, "report_code": { "type": "string", "description": "Código de informe goAML derivado de report_type, p. ej., STR, CTR, BCR." }, "report_number": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "DRAFT", "VALIDATED", "FINALIZED" ] }, "status_display": { "type": "string" }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2 }, "rentity_id": { "type": "string", "nullable": true, "description": "ID de entidad informante emitido por la UIF." }, "rentity_branch": { "type": "string", "nullable": true }, "submission_code": { "type": "string", "enum": [ "E", "M" ] }, "entity_reference": { "type": "string", "nullable": true }, "fiu_ref_number": { "type": "string", "nullable": true }, "currency_code_local": { "type": "string", "minLength": 3, "maxLength": 3, "nullable": true }, "submission_date": { "type": "string", "format": "date-time", "nullable": true }, "reporting_person": { "type": "object" }, "location": { "type": "object" }, "reason": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "activity": { "type": "string", "nullable": true }, "narrative": { "type": "object", "description": "Secciones narrativas de las cinco W.", "properties": { "who": { "type": "string" }, "what": { "type": "string" }, "when": { "type": "string" }, "where": { "type": "string" }, "why": { "type": "string" }, "how": { "type": "string" } } }, "report_indicators": { "type": "array", "items": { "type": "string" } }, "included_fields": { "type": "array", "items": { "type": "string" } }, "transactions": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "validation_errors": { "type": "array", "description": "Resultado de la validación más reciente; cada entrada es un objeto con field y message.", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } } } }, "validated_at": { "type": "string", "format": "date-time", "nullable": true }, "finalized_at": { "type": "string", "format": "date-time", "nullable": true }, "created_by_email": { "type": "string", "nullable": true }, "created_by_name": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "TransactionRuleCondition": { "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "Ruta del campo de la transacción que se evalúa. Campos principales: amount, currency, direction, action_type, score, severity, transaction_type, payment_details, preferred_currency_amount (si no existe, se usa amount_in_default_currency), default_currency_code, subject_country, counterparty_country, subject_vendor_data, counterparty_vendor_data, subject_device_fingerprint, counterparty_device_fingerprint, subject_browser_family, subject_browser_version, subject_platform, subject_accept_language, subject_session_age_ms, subject_ip_country, counterparty_ip_country, subject_ip_address, counterparty_ip_address, subject_payment_method_type, subject_payment_method_country, subject_payment_method_fingerprint, subject_payment_method_account_id (y sus equivalentes counterparty_payment_method_*), travel_rule_status, travel_rule_required, travel_rule_obligations_count, counterparty_dd_status (tu decisión sobre la contraparte de Travel Rule: APPROVED, RESTRICTED o BLOCKED; una entidad sigue la de su marca), counterparty_risk_level (LOW, MEDIUM o HIGH; HIGH mientras tu propio análisis de la contraparte esté marcado), counterparty_jurisdiction (el país del VASP de la contraparte), counterparty_responsiveness (RESPONSIVE, UNRESPONSIVE o UNKNOWN), subject_days_since_previous_transaction, tags y custom_values. para cualquier clave enviada en custom_properties al crear la transacción. Los campos de código de país aceptan ISO-2 o ISO-3; ambos lados se normalizan a ISO-3 antes de la comparación." }, "operator": { "type": "string", "enum": [ "eq", "ne", "gt", "gte", "lt", "lte", "in", "not_in", "contains", "not_contains", "contains_any", "regex", "fuzzy_match", "exists", "is_not_empty", "is_not_null", "not_exists", "is_empty", "is_null" ], "description": "Operador de comparación. in/not_in comprueban la pertenencia (value puede ser una lista o un único valor escalar). contains/not_contains son comprobaciones de subcadena sin distinguir mayúsculas y minúsculas sobre un valor de tipo cadena. contains_any recibe una lista de cadenas y coincide cuando alguna de ellas es una subcadena del valor del campo, sin distinguir mayúsculas y minúsculas. regex compara el patrón de value con el campo. fuzzy_match compara con la cadena de value usando el umbral `score` requerido (0-100). gt/gte/lt/lte nunca coinciden cuando falta alguno de los dos lados. exists/is_not_empty/is_not_null (alias) y not_exists/is_empty/is_null (alias) son comprobaciones de presencia que ignoran `value`." }, "value": { "description": "Valor de comparación. Su forma depende del operador y de value_type; omítelo para los operadores de comprobación de presencia. Todos los demás operadores necesitan un valor que no sea `null` ni una lista vacía; de lo contrario, la regla se rechaza con `400`. `contains_any` necesita una lista de cadenas, y `contains`, `not_contains` y `regex` necesitan una única cadena." }, "value_type": { "type": "string", "enum": [ "list", "field", "relative_date" ], "description": "Interpretación opcional del valor. `list`: el valor es el UUID de una lista y las entradas de la lista pasan a ser el valor de comparación. `field`: el valor es la ruta de otro campo y se compara campo con campo. `relative_date`: el valor es un objeto de fecha relativa, p. ej. {\"direction\": \"past\", \"unit\": \"days\", \"amount\": 30}." }, "score": { "type": "number", "minimum": 0, "maximum": 100, "description": "Obligatorio cuando operator es fuzzy_match: el umbral de similitud de 0 a 100." }, "group_index": { "type": "integer", "description": "Lógica agrupada opcional. Cuando alguna condición incluye group_index, las condiciones que comparten un mismo índice forman un grupo y la evaluación agrupada sustituye a evaluation_mode." }, "group_logic": { "type": "string", "enum": [ "AND", "OR" ], "default": "AND", "description": "Cómo se combinan las condiciones DENTRO de un grupo." }, "groups_logic": { "type": "string", "enum": [ "AND", "OR" ], "default": "OR", "description": "Cómo se combinan los resultados ENTRE grupos. Se lee de la primera condición." } }, "description": "Una condición lee solo la transacción que se está evaluando: nunca filtra la ventana de agregación." }, "TransactionRuleAggregation": { "type": "object", "required": [ "value" ], "properties": { "metric": { "type": "string", "enum": [ "count", "sum", "max", "min", "avg", "distinct_count" ], "default": "count", "description": "Cómo se agregan las transacciones históricas que coinciden. unique_count se acepta como alias de distinct_count." }, "field": { "type": "string", "default": "amount", "description": "Campo que se agrega mediante sum/max/min/avg/distinct_count. Se ignora con count." }, "operator": { "type": "string", "enum": [ "eq", "ne", "gt", "gte", "lt", "lte" ], "default": "eq", "description": "Comparación aplicada a la métrica calculada." }, "value": { "type": "number", "description": "Umbral con el que se compara la métrica calculada." }, "window": { "type": "string", "pattern": "^\\d+(m|h|d)$", "default": "1d", "description": "Ventana retrospectiva que termina en el txn_date de la transacción: m (MINUTOS, no meses), h (horas) o d (días), por ejemplo 30m, 24h, 7d, 30d." }, "filters": { "type": "object", "additionalProperties": true, "description": "Restringe qué transacciones históricas se agregan. Las claves son rutas de campo del catálogo de campos de condición; un valor \"__current__\" se resuelve al valor del mismo campo en la transacción que se está evaluando (p. ej., {\"subject_vendor_data\": \"__current__\"} limita la ventana al mismo sujeto), y un valor de lista indica pertenencia. Los filtros comparan SOLO por igualdad o pertenencia: no hay filtro lt/gte, así que aquí no se puede expresar un rango como \"transacciones históricas inferiores a 10,000\". Aplica el rango a la métrica en su lugar (la métrica max con el operador lt mantiene todas las transacciones de la ventana por debajo del umbral)." } }, "description": "Control de velocidad sobre las transacciones históricas de la aplicación dentro de la ventana. Todas las entradas de agregación deben coincidir para que la regla coincida, independientemente de evaluation_mode. Una agregación solo restringe la ventana; la transacción que se evalúa está restringida por scope y conditions, así que repite direction, currency o transaction_type en ambas partes cuando la regla los garantice." }, "TransactionRuleScope": { "type": "object", "properties": { "transaction_types": { "type": "array", "items": { "type": "string" }, "description": "Restringe a tipos de transacción, por ejemplo finance, kyc, travel_rule, user_event. Vacío o ausente = sin restricción." }, "directions": { "type": "array", "items": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "description": "Restringe a direcciones de transacción (sin distinguir mayúsculas y minúsculas al escribir)." }, "action_types": { "type": "array", "items": { "type": "string" }, "description": "Restringe a tus valores de action_type, por ejemplo withdrawal, deposit." } }, "description": "A qué transacciones se aplica la regla. Solo se aceptan estas tres claves." }, "TransactionRuleAction": { "oneOf": [ { "$ref": "#/components/schemas/TransactionRuleActionAddScore" }, { "$ref": "#/components/schemas/TransactionRuleActionChangeStatus" }, { "$ref": "#/components/schemas/TransactionRuleActionAddTags" }, { "$ref": "#/components/schemas/TransactionRuleActionAddNote" }, { "$ref": "#/components/schemas/TransactionRuleActionAddToList" }, { "$ref": "#/components/schemas/TransactionRuleActionOpenCase" } ], "discriminator": { "propertyName": "type", "mapping": { "add_score": "#/components/schemas/TransactionRuleActionAddScore", "change_status": "#/components/schemas/TransactionRuleActionChangeStatus", "add_tags": "#/components/schemas/TransactionRuleActionAddTags", "add_note": "#/components/schemas/TransactionRuleActionAddNote", "add_to_list": "#/components/schemas/TransactionRuleActionAddToList", "open_case": "#/components/schemas/TransactionRuleActionOpenCase" } }, "description": "Una acción de regla. Una regla puede tener varias; todas se aplican a la vez cuando la regla coincide. Las reglas en modo TEST registran lo que habrían hecho sin aplicar ninguna acción." }, "TransactionRuleCreateRequest": { "type": "object", "required": [ "title", "category", "mode" ], "properties": { "title": { "type": "string", "description": "Nombre de la regla. Único por aplicación entre las reglas no eliminadas; los duplicados devuelven 400." }, "description": { "type": "string", "nullable": true }, "category": { "type": "string", "description": "Tema de riesgo que se usa para agrupar y generar informes, p. ej., finance, aml_ctf, anomaly_detection, fatf, device_intelligence, crypto_monitoring, travel_rule, responsible_gaming, e_commerce." }, "mode": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "TEST" ], "description": "ACTIVE evalúa en vivo. TEST evalúa y registra las ejecuciones de reglas, pero nunca modifica la puntuación ni el estado: es el modo inicial recomendado. DISABLED se omite." }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ], "default": "ALL", "description": "Indica si deben cumplirse todas las condiciones (ALL) o al menos una (ANY). Se ignora cuando las condiciones usan group_index." }, "scope": { "$ref": "#/components/schemas/TransactionRuleScope" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleCondition" } }, "aggregation": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAggregation" } }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAction" } }, "metadata": { "type": "object", "description": "Metadatos libres guardados en la regla." } }, "description": "Crea una regla CUSTOM. Las reglas en modo ACTIVE se aplican de inmediato a las nuevas transacciones. Créalas en modo TEST y haz primero un backtest." }, "TransactionRuleUpdateRequest": { "type": "object", "properties": { "title": { "type": "string", "description": "Nombre de la regla. Único por aplicación entre las reglas no eliminadas; los duplicados devuelven 400." }, "description": { "type": "string", "nullable": true }, "category": { "type": "string", "description": "Tema de riesgo que se usa para agrupar y generar informes, p. ej., finance, aml_ctf, anomaly_detection, fatf, device_intelligence, crypto_monitoring, travel_rule, responsible_gaming, e_commerce." }, "mode": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "TEST" ], "description": "ACTIVE evalúa en vivo. TEST evalúa y registra las ejecuciones de reglas, pero nunca modifica la puntuación ni el estado: es el modo inicial recomendado. DISABLED se omite." }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ], "default": "ALL", "description": "Indica si deben cumplirse todas las condiciones (ALL) o al menos una (ANY). Se ignora cuando las condiciones usan group_index." }, "scope": { "$ref": "#/components/schemas/TransactionRuleScope" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleCondition" } }, "aggregation": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAggregation" } }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAction" } }, "metadata": { "type": "object", "description": "Metadatos libres guardados en la regla." } }, "description": "Actualización parcial. Las reglas personalizadas aceptan todos los campos; las reglas de la biblioteca (PRESET) solo aceptan mode; cualquier otro campo devuelve 400." }, "TransactionRuleDetail": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "title": { "type": "string", "description": "Nombre de la regla. Único por aplicación entre las reglas no eliminadas; los duplicados devuelven 400." }, "description": { "type": "string", "nullable": true }, "category": { "type": "string", "description": "Tema de riesgo que se usa para agrupar y generar informes, p. ej., finance, aml_ctf, anomaly_detection, fatf, device_intelligence, crypto_monitoring, travel_rule, responsible_gaming, e_commerce." }, "mode": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "TEST" ], "description": "ACTIVE evalúa en vivo. TEST evalúa y registra las ejecuciones de reglas, pero nunca modifica la puntuación ni el estado: es el modo inicial recomendado. DISABLED se omite." }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ], "default": "ALL", "description": "Indica si deben cumplirse todas las condiciones (ALL) o al menos una (ANY). Se ignora cuando las condiciones usan group_index." }, "scope": { "$ref": "#/components/schemas/TransactionRuleScope" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleCondition" } }, "aggregation": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAggregation" } }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAction" } }, "metadata": { "type": "object", "description": "Metadatos libres guardados en la regla." }, "severity": { "type": "string", "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "nullable": true, "description": "Gravedad informativa que incluyen las reglas de la biblioteca; no se puede establecer en reglas personalizadas." }, "source": { "type": "string", "enum": [ "PRESET", "CUSTOM" ], "description": "Las reglas PRESET provienen de la biblioteca (instalar/desinstalar, ediciones solo del modo); las reglas CUSTOM son completamente tuyas." }, "library_key": { "type": "string", "nullable": true, "description": "Identificador estable de la biblioteca; null para reglas personalizadas." }, "latest_triggered_at": { "type": "string", "format": "date-time", "nullable": true }, "run_count": { "type": "integer", "description": "Cuántas transacciones coincidieron con esta regla." }, "approved_count": { "type": "integer" }, "reviewed_count": { "type": "integer" }, "declined_count": { "type": "integer" }, "awaiting_user_count": { "type": "integer" }, "approved_pct": { "type": "number" }, "reviewed_pct": { "type": "number" }, "declined_pct": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "TransactionRuleBacktestRequest": { "type": "object", "properties": { "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleCondition" }, "default": [] }, "aggregation": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAggregation" }, "default": [] }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ], "default": "ALL" }, "scope": { "$ref": "#/components/schemas/TransactionRuleScope" }, "period_days": { "type": "integer", "minimum": 1, "maximum": 365, "default": 90 } }, "description": "Configuración hipotética de una regla para evaluar contra las transacciones recientes. Es de solo lectura y gratuita: no se crea ni se modifica nada. Envía las mismas conditions, aggregation, evaluation_mode Y scope que la regla que quieres activar. Si se omiten conditions, aggregation y scope, no añaden restricciones propias; omitir scope puede incluir direcciones o tipos de transacción que la regla guardada excluye. Si se omite evaluation_mode, su valor predeterminado es ALL (lo que puede reducir las coincidencias de una regla ANY), y si se omite period_days, su valor predeterminado es 90 días, no un historial ilimitado." }, "TransactionRuleBacktestResult": { "type": "object", "properties": { "evaluated": { "type": "integer", "description": "Transacciones evaluadas (las más recientes primero, con un límite)." }, "matched": { "type": "integer", "description": "Transacciones con las que habría coincidido la configuración." }, "affected_entities": { "type": "integer", "description": "Sujetos distintos (según vendor_data) entre las coincidencias." }, "period_days": { "type": "integer" } } }, "TransactionRuleLibraryEntry": { "type": "object", "properties": { "library_key": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "category": { "type": "string" }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ] }, "scope": { "$ref": "#/components/schemas/TransactionRuleScope" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleCondition" } }, "aggregation": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAggregation" } }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAction" } }, "metadata": { "type": "object" }, "bundle": { "type": "string", "nullable": true, "description": "Familia funcional, p. ej., finance, aml_ctf, crypto_monitoring, travel_rule, responsible_gaming." }, "tags": { "type": "array", "items": { "type": "string" } }, "industries": { "type": "array", "items": { "type": "string" } }, "source": { "type": "string" }, "is_installed": { "type": "boolean", "description": "Si este preajuste está instalado actualmente en la aplicación." } } }, "TransactionRuleInstallRequest": { "type": "object", "properties": { "library_keys": { "type": "array", "items": { "type": "string" }, "description": "Ajustes predefinidos concretos que se van a instalar o desinstalar." }, "bundle": { "type": "string", "description": "Instala o desinstala en su lugar todos los presets de este bundle." } }, "description": "Proporciona library_keys O bundle." }, "TransactionRuleInstallResult": { "type": "object", "properties": { "installed_library_keys": { "type": "array", "items": { "type": "string" }, "description": "Solo POST (instalación): presets instalados por esta llamada." }, "installed_count": { "type": "integer", "description": "Solo POST (instalación)." }, "uninstalled_count": { "type": "integer", "description": "Solo para DELETE (desinstalación): presets eliminados por esta llamada." } } }, "WalletScreeningResult": { "type": "object", "properties": { "provider": { "type": "string", "description": "Proveedor que realizó el análisis (p. ej., `merklescience`, `crystal`)." }, "screening_type": { "type": "string", "enum": [ "WALLET_SCREENING" ], "description": "Siempre `WALLET_SCREENING` para este endpoint." }, "risk_score": { "type": "integer", "description": "Puntuación de riesgo normalizada de 0 a 100. Un valor más alto indica una mayor exposición a entidades de riesgo. Merkle Science califica una dirección de 0 a 5, lo que se corresponde con 0, 15, 35, 55, 75 o 95." }, "severity": { "type": "string", "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "description": "Nivel de riesgo derivado de `risk_score`: `0-9` UNKNOWN, `10-39` LOW, `40-69` MEDIUM, `70-89` HIGH, `90-100` CRITICAL. `UNKNOWN` es la banda más baja, no un estado aparte sin datos: un `risk_score` de 0 (el caso habitual de una dirección limpia) significa que no hay ninguna evaluación adversa, mientras que una puntuación distinta de cero en el rango 1-9 es una señal real pero inferior a LOW; consulta el `risk_score`, no solo la banda. Nunca trates `UNKNOWN` como una calificación afirmativa de riesgo bajo o sin riesgo; no lo muestres como aprobado." }, "status": { "type": "string", "enum": [ "SCREENED", "PENDING", "ERROR" ], "description": "Estado del resultado del análisis." }, "summary": { "type": "string", "description": "Resumen legible del resultado del análisis." }, "wallet_address": { "type": "string", "description": "La dirección analizada, devuelta tal cual." }, "transaction_hash": { "type": "string", "nullable": true, "description": "Campo del análisis de transacciones, compartido con la estructura del resultado. Siempre es `null` en un resultado de análisis de wallets." }, "blockchain": { "type": "string", "description": "La blockchain que se analizó." }, "block_timestamp": { "type": "string", "nullable": true, "description": "Campo del análisis de transacciones, compartido con la estructura del resultado. Siempre es `null` en un resultado de análisis de wallets." }, "total_value_usd": { "type": "number", "nullable": true, "description": "Campo del análisis de transacciones, compartido con la estructura del resultado. Siempre es `null` en un resultado de análisis de wallets." }, "fee_usd": { "type": "number", "nullable": true, "description": "Campo del análisis de transacciones, compartido con la estructura del resultado. Siempre es `null` en un resultado de análisis de wallets." }, "sender_rows": { "type": "array", "items": { "type": "object" }, "description": "Campo del análisis de transacciones, compartido con la estructura del resultado. Siempre está vacío en un resultado de análisis de wallets." }, "receiver_rows": { "type": "array", "items": { "type": "object" }, "description": "Campo del análisis de transacciones, compartido con la estructura del resultado. Siempre está vacío en un resultado de análisis de wallets." }, "transaction_flows": { "type": "array", "items": { "type": "object" }, "description": "Campo del análisis de transacciones, compartido con la estructura del resultado. Siempre está vacío en un resultado de análisis de wallets." }, "transaction_flows_status": { "type": "string", "nullable": true, "description": "Campo del análisis de transacciones, compartido con la estructura del resultado. Siempre es `null` en un resultado de análisis de wallets." }, "transaction_flows_error": { "type": "string", "nullable": true, "description": "Campo del análisis de transacciones, compartido con la estructura del resultado. Siempre es `null` en un resultado de análisis de wallets." }, "source_of_funds": { "type": "array", "description": "De dónde recibió fondos la dirección, atribuido por entidad. Cada entrada es un desglose de exposición.", "items": { "type": "object", "properties": { "category": { "type": "string", "description": "Categoría de riesgo normalizada, por ejemplo `exchange_licensed`, `dex`, `defi`, `payment_processor`, `mixer`, `darknet_market`, `sanctioned`, `stolen_funds`, `high_risk_exchange`." }, "percentage": { "type": "number", "description": "Proporción de la exposición total del sentido, de 0 a 100." }, "amount_usd": { "type": "number", "nullable": true, "description": "Valor en USD atribuido a esta entidad." }, "entity_name": { "type": "string", "nullable": true, "description": "Nombre de la entidad atribuida, por ejemplo un exchange, un mixer o un grupo sancionado." }, "entity_type": { "type": "string", "nullable": true, "description": "Tipo de entidad del proveedor (p. ej., `Exchange`, `DeFi`, `Sanctions`, `Theft`)." }, "entity_subtype": { "type": "string", "nullable": true, "description": "Subtipo más detallado (p. ej., `Mandatory KYC and AML`, `OFAC`, `Yield Aggregator`)." }, "hops": { "type": "integer", "nullable": true, "description": "Número de saltos hasta la entidad (1 para una contraparte directa), cuando el proveedor lo informa. Siempre `null` para Merkle Science, que solo informa de si la exposición es directa o indirecta: usa `exposure_type`." }, "description": { "type": "string", "nullable": true, "description": "`entity_type / entity_subtype`, tal como el proveedor etiqueta la entidad." }, "is_direct": { "type": "boolean", "description": "True cuando `exposure_type` es `direct`." }, "exposure_direction": { "type": "string", "enum": [ "incoming", "outgoing", "connected" ], "description": "Si los fondos provinieron de esta entidad (`incoming`) o se enviaron a ella (`outgoing`)." }, "exposure_type": { "type": "string", "enum": [ "direct", "indirect" ], "description": "Exposición `direct` (1 salto) o `indirect` (varios saltos)." }, "provider_entity_id": { "type": "string", "nullable": true, "description": "El identificador propio del proveedor para la entidad." }, "provider_entity_type_id": { "type": "string", "nullable": true, "description": "El identificador propio del proveedor para `entity_type`." }, "provider_entity_subtype_id": { "type": "string", "nullable": true, "description": "El identificador propio del proveedor para `entity_subtype`." }, "country": { "type": "string", "nullable": true, "description": "País principal de la entidad en formato ISO 3166-1 alfa-2. Vacío o `null` cuando el proveedor no lo conoce." }, "raw_amount": { "type": "number", "nullable": true, "description": "Importe en la unidad propia del activo, cuando el proveedor lo informa." }, "raw_currency": { "type": "string", "nullable": true, "description": "Unidad de `raw_amount`, cuando el proveedor la informa." } } } }, "destination_of_funds": { "type": "array", "description": "A dónde envió fondos la dirección, atribuido por entidad. Misma estructura de elementos que `source_of_funds`, con `exposure_direction` = `outgoing`.", "items": { "type": "object", "properties": { "category": { "type": "string", "description": "Categoría de riesgo normalizada, por ejemplo `exchange_licensed`, `dex`, `defi`, `payment_processor`, `mixer`, `darknet_market`, `sanctioned`, `stolen_funds`, `high_risk_exchange`." }, "percentage": { "type": "number", "description": "Proporción de la exposición total del sentido, de 0 a 100." }, "amount_usd": { "type": "number", "nullable": true, "description": "Valor en USD atribuido a esta entidad." }, "entity_name": { "type": "string", "nullable": true, "description": "Nombre de la entidad atribuida, por ejemplo un exchange, un mixer o un grupo sancionado." }, "entity_type": { "type": "string", "nullable": true, "description": "Tipo de entidad del proveedor (p. ej., `Exchange`, `DeFi`, `Sanctions`, `Theft`)." }, "entity_subtype": { "type": "string", "nullable": true, "description": "Subtipo más detallado (p. ej., `Mandatory KYC and AML`, `OFAC`, `Yield Aggregator`)." }, "hops": { "type": "integer", "nullable": true, "description": "Número de saltos hasta la entidad (1 para una contraparte directa), cuando el proveedor lo informa. Siempre `null` para Merkle Science, que solo informa de si la exposición es directa o indirecta: usa `exposure_type`." }, "description": { "type": "string", "nullable": true, "description": "`entity_type / entity_subtype`, tal como el proveedor etiqueta la entidad." }, "is_direct": { "type": "boolean", "description": "True cuando `exposure_type` es `direct`." }, "exposure_direction": { "type": "string", "enum": [ "incoming", "outgoing", "connected" ], "description": "Si los fondos provinieron de esta entidad (`incoming`) o se enviaron a ella (`outgoing`)." }, "exposure_type": { "type": "string", "enum": [ "direct", "indirect" ], "description": "Exposición `direct` (1 salto) o `indirect` (varios saltos)." }, "provider_entity_id": { "type": "string", "nullable": true, "description": "El identificador propio del proveedor para la entidad." }, "provider_entity_type_id": { "type": "string", "nullable": true, "description": "El identificador propio del proveedor para `entity_type`." }, "provider_entity_subtype_id": { "type": "string", "nullable": true, "description": "El identificador propio del proveedor para `entity_subtype`." }, "country": { "type": "string", "nullable": true, "description": "País principal de la entidad en formato ISO 3166-1 alfa-2. Vacío o `null` cuando el proveedor no lo conoce." }, "raw_amount": { "type": "number", "nullable": true, "description": "Importe en la unidad propia del activo, cuando el proveedor lo informa." }, "raw_currency": { "type": "string", "nullable": true, "description": "Unidad de `raw_amount`, cuando el proveedor la informa." } } } }, "counterparty_connections": { "type": "array", "description": "Entidades a las que el proveedor atribuye la dirección analizada. En Merkle Science provienen de las etiquetas de propietario y de usuario de la propia dirección, por lo que la misma entidad puede aparecer dos veces, y no incluyen flujos de fondos: `received_usd`, `sent_usd`, `received_hops` y `sent_hops` son `null` y `percentage` es 0. No tomes decisiones de enrutamiento según `risk_level` o `is_direct` aquí: usa `sanctions_hit`, `dominant_risk_category` y `risk_factors[].is_high_risk` para el veredicto, y `exposure_type` en `source_of_funds`/`destination_of_funds` para saber si la exposición es directa.", "items": { "type": "object", "properties": { "entity_name": { "type": "string", "nullable": true, "description": "Nombre de la entidad atribuida." }, "entity_type": { "type": "string", "nullable": true, "description": "Tipo de entidad del proveedor." }, "entity_subtype": { "type": "string", "nullable": true, "description": "Subtipo de entidad del proveedor." }, "risk_level": { "type": "string", "description": "En minúsculas y depende del proveedor. Para Merkle Science es la calificación de riesgo propia de la dirección, de 0 a 5 (`no_risk`, `low`, `medium_low`, `medium`, `high`, `critical`), elevada a `high` cuando la categoría de la entidad es de alto riesgo; no es una calificación aparte de la entidad." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Categorías de riesgo normalizadas de la entidad." }, "received_usd": { "type": "number", "nullable": true, "description": "USD recibidos de la entidad, cuando el proveedor lo informa." }, "sent_usd": { "type": "number", "nullable": true, "description": "USD enviados a la entidad, cuando el proveedor lo informa." }, "received_hops": { "type": "integer", "nullable": true, "description": "Saltos hasta la entidad del lado receptor, cuando el proveedor los informa." }, "sent_hops": { "type": "integer", "nullable": true, "description": "Saltos hasta la entidad del lado emisor, cuando el proveedor los informa." }, "percentage": { "type": "number", "description": "Proporción de la exposición de la dirección, cuando el proveedor la informa; en caso contrario, 0." }, "is_direct": { "type": "boolean", "description": "Siempre `true` para Merkle Science, cuyas conexiones son atribuciones y no contrapartes." }, "country": { "type": "string", "nullable": true, "description": "País de la entidad, cuando se conoce." }, "provider_entity_id": { "type": "string", "nullable": true, "description": "El identificador propio del proveedor para la entidad." } } } }, "network_nodes": { "type": "array", "items": { "type": "object" }, "description": "Nodos del grafo de exposición para el análisis de transacciones. Vacíos en un resultado de análisis de wallets." }, "network_edges": { "type": "array", "items": { "type": "object" }, "description": "Aristas del grafo de exposición para el análisis de transacciones. Vacías en un resultado de análisis de wallets." }, "sanctions_hit": { "type": "boolean", "description": "True si la dirección tiene exposición directa o indirecta a sanciones." }, "pep_counterparty": { "type": "boolean", "description": "Exposición como persona expuesta políticamente. `null` cuando no hay ningún hallazgo de PEP disponible, lo que ocurre hoy en todos los resultados porque ningún proveedor lo informa; `false` solo ante un resultado de análisis negativo explícito. No interpretes `null` como una comprobación de PEP completada.", "nullable": true }, "dominant_risk_category": { "type": "string", "nullable": true, "description": "Categoría de alto riesgo con mayor peso, o `null` cuando ninguna es dominante (p. ej., `sanctioned`, `mixer`, `stolen_funds`)." }, "risk_factors": { "type": "array", "description": "Explicación ordenada de `risk_score`: qué produjo este veredicto. Los proveedores califican una dirección según su propio modelo y devuelven solo un veredicto (Merkle Science devuelve un entero de 0 a 5), por lo que la puntuación por sí sola no permite actuar. Se ordena primero por alto riesgo y luego por el valor que pasó por cada factor, con un máximo de los cinco más relevantes; `source_of_funds` y `destination_of_funds` siempre contienen el desglose completo. Un `risk_score` alto sin ninguna entrada `is_high_risk` significa que el proveedor no informó ninguna coincidencia con sanciones ni con entidades atribuidas y calificó la dirección únicamente según su propio modelo de exposición; `summary` lo indica de forma explícita.", "items": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "attribution", "exposure" ], "description": "`attribution` es lo que el proveedor dice que es la propia dirección (su propia etiqueta o clúster); `exposure` es hacia dónde se movieron realmente sus fondos." }, "category": { "type": "string", "description": "Categoría de riesgo normalizada, con el mismo vocabulario que el desglose de exposición." }, "label": { "type": "string", "description": "La redacción propia del proveedor para el factor (p. ej., `Gambling / Crypto only`), que es lo mismo que verías en la consola del proveedor." }, "entity_name": { "type": "string", "nullable": true, "description": "Entidad atribuida detrás del factor, por ejemplo un sitio de apuestas o un exchange." }, "direction": { "type": "string", "enum": [ "incoming", "outgoing", "connected", "unknown", "attribution" ], "description": "Sentido del flujo de fondos, `attribution` cuando el factor determinante es la propia etiqueta de la dirección, o `unknown` cuando el proveedor no indicó un sentido." }, "exposure_type": { "type": "string", "enum": [ "direct", "indirect", "unknown", "attribution" ], "description": "`direct` (1 salto) o `indirect` (varios saltos), `attribution` para la etiqueta propia de la dirección, o `unknown` cuando el proveedor no indicó a cuántos saltos está la contraparte. Trata `unknown` como sin clasificar, no como `direct`." }, "amount_usd": { "type": "number", "format": "float", "nullable": true, "description": "Valor en USD atribuido a este factor determinante." }, "percentage": { "type": "number", "format": "float", "description": "Proporción del volumen analizado TOTAL de la dirección, con ambos sentidos combinados, a diferencia de `percentage` dentro de `source_of_funds`/`destination_of_funds`, que se normaliza por sentido. Es comparable y sumable en toda la lista." }, "is_high_risk": { "type": "boolean", "description": "Si la categoría es una de las que Didit considera de alto riesgo (`sanctioned`, `mixer`, `stolen_funds`, `ransomware`, `scam`, `darknet_market`, `terrorist_financing`, `child_exploitation`, `hacked_exchange`, `high_risk_exchange`, `seized_funds`)." }, "description": { "type": "string", "description": "Representación en una línea del factor determinante, por ejemplo `9.01% indirect outgoing exposure to Gambling / Crypto only (Example Gambling)`." } } } }, "raw_response": { "type": "object", "additionalProperties": true, "description": "El payload propio del proveedor. Su estructura depende del proveedor y puede cambiar sin previo aviso: lee los campos normalizados en lugar de analizarlo." }, "report_signature": { "type": "string", "description": "Firma HMAC-SHA256 opaca sobre este resultado exacto, limitada a tu aplicación. No tiene significado por sí sola: vuelve a enviar el cuerpo completo de la respuesta, sin modificar e incluyendo este campo, a `POST /v3/wallet-screening/pdf/` para generarlo como PDF. El endpoint de PDF rechaza la solicitud con `400` si falta `report_signature` o si se editó algún campo firmado (p. ej., `risk_score`, `severity`, `sanctions_hit`) antes de reenviarlo." } }, "required": [ "provider", "screening_type", "risk_score", "severity", "status", "summary", "wallet_address", "blockchain", "sanctions_hit", "dominant_risk_category", "source_of_funds", "destination_of_funds", "counterparty_connections", "report_signature" ] }, "NetworkRiskDisplay": { "type": "object", "properties": { "score": { "type": "integer", "description": "Puntuación de riesgo, de 0 a 100." }, "band": { "type": "string", "enum": [ "low", "medium", "high" ], "description": "Banda con la que se muestra la puntuación. high >= 70, medium >= 40; en otro caso, low." }, "bar": { "type": "number", "format": "float", "description": "Valor normalizado de 0 a 1 para representar una barra de riesgo." } } }, "NetworkNodeTag": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string", "nullable": true, "description": "Null para las etiquetas de protección, cuyo token de color gestiona el renderizador." }, "source": { "type": "string", "enum": [ "subject_tag", "session_tag", "transaction_tag", "signal_guard" ], "description": "Origen de la etiqueta: una etiqueta en el usuario o la empresa, una etiqueta en una sesión de esta red, una etiqueta en una transacción a la que pertenece una parte, o una condición de protección de señales (p. ej., hub, IP de centro de datos)." }, "category": { "type": "string", "enum": [ "customer", "quality" ], "nullable": true, "description": "customer para etiquetas definidas por el cliente, quality para etiquetas de control de calidad de la señal. Null cuando no aplica." } } }, "NetworkListItem": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "network_id": { "type": "string", "description": "ID secuencial legible por organización, p. ej. N-0001." }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "active", "in_review", "resolved", "dismissed" ], "description": "Estado del ciclo de vida de la red. Es distinto del outcome_status de cada solicitante dentro de una red (approved/in_review/declined/not_completed)." }, "risk": { "$ref": "#/components/schemas/NetworkRiskDisplay" }, "pattern_types": { "type": "array", "items": { "type": "string", "enum": [ "exact_same_device", "similar_device", "same_ip_address", "same_address", "similar_selfie_backgrounds", "similar_poa_documents", "same_document_number", "same_phone_number", "same_email" ] }, "description": "Los patrones de agrupamiento detectados en esta red." }, "signal_types": { "type": "array", "items": { "type": "string", "enum": [ "ip_address", "device", "face", "document_number", "phone", "email", "address" ] }, "description": "Los distintos tipos de señal presentes en esta red." }, "member_counts": { "type": "object", "description": "Recuentos de miembros por categoría (p. ej., total, por outcome_status)." }, "member_status": { "type": "object", "description": "Desglose de los miembros por outcome_status." }, "signal_coverage": { "type": "object", "description": "Cobertura por signal_type de los miembros de esta red." }, "first_activity_at": { "type": "string", "format": "date-time", "nullable": true }, "last_activity_at": { "type": "string", "format": "date-time", "nullable": true } } }, "NetworkDetail": { "allOf": [ { "$ref": "#/components/schemas/NetworkListItem" }, { "type": "object", "properties": { "stats": { "type": "object", "description": "Estadísticas agregadas de la red (p. ej., totales de miembros)." }, "fraud_tags": { "type": "array", "items": { "type": "object" }, "description": "Etiquetas de patrones de fraude detectadas en la red." }, "risk_signals": { "type": "object", "description": "Resúmenes de señales de riesgo: residential_proxy_reuse, email_intelligence, phone_intelligence." }, "reviewed_at": { "type": "string", "format": "date-time", "nullable": true }, "reviewed_by": { "type": "string", "nullable": true }, "review_reason": { "type": "string", "nullable": true } } } ], "properties": { "notes_count": { "type": "integer", "minimum": 0, "readOnly": true, "description": "Número de notas privadas de analistas en esta investigación." } } }, "NetworkGraphNode": { "type": "object", "description": "Un nodo de sujeto o un nodo de señal, que se distinguen por kind. Los nodos de sujeto (kind: vendor_user | vendor_business | transaction_party) incluyen id, kind, subject, node_status (approved | in_review | declined | not_completed) y tags. Los nodos de señal (kind: signal) incluyen id, kind, uuid, signal_type, subject_count, coverage, is_hub, is_datacenter_ip, is_high_collision_device, node_status (signal_active | signal_guarded), tags, risk_evidence, first_seen_at y last_seen_at.", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "vendor_user", "vendor_business", "transaction_party", "signal" ] } } }, "NetworkGraphEdge": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "source": { "type": "string", "description": "ID del nodo del sujeto." }, "target": { "type": "string", "description": "ID del nodo de señal." }, "subject_kind": { "type": "string", "enum": [ "vendor_user", "vendor_business", "transaction_party" ] }, "signal_type": { "type": "string", "enum": [ "ip_address", "device", "face", "document_number", "phone", "email", "address" ] }, "confidence": { "type": "number", "format": "float", "description": "1.0 para una coincidencia exacta." }, "observation_count": { "type": "integer" }, "first_seen_at": { "type": "string", "format": "date-time", "nullable": true }, "last_seen_at": { "type": "string", "format": "date-time", "nullable": true } } }, "NetworkGraph": { "type": "object", "properties": { "network": { "$ref": "#/components/schemas/NetworkDetail" }, "depth": { "type": "integer", "nullable": true, "description": "Profundidad efectiva aplicada, o null cuando no tiene límite (depth=all)." }, "truncated": { "type": "boolean", "description": "True si el vecindario se truncó por la profundidad." }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkGraphNode" } }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkGraphEdge" } }, "metrics": { "type": "object", "properties": { "node_count": { "type": "integer" }, "edge_count": { "type": "integer" }, "hub_signal_count": { "type": "integer" } } } } }, "NetworkMember": { "type": "object", "properties": { "subject": { "type": "object", "description": "El vendor_user, vendor_business o transaction_party que representa este miembro." }, "outcome_status": { "type": "string", "description": "El resultado de la verificación o decisión del sujeto." }, "node_status": { "type": "string", "enum": [ "approved", "in_review", "declined", "not_completed", "signal_active", "signal_guarded" ], "description": "En una fila de miembro, siempre es uno de los valores de resultado del sujeto: approved, in_review, declined o not_completed." }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkNodeTag" } }, "risk": { "$ref": "#/components/schemas/NetworkRiskDisplay" }, "signal_coverage": { "type": "object" }, "shared_infrastructure": { "type": "object" }, "joined_at": { "type": "string", "format": "date-time", "nullable": true }, "last_seen_at": { "type": "string", "format": "date-time", "nullable": true }, "provenance": { "type": "object", "properties": { "session_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "business_session_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "transaction_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "NetworkSignal": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "signal_type": { "type": "string", "enum": [ "ip_address", "device", "face", "document_number", "phone", "email", "address" ] }, "subject_count": { "type": "integer" }, "coverage": { "type": "number", "format": "float" }, "is_hub": { "type": "boolean", "description": "True cuando esta señal vincula un número inusualmente alto de sujetos." }, "is_datacenter_ip": { "type": "boolean" }, "is_high_collision_device": { "type": "boolean" }, "node_status": { "type": "string", "enum": [ "signal_active", "signal_guarded" ] }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkNodeTag" } }, "risk_evidence": { "type": "object" }, "first_seen_at": { "type": "string", "format": "date-time", "nullable": true }, "last_seen_at": { "type": "string", "format": "date-time", "nullable": true } } }, "NetworkTimelineEvent": { "type": "object", "properties": { "event_type": { "type": "string", "description": "p. ej., network_detected, signal_observed, network_in_review, network_resolved, network_dismissed." }, "occurred_at": { "type": "string", "format": "date-time", "nullable": true }, "label": { "type": "string" }, "metadata": { "type": "object" } } }, "NetworkMap": { "type": "object", "properties": { "network": { "$ref": "#/components/schemas/NetworkDetail" }, "convergence_count": { "type": "integer", "description": "Número de puntos de dirección o ubicación distintos en los que coinciden los miembros." }, "countries": { "type": "array", "items": { "type": "string" } }, "points": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "country": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "latitude": { "type": "number", "format": "float", "nullable": true }, "longitude": { "type": "number", "format": "float", "nullable": true }, "observed_at": { "type": "string", "format": "date-time", "nullable": true } } } } } }, "EntityNetworkMembership": { "type": "object", "properties": { "network": { "$ref": "#/components/schemas/NetworkListItem" }, "subject": { "type": "object" }, "signal_types": { "type": "array", "items": { "type": "string", "enum": [ "ip_address", "device", "face", "document_number", "phone", "email", "address" ] } }, "signal_count": { "type": "integer" }, "joined_at": { "type": "string", "format": "date-time", "nullable": true }, "last_seen_at": { "type": "string", "format": "date-time", "nullable": true } } }, "RiskSignals": { "type": "object", "description": "Contexto opcional de dispositivo y red observado por tu aplicación. Todos los campos son opcionales. Enviarlos alimenta la detección de coincidencias entre sesiones en Networks.", "properties": { "ip": { "type": "string", "format": "ip", "description": "Dirección IPv4 o IPv6 observada para el usuario final.", "example": "192.0.2.1" }, "device_id": { "type": "string", "maxLength": 255, "description": "Identificador estable del dispositivo recopilado por tu aplicación (`ANDROID_ID` en Android, `identifierForVendor` en iOS)." }, "device_platform": { "type": "string", "enum": [ "android", "ios", "ipados", "tvos", "web" ], "description": "Plataforma del dispositivo del usuario final." }, "device_model": { "type": "string", "maxLength": 255, "description": "Modelo del dispositivo que informa tu aplicación." }, "os_version": { "type": "string", "maxLength": 64, "description": "Versión del sistema operativo." }, "app_version": { "type": "string", "maxLength": 64, "description": "Versión de tu aplicación." }, "user_agent": { "type": "string", "maxLength": 512, "description": "User agent del navegador o de la aplicación." } } }, "PhoneRiskRequest": { "type": "object", "required": [ "phone_number" ], "properties": { "phone_number": { "type": "string", "maxLength": 20, "description": "Número de teléfono que se va a puntuar. Se valida y se normaliza a E.164.", "example": "+14155552671" }, "country_code": { "type": "string", "maxLength": 3, "description": "Indicación de país ISO 3166-1 alfa-2 o alfa-3 opcional para la cobertura de inteligencia.", "example": "US" }, "signals": { "$ref": "#/components/schemas/RiskSignals" }, "vendor_data": { "type": "string", "description": "Tu referencia estable para esta solicitud. Se guarda en la sesión de API y se devuelve en la respuesta." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Tus metadatos JSON no sensibles. Se almacenan en la sesión de API y se devuelven en la respuesta." }, "enable_social": { "type": "boolean", "default": false, "description": "Si es true, también se consulta la huella social del número: las plataformas de mensajería, redes sociales, comercio electrónico y profesionales en las que está registrado. Se factura como una unidad `phone_social` por solicitud, además del precio propio de este endpoint.", "example": true } } }, "EmailRiskRequest": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "description": "Dirección de correo electrónico que se va a puntuar.", "example": "alice@example.com" }, "country_code": { "type": "string", "maxLength": 3, "description": "Indicación de país ISO 3166-1 alfa-2 o alfa-3 opcional para la cobertura de inteligencia.", "example": "US" }, "signals": { "$ref": "#/components/schemas/RiskSignals" }, "vendor_data": { "type": "string", "description": "Tu referencia estable para esta solicitud. Se guarda en la sesión de API y se devuelve en la respuesta." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Tus metadatos JSON no sensibles. Se almacenan en la sesión de API y se devuelven en la respuesta." }, "enable_social": { "type": "boolean", "default": false, "description": "Si es true, también se consulta la huella social de la dirección: las plataformas de correo electrónico, redes sociales, profesionales, comercio electrónico y entretenimiento en las que está registrada. Se factura como una unidad `email_social` por solicitud, además del precio propio de este endpoint.", "example": true } } }, "IPRiskRequest": { "type": "object", "required": [ "ip_address" ], "properties": { "ip_address": { "type": "string", "format": "ip", "description": "Dirección IPv4 o IPv6 que se va a puntuar.", "example": "8.8.8.8" }, "claimed_country": { "type": "string", "maxLength": 3, "description": "País ISO 3166-1 alfa-2 o alfa-3 opcional declarado por el usuario o la sesión. Se usa para calcular `country_mismatch`.", "example": "ESP" }, "user_agent": { "type": "string", "maxLength": 512, "description": "User agent observado por tu backend. Se almacena como contexto de la solicitud; no proporciona huella digital del dispositivo." }, "vendor_data": { "type": "string", "description": "Tu referencia estable para esta solicitud. Se guarda en la sesión de API y se devuelve en la respuesta." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Tus metadatos JSON no sensibles. Se almacenan en la sesión de API y se devuelven en la respuesta." } } }, "RiskWarning": { "type": "object", "required": [ "feature", "risk", "log_type", "short_description", "long_description" ], "properties": { "feature": { "type": "string", "description": "Función que generó la advertencia." }, "risk": { "type": "string", "description": "Código de riesgo legible por máquina. Con el tiempo pueden añadirse nuevos valores." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Contexto específico del riesgo, o `null`." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravedad que usan las reglas de decisión." }, "short_description": { "type": "string", "description": "Resumen legible de una línea." }, "long_description": { "type": "string", "description": "Explicación legible." } } }, "RiskLifecycleEvent": { "type": "object", "required": [ "type", "timestamp", "details", "fee" ], "properties": { "type": { "type": "string", "description": "Tipo de evento legible por máquina. Se pueden añadir nuevos valores con el tiempo." }, "timestamp": { "type": "string", "format": "date-time", "description": "Cuándo ocurrió el evento." }, "details": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Payload específico del evento, o `null`." }, "fee": { "type": "number", "description": "Importe en USD facturado por este evento." } } }, "PhoneMatchItem": { "type": "object", "description": "Otra sesión de tu aplicación que usó el mismo número de teléfono con un `vendor_data` distinto.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID de sesión de la otra verificación que usó este número de teléfono." }, "session_number": { "type": "integer", "description": "Número secuencial legible de esa sesión." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` de esa sesión." }, "verification_date": { "type": "string", "description": "Cuándo se creó esa sesión (`YYYY-MM-DDTHH:MM:SSZ`)." }, "phone_number": { "type": "string", "description": "El número de teléfono que coincidió." }, "status": { "type": "string", "description": "Estado de esa sesión (p. ej., `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Si el número de teléfono está en la lista de bloqueo de tu aplicación." }, "api_service": { "type": "string", "nullable": true, "description": "En las sesiones de tipo API, la API independiente que la creó; `null` en las sesiones de verificación normales." }, "source": { "type": "string", "description": "Dónde se encontró la coincidencia. Normalmente `session`; una coincidencia en la lista de bloqueo a través de una entrada de lista de la organización usa `list_entry`." } } }, "EmailMatchItem": { "type": "object", "description": "Otra sesión de tu aplicación que usó la misma dirección de correo electrónico con un `vendor_data` distinto.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID de sesión de la otra verificación que usó esta dirección de correo electrónico." }, "session_number": { "type": "integer", "description": "Número secuencial legible de esa sesión." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` de esa sesión." }, "verification_date": { "type": "string", "description": "Cuándo se creó esa sesión (`YYYY-MM-DDTHH:MM:SSZ`)." }, "email": { "type": "string", "description": "La dirección de correo electrónico que coincidió." }, "status": { "type": "string", "description": "Estado de esa sesión (p. ej., `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Si la dirección de correo electrónico está en la lista de bloqueo de tu aplicación." }, "api_service": { "type": "string", "nullable": true, "description": "En las sesiones de tipo API, la API independiente que la creó; `null` en las sesiones de verificación normales." }, "source": { "type": "string", "description": "Dónde se encontró la coincidencia. Normalmente `session`; una coincidencia en la lista de bloqueo a través de una entrada de lista de la organización usa `list_entry`." } } }, "PhoneIntelligence": { "type": "object", "description": "Bloque normalizado de inteligencia telefónica. Solo está presente cuando el complemento de inteligencia se ejecutó para esta consulta; cuando está presente, también se expone con el alias `enrichment` y valores idénticos.", "properties": { "score": { "type": "number", "nullable": true, "description": "Puntuación de riesgo normalizada de 0 a 100. Cuanto más alta, mayor es el riesgo." }, "phone_type_risk": { "type": "string", "nullable": true, "description": "`Low`, `Medium` o `High`, según la puntuación." }, "phone_trust_index": { "type": "number", "nullable": true, "description": "Inverso de la puntuación, para paneles en los que un valor más alto es mejor." }, "network_stability_index": { "type": "number", "nullable": true, "description": "Estabilidad de la red de la línea." }, "is_disposable": { "type": "boolean", "nullable": true, "description": "`true` cuando el número parece desechable o virtual." }, "is_ported": { "type": "boolean", "nullable": true, "description": "`true` cuando el número ha cambiado de operador." }, "is_recently_ported": { "type": "boolean", "nullable": true, "description": "`true` cuando la portabilidad se produjo recientemente." }, "carrier_type": { "type": "string", "nullable": true, "description": "Clasificación de la línea que devuelve la consulta (p. ej., `mobile`)." }, "reason_codes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Identificador estable de Didit para la señal, por ejemplo `IR-5AC67A32`. Es opaco: agrupa y filtra por él, pero no lo analices." }, "value": { "nullable": true, "description": "En un indicador de riesgo (por ejemplo, `voip`, `leaked`, `disposable`, `spam_trap`), su valor: un booleano, un nivel o una fecha. Null en un código de motivo con puntuación." }, "direction": { "type": "string", "enum": [ "risk", "trust" ], "description": "Si la señal aumentó el riesgo o aportó confianza." }, "message": { "type": "string", "description": "Explicación legible de la señal, en inglés." }, "impact_level": { "type": "string", "nullable": true, "description": "Cuánto movió la señal la puntuación, por ejemplo `low`, `medium` o `high`." } } }, "description": "Señales que explican la puntuación, cada una con un código estable de Didit, una dirección, un mensaje y un nivel de impacto. Pueden aparecer códigos nuevos con el tiempo, así que no rechaces los códigos desconocidos." } } }, "EmailIntelligence": { "type": "object", "description": "Bloque normalizado de inteligencia de correo electrónico. Solo está presente cuando el complemento de inteligencia se ejecutó para este correo; cuando está presente, también se expone con el alias `enrichment` y valores idénticos.", "properties": { "score": { "type": "number", "nullable": true, "description": "Puntuación de riesgo normalizada de 0 a 100. Cuanto más alta, mayor es el riesgo." }, "deliverable": { "type": "string", "nullable": true, "description": "Rango de entregabilidad (p. ej., `high`)." }, "breach_risk_level": { "type": "string", "nullable": true, "description": "`Low`, `Medium` o `High`." }, "breach_risk_index": { "type": "number", "nullable": true, "description": "Índice numérico de riesgo de filtración." }, "is_recent_breach": { "type": "boolean", "nullable": true, "description": "`true` cuando la dirección aparece en una filtración reciente." }, "is_frequent_breached": { "type": "boolean", "nullable": true, "description": "`true` cuando la dirección aparece en muchas filtraciones." }, "is_disposable": { "type": "boolean", "nullable": true, "description": "`true` cuando el dominio es un proveedor de correo desechable." }, "is_free_domain": { "type": "boolean", "nullable": true, "description": "`true` cuando el dominio es un proveedor de correo gratuito." }, "is_breached": { "type": "boolean", "nullable": true, "description": "`true` cuando la dirección aparece en filtraciones conocidas." }, "no_of_breaches": { "type": "number", "nullable": true, "description": "Número de filtraciones conocidas que contienen la dirección." }, "reason_codes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Identificador estable de Didit para la señal, por ejemplo `IR-5AC67A32`. Es opaco: agrupa y filtra por él, pero no lo analices." }, "value": { "nullable": true, "description": "En un indicador de riesgo (por ejemplo, `voip`, `leaked`, `disposable`, `spam_trap`), su valor: un booleano, un nivel o una fecha. Null en un código de motivo con puntuación." }, "direction": { "type": "string", "enum": [ "risk", "trust" ], "description": "Si la señal aumentó el riesgo o aportó confianza." }, "message": { "type": "string", "description": "Explicación legible de la señal, en inglés." }, "impact_level": { "type": "string", "nullable": true, "description": "Cuánto movió la señal la puntuación, por ejemplo `low`, `medium` o `high`." } } }, "description": "Señales que explican la puntuación, cada una con un código estable de Didit, una dirección, un mensaje y un nivel de impacto. Pueden aparecer códigos nuevos con el tiempo, así que no rechaces los códigos desconocidos." } } }, "IPRiskResult": { "type": "object", "description": "Resultado de riesgo de la IP. Los campos de enriquecimiento individuales pueden ser `null` cuando la consulta no devolvió datos utilizables.", "required": [ "status", "threat" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review" ], "description": "`In Review` cuando el país resuelto no coincide con `claimed_country`, o cuando la dirección está asociada a una VPN, a Tor o a infraestructura de centros de datos. En caso contrario, `Approved`." }, "ip_address": { "type": "string", "nullable": true, "description": "La dirección evaluada. `null` cuando ninguna fuente de enriquecimiento devolvió datos utilizables." }, "ip_country": { "type": "string", "nullable": true, "description": "Nombre del país resuelto." }, "ip_country_code": { "type": "string", "nullable": true, "description": "Código de país resuelto. Compara países mediante `country_mismatch` en lugar de comparar tú mismo las cadenas de país sin procesar." }, "ip_state": { "type": "string", "nullable": true, "description": "Estado o región resueltos." }, "ip_city": { "type": "string", "nullable": true, "description": "Ciudad resuelta." }, "latitude": { "type": "number", "nullable": true, "description": "Geolocalización aproximada de la red, no una ubicación precisa del dispositivo." }, "longitude": { "type": "number", "nullable": true, "description": "Geolocalización aproximada de la red, no una ubicación precisa del dispositivo." }, "isp": { "type": "string", "nullable": true, "description": "Proveedor de servicios de Internet que da servicio a la dirección." }, "organization": { "type": "string", "nullable": true, "description": "Organización propietaria del bloque de direcciones." }, "is_vpn_or_tor": { "type": "boolean", "nullable": true, "description": "`true` cuando la dirección está asociada a infraestructura de VPN o Tor." }, "is_data_center": { "type": "boolean", "nullable": true, "description": "`true` cuando la dirección pertenece a una red de hosting o de centro de datos." }, "time_zone": { "type": "string", "nullable": true, "description": "Zona horaria de la ubicación resuelta." }, "time_zone_offset": { "type": "string", "nullable": true, "description": "Desfase UTC de la ubicación resuelta." }, "asn_number": { "type": "number", "nullable": true, "description": "Número de sistema autónomo." }, "asn_organization": { "type": "string", "nullable": true, "description": "Organización que opera el sistema autónomo." }, "connection_type": { "type": "string", "nullable": true, "description": "Clasificación de la conexión (p. ej., `cellular`, `hosting`)." }, "carrier": { "type": "string", "nullable": true, "description": "Operador móvil cuando la dirección pertenece a una red móvil." }, "proxy_type": { "type": "string", "nullable": true, "description": "Clasificación de proxy cuando la dirección está detrás de un proxy." }, "claimed_country": { "type": "string", "nullable": true, "description": "Devuelve el `claimed_country` que enviaste." }, "country_mismatch": { "type": "boolean", "nullable": true, "description": "`true` cuando el país resuelto difiere de `claimed_country`. `null` cuando no hay datos de enriquecimiento o no hay un país declarado disponible." }, "threat": { "type": "object", "additionalProperties": true, "description": "Evidencia libre de amenazas de red procedente de la fuente de enriquecimiento (p. ej., `is_proxy`, `is_tor`). Objeto vacío cuando no hay datos de enriquecimiento disponibles. Trátalo como un detalle de diagnóstico, no como un contrato estable." } } }, "PhoneRiskResponse": { "type": "object", "required": [ "request_id", "status", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sesión de API creada para esta solicitud. Guárdalo junto con `vendor_data` si necesitas relacionar el resultado con webhooks posteriores o con la actividad en la consola." }, "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Decisión final de esta sesión de API. Normalmente es `Approved`; la evaluación de riesgo puede producir `In Review` o `Declined`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste, o `null` si no enviaste ninguno." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Devuelve el `metadata` que enviaste, o `null` si no enviaste ninguno." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de tiempo de esta respuesta." }, "phone": { "type": "object", "description": "Informe de teléfono normalizado, el mismo bloque que usan las respuestas de Verificación de teléfono.", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Decisión para este número de teléfono. Refleja el `status` de nivel superior." }, "phone_number_prefix": { "type": "string", "description": "Código telefónico del país con `+` inicial (por ejemplo, `+1`).", "example": "+1" }, "phone_number": { "type": "string", "description": "Número nacional sin el prefijo telefónico del país.", "example": "4155552671" }, "full_number": { "type": "string", "description": "Número completo en formato E.164.", "example": "+14155552671" }, "country_code": { "type": "string", "nullable": true, "description": "País ISO 3166-1 alpha-2 del número.", "example": "US" }, "country_name": { "type": "string", "description": "Nombre completo del país derivado de `country_code`.", "example": "United States" }, "carrier": { "type": "object", "nullable": true, "description": "Red actual que da servicio al número. `null` cuando la consulta no pudo identificar un operador.", "properties": { "name": { "type": "string", "description": "Nombre del operador. Cadena vacía cuando la consulta no pudo identificarlo." }, "type": { "type": "string", "description": "Tipo de línea que devuelve la consulta: `mobile`, `fixed_line`, `voip`, `isp`, `vpn`, `toll_free`, `premium_rate` o similares." } } }, "is_disposable": { "type": "boolean", "description": "`true` cuando el número pertenece a un servicio de números temporales o desechables." }, "is_virtual": { "type": "boolean", "description": "`true` cuando el tipo de línea es virtual (`voip`, `isp` o `vpn`)." }, "verification_method": { "type": "string", "nullable": true, "description": "Canal OTP de la verificación subyacente. `null` en las consultas de riesgo, que nunca envían un código." }, "verification_attempts": { "type": "integer", "description": "Envíos de OTP para este número. `0` en las consultas de riesgo." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que el número se verificó por última vez mediante un OTP. `null` para consultas de riesgo." }, "warnings": { "type": "array", "description": "Advertencias de riesgo registradas para esta solicitud. Array vacío cuando no hay ninguna.", "items": { "$ref": "#/components/schemas/RiskWarning" } }, "lifecycle": { "type": "array", "description": "Registro de auditoría cronológico de la solicitud. Array vacío para consultas de riesgo sin eventos de envío.", "items": { "$ref": "#/components/schemas/RiskLifecycleEvent" } }, "matches": { "type": "array", "description": "Otras sesiones de tu aplicación en las que un usuario distinto (con un `vendor_data` diferente) usó el mismo número de teléfono. Hasta 5 entradas. Array vacío cuando no hay coincidencias.", "items": { "$ref": "#/components/schemas/PhoneMatchItem" } }, "phone_intelligence": { "$ref": "#/components/schemas/PhoneIntelligence" }, "enrichment": { "$ref": "#/components/schemas/PhoneIntelligence" }, "phone_social": { "$ref": "#/components/schemas/PhoneSocialFootprint" } } } } }, "EmailRiskResponse": { "type": "object", "required": [ "request_id", "status", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sesión de API creada para esta solicitud. Guárdalo junto con `vendor_data` si necesitas relacionar el resultado con webhooks posteriores o con la actividad en la consola." }, "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Decisión final de esta sesión de API. Normalmente es `Approved`; la evaluación de riesgo puede producir `In Review` o `Declined`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste, o `null` si no enviaste ninguno." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Devuelve el `metadata` que enviaste, o `null` si no enviaste ninguno." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de tiempo de esta respuesta." }, "email": { "type": "object", "description": "Informe de correo electrónico normalizado, el mismo bloque que usan las respuestas de Verificación de correo electrónico.", "required": [ "status", "email", "is_breached", "breaches", "is_disposable", "is_undeliverable" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Decisión para esta dirección de correo electrónico. Refleja el `status` de nivel superior." }, "email": { "type": "string", "description": "La dirección evaluada.", "example": "alice@example.com" }, "is_breached": { "type": "boolean", "description": "Si la dirección aparece en una filtración de credenciales conocida." }, "breaches": { "type": "array", "description": "Hasta 5 de las filtraciones conocidas más recientes que contienen esta dirección. Array vacío cuando `is_breached` es `false`.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Identificador de la filtración." }, "domain": { "type": "string", "description": "Dominio del servicio filtrado." }, "breach_date": { "type": "string", "format": "date", "description": "Fecha en que se produjo la filtración." }, "breach_emails_count": { "type": "integer", "description": "Número total de cuentas expuestas en la filtración." }, "description": { "type": "string", "description": "Descripción legible de la brecha (puede contener marcado HTML)." }, "logo_path": { "type": "string", "description": "URL del logotipo del servicio afectado por la filtración." }, "data_classes": { "type": "array", "items": { "type": "string" }, "description": "Categorías de datos expuestos, en snake_case (p. ej., `email_addresses`, `passwords`)." }, "is_verified": { "type": "boolean", "description": "Si la filtración se ha verificado como legítima." } } } }, "is_disposable": { "type": "boolean", "description": "Si el dominio pertenece a un proveedor de correo desechable." }, "is_undeliverable": { "type": "boolean", "description": "Si se determinó que la dirección no es entregable." }, "verification_attempts": { "type": "integer", "description": "Envíos de OTP para esta dirección. `0` en las consultas de riesgo." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se verificó la dirección por última vez mediante un OTP. `null` para las consultas de riesgo." }, "warnings": { "type": "array", "description": "Advertencias de riesgo registradas para esta solicitud. Array vacío cuando no hay ninguna.", "items": { "$ref": "#/components/schemas/RiskWarning" } }, "lifecycle": { "type": "array", "description": "Registro de auditoría cronológico de la solicitud. Array vacío para consultas de riesgo sin envíos.", "items": { "$ref": "#/components/schemas/RiskLifecycleEvent" } }, "matches": { "type": "array", "description": "Otras sesiones de tu aplicación en las que un usuario distinto (con un `vendor_data` diferente) usó la misma dirección de correo electrónico. Hasta 5 entradas. Array vacío cuando no hay coincidencias.", "items": { "$ref": "#/components/schemas/EmailMatchItem" } }, "email_intelligence": { "$ref": "#/components/schemas/EmailIntelligence" }, "enrichment": { "$ref": "#/components/schemas/EmailIntelligence" }, "email_social": { "$ref": "#/components/schemas/EmailSocialFootprint" } } } } }, "IPRiskResponse": { "type": "object", "required": [ "request_id", "status", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sesión de API creada para esta solicitud. Guárdalo junto con `vendor_data` si necesitas relacionar el resultado con webhooks posteriores o con la actividad en la consola." }, "status": { "type": "string", "enum": [ "Approved", "In Review" ], "description": "Decisión para esta sesión de API: `In Review` ante riesgo de red o de discrepancia de país; en caso contrario, `Approved`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste, o `null` si no enviaste ninguno." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Devuelve el `metadata` que enviaste, o `null` si no enviaste ninguno." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de tiempo de esta respuesta." }, "ip": { "type": "object", "description": "Resultado de riesgo de la IP. Los campos de enriquecimiento individuales pueden ser `null` cuando la consulta no devolvió datos utilizables.", "required": [ "status", "threat" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review" ], "description": "`In Review` cuando el país resuelto no coincide con `claimed_country`, o cuando la dirección está asociada a una VPN, a Tor o a infraestructura de centros de datos. En caso contrario, `Approved`." }, "ip_address": { "type": "string", "nullable": true, "description": "La dirección evaluada. `null` cuando ninguna fuente de enriquecimiento devolvió datos utilizables." }, "ip_country": { "type": "string", "nullable": true, "description": "Nombre del país resuelto." }, "ip_country_code": { "type": "string", "nullable": true, "description": "Código de país resuelto. Compara países mediante `country_mismatch` en lugar de comparar tú mismo las cadenas de país sin procesar." }, "ip_state": { "type": "string", "nullable": true, "description": "Estado o región resueltos." }, "ip_city": { "type": "string", "nullable": true, "description": "Ciudad resuelta." }, "latitude": { "type": "number", "nullable": true, "description": "Geolocalización aproximada de la red, no una ubicación precisa del dispositivo." }, "longitude": { "type": "number", "nullable": true, "description": "Geolocalización aproximada de la red, no una ubicación precisa del dispositivo." }, "isp": { "type": "string", "nullable": true, "description": "Proveedor de servicios de Internet que da servicio a la dirección." }, "organization": { "type": "string", "nullable": true, "description": "Organización propietaria del bloque de direcciones." }, "is_vpn_or_tor": { "type": "boolean", "nullable": true, "description": "`true` cuando la dirección está asociada a infraestructura de VPN o Tor." }, "is_data_center": { "type": "boolean", "nullable": true, "description": "`true` cuando la dirección pertenece a una red de hosting o de centro de datos." }, "time_zone": { "type": "string", "nullable": true, "description": "Zona horaria de la ubicación resuelta." }, "time_zone_offset": { "type": "string", "nullable": true, "description": "Desfase UTC de la ubicación resuelta." }, "asn_number": { "type": "number", "nullable": true, "description": "Número de sistema autónomo." }, "asn_organization": { "type": "string", "nullable": true, "description": "Organización que opera el sistema autónomo." }, "connection_type": { "type": "string", "nullable": true, "description": "Clasificación de la conexión (p. ej., `cellular`, `hosting`)." }, "carrier": { "type": "string", "nullable": true, "description": "Operador móvil cuando la dirección pertenece a una red móvil." }, "proxy_type": { "type": "string", "nullable": true, "description": "Clasificación de proxy cuando la dirección está detrás de un proxy." }, "claimed_country": { "type": "string", "nullable": true, "description": "Devuelve el `claimed_country` que enviaste." }, "country_mismatch": { "type": "boolean", "nullable": true, "description": "`true` cuando el país resuelto difiere de `claimed_country`. `null` cuando no hay datos de enriquecimiento o no hay un país declarado disponible." }, "threat": { "type": "object", "additionalProperties": true, "description": "Evidencia libre de amenazas de red procedente de la fuente de enriquecimiento (p. ej., `is_proxy`, `is_tor`). Objeto vacío cuando no hay datos de enriquecimiento disponibles. Trátalo como un detalle de diagnóstico, no como un contrato estable." } } } } }, "SocialFootprintPlatform": { "type": "object", "properties": { "platform": { "type": "string", "description": "Identificador de la plataforma.", "example": "whatsapp" }, "category": { "type": "string", "description": "Categoría de la plataforma, por ejemplo MESSAGING, SOCIAL_MEDIA, ECOMMERCE, PROFESSIONAL, EMAIL_PROVIDER.", "example": "MESSAGING" }, "scope": { "type": "string", "enum": [ "global", "local" ], "description": "`global` para plataformas de alcance mundial, `local` para las específicas de una región.", "example": "global" } } }, "SocialFootprintCategorySummary": { "type": "object", "properties": { "registered": { "type": "integer", "nullable": true, "description": "Plataformas de esta categoría en las que se ha confirmado el registro.", "example": 2 }, "ratio": { "type": "number", "format": "float", "nullable": true, "description": "Proporción de las plataformas comprobadas de la categoría en las que existe un registro, de 0.0 a 1.0.", "example": 0.6667 } } }, "SocialFootprintProfile": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Nombre del perfil, cuando la plataforma lo expone." }, "photo": { "type": "string", "nullable": true, "description": "URL de la foto del perfil, cuando la plataforma la expone." }, "about": { "type": "string", "nullable": true, "description": "Texto de presentación o biografía del perfil, cuando la plataforma lo expone." }, "privacy_status": { "type": "string", "nullable": true, "enum": [ "PUBLIC", "PRIVATE", null ], "description": "Visibilidad del perfil, cuando la plataforma la expone." }, "business_account": { "type": "boolean", "nullable": true, "description": "Si el perfil es una cuenta de empresa, cuando la plataforma lo expone." } } }, "PhoneSocialFootprint": { "type": "object", "nullable": true, "description": "Huella social del número de teléfono: las plataformas en línea en las que está registrado. Solo está presente cuando se activó `enable_social` y la comprobación finalizó. Cualquier recuento puede ser null cuando no se obtuvieron datos para él. `profiles_registered: 0` significa que se comprobaron las plataformas y que el número de teléfono no se encontró en ninguna de ellas: es una respuesta válida y facturable, y una señal habitual de identidad sintética.", "properties": { "profiles_registered": { "type": "integer", "nullable": true, "description": "Plataformas en las que se ha confirmado que el número de teléfono está registrado.", "example": 5 }, "profiles_checked": { "type": "integer", "nullable": true, "description": "Plataformas evaluadas para el registro.", "example": 14 }, "names_found": { "type": "integer", "nullable": true, "description": "Plataformas que devolvieron un nombre asociado.", "example": 0 }, "photos_found": { "type": "integer", "nullable": true, "description": "Plataformas que devolvieron una foto de perfil.", "example": 0 }, "communication_breadth": { "type": "integer", "nullable": true, "description": "Plataformas de comunicación en las que se detectó presencia.", "example": 2 }, "digital_footprint_diversity": { "type": "integer", "nullable": true, "description": "Categorías de plataforma distintas en las que se detectó presencia.", "example": 5 }, "digital_sophistication_index": { "type": "integer", "nullable": true, "description": "Indicador compuesto de madurez digital, de 0 a 10.", "example": 5 }, "engagement_depth_index": { "type": "integer", "nullable": true, "description": "Indicador de riqueza del perfil, de 0 a 10.", "example": 3 }, "subscription_affordability_index": { "type": "integer", "nullable": true, "description": "Proporción entre plataformas gratuitas y de pago, de 0 a 10.", "example": 2 }, "free_platforms": { "type": "integer", "nullable": true, "description": "Registros en plataformas gratuitas.", "example": 4 }, "full_paid_platforms": { "type": "integer", "nullable": true, "description": "Registros en plataformas totalmente de pago.", "example": 0 }, "partial_paid_platforms": { "type": "integer", "nullable": true, "description": "Registros en plataformas freemium.", "example": 1 }, "whatsapp_profile_completeness": { "type": "string", "nullable": true, "enum": [ "Basic", "Partial", "Complete", "Not Present", null ], "description": "Grado de completitud del perfil de WhatsApp. Solo para teléfono; null para correo electrónico.", "example": "Partial" }, "registered_platforms": { "type": "array", "description": "Plataformas en las que se ha confirmado el registro.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "not_registered_platforms": { "type": "array", "description": "Plataformas comprobadas con resultado negativo.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "categories": { "type": "object", "description": "Número de registros y proporción por categoría de plataforma.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintCategorySummary" } }, "profiles": { "type": "object", "description": "Detalles del perfil por plataforma, indexados por plataforma, cuando la plataforma los expone.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintProfile" } } } }, "EmailSocialFootprint": { "type": "object", "nullable": true, "description": "Huella social de la dirección de correo electrónico: las plataformas en línea en las que está registrada. Solo está presente cuando se activó `enable_social` y la comprobación finalizó. Cualquier recuento puede ser null cuando no se obtuvieron datos para él. `profiles_registered: 0` significa que se comprobaron las plataformas y que la dirección de correo electrónico no se encontró en ninguna de ellas: es una respuesta válida y facturable, y una señal habitual de identidad sintética.", "properties": { "profiles_registered": { "type": "integer", "nullable": true, "description": "Plataformas en las que se ha confirmado que la dirección de correo electrónico está registrada.", "example": 5 }, "profiles_checked": { "type": "integer", "nullable": true, "description": "Plataformas evaluadas para el registro.", "example": 14 }, "names_found": { "type": "integer", "nullable": true, "description": "Plataformas que devolvieron un nombre asociado.", "example": 0 }, "photos_found": { "type": "integer", "nullable": true, "description": "Plataformas que devolvieron una foto de perfil.", "example": 0 }, "communication_breadth": { "type": "integer", "nullable": true, "description": "Plataformas de comunicación en las que se detectó presencia.", "example": 2 }, "digital_footprint_diversity": { "type": "integer", "nullable": true, "description": "Categorías de plataforma distintas en las que se detectó presencia.", "example": 5 }, "digital_sophistication_index": { "type": "integer", "nullable": true, "description": "Indicador compuesto de madurez digital, de 0 a 10.", "example": 5 }, "engagement_depth_index": { "type": "integer", "nullable": true, "description": "Indicador de riqueza del perfil, de 0 a 10.", "example": 3 }, "subscription_affordability_index": { "type": "integer", "nullable": true, "description": "Proporción entre plataformas gratuitas y de pago, de 0 a 10.", "example": 2 }, "free_platforms": { "type": "integer", "nullable": true, "description": "Registros en plataformas gratuitas.", "example": 4 }, "full_paid_platforms": { "type": "integer", "nullable": true, "description": "Registros en plataformas totalmente de pago.", "example": 0 }, "partial_paid_platforms": { "type": "integer", "nullable": true, "description": "Registros en plataformas freemium.", "example": 1 }, "whatsapp_profile_completeness": { "type": "string", "nullable": true, "enum": [ "Basic", "Partial", "Complete", "Not Present", null ], "description": "Grado de completitud del perfil de WhatsApp. Solo para teléfono; null para correo electrónico.", "example": "Partial" }, "registered_platforms": { "type": "array", "description": "Plataformas en las que se ha confirmado el registro.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "not_registered_platforms": { "type": "array", "description": "Plataformas comprobadas con resultado negativo.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "categories": { "type": "object", "description": "Número de registros y proporción por categoría de plataforma.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintCategorySummary" } }, "profiles": { "type": "object", "description": "Detalles del perfil por plataforma, indexados por plataforma, cuando la plataforma los expone.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintProfile" } } } }, "KYBRegistryAddress": { "type": "object", "description": "Una dirección que declara el registro, con la misma estructura para todos los países y fuentes de registro. Todas las claves están siempre presentes; una parte que el registro no publica es null.", "properties": { "type": { "type": "string", "nullable": true, "description": "Tipo de dirección en minúsculas: `registered` para el domicilio social; otros tipos, tal como los denomina el registro (por ejemplo, `postal`, `office`). `null` cuando el registro no indica de qué dirección se trata." }, "address": { "type": "string", "description": "La dirección completa en una sola línea. Siempre está presente en todas las direcciones." }, "street": { "type": "string", "nullable": true, "description": "Calle y número." }, "city": { "type": "string", "nullable": true, "description": "Ciudad o localidad." }, "postal_code": { "type": "string", "nullable": true, "description": "Código postal." }, "region": { "type": "string", "nullable": true, "description": "Región, estado o provincia." }, "country_code": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alfa-2." }, "description": { "type": "string", "nullable": true, "description": "La etiqueta propia del registro para la dirección, cuando proporciona una." } }, "required": [ "type", "address", "street", "city", "postal_code", "region", "country_code", "description" ] }, "KYBRegistryIndustry": { "type": "object", "description": "Una actividad en la que el registro clasifica a la empresa, con la misma estructura para todos los países y fuentes de registro.", "properties": { "code": { "type": "string", "nullable": true, "description": "Código de actividad tal como lo publica el registro (por ejemplo, `73110`)." }, "description": { "type": "string", "nullable": true, "description": "Etiqueta de la actividad, cuando el registro la publica." }, "scheme": { "type": "string", "nullable": true, "description": "Sistema de clasificación, con un único nombre por sistema independientemente de la fuente que lo haya informado: `UK SIC 2007`, `US SIC`, `NACE Rev. 2`, `NACE Rev. 2.1`, `NAF Rev. 2`, `CNAE`, `SBI`, `NOGA 2008`, `CAE Rev. 4`, `Canada SIC 1977`; los demás sistemas nacionales conservan el nombre que les da el registro. Es nulo cuando el registro no indica el sistema." }, "is_primary": { "type": "boolean", "description": "True para la actividad principal de la empresa. Exactamente una entrada es la principal cuando la lista no está vacía." } }, "required": [ "code", "description", "scheme", "is_primary" ] }, "KYBRegistryShareholding": { "type": "object", "nullable": true, "description": "Qué participación tiene un propietario, con la misma estructura para cada país y fuente de registro. Es null cuando el registro no indica ninguna participación. Un rango (por ejemplo, el 25-50% de un PSC del Reino Unido) no es una participación: `percentage` es null y el rango se mantiene en `ownership_min_shares` / `ownership_max_shares`.", "properties": { "share_class": { "type": "string", "nullable": true, "description": "Clase o tipo de participación tal como la denomina el registro." }, "number_of_shares": { "type": "number", "nullable": true, "description": "Número de acciones en posesión." }, "currency": { "type": "string", "nullable": true, "description": "Moneda ISO 4217 de los valores siguientes." }, "nominal_value": { "type": "number", "nullable": true, "description": "Valor nominal por acción." }, "total_value": { "type": "number", "nullable": true, "description": "Valor total de la participación." }, "percentage": { "type": "number", "nullable": true, "description": "Participación exacta en porcentaje, con cuatro decimales." } }, "required": [ "share_class", "number_of_shares", "currency", "nominal_value", "total_value", "percentage" ] }, "KYBRegistryOwnership": { "type": "object", "description": "El resultado del nivel de propiedad (accionistas / UBO), con la misma estructura para cada país y fuente de registro.", "properties": { "status": { "type": "string", "nullable": true, "enum": [ "not_requested", "pending", "delivered", "not_held", "unavailable", null ], "description": "`delivered` cuando el registro publicó la propiedad; `not_held` cuando el registro de propiedad respondió y no incluye la empresa en absoluto (consulta `unavailable_reason`); `unavailable` cuando no proporcionó los datos de propiedad por cualquier otro motivo (consulta `unavailable_reason`); `pending` mientras el registro todavía los está obteniendo; `not_requested` para el nivel Basic." }, "tier_requested": { "type": "string", "nullable": true, "enum": [ "basic", "shareholders", "ubo", null ], "description": "El nivel que solicitó el flujo." }, "tier_delivered": { "type": "string", "nullable": true, "enum": [ "basic", "shareholders", "ubo", null ], "description": "El nivel que entregó el registro (y que se factura). Una solicitud de UBO respondida solo con accionistas directos es `shareholders`." }, "unavailable_reason": { "type": "string", "nullable": true, "enum": [ "no_owners_on_record", "no_natural_person_owner", "ownership_section_unavailable", "company_not_found", "ambiguous_company_match", "missing_registration_number", "entity_type_not_covered", "provider_unavailable", "other", null ], "description": "Por qué no se entregó un nivel de propiedad solicitado. Es null salvo que `status` sea `unavailable` o `pending`." }, "direct_ownership_complete": { "type": "boolean", "nullable": true, "description": "True cuando las participaciones declaradas de los accionistas directos suman 100% (con un margen de redondeo de un punto porcentual); false cuando no es así; null cuando no se entregaron los datos de propiedad o no se declara alguna participación." }, "unresolved": { "type": "array", "description": "Partes de la cadena de propiedad que el registro no pudo resolver; por ejemplo, cuando no consta ninguna estructura de grupo por encima de los propietarios directos.", "items": { "type": "object", "properties": { "reason": { "type": "string" }, "section": { "type": "string", "nullable": true } } } } }, "required": [ "status", "tier_requested", "tier_delivered", "unavailable_reason", "direct_ownership_complete", "unresolved" ] }, "KYBRegistryData": { "type": "object", "nullable": true, "description": "Detalle normalizado del registro de Didit para la empresa: el resultado de propiedad (`ownership_error`, `section_errors`, `ubo_resolution`, `lite_enrichment`), las correcciones realizadas con update-data y los datos del registro que no tienen un campo propio. Nunca incluye el registro original de la fuente del registro. Todas las claves son opcionales y solo aparecen cuando la empresa tiene un valor para ellas; se pueden añadir claves nuevas. Consulta los campos canónicos (`addresses`, `industries`, `ownership`, `beneficial_owners[].shareholding`) para todo lo que cubren.", "properties": { "company_name": { "type": "string", "description": "Nombre de la empresa tal como se corrigió en la consola." }, "registration_number": { "type": "string", "description": "Número de registro tal como lo indica el registro o una corrección hecha en la consola." }, "country_code": { "type": "string", "description": "País del registro, tal como lo indica el registro o una corrección hecha en la consola." }, "region": { "type": "string", "description": "Región o estado del registro." }, "incorporation_date": { "type": "string", "description": "Fecha de constitución (ISO 8601)." }, "registration_date": { "type": "string", "description": "Fecha de registro (ISO 8601) cuando el registro indica una distinta de la fecha de constitución." }, "dissolution_date": { "type": "string", "description": "Fecha de disolución (ISO 8601) cuando el registro indica una." }, "tax_number": { "type": "string", "description": "Número de identificación fiscal." }, "vat_number": { "type": "string", "description": "Número de IVA." }, "legal_address": { "type": "string", "description": "Dirección legal tal como se corrigió en la consola." }, "registered_address": { "type": "string", "description": "Dirección registrada tal como figura en el registro." }, "company_type": { "type": "string", "description": "Forma jurídica." }, "registry_status": { "type": "string", "description": "Estado de la empresa en el registro." }, "verification_status": { "type": "string", "description": "Estado de la verificación." }, "alternative_names": { "type": "string", "description": "Otros nombres comerciales que usa o ha usado la empresa." }, "nature_of_business": { "type": "string", "description": "Descripción de la actividad." }, "registered_capital": { "type": "string", "description": "Capital social tal como figura impreso." }, "registered_capital_amount": { "type": "string", "description": "Importe del capital social, como cadena decimal." }, "registered_capital_currency": { "type": "string", "description": "Moneda del capital social (ISO 4217)." }, "website": { "type": "string", "description": "Sitio web." }, "email": { "type": "string", "description": "Correo electrónico de contacto." }, "phone": { "type": "string", "description": "Teléfono de contacto." }, "legal_entity_identifier": { "type": "string", "description": "Identificador de entidad jurídica (LEI)." }, "location_of_registration": { "type": "string", "description": "Lugar de registro." }, "control_scheme": { "type": "string", "description": "Esquema de gobierno corporativo cuando el registro lo expone." }, "ownership_error": { "type": "string", "enum": [ "no_owners_on_record", "no_natural_person_owner", "ownership_section_unavailable", "company_not_found", "ambiguous_company_match", "missing_registration_number", "entity_type_not_covered", "provider_unavailable", "other" ], "description": "Por qué no se entregó un nivel de propiedad solicitado, con los mismos códigos que `ownership.unavailable_reason`. `no_owners_on_record` (el registro respondió y no indica ningún propietario) y `ownership_section_unavailable` (el registro no devolvió la sección de propiedad) son resultados distintos." }, "section_errors": { "type": "object", "description": "Secciones que el registro no devolvió, indexadas por sección (`officers`, `shareholders`, `group_structure`). Una sección que aparece aquí nunca se entregó: una lista vacía junto a ella no dice nada sobre la empresa.", "additionalProperties": { "$ref": "#/components/schemas/KYBRegistrySectionError" } }, "ubo_resolution": { "$ref": "#/components/schemas/KYBRegistryUboResolution" }, "lite_enrichment": { "$ref": "#/components/schemas/KYBRegistryLiteEnrichment" }, "registry_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Los campos propios del registro mercantil para la empresa, con las claves tal como las nombra el registro, como valores simples (registros heredados). Solo se incluyen los campos revisados como datos del registro." }, "registry_sources": { "type": "array", "description": "Los registros oficiales de los que se leyó el registro (registros heredados). Las demás fuentes no se nombran.", "items": { "$ref": "#/components/schemas/KYBRegistrySource" } }, "previous_names": { "type": "array", "items": { "type": "string" }, "description": "Nombres con los que la empresa estuvo registrada anteriormente (registros antiguos)." }, "parent_companies": { "type": "array", "items": { "type": "string" }, "description": "Empresas matrices que indica el registro (registros heredados)." }, "documents_available": { "type": "integer", "description": "Cuántos documentos presentados ofrece el registro para la empresa (registros heredados)." } } }, "KYBRegistryGroupCompany": { "type": "object", "description": "Una empresa del grupo corporativo, identificada por su identidad en el registro.", "properties": { "name": { "type": "string", "nullable": true, "description": "Nombre de la empresa." }, "country_code": { "type": "string", "nullable": true, "description": "País de registro." }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registro." } }, "required": [ "name", "country_code", "registration_number" ] }, "KYBRegistryUboResolution": { "type": "object", "description": "Cómo recorrió el nivel UBO la cadena de propiedad por encima de la empresa.", "properties": { "parent_chain": { "type": "array", "description": "Matrices corporativas, desde la matriz última hasta la empresa.", "items": { "$ref": "#/components/schemas/KYBRegistryGroupCompany" } }, "subsidiaries": { "type": "array", "description": "Empresas situadas directamente por debajo de la empresa en su grupo corporativo.", "items": { "$ref": "#/components/schemas/KYBRegistryGroupCompany" } }, "unresolved": { "type": "array", "description": "Partes de la cadena que el registro no pudo resolver (las mismas entradas que `ownership.unresolved`).", "items": { "type": "object", "properties": { "reason": { "type": "string", "description": "Por qué, por ejemplo `no_group_structure_on_record`, `selected_company_not_in_group_structure` o `section_error`." }, "section": { "type": "string", "nullable": true, "description": "La sección afectada, por ejemplo `group_structure`." } }, "required": [ "reason", "section" ] } } }, "required": [ "parent_chain", "subsidiaries", "unresolved" ] }, "KYBRegistrySectionError": { "type": "object", "description": "Una sección que el registro no devolvió.", "properties": { "status_code": { "type": "integer", "nullable": true, "description": "El estado que respondió el registro para la sección." } }, "required": [ "status_code" ] }, "KYBRegistryLiteEnrichment": { "type": "object", "description": "Campos vacíos del perfil Lite que rellenó otra de las fuentes de registro del país. No se indica cuál es la fuente.", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "Los campos de la empresa que se rellenaron." }, "people_added": { "type": "integer", "description": "Cuántos administradores o propietarios se añadieron." } }, "required": [ "fields", "people_added" ] }, "KYBRegistrySource": { "type": "object", "description": "Registro oficial del que se leyó la información. Solo se nombran registros gubernamentales oficiales, reguladores y el sistema oficial de identificadores; cualquier otra fuente se omite.", "properties": { "name": { "type": "string", "description": "Nombre del registro, por ejemplo `UK Companies House`." }, "source_type": { "type": "string", "enum": [ "official" ], "description": "Siempre `official`." } }, "required": [ "name", "source_type" ] }, "KYBOwnershipStructure": { "type": "object", "nullable": true, "description": "La tabla de capitalización que acreditó el registro, tal como estaba cuando se entregó el nivel de propiedad: `shareholders` directos y `beneficial_owners`. Null cuando el registro no acreditó ninguna propiedad. Nunca incluye las filas propias de la fuente del registro; consulta `company.beneficial_owners` y `company.ownership` para ver el registro actual.", "properties": { "shareholders": { "type": "array", "items": { "$ref": "#/components/schemas/KYBOwnershipStructureOwner" } }, "beneficial_owners": { "type": "array", "items": { "$ref": "#/components/schemas/KYBOwnershipStructureOwner" } } }, "required": [ "shareholders", "beneficial_owners" ] }, "KYBOwnershipStructureOwner": { "type": "object", "description": "Un propietario de la instantánea de propiedad: la misma identidad registral y participación que `company.beneficial_owners[]`, y su `shareholding` canónico.", "properties": { "name": { "type": "string", "nullable": true, "description": "Nombre del titular tal como figura en el registro." }, "first_name": { "type": "string", "nullable": true, "description": "Nombre de pila de una persona física, cuando el registro lo indica." }, "last_name": { "type": "string", "nullable": true, "description": "Apellido, para una persona física, cuando el registro lo indica." }, "date_of_birth": { "type": "string", "nullable": true, "description": "Fecha de nacimiento (ISO 8601) cuando el registro la publica." }, "country_of_birth": { "type": "string", "nullable": true, "description": "País de nacimiento, cuando el registro lo publica." }, "company_name": { "type": "string", "nullable": true, "description": "Nombre de la empresa, en el caso de un propietario corporativo." }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registro, para un propietario que es una persona jurídica." }, "entity_type": { "type": "string", "nullable": true, "enum": [ "person", "company", null ], "description": "Si el propietario es una persona física o una empresa." }, "nationality": { "type": "string", "nullable": true, "description": "Nacionalidad, cuando el registro la indica." }, "designation": { "type": "string", "nullable": true, "description": "El cargo o rol del propietario tal como lo muestra el registro." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "`shareholder` para un titular directo, `ubo` para un beneficiario final." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Límite inferior de la participación, en porcentaje (igual al límite superior cuando la participación es exacta)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Límite superior de la participación, en porcentaje." }, "voting_min_shares": { "type": "string", "nullable": true, "description": "Límite inferior de los derechos de voto, en porcentaje." }, "voting_max_shares": { "type": "string", "nullable": true, "description": "Límite superior de los derechos de voto, en porcentaje." }, "appointment_date": { "type": "string", "nullable": true, "description": "Fecha en que comenzó la participación o el nombramiento (ISO 8601)." }, "is_active": { "type": "boolean", "nullable": true, "description": "Falso para un antiguo propietario." }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } }, "required": [ "name", "first_name", "last_name", "date_of_birth", "country_of_birth", "company_name", "registration_number", "entity_type", "nationality", "designation", "roles", "ownership_min_shares", "ownership_max_shares", "voting_min_shares", "voting_max_shares", "appointment_date", "is_active", "shareholding" ] }, "DigitalIdWalletApiWalletVerificationError": { "type": "object", "properties": { "error": { "type": "string", "description": "Código estable legible por máquina, p. ej., wallet_unavailable." }, "detail": { "type": "string" } }, "required": [ "detail", "error" ] }, "DigitalIdWalletApiWalletVerificationStartForbidden": { "oneOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiClientCredentialsForbiddenErrorMessage" }, { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } ] }, "DigitalIdWalletApiClientCredentialsForbiddenErrorMessage": { "type": "object", "properties": { "detail": { "type": "string", "default": "Forbidden - User doesn't have permission" } } }, "DigitalIdWalletApiWalletVerificationStartBadRequest": { "oneOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" }, { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationFieldErrors" } ] }, "DigitalIdWalletApiWalletVerificationFieldErrors": { "type": "object", "description": "Errores de validación de la solicitud: cada campo rechazado con sus mensajes.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "DigitalIdWalletApiWalletVerificationResponse": { "type": "object", "description": "Una verificación de wallet independiente, tal como la devuelve cada endpoint de wallets.", "properties": { "request_id": { "type": "string", "format": "uuid" }, "wallet_verification": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResult" }, "vendor_data": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "El objeto de metadatos enviado al inicio, o null." }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "created_at", "metadata", "request_id", "vendor_data", "wallet_verification" ] }, "DigitalIdWalletApiWalletVerificationResult": { "type": "object", "properties": { "wallet": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWallet" } ], "readOnly": true }, "country": { "type": "string" }, "status": { "type": "string", "description": "Not Finished mientras está pendiente; después, Approved (verificado) o Declined." }, "outcome": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResultOutcomeEnum" }, "error": { "type": "string", "nullable": true, "readOnly": true }, "interaction": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiInteractionEnum" } ], "readOnly": true }, "simulated": { "type": "boolean", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time" }, "next_action": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWalletNextAction" } ], "nullable": true, "readOnly": true }, "identity": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWalletIdentity" } ], "nullable": true, "readOnly": true }, "attributes": { "type": "object", "additionalProperties": {}, "nullable": true, "readOnly": true }, "level_of_assurance": { "type": "string", "nullable": true }, "verified_at": { "type": "string", "format": "date-time", "nullable": true }, "signature_valid": { "type": "boolean", "nullable": true, "description": "True una vez verificada la firma de la credencial; null para una simulada." }, "credential_type": { "type": "string", "nullable": true } }, "required": [ "attributes", "country", "credential_type", "error", "expires_at", "identity", "interaction", "level_of_assurance", "next_action", "outcome", "signature_valid", "simulated", "status", "verified_at", "wallet" ] }, "DigitalIdWalletApiWalletIdentity": { "type": "object", "properties": { "full_name": { "type": "string", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "nationality": { "type": "string", "nullable": true, "description": "Nacionalidad ISO3, solo cuando la wallet la declara (nunca se infiere)." }, "issuing_state": { "type": "string", "description": "País ISO3 cuyo esquema emitió la identidad." } }, "required": [ "date_of_birth", "first_name", "full_name", "issuing_state", "last_name", "nationality" ] }, "DigitalIdWalletApiWalletNextAction": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWalletNextActionTypeEnum" } ], "description": "redirect: envía el navegador del usuario a url. confirm_in_app: muestra verification_code al usuario, que comprueba que coincide con el código de su app de wallet y confirma allí; después, consulta periódicamente el estado. request_digital_credential: en un gesto del usuario en el origen con el que empezaste, solicita la credencial a la wallet con digital_credentials.request y envía lo que devuelva a POST .../verifications/{request_id}/response/.\n\n* `redirect` - redirect\n* `confirm_in_app` - confirm_in_app\n* `request_digital_credential` - request_digital_credential" }, "url": { "type": "string", "format": "uri", "description": "Solo redirect: dónde inicia sesión el usuario con la wallet." }, "digital_credentials": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWalletDigitalCredentialsRequest" } ], "description": "Solo request_digital_credential: la solicitud que se debe entregar a la wallet." }, "verification_code": { "type": "string", "description": "Solo confirm_in_app: el código de comparación de 4 dígitos que también muestra la app de la wallet." }, "poll_interval_seconds": { "type": "integer", "description": "Solo confirm_in_app: con qué frecuencia llamar a POST .../verifications/{request_id}/poll/ para obtener una respuesta rápida. Didit también consulta en segundo plano los inicios de sesión pendientes, así que el webhook informa del resultado aunque no hagas consultas." } }, "required": [ "type" ] }, "DigitalIdWalletApiWalletNextActionTypeEnum": { "enum": [ "redirect", "confirm_in_app", "request_digital_credential" ], "type": "string", "description": "* `redirect` - redirect\n* `confirm_in_app` - confirm_in_app\n* `request_digital_credential` - request_digital_credential" }, "DigitalIdWalletApiInteractionEnum": { "enum": [ "redirect", "in_app", "digital_credentials" ], "type": "string", "description": "* `redirect` - redirect\n* `in_app` - in_app\n* `digital_credentials` - digital_credentials" }, "DigitalIdWalletApiWalletVerificationResultOutcomeEnum": { "enum": [ "pending", "verified", "cancelled", "timeout", "failed" ], "type": "string", "description": "* `pending` - Pendiente\n* `verified` - Verificado\n* `cancelled` - Cancelado por el usuario\n* `timeout` - Tiempo de espera agotado\n* `failed` - Fallido" }, "DigitalIdWalletApiWallet": { "type": "object", "properties": { "id": { "type": "string", "description": "Id de catálogo de la wallet, p. ej., bankid_se." }, "name": { "type": "string" }, "issuing_authority": { "type": "string", "nullable": true } }, "required": [ "id", "issuing_authority", "name" ] }, "DigitalIdWalletApiEudiWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con EUDI Wallet (AUT, BEL, BGR, HRV, CYP, CZE, DNK, EST, FIN, FRA, DEU, GRC, HUN, IRL, ITA, LVA, LTU, LUX, MLT, NLD, POL, PRT, ROU, SVK, SVN, ESP, SWE, ISL, LIE, NOR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiEudiWalletVerificationStartCountryEnum" } ], "description": "País ISO 3166-1 alpha-3 de la identidad EUDI Wallet.\n\n* `AUT` - AUT\n* `BEL` - BEL\n* `BGR` - BGR\n* `HRV` - HRV\n* `CYP` - CYP\n* `CZE` - CZE\n* `DNK` - DNK\n* `EST` - EST\n* `FIN` - FIN\n* `FRA` - FRA\n* `DEU` - DEU\n* `GRC` - GRC\n* `HUN` - HUN\n* `IRL` - IRL\n* `ITA` - ITA\n* `LVA` - LVA\n* `LTU` - LTU\n* `LUX` - LUX\n* `MLT` - MLT\n* `NLD` - NLD\n* `POL` - POL\n* `PRT` - PRT\n* `ROU` - ROU\n* `SVK` - SVK\n* `SVN` - SVN\n* `ESP` - ESP\n* `SWE` - SWE\n* `ISL` - ISL\n* `LIE` - LIE\n* `NOR` - NOR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "country", "return_url" ] }, "DigitalIdWalletApiDeviceEnum": { "enum": [ "same_device", "cross_device" ], "type": "string", "description": "* `same_device` - same_device\n* `cross_device` - cross_device" }, "DigitalIdWalletApiEudiWalletVerificationStartCountryEnum": { "enum": [ "AUT", "BEL", "BGR", "HRV", "CYP", "CZE", "DNK", "EST", "FIN", "FRA", "DEU", "GRC", "HUN", "IRL", "ITA", "LVA", "LTU", "LUX", "MLT", "NLD", "POL", "PRT", "ROU", "SVK", "SVN", "ESP", "SWE", "ISL", "LIE", "NOR" ], "type": "string", "description": "* `AUT` - AUT\n* `BEL` - BEL\n* `BGR` - BGR\n* `HRV` - HRV\n* `CYP` - CYP\n* `CZE` - CZE\n* `DNK` - DNK\n* `EST` - EST\n* `FIN` - FIN\n* `FRA` - FRA\n* `DEU` - DEU\n* `GRC` - GRC\n* `HUN` - HUN\n* `IRL` - IRL\n* `ITA` - ITA\n* `LVA` - LVA\n* `LTU` - LTU\n* `LUX` - LUX\n* `MLT` - MLT\n* `NLD` - NLD\n* `POL` - POL\n* `PRT` - PRT\n* `ROU` - ROU\n* `SVK` - SVK\n* `SVN` - SVN\n* `ESP` - ESP\n* `SWE` - SWE\n* `ISL` - ISL\n* `LIE` - LIE\n* `NOR` - NOR" }, "DigitalIdWalletApiConnectidWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con ConnectID (AUS).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiConnectidWalletVerificationStartCountryEnum" } ], "default": "AUS", "description": "País ISO 3166-1 alpha-3 de la identidad ConnectID. El valor predeterminado es AUS, el único país en el que opera.\n\n* `AUS` - AUS" }, "authorisation_server_id": { "type": "string", "minLength": 1, "description": "ID del servidor de autorización seleccionado con el selector de bancos de ConnectID. En sandbox, el valor predeterminado es Mock Bank A.", "maxLength": 36 }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiConnectidWalletVerificationStartCountryEnum": { "enum": [ "AUS" ], "type": "string", "description": "* `AUS` - AUS" }, "DigitalIdWalletApiAudkenniWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con Auðkenni (ISL).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiAudkenniWalletVerificationStartCountryEnum" } ], "default": "ISL", "description": "País ISO 3166-1 alpha-3 de la identidad Auðkenni. El valor predeterminado es ISL, el único país en el que opera.\n\n* `ISL` - ISL" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiAudkenniWalletVerificationStartCountryEnum": { "enum": [ "ISL" ], "type": "string", "description": "* `ISL` - ISL" }, "DigitalIdWalletApiFranceconnectWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con FranceConnect (FRA).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiFranceconnectWalletVerificationStartCountryEnum" } ], "default": "FRA", "description": "País ISO 3166-1 alpha-3 de la identidad FranceConnect. El valor predeterminado es FRA, el único país en el que opera.\n\n* `FRA` - FRA" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiFranceconnectWalletVerificationStartCountryEnum": { "enum": [ "FRA" ], "type": "string", "description": "* `FRA` - FRA" }, "DigitalIdWalletApiDiiaWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con Diia (UKR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDiiaWalletVerificationStartCountryEnum" } ], "default": "UKR", "description": "País ISO 3166-1 alpha-3 de la identidad Diia. El valor predeterminado es UKR, el único país en el que opera.\n\n* `UKR` - UKR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiDiiaWalletVerificationStartCountryEnum": { "enum": [ "UKR" ], "type": "string", "description": "* `UKR` - UKR" }, "DigitalIdWalletApiMojeidWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con MojeID (CZE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryE2dEnum" } ], "default": "CZE", "description": "País ISO 3166-1 alfa-3 de la identidad de MojeID. El valor predeterminado es CZE, el único país en el que opera.\n\n* `CZE` - CZE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiCountryE2dEnum": { "enum": [ "CZE" ], "type": "string", "description": "* `CZE` - CZE" }, "DigitalIdWalletApiBankidCzWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con Bank iD (CZE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryE2dEnum" } ], "default": "CZE", "description": "País ISO 3166-1 alpha-3 de la identidad Bank iD. El valor predeterminado es CZE, el único país en el que opera.\n\n* `CZE` - CZE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con eParaksts mobile (LVA).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiEparakstsMobileWalletVerificationStartCountryEnum" } ], "default": "LVA", "description": "País ISO 3166-1 alfa-3 de la identidad móvil de eParaksts. El valor predeterminado es LVA, el único país en el que opera.\n\n* `LVA` - LVA" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiEparakstsMobileWalletVerificationStartCountryEnum": { "enum": [ "LVA" ], "type": "string", "description": "* `LVA` - LVA" }, "DigitalIdWalletApiIdcardEeWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con Estonian ID-card (EST).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum" } ], "default": "EST", "description": "País ISO 3166-1 alpha-3 de la identidad de la tarjeta de identidad estonia. El valor predeterminado es EST, el único país en el que opera.\n\n* `EST` - EST" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum": { "enum": [ "EST" ], "type": "string", "description": "* `EST` - EST" }, "DigitalIdWalletApiMobileIdWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con Mobile-ID (EST, LTU).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiMobileIdWalletVerificationStartCountryEnum" } ], "description": "País ISO 3166-1 alfa-3 de la identidad de Mobile-ID.\n\n* `EST` - EST\n* `LTU` - LTU" }, "personal_code": { "type": "string", "minLength": 1, "description": "El código de identificación personal nacional del usuario. Se dirige a la app Mobile-ID del usuario; el usuario confirma el código de comparación e introduce su PIN en la app. Nunca recopiles el PIN.", "pattern": "^[0-9-]{6,20}$" }, "phone_number": { "type": "string", "minLength": 1, "description": "El número de teléfono de Mobile-ID en formato E.164 (+372... o +370...).", "maxLength": 16 } }, "required": [ "country", "personal_code", "phone_number" ] }, "DigitalIdWalletApiMobileIdWalletVerificationStartCountryEnum": { "enum": [ "EST", "LTU" ], "type": "string", "description": "* `EST` - EST\n* `LTU` - LTU" }, "DigitalIdWalletApiSmartIdWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con Smart-ID (EST, LVA, LTU, BEL).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiSmartIdWalletVerificationStartCountryEnum" } ], "description": "País ISO 3166-1 alfa-3 de la identidad de Smart-ID.\n\n* `EST` - EST\n* `LVA` - LVA\n* `LTU` - LTU\n* `BEL` - BEL" }, "personal_code": { "type": "string", "minLength": 1, "description": "El código de identificación personal nacional del usuario. Se dirige a la app Smart-ID del usuario; el usuario confirma el código de comparación e introduce su PIN en la app. Nunca recopiles el PIN.", "pattern": "^[0-9-]{6,20}$" } }, "required": [ "country", "personal_code" ] }, "DigitalIdWalletApiSmartIdWalletVerificationStartCountryEnum": { "enum": [ "EST", "LVA", "LTU", "BEL" ], "type": "string", "description": "* `EST` - EST\n* `LVA` - LVA\n* `LTU` - LTU\n* `BEL` - BEL" }, "DigitalIdWalletApiGovukWalletWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con GOV.UK Wallet (GBR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountry520Enum" } ], "default": "GBR", "description": "País ISO 3166-1 alpha-3 de la identidad GOV.UK Wallet. El valor predeterminado es GBR, el único país en el que opera.\n\n* `GBR` - GBR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiCountry520Enum": { "enum": [ "GBR" ], "type": "string", "description": "* `GBR` - GBR" }, "DigitalIdWalletApiOneidWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con OneID (GBR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountry520Enum" } ], "default": "GBR", "description": "País ISO 3166-1 alfa-3 de la identidad de OneID. El valor predeterminado es GBR, el único país en el que opera.\n\n* `GBR` - GBR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiGovbrWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con gov.br (BRA).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiGovbrWalletVerificationStartCountryEnum" } ], "default": "BRA", "description": "País ISO 3166-1 alfa-3 de la identidad de gov.br. El valor predeterminado es BRA, el único país en el que opera.\n\n* `BRA` - BRA" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiGovbrWalletVerificationStartCountryEnum": { "enum": [ "BRA" ], "type": "string", "description": "* `BRA` - BRA" }, "DigitalIdWalletApiUaePassWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con UAE PASS (ARE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum" } ], "default": "ARE", "description": "País ISO 3166-1 alfa-3 de la identidad de UAE PASS. El valor predeterminado es ARE, el único país en el que opera.\n\n* `ARE` - ARE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum": { "enum": [ "ARE" ], "type": "string", "description": "* `ARE` - ARE" }, "DigitalIdWalletApiFrejaidWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con Freja eID (SWE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryEe9Enum" } ], "default": "SWE", "description": "País ISO 3166-1 alpha-3 de la identidad Freja eID. El valor predeterminado es SWE, el único país en el que opera.\n\n* `SWE` - SWE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiCountryEe9Enum": { "enum": [ "SWE" ], "type": "string", "description": "* `SWE` - SWE" }, "DigitalIdWalletApiPersonalausweisWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con Personalausweis (DEU).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiPersonalausweisWalletVerificationStartCountryEnum" } ], "default": "DEU", "description": "País ISO 3166-1 alfa-3 de la identidad de Personalausweis. El valor predeterminado es DEU, el único país en el que opera.\n\n* `DEU` - DEU" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiPersonalausweisWalletVerificationStartCountryEnum": { "enum": [ "DEU" ], "type": "string", "description": "* `DEU` - DEU" }, "DigitalIdWalletApiFtnWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con Finnish Trust Network (FIN).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiFtnWalletVerificationStartCountryEnum" } ], "default": "FIN", "description": "País ISO 3166-1 alpha-3 de la identidad Finnish Trust Network. El valor predeterminado es FIN, el único país en el que opera.\n\n* `FIN` - FIN" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiFtnWalletVerificationStartCountryEnum": { "enum": [ "FIN" ], "type": "string", "description": "* `FIN` - FIN" }, "DigitalIdWalletApiIdinWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con iDIN (NLD).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiIdinWalletVerificationStartCountryEnum" } ], "default": "NLD", "description": "País ISO 3166-1 alfa-3 de la identidad de iDIN. El valor predeterminado es NLD, el único país en el que opera.\n\n* `NLD` - NLD" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiIdinWalletVerificationStartCountryEnum": { "enum": [ "NLD" ], "type": "string", "description": "* `NLD` - NLD" }, "DigitalIdWalletApiItsmeWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con itsme (BEL, LUX, NLD).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiItsmeWalletVerificationStartCountryEnum" } ], "description": "País ISO 3166-1 alfa-3 de la identidad de itsme.\n\n* `BEL` - BEL\n* `LUX` - LUX\n* `NLD` - NLD" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "country", "return_url" ] }, "DigitalIdWalletApiItsmeWalletVerificationStartCountryEnum": { "enum": [ "BEL", "LUX", "NLD" ], "type": "string", "description": "* `BEL` - BEL\n* `LUX` - LUX\n* `NLD` - NLD" }, "DigitalIdWalletApiBuypassWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con Buypass ID (NOR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryAfcEnum" } ], "default": "NOR", "description": "País ISO 3166-1 alpha-3 de la identidad Buypass ID. El valor predeterminado es NOR, el único país en el que opera.\n\n* `NOR` - NOR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiCountryAfcEnum": { "enum": [ "NOR" ], "type": "string", "description": "* `NOR` - NOR" }, "DigitalIdWalletApiVippsWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con Vipps (NOR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryAfcEnum" } ], "default": "NOR", "description": "País ISO 3166-1 alfa-3 de la identidad de Vipps. El valor predeterminado es NOR, el único país en el que opera.\n\n* `NOR` - NOR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiBankidNoWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con BankID (NOR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryAfcEnum" } ], "default": "NOR", "description": "País ISO 3166-1 alpha-3 de la identidad BankID. El valor predeterminado es NOR, el único país en el que opera.\n\n* `NOR` - NOR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiBankidSeWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con BankID (SWE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryEe9Enum" } ], "default": "SWE", "description": "País ISO 3166-1 alpha-3 de la identidad BankID. El valor predeterminado es SWE, el único país en el que opera.\n\n* `SWE` - SWE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiMitidWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con MitID (DNK).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiMitidWalletVerificationStartCountryEnum" } ], "default": "DNK", "description": "País ISO 3166-1 alfa-3 de la identidad de MitID. El valor predeterminado es DNK, el único país en el que opera.\n\n* `DNK` - DNK" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la que vuelve el navegador del usuario después de la wallet, con request_id y result añadidos. Su host debe estar registrado en allowed_return_hosts de la aplicación (o ser su dominio de marca blanca). Nunca confíes solo en result: consulta el resultado con GET .../verifications/{request_id}/ o con el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device cuando el usuario inicia sesión en el dispositivo que muestra tu página, cross_device cuando usa otro (p. ej., el código QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiMitidWalletVerificationStartCountryEnum": { "enum": [ "DNK" ], "type": "string", "description": "* `DNK` - DNK" }, "DigitalIdWalletApiWalletCatalogResponse": { "type": "object", "properties": { "wallets": { "type": "array", "items": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletCatalogEntry" } } }, "required": [ "wallets" ] }, "DigitalIdWalletApiWalletCatalogEntry": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string", "description": "El endpoint de inicio propio de la wallet." }, "countries": { "type": "array", "items": { "type": "string" } }, "issuing_authority": { "type": "string" }, "level_of_assurance": { "type": "string", "nullable": true }, "interaction": { "$ref": "#/components/schemas/DigitalIdWalletApiInteractionEnum" }, "required_fields": { "type": "array", "items": { "type": "string" } }, "available": { "type": "boolean", "description": "Si esta aplicación puede iniciarlo ahora en este entorno. Figurar en la lista no significa que esté disponible en producción." } }, "required": [ "available", "countries", "id", "interaction", "issuing_authority", "level_of_assurance", "name", "path", "required_fields" ] }, "CaseDuplicateCaseDuplicate": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "case_number": { "type": "string", "nullable": true, "maxLength": 32 }, "title": { "type": "string", "maxLength": 255 }, "status": { "$ref": "#/components/schemas/CaseDuplicateStatusEnum" }, "priority": { "$ref": "#/components/schemas/CaseDuplicatePriorityEnum" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "title", "uuid" ] }, "CaseDuplicateCaseDuplicatePage": { "type": "object", "properties": { "count": { "type": "integer" }, "next_offset": { "type": "integer", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseDuplicateCaseDuplicate" } } }, "required": [ "count", "next_offset", "results" ] }, "RoutingPublicationPolicyDraftResponse": { "type": "object", "properties": { "draft": { "allOf": [ { "$ref": "#/components/schemas/RoutingPublicationPolicyDraft" } ], "nullable": true } }, "required": [ "draft" ] }, "RoutingPublicationPolicyDraftWriteRequest": { "type": "object", "properties": { "expected_version": { "type": "integer", "minimum": 0 }, "expected_revision": { "type": "string", "format": "uuid", "nullable": true }, "changes": { "type": "object", "additionalProperties": {} } }, "required": [ "changes", "expected_revision", "expected_version" ] }, "CasePublicationPolicyDraft": { "type": "object", "properties": { "revision": { "type": "string", "format": "uuid" }, "base_version": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "changes": {}, "actor_email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "base_version", "updated_at" ] }, "CasePublicationPolicyDraftPreconditionRequest": { "type": "object", "properties": { "expected_version": { "type": "integer", "minimum": 0 }, "expected_revision": { "type": "string", "format": "uuid", "nullable": true } }, "required": [ "expected_revision", "expected_version" ] }, "CaseCollaborationCaseNote": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "comment": { "type": "string" }, "actor_email": { "type": "string", "format": "email", "nullable": true, "maxLength": 255 }, "actor_name": { "type": "string", "nullable": true, "maxLength": 255 }, "mentioned_emails": {}, "is_internal": { "type": "boolean" }, "attachments": {}, "tags": {}, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "reply_to": { "allOf": [ { "$ref": "#/components/schemas/CaseCollaborationCaseNoteReply" } ], "nullable": true, "readOnly": true }, "is_pinned": { "type": "boolean" }, "client_reference": { "type": "string", "format": "uuid", "nullable": true } }, "required": [ "comment", "created_at", "reply_to", "uuid" ] }, "CustomerMessagingPaginatedCaseRequestList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=400&limit=100" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=200&limit=100" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerMessagingCaseRequest" } } } }, "FraudCheckResponse": { "type": "object", "properties": { "check_id": { "type": "string", "format": "uuid" }, "request_id": { "type": "string", "format": "uuid", "description": "Sesión de verificación nativa creada para esta comprobación." }, "client_reference": { "type": "string", "nullable": true }, "processing_status": { "$ref": "#/components/schemas/FraudProcessingStatusEnum" }, "profile_id": { "type": "string" }, "profile_version": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/FraudCheckInput" } }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/FraudCheckModuleReport" } }, "attribute_evidence": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "compound_evidence": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "risk": { "type": "array", "items": { "$ref": "#/components/schemas/FraudCheckRisk" } }, "network": { "type": "object", "additionalProperties": {} }, "enrichment": { "type": "object", "additionalProperties": {} }, "identity_relationship": { "allOf": [ { "$ref": "#/components/schemas/FraudCheckIdentityRelationship" } ], "nullable": true }, "recommendation": { "$ref": "#/components/schemas/FraudRecommendationEnum" }, "next_action": { "$ref": "#/components/schemas/FraudNextActionEnum" }, "decision_reasons": { "type": "array", "items": { "type": "string" } }, "coverage": { "type": "object", "additionalProperties": {} }, "usage": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "vendor_data": { "type": "string", "nullable": true }, "metadata": { "nullable": true } }, "required": [ "attribute_evidence", "check_id", "client_reference", "completed_at", "compound_evidence", "coverage", "created_at", "decision_reasons", "inputs", "modules", "network", "next_action", "processing_status", "profile_id", "profile_version", "recommendation", "risk", "usage" ] }, "CaseReviewTeam": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/CaseReviewTeamMember" }, "maxItems": 250 }, "is_active": { "type": "boolean" }, "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } } }, "CaseActionCaseEntityActionRequest": { "type": "object", "properties": { "client_reference": { "type": "string", "format": "uuid" }, "retry": { "type": "boolean", "default": false }, "action": { "$ref": "#/components/schemas/CaseActionActionEnum" }, "status": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "note": { "type": "string", "nullable": true } }, "required": [ "action" ] }, "RoutingPublicationPaginatedPolicyRevisionList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=400&limit=100" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=200&limit=100" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingPublicationPolicyRevision" } } } }, "FraudRecommendationEnum": { "enum": [ "approve", "review", "reject" ], "type": "string", "description": "* `approve` - Aprobar\n* `review` - Revisar\n* `reject` - Rechazar" }, "CustomerMessagingCaseRequestPreviewResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "expires_at": { "type": "string", "format": "date-time" }, "recipient": { "type": "string", "format": "email" }, "sender": { "type": "string" }, "subject": { "type": "string" }, "html": { "type": "string" }, "requires_user_action": { "type": "boolean" }, "preview_token": { "type": "string" } }, "required": [ "expires_at", "html", "preview_token", "recipient", "request_id", "requires_user_action", "sender", "subject" ] }, "CustomerMessagingCaseCustomerResponseRequest": { "type": "object", "properties": { "full_name": { "type": "string", "minLength": 1, "maxLength": 512 }, "date_of_birth": { "type": "string", "format": "date" }, "file": { "type": "string", "format": "binary", "writeOnly": true } } }, "CaseCollaborationCaseNoteReply": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "actor_name": { "type": "string", "nullable": true }, "actor_email": { "type": "string", "format": "email", "nullable": true }, "comment": { "type": "string", "maxLength": 300 } }, "required": [ "actor_email", "actor_name", "comment", "uuid" ] }, "FraudCheckModuleReport": { "type": "object", "properties": { "module": { "$ref": "#/components/schemas/FraudExcludeEnum" }, "status": { "$ref": "#/components/schemas/FraudStatusEnum" }, "reason": { "type": "string", "nullable": true }, "latency_ms": { "type": "integer" }, "freshness": { "type": "string", "nullable": true }, "billable_units": { "type": "integer" } }, "required": [ "billable_units", "freshness", "latency_ms", "module", "reason", "status" ] }, "CaseDuplicateEntityTypeEnum": { "enum": [ "session", "business_session", "transaction" ], "type": "string", "description": "* `session` - Sesión\n* `business_session` - Sesión de empresa\n* `transaction` - Transacción" }, "FraudClientCredentialsErrorMessage": { "type": "object", "properties": { "detail": { "type": "string", "default": "Authentication failed: Invalid client access token." } } }, "FraudAvailabilityEnum": { "enum": [ "available", "not_requested", "no_reference", "insufficient_history", "unsupported_region", "source_unavailable" ], "type": "string", "description": "* `available` - Disponible\n* `not_requested` - No solicitado\n* `no_reference` - Sin referencia\n* `insufficient_history` - Historial insuficiente\n* `unsupported_region` - Región no compatible\n* `source_unavailable` - Fuente no disponible" }, "CasePublicationPolicyDraftResponse": { "type": "object", "properties": { "draft": { "allOf": [ { "$ref": "#/components/schemas/CasePublicationPolicyDraft" } ], "nullable": true } }, "required": [ "draft" ] }, "FraudCheckAttributesRequest": { "type": "object", "description": "Atributos de corroboración. Todos son opcionales y amplían la cobertura de los módulos.", "properties": { "first_name": { "type": "string", "maxLength": 128 }, "last_name": { "type": "string", "maxLength": 128 }, "full_name": { "type": "string", "maxLength": 256 }, "date_of_birth": { "type": "string", "format": "date" }, "nationality": { "type": "string", "maxLength": 3 }, "gender": { "type": "string", "maxLength": 16 }, "address": { "type": "string", "maxLength": 512 }, "city": { "type": "string", "maxLength": 128 }, "state": { "type": "string", "maxLength": 128 }, "postal_code": { "type": "string", "maxLength": 32 } } }, "NetworkNote": { "type": "object", "required": [ "uuid", "actor_email", "comment", "client_reference", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "actor_email": { "type": "string", "format": "email", "readOnly": true, "description": "Autor autenticado, asignado por el servidor." }, "comment": { "type": "string", "minLength": 1, "maxLength": 10000 }, "client_reference": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } } }, "CaseActionEntityTypeEnum": { "enum": [ "user", "business" ], "type": "string", "description": "* `user` - user\n* `business` - business" }, "CaseRoutingCondition": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "source", "priority", "tags" ] }, "operator": { "type": "string", "enum": [ "equals", "in", "contains" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "field", "operator", "value" ], "description": "El origen y la prioridad admiten equals o in con los valores admitidos. Las etiquetas admiten contains con una sola etiqueta no vacía." }, "RoutingPublicationPolicyRevision": { "type": "object", "properties": { "version": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "snapshot": {}, "actor_email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "published_at": { "type": "string", "format": "date-time" } }, "required": [ "published_at", "snapshot", "version" ] }, "CasePublicationPolicyRevision": { "type": "object", "properties": { "version": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "snapshot": {}, "actor_email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "published_at": { "type": "string", "format": "date-time" } }, "required": [ "published_at", "snapshot", "version" ] }, "FraudCheckIdentityRelationship": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/FraudResultEnum" }, "reference_type": { "type": "string" }, "country": { "type": "string" }, "availability": { "$ref": "#/components/schemas/FraudAvailabilityEnum" }, "reason_codes": { "type": "array", "items": { "type": "string" } } }, "required": [ "availability", "country", "reason_codes", "reference_type", "result" ] }, "CasePublicationPaginatedPolicyRevisionList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=400&limit=100" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=200&limit=100" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CasePublicationPolicyRevision" } } } }, "CaseDuplicateBlankEnum": { "enum": [ "" ] }, "FraudCheckPlan": { "type": "object", "properties": { "profile_id": { "type": "string" }, "profile_version": { "type": "string" }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/FraudCheckPlannedModule" } }, "estimated_price": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "is_sandbox": { "type": "boolean" }, "can_afford": { "type": "boolean" } }, "required": [ "can_afford", "currency", "estimated_price", "is_sandbox", "modules", "profile_id", "profile_version" ] }, "CaseReviewTeamUpdate": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/CaseReviewTeamMember" }, "maxItems": 250 }, "is_active": { "type": "boolean" } } }, "RoutingPublicationPolicyDraft": { "type": "object", "properties": { "revision": { "type": "string", "format": "uuid" }, "base_version": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "changes": {}, "actor_email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "base_version", "updated_at" ] }, "FraudCheckRequestRequest": { "type": "object", "properties": { "client_reference": { "type": "string", "minLength": 1, "description": "Tu propia referencia para esta comprobación. También sirve como clave de idempotencia: reutilizarla con el mismo cuerpo devuelve la comprobación original sin volver a ejecutar ni facturar los módulos; reutilizarla con un cuerpo distinto devuelve 409.", "maxLength": 255 }, "profile": { "type": "string", "minLength": 1, "default": "standard", "description": "ID del perfil de orquestación. Por defecto, el perfil `standard` de Didit.", "maxLength": 64 }, "profile_version": { "type": "string", "minLength": 1, "description": "Fija una versión congelada del perfil. De forma predeterminada, se usa la versión actual del perfil.", "maxLength": 32 }, "subject": { "$ref": "#/components/schemas/FraudCheckSubjectRequest" }, "context": { "$ref": "#/components/schemas/FraudCheckContextRequest" }, "checks": { "$ref": "#/components/schemas/FraudCheckModuleSelectionRequest" }, "vendor_data": { "type": "string", "maxLength": 1000 }, "metadata": {} }, "required": [ "subject" ] }, "CaseDuplicateCaseSubjectInputRequest": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CaseDuplicateTypeEnum" }, "uuid": { "type": "string", "format": "uuid" } }, "required": [ "type", "uuid" ] }, "CaseReviewTeamMember": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid" }, "availability": { "type": "string", "enum": [ "available", "unavailable" ], "default": "available" }, "capacity": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 10 }, "skills": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "maxItems": 25 }, "available_from": { "type": "string", "format": "date-time", "nullable": true }, "available_until": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "user_id" ] }, "CaseRoutingPreviewRequest": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "MANUAL", "AML_SCREENING", "TRANSACTION_RULE", "WORKFLOW_BUILDER" ] }, "priority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ], "default": "MEDIUM" }, "tags": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "maxItems": 50 }, "rule_uuid": { "type": "string", "format": "uuid" }, "draft": { "$ref": "#/components/schemas/CaseRoutingRuleCreate" } }, "required": [ "source" ] }, "FraudExcludeEnum": { "enum": [ "normalization", "email_risk", "email_social", "phone_social", "phone_risk", "ip_risk", "database_validation", "networks_same_org", "networks_cross_org", "biometric_identity" ], "type": "string", "description": "* `normalization` - Normalización\n* `email_risk` - Riesgo del correo electrónico\n* `email_social` - Presencia social del correo electrónico\n* `phone_social` - Presencia social del teléfono\n* `phone_risk` - Riesgo del teléfono\n* `ip_risk` - Riesgo de IP\n* `database_validation` - Validación de base de datos\n* `networks_same_org` - Redes de la misma organización\n* `networks_cross_org` - Redes entre organizaciones\n* `biometric_identity` - Identidad biométrica" }, "CaseDuplicateCaseLinkCreateRequest": { "type": "object", "properties": { "entity_type": { "$ref": "#/components/schemas/CaseDuplicateEntityTypeEnum" }, "entity_uuid": { "type": "string", "format": "uuid" } }, "required": [ "entity_type", "entity_uuid" ] }, "CaseDuplicateStatusEnum": { "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ], "type": "string", "description": "* `OPEN` - Abierto\n* `AWAITING_USER` - En espera del usuario\n* `RESOLVED` - Resuelto" }, "FraudBandEnum": { "enum": [ "low", "medium", "high", "unknown" ], "type": "string", "description": "* `low` - Bajo\n* `medium` - Medio\n* `high` - Alto\n* `unknown` - Desconocido" }, "CaseDuplicatePriorityEnum": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "* `LOW` - Bajo\n* `MEDIUM` - Medio\n* `HIGH` - Alto" }, "FraudStatusEnum": { "enum": [ "planned", "completed", "skipped", "failed" ], "type": "string", "description": "* `planned` - Planificado\n* `completed` - Completado\n* `skipped` - Omitido\n* `failed` - Fallido" }, "FraudCheckInput": { "type": "object", "properties": { "reference": { "type": "string", "description": "Identificador ofuscado del dato enviado." }, "type": { "$ref": "#/components/schemas/FraudTypeEnum" }, "namespace": { "type": "object", "additionalProperties": {} }, "quality": { "type": "string" }, "normalization": { "type": "object", "additionalProperties": {} }, "availability": { "$ref": "#/components/schemas/FraudAvailabilityEnum" } }, "required": [ "availability", "namespace", "normalization", "quality", "reference", "type" ] }, "CustomerMessagingPurposesEnum": { "enum": [ "identity_document", "proof_of_address", "business_document", "confirm_details", "review_in_progress" ], "type": "string", "description": "* `identity_document` - identity_document\n* `proof_of_address` - proof_of_address\n* `business_document` - business_document\n* `confirm_details` - confirm_details\n* `review_in_progress` - review_in_progress" }, "FraudTypeEnum": { "enum": [ "email", "phone", "national_id", "tax_number", "passport_number", "driving_licence_number", "residence_permit_number", "voter_id", "external_id" ], "type": "string", "description": "* `email` - Correo electrónico\n* `phone` - Teléfono\n* `national_id` - Documento nacional de identidad\n* `tax_number` - Número de identificación fiscal\n* `passport_number` - Número de pasaporte\n* `driving_licence_number` - Número de licencia de conducir\n* `residence_permit_number` - Número de permiso de residencia\n* `voter_id` - Credencial de elector\n* `external_id` - ID externo" }, "CaseDuplicateCaseSubjectInput": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CaseDuplicateTypeEnum" }, "uuid": { "type": "string", "format": "uuid" } }, "required": [ "type", "uuid" ] }, "CaseReviewTeamCreate": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/CaseReviewTeamMember" }, "maxItems": 250 }, "is_active": { "type": "boolean" } }, "required": [ "name", "members" ] }, "CaseDuplicateCaseDuplicateQueryRequest": { "type": "object", "properties": { "subject": { "$ref": "#/components/schemas/CaseDuplicateCaseSubjectInputRequest" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/CaseDuplicateCaseLinkCreateRequest" } }, "offset": { "type": "integer", "maximum": 1000000, "minimum": 0, "default": 0 } } }, "CaseDuplicateResolutionEnum": { "enum": [ "FALSE_POSITIVE", "VALID_THREAT" ], "type": "string", "description": "* `FALSE_POSITIVE` - Falso positivo\n* `VALID_THREAT` - Amenaza válida" }, "CasePublicationPolicyDraftWriteRequest": { "type": "object", "properties": { "expected_version": { "type": "integer", "minimum": 0 }, "expected_revision": { "type": "string", "format": "uuid", "nullable": true }, "changes": { "type": "object", "additionalProperties": {} } }, "required": [ "changes", "expected_revision", "expected_version" ] }, "FraudCheckSubjectRequest": { "type": "object", "properties": { "selfie": { "type": "string", "minLength": 1, "description": "Selfie en JPEG, PNG o WebP codificada en base64, de hasta 6 MB. Sin imagen de referencia ni URL.", "maxLength": 8388672 }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/FraudCheckIdentifierRequest" }, "description": "Uno o más identificadores tipados. Basta con uno.", "maxItems": 10, "minItems": 1 }, "attributes": { "$ref": "#/components/schemas/FraudCheckAttributesRequest" } }, "required": [ "identifiers" ] }, "RoutingPublicationRoutingCondition": { "type": "object", "properties": { "field": { "$ref": "#/components/schemas/RoutingPublicationFieldEnum" }, "operator": { "$ref": "#/components/schemas/RoutingPublicationOperatorEnum" }, "value": {} }, "required": [ "field", "operator", "value" ] }, "CaseActionCaseActionReceipt": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "client_reference": { "type": "string", "format": "uuid" }, "action": { "type": "string", "maxLength": 32 }, "status": { "$ref": "#/components/schemas/CaseActionStatusEnum" }, "result": {}, "error": { "type": "string", "maxLength": 255 }, "actor_email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "attempts": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "action", "client_reference", "created_at", "status", "updated_at", "uuid" ] }, "FraudCheckContextRequest": { "type": "object", "properties": { "ip_address": { "type": "string", "minLength": 1 }, "user_agent": { "type": "string", "maxLength": 512 }, "country": { "type": "string", "description": "País en el que el sujeto afirma encontrarse. Solo aporta contexto; nunca es prueba de la titularidad de la identidad.", "maxLength": 3 }, "purpose": { "type": "string", "maxLength": 128 }, "consent_obtained": { "type": "boolean" } } }, "CustomerMessagingCaseCustomerResponseResult": { "type": "object", "properties": { "responded_at": { "type": "string", "format": "date-time" } }, "required": [ "responded_at" ] }, "CustomerMessagingCaseRequestContact": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "verified_at": { "type": "string", "format": "date-time" } }, "required": [ "email", "uuid", "verified_at" ] }, "FraudClientCredentialsForbiddenErrorMessage": { "type": "object", "properties": { "detail": { "type": "string", "default": "Forbidden - User doesn't have permission" } } }, "CasePublicationAssignmentMethodEnum": { "enum": [ "MANUAL", "AUTOMATIC" ], "type": "string", "description": "* `MANUAL` - Manual\n* `AUTOMATIC` - Automático" }, "CaseDuplicateNullEnum": { "enum": [ null ] }, "CustomerMessagingLanguageEnum": { "enum": [ "en", "es", "pt" ], "type": "string", "description": "* `en` - en\n* `es` - es\n* `pt` - pt" }, "CaseDuplicateCaseFraudSourceContextRequest": { "type": "object", "properties": { "check_id": { "type": "string", "format": "uuid" }, "request_id": { "type": "string", "format": "uuid" }, "source_section": { "type": "string", "minLength": 1, "pattern": "^[A-Z][A-Z0-9_:-]{0,63}$" } }, "required": [ "check_id", "request_id", "source_section" ] }, "FraudCheckPlannedModule": { "type": "object", "properties": { "module": { "$ref": "#/components/schemas/FraudExcludeEnum" }, "available": { "type": "boolean" }, "availability_reason": { "type": "string", "nullable": true }, "will_run": { "type": "boolean" }, "selection_reason": { "type": "string", "nullable": true }, "estimated_price": { "type": "string", "nullable": true } }, "required": [ "availability_reason", "available", "estimated_price", "module", "selection_reason", "will_run" ] }, "CustomerMessagingCaseRequestOptions": { "type": "object", "properties": { "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestContact" } }, "purposes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerMessagingPurposesEnum" } }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerMessagingLanguagesEnum" } } }, "required": [ "contacts", "languages", "purposes" ] }, "CaseCollaborationPaginatedCaseNoteList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=400&limit=100" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=200&limit=100" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseCollaborationCaseNote" } } } }, "FraudProcessingStatusEnum": { "enum": [ "pending", "running", "completed", "failed" ], "type": "string", "description": "* `pending` - Pendiente\n* `running` - En ejecución\n* `completed` - Completado\n* `failed` - Fallido" }, "CasePublicationCaseBlueprint": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 24 }, "description": { "type": "string", "nullable": true }, "assignment_method": { "$ref": "#/components/schemas/CasePublicationAssignmentMethodEnum" }, "assignee_pool": {}, "max_active_cases": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true }, "escalation_enabled": { "type": "boolean" }, "escalation_blueprint": { "type": "string", "format": "uuid", "nullable": true }, "escalation_blueprint_name": { "type": "string", "readOnly": true }, "transfer_enabled": { "type": "boolean" }, "four_eyes_checker_blueprint": { "type": "string", "format": "uuid", "nullable": true }, "four_eyes_checker_blueprint_name": { "type": "string", "readOnly": true }, "require_resolution_note": { "type": "boolean" }, "content_config": {}, "version": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "default_deadline_hours": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true }, "is_active": { "type": "boolean" }, "preset_key": { "type": "string", "nullable": true, "maxLength": 64 }, "creation_sources": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "receives_escalation_from": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "creation_sources", "escalation_blueprint_name", "four_eyes_checker_blueprint_name", "name", "receives_escalation_from", "updated_at", "uuid" ] }, "CaseRoutingRuleUpdate": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "priority": { "type": "integer", "minimum": 0 }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/CaseRoutingCondition" }, "maxItems": 20 }, "required_skills": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "maxItems": 25 }, "blueprint": { "type": "string", "format": "uuid" }, "team": { "type": "string", "format": "uuid", "nullable": true }, "is_active": { "type": "boolean" }, "expected_version": { "type": "integer", "minimum": 1, "writeOnly": true, "description": "Versión que abrió el editor. Si se indica, las escrituras obsoletas devuelven 409 sin modificar la regla." } } }, "CustomerMessagingCaseRequestPreviewRequest": { "type": "object", "properties": { "contact_id": { "type": "string", "format": "uuid" }, "purpose": { "$ref": "#/components/schemas/CustomerMessagingPurposeEnum" }, "language": { "allOf": [ { "$ref": "#/components/schemas/CustomerMessagingLanguageEnum" } ], "default": "en" } }, "required": [ "contact_id", "purpose" ] }, "CaseDuplicateCaseFraudSourceContext": { "type": "object", "properties": { "check_id": { "type": "string", "format": "uuid" }, "request_id": { "type": "string", "format": "uuid" }, "source_section": { "type": "string", "pattern": "^[A-Z][A-Z0-9_:-]{0,63}$" } }, "required": [ "check_id", "request_id", "source_section" ] }, "RoutingPublicationOperatorEnum": { "enum": [ "equals", "in", "contains" ], "type": "string", "description": "* `equals` - equals\n* `in` - in\n* `contains` - contains" }, "CaseRoutingPreview": { "type": "object", "properties": { "rule_uuid": { "type": "string", "format": "uuid", "nullable": true }, "rule_name": { "type": "string", "nullable": true }, "rule_version": { "type": "integer", "nullable": true }, "blueprint_uuid": { "type": "string", "format": "uuid", "nullable": true }, "team_uuid": { "type": "string", "format": "uuid", "nullable": true }, "assignee_user_id": { "type": "string", "format": "uuid", "nullable": true }, "reason": { "type": "string" }, "candidates": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid" }, "eligible": { "type": "boolean" }, "active_cases": { "type": "integer", "nullable": true }, "reason": { "type": "string", "nullable": true } } } }, "matched_rules": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "priority": { "type": "integer" } } } } } }, "FraudDimensionEnum": { "enum": [ "identity", "contact", "device_network", "behavioral", "fraud_network" ], "type": "string", "description": "* `identity` - Identidad\n* `contact` - Contacto\n* `device_network` - Red de dispositivos\n* `behavioral` - Comportamiento\n* `fraud_network` - Red de fraude" }, "FraudBadRequestErrorMessage": { "type": "object", "properties": { "detail": { "type": "string", "default": "Bad Request - Invalid request data" } } }, "FraudNextActionEnum": { "enum": [ "none", "manual_review", "step_up", "resubmit_capture" ], "type": "string", "description": "* `none` - Ninguna\n* `manual_review` - Revisión manual\n* `step_up` - Verificación adicional\n* `resubmit_capture` - Repetir captura" }, "RoutingPublicationPolicyDraftPreconditionRequest": { "type": "object", "properties": { "expected_version": { "type": "integer", "minimum": 0 }, "expected_revision": { "type": "string", "format": "uuid", "nullable": true } }, "required": [ "expected_revision", "expected_version" ] }, "FraudCheckRisk": { "type": "object", "properties": { "dimension": { "$ref": "#/components/schemas/FraudDimensionEnum" }, "score": { "type": "integer", "nullable": true }, "band": { "$ref": "#/components/schemas/FraudBandEnum" }, "availability": { "$ref": "#/components/schemas/FraudAvailabilityEnum" }, "requested_but_unavailable": { "type": "boolean", "description": "True cuando la solicitud aportó todo lo que esta dimensión necesitaba y aun así la plataforma no pudo responderla. Una comprobación así nunca se recomienda para aprobación basándose en las dimensiones que sí respondieron." }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "evidence_indexes": { "type": "array", "items": { "type": "integer" } } }, "required": [ "availability", "band", "dimension", "evidence_indexes", "reason_codes", "requested_but_unavailable", "score" ] }, "CaseDuplicateSourceEnum": { "enum": [ "MANUAL", "AML_SCREENING", "TRANSACTION_RULE", "WORKFLOW_BUILDER" ], "type": "string", "description": "* `MANUAL` - Manual\n* `AML_SCREENING` - Análisis AML\n* `TRANSACTION_RULE` - Regla de transacción\n* `WORKFLOW_BUILDER` - Constructor de flujos" }, "CaseCollaborationPatchedCaseNoteUpdateRequest": { "type": "object", "properties": { "is_pinned": { "type": "boolean" } } }, "CustomerMessagingPurposeEnum": { "enum": [ "identity_document", "proof_of_address", "business_document", "confirm_details", "review_in_progress" ], "type": "string", "description": "* `identity_document` - identity_document\n* `proof_of_address` - proof_of_address\n* `business_document` - business_document\n* `confirm_details` - confirm_details\n* `review_in_progress` - review_in_progress" }, "CaseDuplicateTypeEnum": { "enum": [ "user", "business" ], "type": "string", "description": "* `user` - user\n* `business` - business" }, "CaseCollaborationCaseNoteCreateRequest": { "type": "object", "properties": { "comment": { "type": "string", "minLength": 1, "maxLength": 10000 }, "reply_to": { "type": "string", "format": "uuid", "nullable": true }, "client_reference": { "type": "string", "format": "uuid", "nullable": true }, "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email", "minLength": 1 } }, "is_internal": { "type": "boolean", "default": false }, "attachments": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "comment" ] }, "CustomerMessagingLanguagesEnum": { "enum": [ "en", "es", "pt" ], "type": "string", "description": "* `en` - en\n* `es` - es\n* `pt` - pt" }, "CustomerMessagingCaseRequestConfirmRequest": { "type": "object", "properties": { "contact_id": { "type": "string", "format": "uuid" }, "purpose": { "$ref": "#/components/schemas/CustomerMessagingPurposeEnum" }, "language": { "allOf": [ { "$ref": "#/components/schemas/CustomerMessagingLanguageEnum" } ], "default": "en" }, "request_id": { "type": "string", "format": "uuid" }, "expires_at": { "type": "string", "format": "date-time" }, "preview_token": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "contact_id", "expires_at", "preview_token", "purpose", "request_id" ] }, "CaseRoutingRule": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "priority": { "type": "integer", "minimum": 0 }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/CaseRoutingCondition" }, "maxItems": 20 }, "required_skills": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "maxItems": 25 }, "blueprint": { "type": "string", "format": "uuid" }, "team": { "type": "string", "format": "uuid", "nullable": true }, "is_active": { "type": "boolean" }, "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "version": { "type": "integer", "readOnly": true }, "blueprint_name": { "type": "string", "readOnly": true }, "team_name": { "type": "string", "nullable": true, "readOnly": true } } }, "FraudResultEnum": { "enum": [ "match", "mismatch", "inconclusive", "no_reference" ], "type": "string", "description": "* `match` - Coincidencia\n* `mismatch` - Discrepancia\n* `inconclusive` - No concluyente\n* `no_reference` - Sin referencia" }, "CaseRoutingRuleCreate": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "priority": { "type": "integer", "minimum": 0 }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/CaseRoutingCondition" }, "maxItems": 20 }, "required_skills": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "maxItems": 25 }, "blueprint": { "type": "string", "format": "uuid" }, "team": { "type": "string", "format": "uuid", "nullable": true }, "is_active": { "type": "boolean" }, "publish": { "type": "boolean", "writeOnly": true, "description": "Establécelo en false para guardar un borrador nunca publicado. El registro permanece inactivo en la versión 0 hasta que el borrador se publique explícitamente. Si se omite este campo, se mantiene la creación inmediata para las integraciones existentes." } }, "required": [ "name", "conditions", "blueprint" ] }, "FraudCheckIdentifierRequest": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/FraudTypeEnum" } ], "description": "Tipo de identificador. Determina qué campos del espacio de nombres son obligatorios.\n\n* `email` - Correo electrónico\n* `phone` - Teléfono\n* `national_id` - Documento nacional de identidad\n* `tax_number` - Número de identificación fiscal\n* `passport_number` - Número de pasaporte\n* `driving_licence_number` - Número de licencia de conducir\n* `residence_permit_number` - Número de permiso de residencia\n* `voter_id` - ID de votante\n* `external_id` - ID externo" }, "value": { "type": "string", "minLength": 1, "description": "El valor del identificador, en cualquier formato habitual.", "maxLength": 255 }, "country": { "type": "string", "description": "País emisor ISO-3166 alfa-2 o alfa-3. Obligatorio para los tipos de identificadores gubernamentales: los mismos dígitos corresponden a personas distintas en países distintos.", "maxLength": 3 }, "issuer": { "type": "string", "description": "Autoridad emisora o emisor subnacional opcional, cuando el país por sí solo no es único.", "maxLength": 128 } }, "required": [ "type", "value" ] }, "CaseActionActionEnum": { "enum": [ "set_status", "add_tags", "add_note", "add_to_blocklist" ], "type": "string", "description": "* `set_status` - set_status\n* `add_tags` - add_tags\n* `add_note` - add_note\n* `add_to_blocklist` - add_to_blocklist" }, "CaseActionCaseActionReceiptPage": { "type": "object", "properties": { "count": { "type": "integer" }, "next_offset": { "type": "integer", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseActionCaseActionReceipt" } } }, "required": [ "count", "next_offset", "results" ] }, "CaseActionCaseEntityActionResult": { "type": "object", "properties": { "receipt": { "$ref": "#/components/schemas/CaseActionCaseActionReceipt" }, "entity_type": { "$ref": "#/components/schemas/CaseActionEntityTypeEnum" }, "entity_uuid": { "type": "string", "format": "uuid" }, "action": { "type": "string" }, "previous_status": { "type": "string" }, "new_status": { "type": "string" }, "tags_added": { "type": "array", "items": { "type": "string" } }, "comment_uuid": { "type": "string", "format": "uuid" }, "blocklisted": { "type": "array", "items": { "type": "string" } } } }, "CustomerMessagingCaseRequest": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "purpose": { "type": "string", "readOnly": true }, "language": { "type": "string", "readOnly": true }, "recipient": { "type": "string", "format": "email", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "readOnly": true }, "actor_email": { "type": "string", "format": "email", "readOnly": true, "nullable": true }, "delivery_status": { "type": "string", "readOnly": true }, "delivered_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "cancelled_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "responded_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "response": { "readOnly": true, "nullable": true }, "has_attachment": { "type": "boolean", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "actor_email", "cancelled_at", "created_at", "delivered_at", "delivery_status", "expires_at", "has_attachment", "language", "purpose", "recipient", "responded_at", "response", "uuid" ] }, "CustomerMessagingCaseRequestPublic": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "purpose": { "$ref": "#/components/schemas/CustomerMessagingPurposeEnum" }, "language": { "$ref": "#/components/schemas/CustomerMessagingLanguageEnum" }, "expires_at": { "type": "string", "format": "date-time" }, "responded_at": { "type": "string", "format": "date-time", "nullable": true }, "copy": { "type": "object", "additionalProperties": {} }, "organization_name": { "type": "string" }, "is_white_label": { "type": "boolean" }, "customization": { "type": "object", "additionalProperties": {}, "nullable": true } }, "required": [ "copy", "customization", "expires_at", "is_white_label", "language", "organization_name", "purpose", "request_id", "responded_at" ] }, "RoutingPublicationFieldEnum": { "enum": [ "source", "priority", "tags" ], "type": "string", "description": "* `source` - source\n* `priority` - priority\n* `tags` - tags" }, "RoutingPublicationCaseRoutingRule": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "priority": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingPublicationRoutingCondition" } }, "required_skills": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "maxItems": 25 }, "blueprint": { "type": "string", "format": "uuid" }, "blueprint_name": { "type": "string", "readOnly": true }, "team": { "type": "string", "format": "uuid", "nullable": true }, "team_name": { "type": "string", "readOnly": true }, "is_active": { "type": "boolean" }, "version": { "type": "integer", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "blueprint", "blueprint_name", "conditions", "created_at", "name", "team_name", "updated_at", "uuid", "version" ] }, "CaseActionStatusEnum": { "enum": [ "APPLIED", "FAILED" ], "type": "string", "description": "* `APPLIED` - Aplicado\n* `FAILED` - Fallido" }, "FraudCheckModuleSelectionRequest": { "type": "object", "properties": { "include": { "type": "array", "items": { "$ref": "#/components/schemas/FraudExcludeEnum" } }, "exclude": { "type": "array", "items": { "$ref": "#/components/schemas/FraudExcludeEnum" } } } }, "SignatureField": { "type": "object", "description": "Un campo que se coloca en un documento de la sesión: qué firmante lo completa, cómo y dónde. Indica una posición (`page`, `x`, `y`, `width` y `height`) o un `anchor`. Las posiciones son fracciones de la página tal como se muestra, desde su esquina superior izquierda, redondeadas a 4 decimales, y el campo debe caber dentro de la página. Un documento admite hasta 200 campos y un firmante hasta 500, y cada rol con campos en un documento necesita allí un campo `signature` o `initials`. Consulta [Campos en el documento](/es/core-technology/electronic-signature/overview#campos-en-el-documento).", "required": [ "key", "type" ], "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$", "description": "Da nombre al campo en los resultados y en `sign.field_values`. Único dentro del documento." }, "type": { "type": "string", "enum": [ "signature", "initials", "full_name", "date_signed", "text", "checkbox", "email", "data" ], "description": "Qué contiene el campo. El firmante aplica su `signature` e `initials` adoptadas, escribe en `text`, marca un `checkbox` y escribe un `email` cuando la sesión no tiene un correo electrónico verificado. Didit rellena `full_name` (el nombre verificado), `date_signed` (la fecha de la firma, en la zona horaria del firmante), `data` (a partir de `prefill`) y un `email` verificado, y los muestra como de solo lectura. No existe un tipo selector de fecha: usa `text`." }, "role": { "type": "string", "enum": [ "verified_person", "legal_representative", "key_people" ], "description": "Quién rellena el campo, con los valores de `signature_signer`. Un paso solo rellena y sella los campos de su propio firmante. El valor predeterminado es el firmante del paso." }, "page": { "type": "integer", "minimum": 1, "description": "Número de página, de 1 al número de páginas del documento. En un documento de Word, una página del PDF convertido." }, "x": { "type": "number", "minimum": 0, "maximum": 1, "description": "Borde izquierdo, como fracción del ancho de la página." }, "y": { "type": "number", "minimum": 0, "maximum": 1, "description": "Borde superior, como fracción de la altura de la página." }, "width": { "type": "number", "minimum": 0.02, "maximum": 1, "description": "Ancho, como fracción del ancho de la página. Una firma tiene un ancho mínimo de `0.12`." }, "height": { "type": "number", "minimum": 0.012, "maximum": 1, "description": "Altura, como fracción de la altura de la página. Una firma tiene una altura mínima de `0.035`." }, "anchor": { "$ref": "#/components/schemas/SignatureFieldAnchor" }, "required": { "type": "boolean", "description": "`signature` and `initials` are required unless you set `false`. `full_name`, `date_signed` and `data` are always required. The signer can't finish a document until its required fields have a value, and a required checkbox must be ticked." }, "label": { "type": "string", "minLength": 1, "maxLength": 80, "description": "Se muestra al firmante y en los resultados. El valor predeterminado depende del tipo." }, "placeholder": { "type": "string", "nullable": true, "maxLength": 80, "description": "Solo `text` y `email`." }, "validation": { "$ref": "#/components/schemas/SignatureFieldValidation" }, "prefill": { "type": "string", "nullable": true, "description": "Origen del valor: `identity.full_name`, `identity.first_name`, `identity.last_name`, `identity.date_of_birth` (`DD/MM/YYYY`), `identity.nationality`, `identity.document_number`, `identity.document_type`, `identity.issuing_country`, `identity.address`, `contact.email`, `contact.phone`, `company.name`, `company.registration_number`, `company.address`, `company.country` (KYB), `session.vendor_data`, `metadata.` (una clave del `metadata` de la sesión) o `api.` (una clave de `sign.field_values`). Obligatorio para `data`. `full_name` siempre usa `identity.full_name` y `email` usa `contact.email`. Los valores de los campos `data`, `full_name` y `email` verificado quedan fijados cuando el firmante empieza a firmar." }, "editable_when_prefilled": { "type": "boolean", "default": false, "description": "Solo `text` y `email`: el firmante puede cambiar un valor prellenado." }, "checked_by_default": { "type": "boolean", "default": false, "description": "Solo `checkbox`: la casilla aparece marcada de inicio." }, "date_format": { "type": "string", "enum": [ "DD/MM/YYYY", "MM/DD/YYYY", "YYYY-MM-DD", "D MMMM YYYY" ], "default": "DD/MM/YYYY", "description": "Solo `date_signed`." } } }, "SessionSignDocument": { "type": "object", "required": [ "file_name", "content_base64" ], "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Título que se muestra al firmante. Valor predeterminado: `file_name`." }, "file_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Nombre de archivo, terminado en `.pdf` o `.docx`." }, "content_base64": { "type": "string", "format": "byte", "description": "El archivo, codificado en base64. Un PDF puede tener hasta 20 MB y 100 páginas, sin contraseña, scripts ni archivos adjuntos. Un archivo de Word (`.docx`) puede tener hasta 20 MB y se convierte a PDF mientras se ejecuta la solicitud, en 25 segundos como máximo; después, el PDF tiene los mismos límites. Hasta 5 archivos de Word por sesión. Un archivo de Word con macros, control de cambios, vínculos a contenido externo u objetos incrustados se rechaza con `signature_document_not_supported`, y uno que no se puede convertir devuelve `signature_document_conversion_failed`, en ambos casos con un `reason`." }, "fields": { "type": "array", "description": "Campos opcionales que se colocan en este documento, hasta 200. Las páginas y posiciones se refieren al PDF o, en el caso de un archivo Word, al PDF convertido. Sin campos, el firmante lee el documento y da su conformidad.", "items": { "$ref": "#/components/schemas/SignatureField" }, "maxItems": 200 } } }, "SignatureResult": { "type": "object", "description": "El resultado de un firmante para un paso de Firma electrónica. Consulta el [informe de Firma electrónica](/es/core-technology/electronic-signature/report-electronic-signature).", "properties": { "id": { "type": "string", "format": "uuid", "description": "Pásalo como `signature_id` para descargar la evidencia de este firmante o validar su firma." }, "node_id": { "type": "string", "description": "El paso del flujo que lo generó." }, "status": { "type": "string", "enum": [ "intro", "review", "code", "signing", "signed", "declined" ], "description": "En qué punto del paso se encuentra el firmante. Solo `signed` significa que los documentos están firmados." }, "verdict": { "type": "string", "enum": [ "Not Finished", "Approved", "In Review", "Declined" ], "description": "El resultado del paso. Una advertencia lo establece mediante su regla; las reglas de estado personalizadas se aplican después." }, "level": { "type": "string", "enum": [ "simple", "aes", "qes" ], "description": "`simple` (predeterminado) o `aes`. `qes` (firma electrónica cualificada, QES) es un complemento que aún no está disponible." }, "format": { "type": "string", "enum": [ "pdf", "pades" ], "description": "`pdf` para una firma simple, `pades` para la avanzada (AES)." }, "profile": { "type": "string", "nullable": true, "description": "`PAdES-B-LT` una vez firmada una firma avanzada (AES); en caso contrario, null." }, "signer": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "El nombre del firmante. Está verificado (a partir de la verificación de identidad aprobada o de la sesión), salvo en el nivel Simple sin un nombre de sesión verificado, donde es el nombre que escribió el firmante y no está verificado." }, "capacity": { "type": "string", "enum": [ "self", "company" ] }, "company": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true, "description": "El cargo de la persona clave, tal como se declaró." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Los roles estructurados de la persona clave, tal como se declararon para la empresa." }, "identity_session_id": { "type": "string", "format": "uuid", "description": "La sesión de KYC que verificó al firmante." } } }, "identity_used": { "type": "object", "description": "La identidad verificada en la que se basa la firma. Vacío para una firma Simple sin identidad verificada.", "properties": { "session_id": { "type": "string", "format": "uuid" }, "kyc_id": { "type": "string", "format": "uuid", "nullable": true }, "verified": { "type": "boolean" }, "expected_name": { "type": "string", "nullable": true, "description": "El nombre con el que debía coincidir el firmante." } } }, "certificate": { "type": "object", "nullable": true, "description": "El certificado con el que se firmaron los documentos. `null` hasta que se firman, y siempre `null` en una firma simple.", "properties": { "issuer": { "type": "string" }, "issued_to": { "type": "string" }, "serial": { "type": "string", "description": "Número de serie, en hexadecimal." }, "valid_from": { "type": "string", "format": "date-time" }, "valid_until": { "type": "string", "format": "date-time" } } }, "confirmation": { "type": "object", "properties": { "channel": { "type": "string", "nullable": true, "enum": [ "email", "sms" ], "description": "`null` para una firma simple, que no tiene código." }, "destination": { "type": "string", "nullable": true, "description": "El contacto enmascarado al que se envió el código." }, "confirmed_at": { "type": "string", "format": "date-time", "nullable": true }, "attempts": { "type": "integer", "description": "Códigos introducidos, incluido el correcto." } } }, "timestamp": { "type": "object", "nullable": true, "description": "La marca de tiempo RFC 3161 de la firma, emitida por Didit. Es `null` hasta que se firma, y siempre `null` en una firma simple.", "properties": { "time": { "type": "string", "format": "date-time" }, "qualified": { "type": "boolean", "description": "Siempre `false` para AES." }, "valid": { "type": "boolean" } } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "El documento de la copia de este firmante. Úsalo para descargar el archivo firmado." }, "uuid": { "type": "string", "format": "uuid", "description": "Igual que `id`." }, "title": { "type": "string" }, "file_name": { "type": "string" }, "pages": { "type": "integer", "description": "Páginas del documento firmadas. En Word, del PDF convertido." }, "size_bytes": { "type": "integer" }, "sha256_original": { "type": "string", "description": "SHA-256 del documento tal como se le mostró al firmante." }, "sha256_signed": { "type": "string", "nullable": true, "description": "SHA-256 del PDF firmado, una vez firmado." }, "status": { "type": "string", "enum": [ "signed", "declined", "not_signed", "not_reached" ], "description": "`not_signed`: abierto pero no firmado. `not_reached`: nunca se abrió." }, "opened_at": { "type": "string", "format": "date-time", "nullable": true }, "read_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que el firmante llegó al final de un documento sin campos, cuando el paso lo exige." }, "read_to_end": { "type": "boolean" }, "consented_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que el firmante aceptó un documento sin campos, o completó los campos de un documento con campos." }, "consent": { "type": "boolean" }, "signed_file": { "type": "string", "nullable": true, "description": "Ruta del PDF firmado, una vez firmado. Consulta [Descargar un documento firmado](/es/sessions-api/electronic-signature/download-signed-document)." }, "mode": { "type": "string", "enum": [ "fields", "read_and_agree" ], "description": "`fields` para un documento con campos, `read_and_agree` para un documento sin campos." }, "source_format": { "type": "string", "enum": [ "pdf", "docx" ], "description": "`pdf`, o `docx` para un documento de Word que Didit convirtió a PDF." }, "conversion": { "type": "object", "nullable": true, "description": "`null` para un PDF. Para un documento de Word, el archivo original y la conversión.", "properties": { "from": { "type": "string", "enum": [ "docx" ] }, "file_name": { "type": "string", "description": "El nombre original de tu archivo de Word." }, "sha256": { "type": "string", "description": "SHA-256 de tu archivo de Word original." }, "size_bytes": { "type": "integer", "description": "Tamaño de tu archivo de Word original." }, "converter": { "type": "string", "description": "Versión del conversor que generó el PDF." } } }, "fields": { "type": "array", "description": "Campos del documento, con sus valores. Vacío para un documento sin campos.", "items": { "$ref": "#/components/schemas/SignatureFieldResult" } } } } }, "adopted_signature": { "type": "object", "nullable": true, "description": "La firma y las iniciales que adoptó el firmante para los campos de firma e iniciales. `null` hasta que el firmante adopte una.", "properties": { "method": { "type": "string", "enum": [ "typed", "drawn" ], "description": "`typed`: el nombre verificado con un estilo de escritura a mano. `drawn`: dibujada con el dedo o con el ratón (mouse)." }, "font": { "type": "string", "nullable": true, "description": "El estilo de escritura a mano de una firma escrita con teclado. `null` cuando se dibuja." }, "adopted_at": { "type": "string", "format": "date-time" } } }, "electronic_signature_consent_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que el firmante aceptó, en la pantalla de revisión, firmar los documentos electrónicamente. Se establece cuando algún documento tiene campos." }, "evidence_file": { "type": "string", "nullable": true, "description": "Ruta del PDF de evidencia, una vez firmado. Consulta [Descargar la evidencia de la firma](/es/sessions-api/electronic-signature/download-evidence)." }, "warnings": { "type": "array", "description": "Advertencias generadas para este firmante. Consulta [Advertencias de firma electrónica](/es/core-technology/electronic-signature/warnings-electronic-signature).", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "SIGNATURE_DECLINED", "SIGNATURE_OTP_FAILED", "SIGNATURE_NAME_MISMATCH", "SIGNATURE_IDENTITY_NOT_VERIFIED", "SIGNATURE_DOCUMENT_CHANGED", "SIGNATURE_FIELD_DATA_MISSING" ] }, "node_id": { "type": "string" } } } }, "validation": { "type": "object", "nullable": true, "description": "La última comprobación criptográfica de los documentos firmados. `null` hasta que se firman los documentos. Si Didit no puede confirmar el resultado de la firma, el valor es `{\"valid\": null, \"reason\": \"signature_provider_outcome_unknown\", \"checked_at\": ...}` y `status` se mantiene en `signing`: considéralo como no firmado.", "properties": { "valid": { "type": "boolean", "nullable": true, "description": "`true` cuando todos los documentos son válidos. `null` cuando no se pudo confirmar el resultado de la firma." }, "reason": { "type": "string", "description": "Se establece cuando `valid` es `null`: `signature_provider_outcome_unknown`." }, "checked_at": { "type": "string", "format": "date-time" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "checked_at": { "type": "string", "format": "date-time" }, "valid": { "type": "boolean", "description": "`true` cuando la firma y el sello de tiempo son válidos y de confianza." }, "integrity": { "type": "boolean", "description": "`true` cuando el documento no ha cambiado desde la firma." }, "trusted": { "type": "boolean", "description": "`true` cuando la cadena del certificado de firma llega a una raíz de confianza." }, "revoked": { "type": "boolean" }, "trusted_list": { "type": "object", "description": "Comprobación en la Lista de Confianza de la UE. Para AES: `{\"status\": \"not_applicable\", \"reason\": \"aes_not_qualified\"}`.", "properties": { "status": { "type": "string" }, "reason": { "type": "string" } } }, "certificate": { "type": "object", "nullable": true, "description": "El certificado con el que se firmaron los documentos. `null` hasta que se firman, y siempre `null` en una firma simple.", "properties": { "issuer": { "type": "string" }, "issued_to": { "type": "string" }, "serial": { "type": "string", "description": "Número de serie, en hexadecimal." }, "valid_from": { "type": "string", "format": "date-time" }, "valid_until": { "type": "string", "format": "date-time" } } }, "timestamp": { "type": "object", "nullable": true, "description": "La marca de tiempo RFC 3161 de la firma, emitida por Didit. Es `null` hasta que se firma, y siempre `null` en una firma simple.", "properties": { "time": { "type": "string", "format": "date-time" }, "qualified": { "type": "boolean", "description": "Siempre `false` para AES." }, "valid": { "type": "boolean" } } } } } } } }, "declined_at": { "type": "string", "format": "date-time", "nullable": true }, "declined_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ] }, "signed_at": { "type": "string", "format": "date-time", "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "description": "Fecha y hora en que el enlace de firma deja de funcionar." }, "email_sent_at": { "type": "string", "format": "date-time", "nullable": true }, "email_unavailable_reason": { "type": "string", "nullable": true }, "ip_address": { "type": "string", "nullable": true, "description": "La dirección IP del firmante cuando solicitó su código." }, "place": { "type": "string", "nullable": true, "description": "No se recopila: siempre es `null`." }, "place_unavailable_reason": { "type": "string", "nullable": true, "enum": [ "not_collected" ] } } }, "SignatureFieldValidation": { "type": "object", "nullable": true, "description": "Reglas para el valor de un campo `text`. La vista previa de la consola, el flujo de firma y la API aplican las mismas reglas.", "properties": { "kind": { "type": "string", "enum": [ "any", "letters", "number", "email", "pattern" ], "description": "`letters`: letras de cualquier alfabeto, espacios, guiones y apóstrofos. `number`: dígitos con un separador decimal opcional. `pattern`: el valor debe coincidir con `pattern`." }, "min_length": { "type": "integer", "minimum": 0, "maximum": 500, "description": "Desde `0` hasta `max_length`." }, "max_length": { "type": "integer", "minimum": 1, "maximum": 500, "default": 120 }, "pattern": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 200, "description": "Obligatorio con `kind: \"pattern\"`. Una expresión regular con la que debe coincidir el valor completo. No se admiten lookarounds ni referencias inversas." }, "message": { "type": "string", "nullable": true, "maxLength": 120, "description": "Se muestra al firmante en lugar del error predeterminado." } } }, "SignatureFieldAnchor": { "type": "object", "description": "Coloca un campo mediante un fragmento de texto del documento en lugar de en una posición. Didit no elimina el texto del PDF, así que escríbelo del mismo color que el fondo de la página. Si no se encuentra el texto, la llamada devuelve `400` con `field_anchor_not_found`. Consulta [Colocar campos mediante texto de anclaje](/es/sessions-api/create-session#colocar-campos-por-texto-de-anclaje).", "required": [ "text" ], "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 64, "description": "Texto que se busca en el documento. En un archivo de Word, se busca en el PDF convertido." }, "occurrence": { "type": "string", "enum": [ "first", "all" ], "default": "first", "description": "`all` coloca un campo por coincidencia; las claves posteriores a la primera reciben `_2`, `_3`, etc." }, "offset_x": { "type": "number", "description": "Se suma al borde izquierdo del texto, como fracción del ancho de la página." }, "offset_y": { "type": "number", "description": "Se suma al borde superior del texto, como fracción de la altura de la página." }, "width": { "type": "number", "minimum": 0.02, "maximum": 1, "description": "Ancho del campo, como fracción del ancho de la página." }, "height": { "type": "number", "minimum": 0.012, "maximum": 1, "description": "Altura del campo, como fracción de la altura de la página." } } }, "SignatureFieldResult": { "type": "object", "description": "Un campo de un documento firmado, con su valor en la copia de este firmante. Consulta [Campos](/es/core-technology/electronic-signature/report-electronic-signature#campos).", "properties": { "key": { "type": "string", "description": "La clave del campo, tal como se usa en `sign.field_values`." }, "type": { "type": "string", "enum": [ "signature", "initials", "full_name", "date_signed", "text", "checkbox", "email", "data" ] }, "role": { "type": "string", "enum": [ "verified_person", "legal_representative", "key_people" ] }, "label": { "type": "string" }, "page": { "type": "integer", "description": "Número de página, a partir de 1. En un documento de Word, una página del PDF convertido." }, "x": { "type": "number", "description": "Borde izquierdo, como fracción del ancho de la página." }, "y": { "type": "number", "description": "Borde superior, como fracción de la altura de la página." }, "width": { "type": "number", "description": "Ancho, como fracción del ancho de la página." }, "height": { "type": "number", "description": "Altura, como fracción de la altura de la página." }, "required": { "type": "boolean" }, "value": { "nullable": true, "description": "Una cadena para `text`, `email`, `full_name`, `date_signed` y `data`, un booleano para un `checkbox`, y `true` para una firma o unas iniciales aplicadas. `null` cuando está vacío." }, "display_value": { "type": "string", "nullable": true, "description": "El valor tal como se estampa en la página: fechas en el `date_format` del campo, `Yes` o `No` para una casilla de verificación, `Signed` para una firma o unas iniciales." }, "value_source": { "type": "string", "nullable": true, "enum": [ "signer", "identity", "contact", "company", "session", "metadata", "api", "signing_time", null ], "description": "Origen del valor: `signer` (escrito, marcado o aplicado por el firmante), `identity` (el documento de identidad verificado), `contact` (el correo electrónico o teléfono verificado), `company` (la empresa verificada), `session` (`vendor_data`), `metadata`, `api` (`sign.field_values`) o `signing_time` (la fecha de firma)." }, "filled_at": { "type": "string", "format": "date-time", "nullable": true }, "image_url": { "type": "string", "nullable": true, "description": "Solo firma e iniciales: la ruta de la imagen aplicada. Consulta [Descargar una imagen de firma](/es/sessions-api/electronic-signature/download-field-image)." }, "value_unavailable_reason": { "type": "string", "nullable": true, "enum": [ "source_empty", null ], "description": "`source_empty` cuando un campo prellenado no tenía valor en la sesión y `signature_field_data_missing_action` permitió que el firmante firmara de todos modos." } } }, "VaspDirectoryWidgetEntry": { "type": "object", "description": "Lo que muestra el selector de VASP del usuario final: quién es el VASP y si se puede contactar.", "properties": { "id": { "type": "string", "format": "uuid", "description": "El id de la entrada, para GET /v3/travel-rule/vasps/{vasp_id}/." }, "kind": { "type": "string", "enum": [ "directory", "didit" ], "description": "directory para una entrada del directorio compartido; didit para un miembro de la red de Didit." }, "name": { "type": "string" }, "lei": { "type": "string" }, "jurisdiction": { "type": "string", "description": "Código de país ISO 3166, tal como lo proporciona la fuente." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Los dominios web del VASP. Siempre vacío para los miembros de la red de Didit." }, "reachable": { "type": "boolean", "description": "Indica si tu aplicación tiene una ruta disponible hacia este VASP o, en el caso de una marca, hacia una de sus entidades. Siempre es true para un miembro de la red de Didit." } } }, "TravelRuleDataSharingFields": { "type": "object", "description": "Los campos que Didit envía a la VASP contraparte sobre tus propios usuarios, por tipo de entidad. El `name` y la `wallet_address` se envían siempre, diga lo que diga la lista. Un tipo de entidad que nunca elegiste comparte todos los campos. Una lista vacía también es una elección: solo comparte el nombre y la wallet.", "properties": { "individual": { "type": "array", "items": { "type": "string", "enum": [ "name", "wallet_address", "address", "national_id", "customer_identification", "date_of_birth", "place_of_birth" ] }, "description": "Campos compartidos sobre una persona física." }, "company": { "type": "array", "items": { "type": "string", "enum": [ "name", "wallet_address", "address", "national_id", "customer_identification" ] }, "description": "Campos compartidos sobre una persona jurídica." } } }, "TravelRuleMatchingRules": { "type": "object", "description": "Con qué rigor se compara cada campo de los datos de la contraparte con los que tienes, por tipo de entidad. Un campo que omitas conserva su valor predeterminado. `NONE` omite la comparación, `STRICT` exige exactamente las mismas palabras, `CONTAINS` acepta un valor cuyas palabras aparezcan todas en el otro, `DEFAULT` es la coincidencia estándar por subconjunto y `FUZZY` acepta grafías parecidas (y, en las fechas de nacimiento, el día y el mes intercambiados).", "properties": { "individual": { "type": "object", "description": "Reglas para una persona física.", "properties": { "name": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Valor predeterminado: sigue `name_matching_strictness`." }, "date_of_birth": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Valor predeterminado: `NONE`." }, "address": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Valor predeterminado: `NONE`." }, "account": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "La wallet por la que se enrutó el intercambio. Valor predeterminado: `STRICT`." } } }, "company": { "type": "object", "description": "Reglas para una persona jurídica.", "properties": { "name": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Valor predeterminado: sigue `name_matching_strictness`." }, "address": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Valor predeterminado: `NONE`." }, "account": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "La wallet por la que se enrutó el intercambio. Valor predeterminado: `STRICT`." } } } } }, "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." } } }, "TravelRuleMessageAttachment": { "type": "object", "nullable": true, "description": "El documento adjunto a un mensaje, almacenado como cualquier otro documento de transacción.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "label": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true }, "uploaded_by": { "type": "string", "nullable": true, "description": "Quién lo adjuntó. En el portal de recogida, un archivo que enviaste muestra el nombre de tu VASP, nunca la persona ni la clave de API que hay detrás." }, "created_at": { "type": "string", "format": "date-time" }, "files": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "file_url": { "type": "string", "nullable": true, "description": "URL de descarga de validez limitada." }, "original_filename": { "type": "string" }, "file_size": { "type": "integer" } } } } } }, "TravelRuleMessage": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "MESSAGE", "DOCUMENT_REQUEST" ] }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "`OUTBOUND` es lo que envió el propio lado de quien lee. En el portal de recogida, la dirección se considera desde el lado de la contraparte." }, "author": { "type": "string", "description": "Quién lo escribió en su propio lado: el correo electrónico de un usuario de la consola o la etiqueta de una clave de API, o el nombre del otro VASP." }, "body": { "type": "string" }, "requested_documents": { "type": "array", "items": { "type": "string" }, "description": "Qué pide un DOCUMENT_REQUEST, en palabras del solicitante." }, "reply_to": { "type": "string", "format": "uuid", "nullable": true }, "fulfilled_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Se establece en un DOCUMENT_REQUEST cuando una respuesta a esa solicitud incluye un documento." }, "attachment": { "$ref": "#/components/schemas/TravelRuleMessageAttachment" }, "created_at": { "type": "string", "format": "date-time" } } }, "TravelRuleMessageCreateRequest": { "type": "object", "description": "Envíalo como JSON, o como multipart/form-data con los archivos adjuntos en `files`.", "properties": { "kind": { "type": "string", "enum": [ "MESSAGE", "DOCUMENT_REQUEST" ], "default": "MESSAGE" }, "body": { "type": "string", "maxLength": 5000, "description": "Obligatorio para un MESSAGE salvo que se adjunte un archivo." }, "requested_documents": { "type": "array", "items": { "type": "string", "maxLength": 255 }, "maxItems": 10, "description": "Obligatorio (al menos uno) para un DOCUMENT_REQUEST, y solo se permite ahí." }, "reply_to": { "type": "string", "format": "uuid", "nullable": true, "description": "Un mensaje de la misma transferencia. Una respuesta que incluye un documento atiende la solicitud de documento a la que responde." }, "files": { "type": "array", "items": { "type": "string", "format": "binary" }, "maxItems": 5, "description": "Solo multipart. Hasta 5 archivos de 10 MB cada uno." } } }, "SessionDeletionJob": { "type": "object", "description": "Una eliminación masiva de sesiones que se ejecuta en segundo plano: progreso y recuentos por resultado, nunca qué sesiones eliminó.", "properties": { "job_id": { "type": "string", "format": "uuid", "description": "Consulta periódicamente `GET /v3/sessions/delete/{job_id}/` con este id." }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ], "description": "`PENDING`: aceptado, aún no ha comenzado. `PROCESSING`: eliminando; `processed` y `outcomes` se están actualizando. `COMPLETED`: se han contabilizado todas las sesiones seleccionadas. `FAILED`: el trabajo se detuvo antes de tiempo; consulta `error`." }, "total": { "type": "integer", "description": "Sesiones seleccionadas cuando se solicitó la eliminación." }, "processed": { "type": "integer", "description": "Sesiones que el trabajo ha terminado de procesar hasta el momento." }, "outcomes": { "type": "object", "description": "Cuántas sesiones terminaron con cada resultado. Todas las claves están siempre presentes.", "properties": { "deleted": { "type": "integer", "description": "Sesiones eliminadas junto con su embedding facial." }, "none": { "type": "integer", "description": "Sesiones eliminadas que no tenían embedding facial." }, "retained_with_user": { "type": "integer", "description": "Sesiones eliminadas mientras se conservaba una plantilla biométrica sin imágenes para su Usuario, según lo indicado en la solicitud o en la política de la aplicación." }, "ineligible_no_vendor_user": { "type": "integer", "description": "Sesiones eliminadas, junto con su embedding facial, porque se solicitó la retención pero no tenían un Usuario vinculado." }, "failed_retryable": { "type": "integer", "description": "Sesiones notificadas como no eliminadas. Un trabajo reintenta por sí mismo un grupo que no pudo eliminar en lugar de contabilizarlo aquí." }, "already_deleted": { "type": "integer", "description": "Sesiones seleccionadas que ya estaban eliminadas, por ejemplo por otra solicitud, cuando el proceso llegó a ellas." } } }, "deleted_child_verifications": { "type": "integer", "description": "Verificaciones creadas por las verificaciones de empresas eliminadas, que se eliminaron junto con ellas. Siempre es `0` en un trabajo iniciado con `POST /v3/sessions/delete/`, que solo elimina sesiones KYC." }, "error": { "type": "string", "nullable": true, "description": "`null` salvo que `status` sea `FAILED`; en ese caso, el motivo por el que se detuvo la eliminación. Las sesiones a las que el trabajo no había llegado siguen existiendo: repite la solicitud para eliminarlas." }, "created_at": { "type": "string", "format": "date-time", "description": "Cuándo se solicitó la eliminación." }, "completed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que terminó el trabajo; `null` mientras se ejecuta." } } }, "EntityStatusUpdateRequest": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Nuevo estado del ciclo de vida. `BLOCKED` también añade el `vendor_data` a la lista de bloqueo del sistema." } } }, "AMLMonitoringToggleResult": { "oneOf": [ { "type": "object", "required": [ "users_total", "already_enabled", "with_existing_aml", "needing_screening", "skipped_no_identity_data", "skipped_blocked", "estimated_screening_cost_usd", "estimated_annual_monitoring_cost_usd", "balance_sufficient", "unmatched" ], "description": "Vista previa del coste. Se devuelve directamente cuando estimate_only es true (no se escribe nada).", "properties": { "users_total": { "type": "integer", "description": "Perfiles que coinciden con la selección." }, "already_enabled": { "type": "integer", "description": "Perfiles ya monitorizados (no hay nada que hacer al activar; son los que se desactivan al desactivar)." }, "with_existing_aml": { "type": "integer", "description": "Perfiles cuyo análisis AML existente pasará a estar monitorizado (sin un nuevo análisis)." }, "needing_screening": { "type": "integer", "description": "Perfiles sin ningún análisis AML que se analizarán primero (se factura como un análisis AML normal)." }, "skipped_no_identity_data": { "type": "integer", "description": "Perfiles que no se pueden analizar porque faltan datos de identidad." }, "skipped_blocked": { "type": "integer", "description": "Usuarios bloqueados que se omitirán (siempre 0 para empresas)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Costo único de los nuevos análisis." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Coste anual de monitorización de los perfiles que pasarán a estar monitorizados." }, "balance_sufficient": { "type": "boolean", "description": "Si el saldo de la organización cubre el análisis más el primer año de monitorización." }, "unmatched": { "type": "array", "items": { "type": "string" }, "description": "Identificadores de la solicitud que no coincidieron con ningún perfil de esta aplicación, exactamente como se enviaron." } } }, { "type": "object", "required": [ "job_id", "status", "is_enabled", "target_type", "total", "processed", "outcomes", "results", "error", "created_at", "completed_at", "estimate", "unmatched" ], "properties": { "job_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ] }, "is_enabled": { "type": "boolean", "description": "true cuando el trabajo activa la monitorización, false cuando la desactiva." }, "target_type": { "type": "string", "enum": [ "user", "business" ], "description": "Qué familia de perfiles activa o desactiva el trabajo." }, "total": { "type": "integer", "description": "Perfiles que procesa el trabajo." }, "processed": { "type": "integer", "description": "Perfiles procesados hasta el momento." }, "outcomes": { "type": "object", "description": "Contadores de resultados por registro. Cada perfil seleccionado corresponde exactamente a un contador; no se omite nada de forma silenciosa.", "properties": { "enabled": { "type": "integer", "description": "Monitorización activada en un análisis AML existente." }, "screened_and_enabled": { "type": "integer", "description": "Se creó un nuevo análisis AML (facturado) y se activó la monitorización en él." }, "already_enabled": { "type": "integer", "description": "La monitorización ya estaba activa; no se cambió nada y no se facturó nada." }, "disabled": { "type": "integer", "description": "Monitorización desactivada en todos los análisis AML del perfil." }, "skipped_no_identity_data": { "type": "integer", "description": "Omitido: al perfil le faltan el nombre completo, la fecha de nacimiento y el país (usuarios) o un nombre (empresas) necesarios para el análisis." }, "skipped_blocked": { "type": "integer", "description": "Omitido: el usuario está bloqueado." }, "skipped_sandbox": { "type": "integer", "description": "Omitido: aplicación de sandbox, no se crea ningún análisis." }, "failed_provider": { "type": "integer", "description": "No se pudo completar el análisis; reinténtalo más tarde." }, "failed_insufficient_balance": { "type": "integer", "description": "El saldo se agotó mientras se ejecutaba el trabajo." } } }, "results": { "type": "array", "description": "Una entrada por perfil procesado, en orden de procesamiento. Crece mientras se ejecuta el trabajo; está completa cuando el estado es COMPLETED. Se registra para los trabajos iniciados a través de la API.", "items": { "type": "object", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "ID interno de Didit del perfil." }, "vendor_data": { "type": "string", "nullable": true, "description": "Tu propio identificador del perfil." }, "outcome": { "type": "string", "enum": [ "enabled", "screened_and_enabled", "already_enabled", "disabled", "skipped_no_identity_data", "skipped_blocked", "skipped_sandbox", "failed_provider", "failed_insufficient_balance" ] } } } }, "error": { "type": "string", "nullable": true, "description": "Mensaje de error genérico cuando el estado es FAILED; la causa detallada se conserva en la plataforma." }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "estimate": { "type": "object", "description": "Vista previa del coste. Se devuelve directamente cuando estimate_only es true (no se escribe nada).", "properties": { "users_total": { "type": "integer", "description": "Perfiles que coinciden con la selección." }, "already_enabled": { "type": "integer", "description": "Perfiles ya monitorizados (no hay nada que hacer al activar; son los que se desactivan al desactivar)." }, "with_existing_aml": { "type": "integer", "description": "Perfiles cuyo análisis AML existente pasará a estar monitorizado (sin un nuevo análisis)." }, "needing_screening": { "type": "integer", "description": "Perfiles sin ningún análisis AML que se analizarán primero (se factura como un análisis AML normal)." }, "skipped_no_identity_data": { "type": "integer", "description": "Perfiles que no se pueden analizar porque faltan datos de identidad." }, "skipped_blocked": { "type": "integer", "description": "Usuarios bloqueados que se omitirán (siempre 0 para empresas)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Costo único de los nuevos análisis." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Coste anual de monitorización de los perfiles que pasarán a estar monitorizados." }, "balance_sufficient": { "type": "boolean", "description": "Si el saldo de la organización cubre el análisis más el primer año de monitorización." } } }, "unmatched": { "type": "array", "items": { "type": "string" }, "description": "Identificadores de la solicitud que no coincidieron con ningún perfil de esta aplicación, exactamente como se enviaron. No forman parte del trabajo." } } } ] }, "AMLMonitoringJob": { "type": "object", "properties": { "job_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ] }, "is_enabled": { "type": "boolean", "description": "true cuando el trabajo activa la monitorización, false cuando la desactiva." }, "target_type": { "type": "string", "enum": [ "user", "business" ], "description": "Qué familia de perfiles activa o desactiva el trabajo." }, "total": { "type": "integer", "description": "Perfiles que procesa el trabajo." }, "processed": { "type": "integer", "description": "Perfiles procesados hasta el momento." }, "outcomes": { "type": "object", "description": "Contadores de resultados por registro. Cada perfil seleccionado corresponde exactamente a un contador; no se omite nada de forma silenciosa.", "properties": { "enabled": { "type": "integer", "description": "Monitorización activada en un análisis AML existente." }, "screened_and_enabled": { "type": "integer", "description": "Se creó un nuevo análisis AML (facturado) y se activó la monitorización en él." }, "already_enabled": { "type": "integer", "description": "La monitorización ya estaba activa; no se cambió nada y no se facturó nada." }, "disabled": { "type": "integer", "description": "Monitorización desactivada en todos los análisis AML del perfil." }, "skipped_no_identity_data": { "type": "integer", "description": "Omitido: al perfil le faltan el nombre completo, la fecha de nacimiento y el país (usuarios) o un nombre (empresas) necesarios para el análisis." }, "skipped_blocked": { "type": "integer", "description": "Omitido: el usuario está bloqueado." }, "skipped_sandbox": { "type": "integer", "description": "Omitido: aplicación de sandbox, no se crea ningún análisis." }, "failed_provider": { "type": "integer", "description": "No se pudo completar el análisis; reinténtalo más tarde." }, "failed_insufficient_balance": { "type": "integer", "description": "El saldo se agotó mientras se ejecutaba el trabajo." } } }, "results": { "type": "array", "description": "Una entrada por perfil procesado, en orden de procesamiento. Crece mientras se ejecuta el trabajo; está completa cuando el estado es COMPLETED. Se registra para los trabajos iniciados a través de la API.", "items": { "type": "object", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "ID interno de Didit del perfil." }, "vendor_data": { "type": "string", "nullable": true, "description": "Tu propio identificador del perfil." }, "outcome": { "type": "string", "enum": [ "enabled", "screened_and_enabled", "already_enabled", "disabled", "skipped_no_identity_data", "skipped_blocked", "skipped_sandbox", "failed_provider", "failed_insufficient_balance" ] } } } }, "error": { "type": "string", "nullable": true, "description": "Mensaje de error genérico cuando el estado es FAILED; la causa detallada se conserva en la plataforma." }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "estimate": { "type": "object", "description": "Vista previa del coste. Se devuelve directamente cuando estimate_only es true (no se escribe nada).", "properties": { "users_total": { "type": "integer", "description": "Perfiles que coinciden con la selección." }, "already_enabled": { "type": "integer", "description": "Perfiles ya monitorizados (no hay nada que hacer al activar; son los que se desactivan al desactivar)." }, "with_existing_aml": { "type": "integer", "description": "Perfiles cuyo análisis AML existente pasará a estar monitorizado (sin un nuevo análisis)." }, "needing_screening": { "type": "integer", "description": "Perfiles sin ningún análisis AML que se analizarán primero (se factura como un análisis AML normal)." }, "skipped_no_identity_data": { "type": "integer", "description": "Perfiles que no se pueden analizar porque faltan datos de identidad." }, "skipped_blocked": { "type": "integer", "description": "Usuarios bloqueados que se omitirán (siempre 0 para empresas)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Costo único de los nuevos análisis." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Coste anual de monitorización de los perfiles que pasarán a estar monitorizados." }, "balance_sufficient": { "type": "boolean", "description": "Si el saldo de la organización cubre el análisis más el primer año de monitorización." } } }, "unmatched": { "type": "array", "items": { "type": "string" }, "description": "Identificadores de la solicitud que no coincidieron con ningún perfil de esta aplicación, exactamente como se enviaron. No forman parte del trabajo." } } }, "OngoingMonitoringToggleRequest": { "type": "object", "required": [ "is_enabled" ], "properties": { "is_enabled": { "type": "boolean", "description": "true para activar la monitorización, false para desactivarla." }, "estimate_only": { "type": "boolean", "default": false, "description": "Si es true, devuelve la estimación del costo y no realiza ninguna escritura." }, "update_all": { "type": "boolean", "default": false, "description": "Aplicar a todas las entidades de la aplicación (acotado por los parámetros filter_* cuando estén presentes)." }, "filter_search": { "type": "string" }, "filter_status": { "type": "array", "items": { "type": "string" } }, "filter_country": { "type": "string" }, "filter_date_from": { "type": "string", "format": "date" }, "filter_date_to": { "type": "string", "format": "date" }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Entidades que se activarán o desactivarán. Obligatorio salvo que update_all sea true." } } }, "OngoingMonitoringJob": { "type": "object", "properties": { "job_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ] }, "is_enabled": { "type": "boolean" }, "total": { "type": "integer" }, "processed": { "type": "integer" }, "outcomes": { "type": "object", "description": "Contadores de resultados por entidad. Nada se omite sin aviso: cada entidad solicitada corresponde exactamente a un contador.", "properties": { "enabled": { "type": "integer", "description": "Monitorización activada en un análisis AML existente." }, "screened_and_enabled": { "type": "integer", "description": "Se creó un nuevo análisis AML (facturado) y se activó la monitorización." }, "already_enabled": { "type": "integer", "description": "La monitorización ya estaba activa (las filas duplicadas heredadas se consolidan)." }, "disabled": { "type": "integer", "description": "Monitorización desactivada en todas las filas AML de la entidad." }, "skipped_no_identity_data": { "type": "integer", "description": "Omitido: no hay nombre completo + fecha de nacimiento + país disponibles para el análisis." }, "skipped_blocked": { "type": "integer", "description": "Omitido: el usuario está bloqueado." }, "skipped_sandbox": { "type": "integer", "description": "Omitido: aplicación de sandbox." }, "failed_provider": { "type": "integer", "description": "Falló la llamada al proveedor de análisis." }, "failed_insufficient_balance": { "type": "integer", "description": "El saldo se agotó a mitad del trabajo." } } }, "error": { "type": "string", "nullable": true }, "estimate": { "type": "object", "description": "Vista previa del coste. Se devuelve directamente cuando estimate_only es true (no se realiza ninguna escritura).", "properties": { "users_total": { "type": "integer", "description": "Entidades de la selección." }, "already_enabled": { "type": "integer" }, "with_existing_aml": { "type": "integer", "description": "Entidades cuyo análisis AML existente pasará a estar monitorizado." }, "needing_screening": { "type": "integer", "description": "Entidades sin ningún análisis AML que se analizarán primero (con cargo)." }, "skipped_no_identity_data": { "type": "integer" }, "skipped_blocked": { "type": "integer" }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2 }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07 }, "balance_sufficient": { "type": "boolean" } } } } }, "OngoingMonitoringToggleResult": { "oneOf": [ { "type": "object", "description": "Vista previa del coste. Se devuelve directamente cuando estimate_only es true (no se realiza ninguna escritura).", "properties": { "users_total": { "type": "integer", "description": "Entidades de la selección." }, "already_enabled": { "type": "integer" }, "with_existing_aml": { "type": "integer", "description": "Entidades cuyo análisis AML existente pasará a estar monitorizado." }, "needing_screening": { "type": "integer", "description": "Entidades sin ningún análisis AML que se analizarán primero (con cargo)." }, "skipped_no_identity_data": { "type": "integer" }, "skipped_blocked": { "type": "integer" }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2 }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07 }, "balance_sufficient": { "type": "boolean" } } }, { "$ref": "#/components/schemas/OngoingMonitoringJob" } ] }, "CaseBlueprintPresetInstallResult": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string" } } } }, "CaseBulkUpdateResult": { "type": "object", "properties": { "updated": { "type": "integer" }, "failures": { "type": "array", "items": { "type": "object", "properties": { "case_uuid": { "type": "string", "format": "uuid" }, "detail": { "type": "string" } } } } } }, "RegulatoryReportList": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de filas coincidentes, limitado a 100 por rendimiento." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "EntityNetworkMembershipList": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/EntityNetworkMembership" } } } }, "SessionDecision": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "El identificador único de la sesión." }, "session_kind": { "type": "string", "enum": [ "user", "business" ], "description": "Discriminador que indica si se trata de una sesión de Verificación de usuarios (KYC) o de Verificación de empresas (KYB). Cuando es `user`, se aplican los arrays de funciones KYC (`id_verifications`, `nfc_verifications`, `liveness_checks`, `face_matches`, `poa_verifications`, `document_ai_documents`, `database_validations`, ...) y los arrays de empresa no aparecen. Cuando es `business`, el payload incluye en su lugar `registry_checks`, `document_verifications`, `key_people_checks` además de los arrays compartidos (`aml_screenings`, `phone_verifications`, `email_verifications`, `ip_analyses`, `questionnaire_responses`). **Se omite cuando se pasa `include=events`**: la estructura de eventos solo existe para sesiones de usuario, por lo que el discriminador se elimina de esa variante." }, "shared_from_session": { "type": "string", "format": "uuid", "nullable": true, "description": "En una sesión clonada con `POST /v3/session/import-shared/`: el `session_id` de la sesión original en la aplicación de origen. `null` en cualquier otra sesión. Se omite cuando se pasa `include=events`." }, "shared_from_session_number": { "type": "integer", "nullable": true, "description": "`session_number` de la sesión de origen cuando esta sesión se importó desde otra aplicación de tu organización. `null` en caso contrario." }, "session_number": { "type": "integer", "description": "El número de la sesión.", "nullable": true }, "session_url": { "type": "string", "format": "uri", "description": "La URL de la sesión.", "nullable": true }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Awaiting User", "In Review", "Approved", "Declined", "Resubmitted", "Expired", "Kyc Expired", "Abandoned" ], "description": "Estado global del ciclo de vida de la sesión: el resultado consolidado del flujo. Los valores finales son `Approved`, `Declined`, `In Review`, `Expired`, `Kyc Expired` y `Abandoned`; `Not Started`, `In Progress`, `Awaiting User` y `Resubmitted` indican que la sesión sigue avanzando por el flujo." }, "status_override": { "type": "object", "nullable": true, "description": "Presente cuando un revisor estableció `status` manualmente. `null` cuando el estado es el automático. Úsalo para distinguir una aprobación manual de una automática.", "properties": { "overridden_at": { "type": "string", "format": "date-time", "nullable": true }, "automatic_status": { "type": "string", "nullable": true, "description": "El estado que determinan las comprobaciones propias de la plataforma." } } }, "decision_trace": { "type": "object", "description": "Cómo se llegó al estado: quién lo estableció y qué advertencias lo provocaron.", "properties": { "status": { "type": "string", "description": "El estado de la sesión." }, "decided_by": { "type": "string", "nullable": true, "enum": [ "manual", "automatic", "investigator", null ], "description": "Quién estableció el estado. `null` mientras la sesión no tiene decisión." }, "decided_at": { "type": "string", "format": "date-time", "nullable": true }, "automatic_status": { "type": "string", "nullable": true, "description": "Lo que concluyen las comprobaciones propias de la plataforma, que difiere de `status` tras una decisión manual." }, "terminal_node_id": { "type": "string", "nullable": true, "description": "El nodo de estado del flujo que finalizó la sesión, si lo hubo." }, "actor": { "type": "object", "nullable": true, "description": "El revisor responsable de una decisión manual.", "properties": { "user": { "type": "string", "nullable": true }, "actor_type": { "type": "string", "nullable": true } } }, "warning_counts": { "type": "object", "description": "Advertencias por `log_type` (`error`, `warning`, `information`) y `total`.", "additionalProperties": { "type": "integer" } }, "status_warnings": { "type": "array", "description": "Las advertencias que establecen un estado `Declined` o `In Review`.", "items": { "type": "object", "properties": { "risk": { "type": "string" }, "feature": { "type": "string", "nullable": true }, "node_id": { "type": "string", "nullable": true }, "log_type": { "type": "string", "nullable": true }, "check_status": { "type": "string", "nullable": true }, "source": { "type": "string", "description": "La lista del payload de la que procede la advertencia, por ejemplo `id_verifications`." }, "short_description": { "type": "string", "nullable": true } } } } } }, "linked_records": { "type": "object", "nullable": true, "description": "Un resumen de otros registros vinculados a la sesión. `null` cuando no hay nada que mostrar, y en los flujos que declaran un estándar de verificación de edad.", "properties": { "same_face": { "type": "object", "nullable": true, "description": "Otras personas cuyo rostro coincidió en alguna de las búsquedas faciales de esta sesión.", "properties": { "count": { "type": "integer" }, "best_match": { "type": "object", "nullable": true, "properties": { "session_id": { "type": "string", "format": "uuid", "nullable": true }, "session_number": { "type": "integer", "nullable": true }, "vendor_user_id": { "type": "string", "format": "uuid", "nullable": true }, "similarity_percentage": { "type": "number", "nullable": true } } } } }, "earlier_verifications": { "type": "object", "nullable": true, "properties": { "count": { "type": "integer" }, "vendor_user_id": { "type": "string", "format": "uuid", "nullable": true } } }, "networks": { "type": "object", "nullable": true, "properties": { "count": { "type": "integer" }, "open": { "type": "integer" }, "dismissed": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "network_id": { "type": "string", "format": "uuid" }, "display_number": { "type": "integer", "nullable": true }, "name": { "type": "string" }, "status": { "type": "string" }, "risk_score": { "type": "number", "nullable": true } } } } } } } }, "workflow_id": { "type": "string", "format": "uuid", "description": "Identificador estable del grupo de flujos que generó esta sesión. Los flujos tienen versiones: este valor identifica el flujo en sí, no una versión concreta.", "nullable": true }, "features": { "type": "array", "items": { "type": "string", "description": "La función de la sesión." }, "description": "Lista de funciones de verificación configuradas para esta sesión, como nombres para mostrar: `ID_VERIFICATION`, `NFC`, `LIVENESS`, `FACE_MATCH`, `POA`, `PHONE`, `EMAIL_VERIFICATION`, `AML`, `IP_ANALYSIS`, `DATABASE_VALIDATION`, `QUESTIONNAIRE`, `AGE_ESTIMATION`, `FACE_SEARCH`, `GEOLOCATION` (verificación de ubicación) (las sesiones de Verificación de empresas usan el conjunto de funciones KYB: `KYB_REGISTRY`, `KYB_DOCUMENTS`, `KYB_KEY_PEOPLE`, `AML`, `PHONE`, `EMAIL_VERIFICATION`, `IP_ANALYSIS`, `QUESTIONNAIRE`). Con `include=events`, cada entrada pasa a ser un objeto `{feature, node_id}` en lugar de una cadena simple, y la función de correo electrónico cambia de nombre: aparece como `EMAIL` en el modo de eventos en lugar del `EMAIL_VERIFICATION` que se usa aquí." }, "vendor_data": { "type": "string", "description": "Los datos del proveedor de la sesión.", "nullable": true }, "metadata": { "type": "object", "description": "Los metadatos de la sesión.", "nullable": true }, "expected_details": { "type": "object", "description": "Datos esperados que se proporcionan al crear la sesión: se usan para la validación cruzada con los datos extraídos (KYC) o para rellenar previamente la búsqueda en el registro de empresas (KYB). Devuelve exactamente las claves que se proporcionaron; `null` cuando no se proporcionó ninguna. Las sesiones KYC incluyen los campos de la persona; las sesiones de empresa (KYB) incluyen `company_name`, `registry_country` y `registration_number`.", "properties": { "first_name": { "type": "string", "description": "Nombre del usuario. Por ejemplo, `John`." }, "last_name": { "type": "string", "description": "Apellido del usuario. Por ejemplo, `Doe`." }, "date_of_birth": { "type": "string", "format": "date", "description": "Fecha de nacimiento del usuario con el formato YYYY-MM-DD. Por ejemplo, `1990-05-15`." }, "gender": { "type": "string", "nullable": true, "enum": [ "M", "F" ], "default": null, "description": "Género del usuario. Debe ser 'M', 'F' o null." }, "nationality": { "type": "string", "description": "Código de país ISO 3166-1 alpha-3 que representa el país de origen del solicitante. Por ejemplo, `USA`." }, "country": { "type": "string", "description": "Código de país ISO 3166-1 alpha-3 que representa el país del documento de prueba de domicilio, o el país del documento de identidad del solicitante, que puede diferir de la nacionalidad. Por ejemplo, `GBR`." }, "address": { "type": "string", "description": "La dirección en un formato legible, con toda la información posible. Por ejemplo, `123 Main St, San Francisco, CA 94105, USA`." }, "identification_number": { "type": "string", "description": "El número de documento, número personal o número fiscal del usuario. Por ejemplo, `123456789`." }, "ip_address": { "type": "string", "format": "ipv4", "description": "Dirección IP esperada para la sesión. Si la dirección IP real difiere de este valor, se registrará una advertencia. Por ejemplo, `192.168.1.100`." }, "expected_document_types": { "type": "array", "description": "Tipos de documento a los que se restringió el paso de verificación de identidad al crear la sesión. Vacío o sin definir significa que no hay restricción. Códigos: `P` (pasaporte), `ID` (documento nacional de identidad), `DL` (licencia de conducir), `RP` (permiso de residencia), `HIC` (tarjeta de seguro médico), `TC` (tarjeta fiscal), `SSC` (tarjeta de seguridad social).", "items": { "type": "string", "enum": [ "P", "ID", "DL", "RP", "HIC", "TC", "SSC" ] } }, "id_country": { "type": "string", "nullable": true, "description": "País emisor esperado del documento de identidad (ISO 3166-1 alfa-3), cuando se restringió al crear la sesión.", "example": "ESP" }, "poa_country": { "type": "string", "nullable": true, "description": "País esperado del documento de prueba de domicilio (ISO 3166-1 alfa-3), cuando se restringió al crear la sesión.", "example": "ESP" }, "company_name": { "type": "string", "description": "Razón social esperada de la empresa. Solo para sesiones de empresa (KYB)." }, "registry_country": { "type": "string", "description": "País del registro esperado en formato `XX` o `XX-YY` (ISO 3166-1 alfa-2, opcionalmente con una subdivisión ISO 3166-2 para registros de nivel estatal, p. ej., `US-CA`). Solo para sesiones de empresa (KYB)." }, "registration_number": { "type": "string", "description": "Número de registro esperado de la empresa. Solo para sesiones de empresa (KYB)." } }, "nullable": true }, "contact_details": { "type": "object", "description": "Datos de contacto proporcionados al crear la sesión (se usan para los correos electrónicos de notificación, la verificación de teléfono o correo electrónico prellenada y el idioma de comunicación). `null` cuando no se proporcionó ni un correo electrónico ni un número de teléfono.", "properties": { "email": { "type": "string", "description": "Dirección de correo electrónico del usuario (p. ej., \"john.doe@example.com\") que se usará durante el paso de Verificación de correo electrónico. Si no se proporciona, el usuario debe indicarla durante el flujo de verificación." }, "email_lang": { "type": "string", "description": "Código de idioma (ISO 639-1) para las notificaciones por correo electrónico. Controla el idioma de todas las comunicaciones por correo electrónico (p. ej., \"en\", \"es\", \"fr\")." }, "send_notification_emails": { "type": "boolean", "default": false, "description": "Si es true y se proporciona un correo electrónico, Didit envía de forma asíncrona el correo inicial \"Verifica tu identidad\" al crear la sesión de Verificación de usuarios (KYC) o Verificación de empresas (KYB). Didit también envía a la dirección de correo electrónico proporcionada notificaciones del estado de la verificación de las sesiones que requieren revisión manual." }, "phone": { "type": "string", "nullable": true, "description": "Número de teléfono del usuario en formato E.164, si está disponible (p. ej., +14155552671). `null` cuando solo se indicó un correo electrónico al crear la sesión. Nota: este campo devuelve el número de teléfono original indicado al crear la sesión. Si el número no era válido, es posible que no esté en formato E.164." } }, "nullable": true }, "callback": { "type": "string", "format": "uri", "description": "La URL de callback de la sesión.", "nullable": true }, "id_verifications": { "type": "array", "nullable": true, "description": "**Array de informes de verificación de identidad (OCR)** generados por los pasos de documento de identidad del grafo del flujo. Siempre es un array JSON: lee `id_verifications[0]` e itera si tu flujo puede ejecutar más de una verificación de identidad (por ejemplo, una verificación principal más una verificación reforzada). Es `null` hasta que al menos un paso de identidad haya generado datos. Cada elemento es el informe completo, que incluye `node_id`, el `status` a nivel de función, los campos extraídos del documento, las URL de las imágenes, las puntuaciones de calidad, la MRZ, el análisis de la dirección, las coincidencias entre sesiones y `warnings[]`.", "items": { "type": "object", "description": "Un informe de verificación de identidad: el informe completo de un solo paso de Verificación de identidad. `verification_method` indica cuál de los tres métodos lo generó (captura de documento, consulta sin documento o inicio de sesión con wallet), y el bloque de evidencias específico del método se rellena en consecuencia.", "properties": { "node_id": { "type": "string", "description": "ID del nodo del grafo del flujo correspondiente al paso de OCR que generó este informe." }, "verification_method": { "type": "string", "enum": [ "document", "id_lookup", "wallet" ], "description": "Qué método de Verificación de identidad generó este informe. `document`: el usuario fotografió un documento de identidad físico (el valor predeterminado, y el valor de todas las sesiones creadas antes de que existieran los demás métodos). `id_lookup`: el usuario escribió su número de identificación nacional y se comprobó en un registro gubernamental u otra fuente oficial de ese país (`id_lookup.source` indica cuál). `wallet`: el usuario inició sesión con una identidad digital gubernamental o bancaria." }, "assurance": { "type": "string", "enum": [ "documentary", "data_match", "cryptographic" ], "description": "Nivel de garantía derivado de `verification_method`: `documentary` para un documento que se capturó y verificó, `data_match` para datos que coincidieron con un registro de la fuente consultada, `cryptographic` para atributos que un proveedor de identidad autenticó y firmó." }, "wallet_provider": { "type": "string", "nullable": true, "description": "Id de catálogo de la wallet cuando `verification_method` es `wallet` (`mitid`, `bankid_se`, `itsme`, ...). `null` en caso contrario." }, "fallback_from": { "type": "object", "nullable": true, "description": "Por qué un método que no es de documento terminó el paso de ID. Se establece en el informe rechazado cuando falló una consulta o un inicio de sesión con wallet y la opción de respaldo del país era `decline`. `null` en caso contrario.", "properties": { "method": { "type": "string", "enum": [ "id_lookup", "wallet" ], "description": "El método que falló." }, "reason": { "type": "string", "description": "El resultado que lo finalizó, p. ej., `no_match`, `provider_error`, `cancelled`, `timeout`." }, "action": { "type": "string", "description": "La acción configurada que se ejecutó, por ejemplo, `decline`." } } }, "id_lookup": { "type": "object", "nullable": true, "description": "Evidencia del registro. Solo está presente cuando `verification_method` es `id_lookup`; en caso contrario, `null`.", "properties": { "source": { "type": "string", "description": "Nombre visible para el cliente de la fuente consultada, p. ej., `Department of Home Affairs` (un registro gubernamental) o `UK credit bureau and financial services records` (no es un registro gubernamental). Es la única indicación de procedencia de la consulta; no des por hecho que la fuente es gubernamental." }, "checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que respondió el registro." }, "attempts": { "type": "integer", "description": "Número de intento, empezando en 1, del que procede este informe." }, "max_attempts": { "type": "integer", "description": "Número de intentos configurado para el país (de 1 a 5, valor predeterminado 1)." }, "outcome": { "type": "string", "enum": [ "match", "partial_match", "no_match", "provider_error", "format_rejected" ], "nullable": true, "description": "Lo que respondió el registro. Solo `match`, `partial_match` y `no_match` cuentan para el límite de intentos y se facturan." }, "comparison": { "type": "array", "description": "Una fila por cada campo comparable sobre el que respondió la fuente, más una fila por cada error de la fuente. Las filas de comparación usan los nombres de campo normalizados que se indican a continuación en lugar de las claves de campo de la solicitud del país, porque varios campos de la solicitud (nombre y apellido, o cualquiera de los alias del identificador) se agrupan en una sola comparación. Una fuente que falló añade una fila con `field: \"provider\"` y `result: \"error\"`, así que lee `result` antes de tratar una fila como un veredicto sobre un campo.", "items": { "type": "object", "required": [ "field", "label", "provided", "record", "result" ], "properties": { "field": { "type": "string", "enum": [ "identification_number", "full_name", "date_of_birth", "address", "provider" ], "description": "Campo de comparación normalizado. `provider` no es un campo del usuario: marca una fila de error de la fuente." }, "label": { "type": "string", "description": "Etiqueta visible de la fila, por ejemplo `ID number`, `Full name`, `Provider`." }, "provided": { "type": "string", "nullable": true, "description": "Lo que escribió el usuario. `null` en una fila de error `provider`." }, "record": { "type": "string", "nullable": true, "description": "Lo que contenía la fuente. En una fila de error `provider`, contiene en su lugar el mensaje de error." }, "result": { "type": "string", "enum": [ "match", "partial", "no_match", "error" ], "description": "Resultado de la comparación por campo. `error` solo aparece en una fila `provider` y significa que esa fuente no respondió; tómalo como información sobre la consulta, nunca como una discrepancia del campo." } } } }, "registry_portrait": { "type": "string", "format": "uri", "nullable": true, "description": "URL prefirmada de corta duración al retrato que devolvió la fuente. Solo en los cuatro registros gubernamentales que devuelven uno (Sudáfrica, Nigeria, Argentina y Panamá)." }, "face_match_score": { "type": "number", "nullable": true, "description": "Selfie frente al retrato del registro, de 0 a 100. Solo cuando el registro devuelve un retrato." } } }, "wallet_verification": { "type": "object", "nullable": true, "description": "Evidencia de la credencial. Solo está presente cuando `verification_method` es `wallet`; `null` en caso contrario.", "properties": { "provider": { "type": "string", "description": "Id de catálogo de la wallet, p. ej., `mitid`." }, "provider_name": { "type": "string", "nullable": true, "description": "Nombre de la wallet tal como la conoce el usuario final, p. ej., `MitID`." }, "issuing_authority": { "type": "string", "nullable": true, "description": "La autoridad responsable de la wallet, p. ej., `Danish Agency for Digital Government`." }, "issuing_country": { "type": "string", "description": "País ISO 3166-1 alfa-3 en el que se ofreció la wallet." }, "credential_type": { "type": "string", "nullable": true, "description": "Credencial que presentó la wallet, p. ej. `person_identification`." }, "level_of_assurance": { "type": "string", "enum": [ "low", "substantial", "high" ], "nullable": true, "description": "El nivel de garantía que afirmó la wallet. Un inicio de sesión que afirma un nivel inferior al solicitado falla en lugar de rebajarse." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "El instante de autenticación de la wallet." }, "signature_valid": { "type": "boolean", "nullable": true, "description": "Si la aserción firmada que devolvió la wallet se validó." }, "attributes": { "type": "object", "additionalProperties": true, "description": "Los atributos que compartió la wallet, con las claves que indica la entrada del catálogo de la wallet." }, "portrait": { "type": "string", "format": "uri", "nullable": true, "description": "URL prefirmada de corta duración al retrato que compartió la wallet, cuando comparte uno." }, "face_match_score": { "type": "number", "nullable": true, "description": "Selfie frente al retrato de la wallet, de 0 a 100, cuando la wallet comparte uno." } } }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Expired" ], "description": "Estado a nivel de función de este paso de verificación de identidad. Es independiente del `status` de nivel superior de la sesión: una sesión puede alcanzar su decisión global mientras una función concreta sigue en `In Review`." }, "document_type": { "type": "string", "description": "Tipo de documento de identidad" }, "document_subtype": { "type": "string", "nullable": true, "description": "Código de subtipo de documento aceptado según la configuración de documentos del flujo, incluida la región del documento cuando corresponda. Ejemplos: `ID_CARD_GENERIC`, `QUEENSLAND_DRIVER_LICENSE_GENERIC`." }, "document_number": { "type": "string", "description": "Número de identificación del documento" }, "personal_number": { "type": "string", "description": "Número de identificación personal" }, "portrait_image": { "type": "string", "format": "uri", "description": "URL de la imagen del retrato" }, "front_image": { "type": "string", "format": "uri", "description": "URL de la imagen del anverso del documento" }, "front_video": { "type": "string", "format": "uri", "description": "URL del video del anverso del documento" }, "back_image": { "type": "string", "format": "uri", "description": "URL de la imagen del reverso del documento" }, "back_video": { "type": "string", "format": "uri", "description": "URL del video del reverso del documento" }, "full_front_image": { "type": "string", "format": "uri", "description": "URL de la imagen completa del anverso del documento" }, "full_back_image": { "type": "string", "format": "uri", "description": "URL de la imagen completa del reverso del documento" }, "front_image_camera_front": { "type": "string", "format": "uri", "description": "URL de la imagen del anverso del documento capturada con la cámara frontal" }, "back_image_camera_front": { "type": "string", "format": "uri", "description": "URL de la imagen del reverso del documento capturada con la cámara frontal" }, "date_of_birth": { "type": "string", "format": "date", "description": "Fecha de nacimiento del documento" }, "age": { "type": "integer", "description": "Edad calculada a partir de la fecha de nacimiento" }, "expiration_date": { "type": "string", "format": "date", "description": "Fecha de caducidad del documento" }, "date_of_issue": { "type": "string", "format": "date", "description": "Fecha de expedición del documento" }, "issuing_state": { "type": "string", "description": "Código ISO del estado emisor" }, "issuing_state_name": { "type": "string", "description": "Nombre completo del estado emisor" }, "first_name": { "type": "string", "description": "Nombre según el documento" }, "last_name": { "type": "string", "description": "Apellido según el documento" }, "full_name": { "type": "string", "description": "Nombre completo del documento" }, "gender": { "type": "string", "description": "Género del documento" }, "address": { "type": "string", "description": "Dirección sin procesar del documento" }, "formatted_address": { "type": "string", "description": "Dirección completa formateada" }, "place_of_birth": { "type": "string", "description": "Lugar de nacimiento según el documento" }, "marital_status": { "type": "string", "description": "Estado civil según el documento" }, "nationality": { "type": "string", "description": "Código ISO de nacionalidad" }, "extra_fields": { "type": "object", "description": "Campos adicionales del documento. Incluye atributos específicos del documento (p. ej., `dl_categories`, `blood_group`, `sponsor`, `employer`, `dl_class_code_b_from`, `dl_class_code_b_to`). Las fechas de validez de las clases de la licencia de conducir se devuelven como `dl_class_code__from` y `dl_class_code__to`, y los códigos de restricción/información por clase (p. ej., la columna 12 de las licencias del Reino Unido) como `dl_class_code__notes`. Cuando el documento incluye nombres, dirección o lugar de nacimiento en varias escrituras, este objeto también incluye las versiones en escritura alternativa de esos campos. La configuración del flujo `preferred_characters` (`latin` o `non_latin`) controla qué escritura se usa en los campos de nivel superior (`first_name`, `last_name`, `full_name`, `address`, `place_of_birth`); la escritura opuesta se coloca aquí como `first_name_non_latin` / `last_name_non_latin` / `full_name_non_latin` / `middle_name_non_latin` / `address_non_latin` / `place_of_birth_non_latin` (cuando `preferred_characters` es `latin`) o con el sufijo `_latin` (cuando `preferred_characters` es `non_latin`). Las claves solo aparecen cuando el OCR extrae realmente un valor real en escritura alternativa: se omite un campo cuyo valor alternativo está en la misma escritura que el conjunto preferido (por ejemplo, un campo con etiqueta en cirílico cuyo valor de OCR se devolvió con homoglifos latinos). Cuando `preferred_characters` es `latin` pero el documento solo contiene texto no latino, Didit translitera los valores extraídos y expone `first_name_latin` / `last_name_latin` / etc. como alternativa.", "additionalProperties": true, "properties": { "dl_categories": { "type": "array", "items": { "type": "string" } }, "blood_group": { "type": "string", "nullable": true }, "first_name_non_latin": { "type": "string", "description": "Nombre en el alfabeto no latino cuando `preferred_characters=latin` y el documento incluye una versión en alfabeto no latino (por ejemplo, `Айна` en un documento de identidad kirguís)." }, "last_name_non_latin": { "type": "string", "description": "Apellido en el alfabeto no latino cuando `preferred_characters=latin` y el documento contiene una versión no latina." }, "middle_name_non_latin": { "type": "string", "description": "Segundo nombre / patronímico en el alfabeto no latino cuando `preferred_characters=latin` y el documento incluye una versión no latina." }, "full_name_non_latin": { "type": "string", "description": "Nombre completo compuesto en el alfabeto no latino. Se reconstruye a partir de los componentes individuales cuando están disponibles tanto el nombre como el apellido." }, "address_non_latin": { "type": "string", "description": "Dirección en la escritura no latina cuando `preferred_characters=latin` y el documento incluye una versión no latina." }, "place_of_birth_non_latin": { "type": "string", "description": "Lugar de nacimiento en el alfabeto no latino cuando `preferred_characters=latin` y el documento incluye una versión no latina." }, "first_name_latin": { "type": "string", "description": "Nombre en alfabeto latino. Se rellena cuando `preferred_characters=non_latin` y el documento incluye una versión en alfabeto latino, o, como transliteración de respaldo, cuando `preferred_characters=latin` pero el documento solo contiene texto en alfabeto no latino." }, "last_name_latin": { "type": "string", "description": "Apellido en alfabeto latino. Mismas reglas que `first_name_latin`." }, "middle_name_latin": { "type": "string", "description": "Segundo nombre / patronímico en alfabeto latino. Mismas reglas que `first_name_latin`." }, "full_name_latin": { "type": "string", "description": "Nombre completo compuesto en alfabeto latino. Siempre se reconstruye a partir de los componentes individuales cuando están disponibles tanto el nombre como el apellido." }, "address_latin": { "type": "string", "description": "Dirección en escritura latina. Mismas reglas que `first_name_latin`." }, "place_of_birth_latin": { "type": "string", "description": "Lugar de nacimiento en alfabeto latino. Se aplican las mismas reglas que a `first_name_latin`." } } }, "mrz": { "type": "object", "nullable": true, "description": "Campos analizados de la zona de lectura mecánica (MRZ) extraídos del documento. `null` si no se detectó ninguna MRZ.", "properties": { "surname": { "type": "string", "example": "MARTINEZ_families` / `very_high_similarity_plus__families`. Solo está presente cuando `match_source` es `recovered_high`." } } } }, "browser_version": { "type": "string", "nullable": true }, "os_version": { "type": "string", "nullable": true }, "user_agent": { "type": "string", "nullable": true, "description": "La cadena de user agent del navegador." }, "accept_language": { "type": "string", "nullable": true, "description": "El encabezado `Accept-Language` que envió el navegador." }, "session_identifier": { "type": "string", "nullable": true, "description": "Identificador de la sesión de navegación en la que se realizó la verificación." }, "session_age_ms": { "type": "integer", "nullable": true, "description": "Antigüedad de esa sesión de navegación en milisegundos cuando se ejecutó el paso." }, "coords_accuracy": { "type": "number", "nullable": true, "description": "Radio de precisión, en metros, de las coordenadas que informó el dispositivo." }, "raw_device_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Señales del dispositivo sin procesar recopiladas para el paso." } } } }, "geolocation_checks": { "type": "array", "nullable": true, "description": "**Array de resultados de verificación de ubicación**, uno por cada paso de verificación de ubicación: el intento aceptado de ese paso. Es `null` hasta que un paso de verificación de ubicación haya generado datos. Los intentos anteriores del mismo paso están en `geolocation_attempts`.", "items": { "$ref": "#/components/schemas/GeolocationCheck" } }, "geolocation_attempts": { "type": "array", "nullable": true, "description": "Todos los intentos de cada paso de verificación de ubicación de esta sesión, del más antiguo al más reciente. Se omiten los intentos sustituidos por un reenvío. Un flujo de verificación (workflow) que oculta `geolocation_checks` mediante sus atributos de respuesta también oculta esta lista.", "items": { "$ref": "#/components/schemas/GeolocationAttempt" } }, "database_validations": { "type": "array", "nullable": true, "description": "**Array de informes de Validación de base de datos**: siempre es un array JSON, nunca un objeto `database_validation` singular. Vale `null` hasta que al menos un paso de validación de base de datos haya generado datos. Cada elemento es el informe completo, que incluye `node_id`, el `status` a nivel de función, `screened_data`, las `validations[]` por servicio (cada una con su `source_data` del registro) y `warnings[]`. Los campos `screened_data` y `source_data` varían según el país:\n\n**ARG (Argentina)**: screened_data: {document_number, selfie, gender, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, date_of_death, tax_id, tax_id_type, face_match_score, sit_1_since, banks, last_position, highest_position, rejected_checks}. Usa la validación biométrica de coincidencia facial de RENAPER. El género se infiere automáticamente a partir del análisis facial o del nombre de pila cuando no figura en el documento (por ejemplo, en licencias de conducir)\n\n**BOL (Bolivia)**: screened_data: {document_number, date_of_birth, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, gender}\n\n**BRA (Brasil)**: screened_data: {tax_number, first_name, last_name, date_of_birth}. source_data siempre incluye {identification_number, first_name, last_name, date_of_birth, lgpd_minor, minor_under_18, minor_under_16} en las coincidencias de CPF correctas. Las consultas exitosas de adultos establecen esos indicadores en false. El servicio Consulta CPF de la Receita Federal puede devolver HTTP 422 (menor de 18 años) o 451 (menor de 16 años) con datos retenidos por la LGPD; en esos casos, source_data establece los indicadores de menor en true según corresponda, incluye el estado HTTP de origen y la validación a nivel de campo es no_match. Consulta la sección de Brasil de la referencia de códigos de resultado de Validación de base de datos para ver la lista completa de códigos.\n\n**CHL (Chile)**: screened_data: {personal_number, first_name, last_name, date_of_birth}. source_data: {identification_number, first_name, last_name, date_of_birth, gender}\n\n**COL (Colombia)**: screened_data: {document_number, document_type, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, document_type}\n\n**CRI (Costa Rica)**: screened_data: {personal_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**DOM (República Dominicana)**: screened_data: {personal_number}. source_data: {identification_number} (solo devuelve válido/no válido)\n\n**ECU (Ecuador)**: screened_data: {personal_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, street, formatted_address, gender, nationality, education, marital_status, spouse, mother_name, father_name, profession}\n\n**ESP (España)**: screened_data: {personal_number, document_type, expiration_date, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, document_type, expiration_date}\n\n**GTM (Guatemala)**: screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**HND (Honduras)**: screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**MEX (México)**: screened_data: {personal_number (CURP), first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, gender, nationality, curp_status, state_of_birth, doc_probatorio, registration_year, registration_state, registration_municipality, num_acta, crip, issuing_state_code, foreign_registry_number, folio_carta, folio_certificado}. Usa el registro civil de RENAPO. Para MEX también está disponible un servicio independiente de comprobación de vigencia del INE como validación adicional individual.\n\n**PAN (Panamá)**: screened_data: {personal_number, selfie}. source_data: {identification_number}. Usa la validación biométrica de SIB\n\n**PER (Perú)**: screened_data: {personal_number (DNI), first_name, last_name}. source_data: {identification_number, first_name, last_name, paternal_name, maternal_name, verification_number, verification_letter}\n\n**PRY (Paraguay)**: screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**SLV (El Salvador)**: screened_data: {document_number, date_of_birth, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**URY (Uruguay)**: screened_data: {personal_number, date_of_birth, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**VEN (Venezuela)**: screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, gender, date_of_birth, document_type}", "items": { "type": "object", "properties": { "node_id": { "type": "string", "description": "Identificador único de este paso de validación de base de datos en el grafo del flujo." }, "issuing_state": { "type": "string", "description": "Código ISO 3166-1 alpha-3 del país cuyas fuentes gubernamentales o de registro se consultaron (p. ej., `BRA`, `MEX`, `ESP`, `NGA`, `IDN`). Validación de base de datos cubre 60+ países de América, Europa, África, Oriente Medio y Asia-Pacífico, además de fuentes globales multipaís. La cobertura se amplía con regularidad, así que trata el valor como un conjunto abierto y no como un enum fijo." }, "validation_type": { "type": "string", "enum": [ "one_by_one", "two_by_two", "not_enabled" ], "description": "Cómo se corroboró el resultado: `one_by_one` (resultado de un solo servicio), `two_by_two` (dos o más servicios distintos obtuvieron de forma independiente una coincidencia total del número de identificación) o `not_enabled` (se guarda cuando ningún servicio produjo una coincidencia utilizable). El valor nunca es `null`. Los modos dedicados de validación biométrica 2x2 están disponibles actualmente para `ECU` y `PER`." }, "screened_data": { "type": "object", "description": "Los datos de entrada usados para la validación. Los campos varían según el país: consulta la documentación de Validación de base de datos (`/core-technology/database-validation/overview`) para ver los formatos de cada país.", "properties": { "last_name": { "type": "string" }, "first_name": { "type": "string" }, "tax_number": { "type": "string", "description": "Brasil: CPF (11 dígitos)" }, "personal_number": { "type": "string", "description": "Chile: RUT, DOM: Cédula (11 dígitos), ECU: Cédula (10 dígitos), ESP: DNI/NIE, MEX: CURP (18 caracteres), PER: DNI (8 dígitos), URY: CI" }, "document_number": { "type": "string", "description": "ARG: DNI, BOL: CI, COL: Cédula, GTM: DPI, HND: DNI, PAN: Cédula, PRY: CI, SLV: DUI, VEN: Cédula" }, "date_of_birth": { "type": "string", "format": "date" }, "document_type": { "type": "string", "description": "COL: CC/CE/TI/NIT, ESP: ID/PASSPORT" }, "expiration_date": { "type": "string", "format": "date", "description": "Obligatorio para ESP" } } }, "validations": { "type": "array", "description": "Una entrada por cada servicio de registro que devolvió un payload de validación. Cada entrada identifica el servicio (`service_id`, `service_name`) e incluye la comparación `validation` por campo, el `outcome_code` / `outcome_detail` del servicio cuando se informa, y el registro normalizado en `source_data`.", "items": { "type": "object", "properties": { "service_id": { "type": "string", "description": "Identificador del servicio de registro que generó este resultado de validación.", "example": "bra_cpf" }, "service_name": { "type": "string", "description": "Nombre legible del servicio de registro.", "example": "Brazil - CPF status check" }, "validation": { "type": "object", "description": "Los resultados de las validaciones de campos.", "properties": { "full_name": { "type": "string", "description": "Resultado de coincidencia del nombre completo (p. ej., 'full_match', 'partial_match', 'no_match')." }, "date_of_birth": { "type": "string", "description": "Resultado de coincidencia de la fecha de nacimiento." }, "identification_number": { "type": "string", "description": "Resultado de coincidencia del número de identificación." } } }, "outcome_code": { "type": "string", "nullable": true, "description": "Resultado legible por máquina de la consulta al registro (por ejemplo, `MATCH`, `NO_MATCH`, `PARTIAL_MATCH`, `INCONCLUSIVE`, códigos específicos de la fuente). Presente cuando el servicio informa uno." }, "outcome_detail": { "type": "string", "nullable": true, "description": "Explicación legible de `outcome_code`, cuando el servicio la proporciona." }, "source_data": { "type": "object", "description": "Los datos devueltos por la base de datos gubernamental. Campos comunes: identification_number, first_name, last_name, full_name, date_of_birth, gender. Campos adicionales por país: BRA siempre incluye lgpd_minor, minor_under_18 y minor_under_16 cuando hay coincidencia de CPF; también incluye el estado HTTP de origen cuando los datos del CPF se retienen en virtud de la LGPD (HTTP 422/451). ECU añade street, formatted_address, nationality, education, marital_status, spouse, mother_name, father_name, profession. PER añade paternal_name, maternal_name, verification_number, verification_letter. ESP añade document_type, expiration_date. VEN/COL añaden document_type.", "additionalProperties": true } } } }, "errors": { "type": "array", "description": "Errores devueltos por los servicios de registro durante la validación, cada uno etiquetado con el `service_id` que lo generó. **Esta clave se omite por completo cuando no hay errores.**", "items": { "type": "object", "description": "El objeto de error del servicio de origen, incluido tal cual (sus claves varían según el servicio; normalmente un mensaje/código y los detalles específicos del proveedor), más `service_id`, que identifica el servicio que produjo el error.", "properties": { "service_id": { "type": "string", "nullable": true, "description": "Identificador del servicio de registro que produjo el error." } }, "additionalProperties": true } }, "match_type": { "type": "string", "enum": [ "no_match", "partial_match", "full_match" ], "nullable": true, "description": "El resultado agregado de coincidencia en los servicios consultados. `null` hasta que se evalúa la validación." }, "status": { "type": "string", "description": "Estado a nivel de función de esta validación de base de datos. Es independiente del `status` de nivel superior de la sesión: una sesión puede alcanzar su decisión global mientras una función concreta sigue en `In Review`.", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ] }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string", "enum": [ "ID_VERIFICATION", "NFC", "LIVENESS", "FACEMATCH", "PROOF_OF_ADDRESS", "PHONE", "EMAIL", "AML", "LOCATION", "DATABASE_VALIDATION", "QUESTIONNAIRE", "DOCUMENT_AI", "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE", "GEOLOCATION", "SIGNATURE" ], "description": "La función que generó esta advertencia. El valor identifica el bloque de función al que pertenece la advertencia. El array de advertencias de cada módulo suele usar el valor que corresponde a su módulo (por ejemplo, `PHONE` dentro de `phone_verifications[].warnings`), pero el enum anterior es la referencia para todas las advertencias de funciones del payload de la decisión." }, "risk": { "type": "string" }, "additional_data": { "type": "object", "nullable": true }, "log_type": { "type": "string" }, "short_description": { "type": "string" }, "long_description": { "type": "string" }, "node_id": { "type": "string", "description": "El ID del nodo del grafo del flujo que generó esta advertencia" } } }, "description": "Advertencias relacionadas con la validación de base de datos." } } } }, "database_validation_not_performed_reason": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Por qué una validación de base de datos configurada no produjo ningún resultado, como `{code, message}` más campos de contexto. Solo está presente cuando `database_validations` es `null` en un flujo que tiene el paso, para que puedas distinguir entre \"el registro coincidió\" y \"no se ejecutó nada\". `null` en caso contrario.", "properties": { "code": { "type": "string", "description": "Motivo estable legible por máquina." }, "message": { "type": "string", "description": "Explicación legible." } } }, "reviews": { "type": "array", "items": { "type": "object", "properties": { "user": { "type": "string", "description": "Quién realizó la revisión. Suele ser el identificador del revisor de la consola (su correo electrónico), pero el valor es `\"API Client\"` en las actualizaciones de estado hechas con una clave de API y `\"Unknown\"` cuando no se pudo identificar a ningún actor, así que no interpretes este campo como una dirección de correo electrónico." }, "new_status": { "type": "string" }, "comment": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } } }, "assignee": { "type": "object", "nullable": true, "description": "El revisor de la consola al que está asignada la sesión, o `null` cuando nadie la tiene asignada.", "properties": { "email": { "type": "string", "format": "email" }, "assigned_at": { "type": "string", "format": "date-time", "nullable": true } } }, "waiting_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que la sesión empezó a esperar revisión. `null` salvo que la sesión esté en `In Review` y tu aplicación configure un plazo de revisión." }, "sla_due_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha límite de la revisión. `null` salvo que la sesión esté en `In Review` y tu aplicación configure un plazo de revisión." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de tiempo en la que se creó la sesión (ISO 8601, UTC)." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de tiempo en la que está previsto que expire esta sesión. Se establece en las sesiones de Verificación de usuarios (KYC) cuando se configuró una expiración al crearlas (o cuando el estado `Approved` desencadena el cálculo de la expiración del KYC). `null` en las sesiones sin una expiración configurada y en los tipos que no usan expiración (p. ej., las sesiones de Verificación de empresas (KYB) que nunca recibieron un `expires_at`)." }, "registry_checks": { "type": "array", "nullable": true, "description": "Comprobaciones en el registro de empresas. Solo está presente cuando `session_kind = business`. Cada elemento incluye el payload completo del registro de empresas.", "items": { "type": "object", "description": "Una verificación en el registro de empresas: el payload completo del registro de empresas, enriquecido con la estructura de propiedad y las advertencias. Solo está presente cuando `session_kind = business`.", "properties": { "status": { "type": "string", "description": "Estado del ciclo de vida de la función." }, "node_id": { "type": "string", "nullable": true }, "data_resolved": { "type": "boolean" }, "company": { "type": "object", "description": "Payload completo del registro de la empresa (el registro oficial combinado con cualquier dato proporcionado por el usuario o editado en la consola).", "properties": { "uuid": { "type": "string", "format": "uuid" }, "node_id": { "type": "string", "nullable": true }, "status": { "type": "string" }, "registry_status": { "type": "string", "nullable": true }, "data_resolved": { "type": "boolean" }, "company_name": { "type": "string" }, "registration_number": { "type": "string", "nullable": true }, "country_code": { "type": "string", "description": "País de constitución (ISO 3166-1 alfa-2, p. ej., `GB`, `DE`, `US`)." }, "region": { "type": "string", "nullable": true, "description": "Código de subdivisión ISO 3166-2 cuando corresponda (p. ej., `CA`, `NY` para estados de EE. UU.)." }, "company_type": { "type": "string", "nullable": true }, "incorporation_date": { "type": "string", "format": "date", "nullable": true }, "registered_address": { "type": "string", "nullable": true }, "tax_number": { "type": "string", "nullable": true }, "risk_level": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ], "nullable": true }, "verification_status": { "type": "string", "nullable": true }, "is_from_registry": { "type": "boolean" }, "fetch_status": { "type": "string", "nullable": true }, "alternative_names": { "type": "string", "nullable": true, "description": "Nombres alternativos, comerciales, anteriores o en el idioma original de la empresa, como texto, cuando se informan." }, "nature_of_business": { "type": "string", "nullable": true }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "format": "decimal", "nullable": true, "description": "Importe del capital social registrado como cadena decimal (p. ej., `\"100.00\"`), extraído de la presentación ante el registro. `null` cuando no está disponible." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Código de moneda ISO 4217 de `registered_capital_amount` (p. ej., `\"GBP\"`). `null` cuando no está disponible." }, "website": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true }, "phone": { "type": "string", "nullable": true }, "legal_entity_identifier": { "type": "string", "nullable": true }, "location_of_registration": { "type": "string", "nullable": true }, "vat_number": { "type": "string", "nullable": true, "description": "Número de IVA de la UE, cuando se recopila durante el paso de registro alojado o se edita después." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Resultado de validar el número de IVA o, si no lo hay, el `tax_number`, al enviar al registro. `valid` / `invalid`: lo decide el registro oficial del país (VIES de la UE, Noruega, Suiza, Brasil, Colombia, Costa Rica, Ecuador, Paraguay; Polonia también mediante su registro nacional de IVA). `format_valid` / `invalid_format`: lo deciden las reglas de formato y dígito de control del país cuando no se puede consultar ningún registro. `could_not_validate`: el registro no estaba disponible. `not_applicable`: no hay número, el país no tiene registro ni reglas, o es una sesión de sandbox." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "El número que se comprobó, tal como lo conoce la fuente (por ejemplo, el número de IVA derivado de un SIREN francés o de un RSIN neerlandés). `null` cuando no se realizó ninguna comprobación." }, "vat_validation_source": { "type": "string", "nullable": true, "enum": [ "eu_vies", "pl_vat_white_list", "no_brreg", "ch_uid_register", "br_receita_federal", "co_rues", "cr_hacienda", "ec_sri", "py_dnit", "format_rules", null ], "description": "La fuente que determinó `vat_validation_status`: un registro oficial o `format_rules`. `null` cuando no se ejecutó ninguna comprobación." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Nombre registrado en la fuente que validó el número, cuando la fuente lo revela. Solo se informa cuando el estado es `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Dirección registrada en la fuente que validó el número, cuando esta la facilita. Solo se establece cuando el estado es `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de tiempo de la comprobación. `null` cuando no se ejecutó ninguna comprobación." }, "financial_summary": { "type": "object", "nullable": true }, "officers": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "designation": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "is_active": { "type": "boolean" }, "kyc_status": { "type": "string", "enum": [ "Approved", "Declined", "Pending" ], "nullable": true }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true }, "first_name": { "type": "string", "nullable": true, "description": "Nombre de pila cuando el registro lo indica explícitamente; no se deduce del nombre completo." }, "last_name": { "type": "string", "nullable": true, "description": "Apellido, cuando el registro lo indica explícitamente." }, "address": { "type": "string", "nullable": true, "description": "Dirección del directivo según el registro." }, "appointment_date": { "type": "string", "nullable": true, "description": "Fecha en que se nombró al cargo.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Fecha en que terminó el nombramiento, cuando se informa.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Fecha de nacimiento completa según el registro. Es null cuando solo se conoce el año o el mes de nacimiento.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Año de nacimiento según el registro, incluso cuando la fecha completa no está disponible." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Mes de nacimiento según el registro. Null cuando solo se conoce el año." } } } }, "beneficial_owners": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "entity_type": { "type": "string", "enum": [ "person", "company" ] }, "roles": { "type": "array", "items": { "type": "string" } }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Límite inferior del porcentaje de propiedad tal como lo informa el registro. Cadena de formato libre (por ejemplo, `\"25.00\"`, `\"50\"`); usa `effective_ownership_percent` para obtener un valor numérico procesado." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Límite superior del porcentaje de propiedad tal como lo informa el registro. Cadena de texto libre; usa `effective_ownership_percent` para obtener un valor numérico ya interpretado." }, "is_active": { "type": "boolean" }, "kyc_status": { "type": "string", "enum": [ "Approved", "Declined", "Pending" ], "nullable": true }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true }, "effective_ownership_percent": { "type": "number", "nullable": true }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "country_of_birth": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "designation": { "type": "string", "nullable": true }, "voting_min_shares": { "type": "string", "nullable": true }, "voting_max_shares": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "nullable": true, "description": "Fecha de nacimiento completa, cuando se informa.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Fecha de nombramiento, cuando se informa.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } } }, "addresses": { "type": "array", "nullable": true, "description": "Todas las direcciones que indica el registro, con una única forma canónica. Es null si no indica ninguna.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "Las actividades en las que el registro clasifica a la empresa, con una única forma canónica. Es null cuando no indica ninguna.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Fechas de presentación ante el registro, cuando están disponibles. Las declaraciones anuales y las juntas generales usan last_annual_return_date y last_agm_date; son distintas de las cuentas financieras." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "description": "Datos confirmados o editados por el usuario final." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true }, "is_editable": { "type": "boolean" }, "ownership": { "$ref": "#/components/schemas/KYBRegistryOwnership" }, "registry_tier": { "type": "string", "nullable": true, "description": "El nivel de registro que solicitó el flujo: `basic`, `shareholders` o `ubo`. También en `ownership.tier_requested`." }, "registry_tier_delivered": { "type": "string", "nullable": true, "description": "El nivel que entregó el registro y que se factura. También está en `ownership.tier_delivered`." }, "registry_ownership_status": { "type": "string", "nullable": true, "description": "`not_requested`, `pending`, `delivered`, `not_held` o `unavailable`. También en `ownership.status`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "El monitor de registro más reciente de la empresa, o `null` si no existe ninguno.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "unavailable_reason": { "type": "string", "nullable": true }, "enrolled_at": { "type": "string", "format": "date-time", "nullable": true }, "cancelled_at": { "type": "string", "format": "date-time", "nullable": true }, "last_bill_date": { "type": "string", "format": "date", "nullable": true }, "next_bill_date": { "type": "string", "format": "date", "nullable": true }, "last_event_at": { "type": "string", "format": "date-time", "nullable": true }, "events_count": { "type": "integer" }, "watched_fields": { "description": "Los campos de la empresa que vigila el monitor." } } } } }, "ownership_structure": { "$ref": "#/components/schemas/KYBOwnershipStructure" }, "warnings": { "type": "array", "items": { "type": "object" } } } } }, "key_people_checks": { "type": "array", "nullable": true, "description": "Comprobaciones agregadas de las personas clave. Solo están presentes cuando `session_kind = business`. Cada elemento usa la estructura de dos grupos (`registry`, `submitted`, `ubo_kyc_summary`).", "items": { "type": "object", "description": "Comprobación agregada sobre los directivos y los UBO de la empresa. Usa la estructura `registry` / `submitted`. Solo está presente cuando session_kind = business.", "properties": { "status": { "type": "string" }, "node_id": { "type": "string", "nullable": true }, "registry": { "type": "object", "description": "Partes descubiertas mediante la comprobación en el registro.", "properties": { "officers": { "type": "array", "description": "Directivos detectados mediante la comprobación en el registro, cada uno con el estado de la sesión KYC secundaria y del análisis AML que se hayan generado para él.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Nombre completo del directivo tal como consta en el registro." }, "designation": { "type": "string", "nullable": true, "description": "Cargo en texto libre según el registro (p. ej., `Director`, `Company Secretary`)." }, "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ], "description": "Rol de directivo normalizado." }, "nationality": { "type": "string", "nullable": true }, "appointment_date": { "type": "string", "nullable": true, "description": "Fecha en que se nombró al cargo.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Fecha en que terminó el nombramiento, cuando se informa.", "format": "date" }, "is_active": { "type": "boolean" }, "address": { "type": "string", "nullable": true, "description": "Dirección del directivo según el registro." }, "aml_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "nullable": true, "description": "Estado del análisis AML ejecutado para este directivo. `null` cuando no se ejecutó ningún análisis AML." }, "kyc_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "nullable": true, "description": "Estado del ciclo de vida sin procesar de la sesión KYC hija creada para este directivo. Es el enum completo de estados de sesión (no un conjunto reducido Approved/Declined/Pending). `null` cuando no existe ninguna sesión KYC hija." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL que se puede compartir de la sesión KYC secundaria. `null` cuando no existe ninguna sesión secundaria." }, "kyc_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID de sesión de la sesión KYC hija. Pásalo a este mismo endpoint de decisión para obtener el informe KYC completo de la persona. `null` cuando no existe ninguna sesión hija." }, "verification_workflow_type": { "type": "string", "nullable": true, "description": "Tipo de flujo base del flujo de la sesión hija (p. ej., `kyc`). `null` para flujos basados en grafos o cuando no existe ninguna sesión hija." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID del flujo que usa la sesión hija. `null` cuando no existe ninguna sesión hija." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Etiqueta legible del flujo de la sesión secundaria. `null` si no está definida." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Progreso por función de la sesión de verificación secundaria, p. ej. `[{\"feature\": \"ID_VERIFICATION\", \"status\": \"Approved\"}]`. `null` cuando la sesión secundaria no tiene una lista de funciones que se pueda resolver.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Nombre visible de la función (por ejemplo, `ID_VERIFICATION`, `LIVENESS`, `AML`)." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estado a nivel de función dentro de la sesión hija." } } } }, "didit_internal_id": { "type": "string", "nullable": true, "description": "Identificador interno estable de la persona verificada detrás de la sesión secundaria, útil para vincular sesiones entre sí. `null` cuando no existe ninguna sesión secundaria o el usuario aún no se ha resuelto." }, "kyc_document_type": { "type": "string", "nullable": true, "description": "Tipo de documento presentado en la sesión de KYC secundaria (p. ej., `P`, `ID`, `DL`). `null` hasta que la sesión secundaria tenga un resultado de verificación de identidad." }, "kyc_nationality": { "type": "string", "nullable": true, "description": "Nacionalidad extraída del documento en la sesión KYC hija. `null` hasta que esté disponible." }, "kyc_liveness_passed": { "type": "boolean", "nullable": true, "description": "Si se superó la comprobación de prueba de vida de la sesión de KYC hija. `null` cuando no se ha realizado ninguna comprobación de prueba de vida." }, "kyc_verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo la sesión KYC secundaria alcanzó `Approved`. `null` mientras la sesión secundaria tiene cualquier otro estado." }, "kyc_aml_categories": { "type": "object", "nullable": true, "description": "Resumen por categoría derivado de las coincidencias AML de la persona. `null` cuando no hay coincidencias.", "properties": { "sanctions": { "type": "string", "enum": [ "match", "clear" ] }, "pep": { "type": "string", "enum": [ "match", "clear" ] }, "adverse_media": { "type": "string", "enum": [ "match", "clear" ] }, "warnings": { "type": "string", "enum": [ "match", "clear" ] } } }, "kyc_notification_sent_at": { "type": "string", "nullable": true, "description": "Marca de tiempo ISO 8601 de la última notificación de invitación a la verificación enviada para la sesión secundaria de esta persona. `null` cuando no se envió ninguna." }, "first_name": { "type": "string", "nullable": true, "description": "Nombre de pila cuando el registro lo indica explícitamente; no se deduce del nombre completo." }, "last_name": { "type": "string", "nullable": true, "description": "Apellido, cuando el registro lo indica explícitamente." }, "date_of_birth": { "type": "string", "nullable": true, "description": "Fecha de nacimiento completa según el registro. Es null cuando solo se conoce el año o el mes de nacimiento.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Año de nacimiento según el registro, incluso cuando la fecha completa no está disponible." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Mes de nacimiento según el registro. Null cuando solo se conoce el año." } } } }, "beneficial_owners": { "type": "array", "description": "Beneficiarios finales detectados mediante la comprobación del registro, cada uno enriquecido con el estado de cualquier sesión KYC hija y análisis AML generados para ellos.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Nombre completo del beneficiario final (o nombre de la empresa para los UBO corporativos)." }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "nullable": true, "description": "Fecha de nacimiento completa, cuando se informa.", "format": "date" }, "country_of_birth": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "entity_type": { "type": "string", "enum": [ "person", "company" ] }, "nationality": { "type": "string", "nullable": true }, "designation": { "type": "string", "nullable": true }, "roles": { "type": "array", "description": "Nombres de los roles que tiene este propietario, p. ej., `[\"ubo\", \"shareholder\"]`.", "items": { "type": "string" } }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Límite inferior del porcentaje de propiedad tal como lo informa el registro. Cadena de formato libre (por ejemplo, `\"25\"`, `\"25-50%\"`); usa `effective_ownership_percent` para obtener un valor numérico procesado." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Límite superior del porcentaje de propiedad tal como lo informa el registro. Cadena de texto libre; usa `effective_ownership_percent` para obtener un valor numérico ya interpretado." }, "is_active": { "type": "boolean" }, "aml_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "nullable": true, "description": "Estado del análisis AML ejecutado para este beneficiario final. `null` cuando no se ejecutó ningún análisis AML." }, "kyc_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "nullable": true, "description": "Estado del ciclo de vida sin procesar de la sesión KYC hija creada para este beneficiario final. Es el enum completo de estados de sesión (no un conjunto reducido Approved/Declined/Pending). `null` cuando no existe ninguna sesión KYC hija." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL que se puede compartir de la sesión KYC secundaria. `null` cuando no existe ninguna sesión secundaria." }, "kyc_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID de sesión de la sesión KYC hija. Pásalo a este mismo endpoint de decisión para obtener el informe KYC completo de la persona. `null` cuando no existe ninguna sesión hija." }, "verification_workflow_type": { "type": "string", "nullable": true, "description": "Tipo de flujo base del flujo de la sesión hija (p. ej., `kyc`). `null` para flujos basados en grafos o cuando no existe ninguna sesión hija." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID del flujo que usa la sesión hija. `null` cuando no existe ninguna sesión hija." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Etiqueta legible del flujo de la sesión secundaria. `null` si no está definida." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Progreso por función de la sesión de verificación secundaria, p. ej. `[{\"feature\": \"ID_VERIFICATION\", \"status\": \"Approved\"}]`. `null` cuando la sesión secundaria no tiene una lista de funciones que se pueda resolver.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Nombre visible de la función (por ejemplo, `ID_VERIFICATION`, `LIVENESS`, `AML`)." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estado a nivel de función dentro de la sesión hija." } } } }, "didit_internal_id": { "type": "string", "nullable": true, "description": "Identificador interno estable de la persona verificada detrás de la sesión secundaria, útil para vincular sesiones entre sí. `null` cuando no existe ninguna sesión secundaria o el usuario aún no se ha resuelto." }, "kyc_document_type": { "type": "string", "nullable": true, "description": "Tipo de documento presentado en la sesión de KYC secundaria (p. ej., `P`, `ID`, `DL`). `null` hasta que la sesión secundaria tenga un resultado de verificación de identidad." }, "kyc_nationality": { "type": "string", "nullable": true, "description": "Nacionalidad extraída del documento en la sesión KYC hija. `null` hasta que esté disponible." }, "kyc_liveness_passed": { "type": "boolean", "nullable": true, "description": "Si se superó la comprobación de prueba de vida de la sesión de KYC hija. `null` cuando no se ha realizado ninguna comprobación de prueba de vida." }, "kyc_verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo la sesión KYC secundaria alcanzó `Approved`. `null` mientras la sesión secundaria tiene cualquier otro estado." }, "kyc_aml_categories": { "type": "object", "nullable": true, "description": "Resumen por categoría derivado de las coincidencias AML de la persona. `null` cuando no hay coincidencias.", "properties": { "sanctions": { "type": "string", "enum": [ "match", "clear" ] }, "pep": { "type": "string", "enum": [ "match", "clear" ] }, "adverse_media": { "type": "string", "enum": [ "match", "clear" ] }, "warnings": { "type": "string", "enum": [ "match", "clear" ] } } }, "kyc_notification_sent_at": { "type": "string", "nullable": true, "description": "Marca de tiempo ISO 8601 de la última notificación de invitación a la verificación enviada para la sesión secundaria de esta persona. `null` cuando no se envió ninguna." }, "child_beneficial_owners": { "type": "array", "description": "En los UBO corporativos: los beneficiarios finales de la propia entidad propietaria, como objetos sin procesar extraídos del registro. Array vacío cuando no aplica.", "items": { "type": "object" } }, "effective_ownership_percent": { "type": "number", "nullable": true, "description": "Porcentaje de propiedad numérico analizado: el límite máximo cuando está disponible y, si no, el límite mínimo. `null` cuando no se pudo analizar ninguno de los dos límites." }, "voting_min_shares": { "type": "string", "nullable": true }, "voting_max_shares": { "type": "string", "nullable": true }, "appointment_date": { "type": "string", "nullable": true, "description": "Fecha de nombramiento, cuando se informa.", "format": "date" } } } } } }, "submitted": { "type": "object", "description": "Partes enviadas por el administrador de la empresa durante el flujo de personas clave (filas de BusinessParty con source=USER).", "properties": { "parties": { "type": "array", "items": { "type": "object", "description": "Parte enviada por el administrador de la empresa mediante el flujo de personas clave (source=USER).", "properties": { "uuid": { "type": "string", "format": "uuid" }, "entity_type": { "type": "string", "enum": [ "person", "company" ] }, "source": { "type": "string", "enum": [ "USER" ], "description": "Aquí siempre es `USER`: este grupo solo contiene las partes introducidas o confirmadas por el usuario final en el flujo de personas clave (las personas descubiertas en el registro aparecen en `registry`)." }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true }, "nationality": { "type": "string", "nullable": true, "description": "Nacionalidad para personas; país de constitución para las partes que son empresas." }, "phone_number": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "position": { "type": "string", "nullable": true, "description": "Cargo o puesto en texto libre (solo personas)." }, "custom_fields": { "type": "object", "description": "Campos personalizados definidos en el flujo y recopilados para esta parte; las claves las definen los descriptores de campos de personas clave del flujo." }, "is_active": { "type": "boolean" }, "is_skipped": { "type": "boolean", "description": "True cuando el usuario final omitió la verificación para esta parte (solo es posible cuando el rol permite omitirla)." }, "requires_verification": { "type": "boolean", "description": "True cuando se requiere una subsesión KYC / KYB secundaria para esta parte según la configuración del rol y los umbrales de propiedad." }, "roles": { "type": "array", "description": "Todos los roles que ocupa esta parte, cada uno con sus propios porcentajes de propiedad y de voto. La parte en sí no tiene un `role`/`ownership_percent` escalar.", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ] }, "ownership_percent": { "type": "number", "nullable": true }, "voting_percent": { "type": "number", "nullable": true } } } }, "kyc_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID de la sesión KYC secundaria para partes que son personas y requieren verificación. `null` en caso contrario." }, "kyc_session_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "nullable": true, "description": "Estado del ciclo de vida de la sesión KYC hija. `null` cuando no existe ninguna sesión KYC hija." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true }, "kyb_sub_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID de la subsesión KYB secundaria para partes corporativas que requieren verificación. `null` en caso contrario." }, "kyb_sub_session_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "nullable": true, "description": "Estado del ciclo de vida de la subsesión KYB hija. `null` cuando no existe ninguna subsesión." }, "kyb_sub_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL que se puede compartir de la subsesión KYB secundaria. `null` cuando no existe ninguna subsesión." }, "verification_workflow_type": { "type": "string", "nullable": true, "description": "Tipo de flujo base del flujo de la sesión hija (se prefiere la sesión KYC y, si no existe, se usa la subsesión KYB). `null` para flujos basados en grafos o cuando no existe ninguna sesión hija." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID del flujo que usa la sesión hija. `null` cuando no existe ninguna sesión hija." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Etiqueta legible del flujo de la sesión secundaria. `null` si no está definida." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Progreso por función de la sesión de verificación secundaria, p. ej. `[{\"feature\": \"ID_VERIFICATION\", \"status\": \"Approved\"}]`. `null` cuando la sesión secundaria no tiene una lista de funciones que se pueda resolver.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Nombre visible de la función (por ejemplo, `ID_VERIFICATION`, `LIVENESS`, `AML`)." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estado a nivel de función dentro de la sesión hija." } } } }, "didit_internal_id": { "type": "string", "nullable": true, "description": "Identificador interno estable de la persona verificada detrás de la sesión secundaria. `null` cuando no se ha resuelto." } } } } } }, "ubo_kyc_summary": { "type": "object", "nullable": true, "description": "Progreso agregado del KYC de los UBO, o null cuando ningún UBO tiene sesiones de KYC vinculadas.", "properties": { "total": { "type": "integer" }, "approved": { "type": "integer" }, "flagged": { "type": "integer", "description": "UBO cuyo KYC está rechazado o en revisión." }, "pending": { "type": "integer" } } }, "warnings": { "type": "array", "items": { "type": "object" } } } } }, "document_verifications": { "type": "array", "nullable": true, "description": "Comprobaciones de verificación de documentos agrupadas por nodo del flujo. Solo aparece cuando `session_kind = business`.", "items": { "type": "object", "description": "Documentos agrupados por nodo del flujo. Solo aparece cuando session_kind = business.", "properties": { "status": { "type": "string" }, "node_id": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "document_type": { "type": "string", "enum": [ "LEGAL_PRESENCE", "COMPANY_DETAILS", "OWNERSHIP_STRUCTURE", "REPRESENTATIVES_AUTHORIZATION", "OTHER" ], "nullable": true, "description": "Grupo general de documentos KYB en el que se clasificó el archivo. `null` mientras no esté clasificado." }, "document_subtype": { "type": "string", "nullable": true, "description": "Subtipo específico detectado por OCR (p. ej. `CERTIFICATE_OF_INCORPORATION`, `SHAREHOLDER_REGISTRY`); `UNKNOWN` cuando el OCR no pudo clasificar el documento con suficiente confianza." }, "document_group": { "type": "string", "enum": [ "LEGAL_PRESENCE", "COMPANY_DETAILS", "OWNERSHIP_STRUCTURE", "REPRESENTATIVES_AUTHORIZATION", "OTHER" ], "nullable": true, "description": "Alias de `document_type`: el nombre del grupo que usan `groups` y `required_groups`." }, "file_url": { "type": "string", "format": "uri", "nullable": true, "description": "Enlace prefirmado de corta duración al archivo subido. `null` para los marcadores de solicitud de documento creados por un analista (`is_requested = true`) que aún no se han completado." }, "original_filename": { "type": "string", "nullable": true, "description": "Nombre del archivo tal como lo subió el usuario o el analista." }, "file_size": { "type": "integer", "nullable": true, "description": "Tamaño del archivo en bytes." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estado de verificación por documento." }, "created_at": { "type": "string", "format": "date-time" }, "cross_check_result": { "type": "object", "nullable": true, "description": "Contraste de los campos del documento extraídos por OCR con el perfil de la empresa en el registro. Es un objeto con las secciones `critical`, `non_critical` y `people`. Cada sección asigna un nombre de campo (p. ej. `company_name`, `registration_number`, `incorporation_date`, `registered_address`) a un registro de comparación como `{\"document\": \"...\", \"registry\": \"...\", \"match\": true, \"score\": 0.97}`. `null` cuando el documento no tenía datos de OCR o no había ninguna empresa del registro con la que comparar." }, "document_metadata": { "type": "object", "nullable": true, "description": "Metadatos extraídos del documento corporativo subido. Cuando la extracción de metadatos se completa correctamente, las 16 claves están siempre presentes (los valores individuales son `null` cuando no aplican al tipo de archivo); el objeto completo es `null` cuando no se pudo extraer nada. En los PDF, `overlay_manipulation` contiene el análisis forense de texto superpuesto.", "properties": { "file_size": { "type": "integer", "nullable": true, "description": "Tamaño del documento." }, "content_type": { "type": "string", "nullable": true, "description": "Tipo de contenido del documento." }, "creation_date": { "type": "string", "nullable": true, "description": "Fecha de creación del documento." }, "modified_date": { "type": "string", "nullable": true, "description": "Fecha de modificación del documento." }, "creator": { "type": "string", "nullable": true, "description": "Herramienta o usuario de creación registrado en los metadatos del archivo (`Creator` del PDF)." }, "producer": { "type": "string", "nullable": true, "description": "Software que generó el archivo (`Producer` del PDF)." }, "software": { "type": "string", "nullable": true, "description": "Software de edición registrado en los metadatos del archivo." }, "encryption": { "type": "string", "nullable": true, "description": "Esquema de cifrado del archivo, cuando está cifrado." }, "is_signed": { "type": "boolean", "nullable": true, "description": "Si el documento incluye una firma digital." }, "is_tampered": { "type": "boolean", "nullable": true, "description": "Si la firma digital no superó la validación (modificación posterior a la firma)." }, "signature_info": { "type": "object", "nullable": true, "description": "Detalles de las firmas digitales, cuando están presentes." }, "exif_original_date": { "type": "string", "nullable": true, "description": "Fecha de captura original EXIF, para imágenes subidas." }, "exif_digitized_date": { "type": "string", "nullable": true, "description": "Fecha de digitalización EXIF, para imágenes subidas." }, "processed_by_known_editor": { "type": "boolean", "nullable": true, "description": "Indica si los metadatos señalan que el archivo pasó por un editor de imágenes/PDF conocido." }, "has_different_creation_mod_date": { "type": "boolean", "nullable": true, "description": "Indica si las fechas de creación y modificación difieren, lo que es una posible señal de edición (aunque no concluyente)." }, "overlay_manipulation": { "type": "object", "nullable": true, "description": "Análisis forense del PDF ante sospecha de manipulación mediante texto superpuesto. Null cuando no se encontraron indicios de manipulación por superposición o el documento no era un PDF.", "properties": { "detected": { "type": "boolean", "description": "Indica si se detectaron indicios de manipulación del texto superpuesto." }, "analyzed": { "type": "boolean", "description": "Si se pudo analizar el PDF." }, "signals": { "type": "array", "items": { "type": "string" }, "description": "Señales forenses que se activaron, como duplicate_font_subset o glyph_fragmentation." }, "manipulated_regions": { "type": "array", "description": "Zonas presuntamente manipuladas, en coordenadas de página del PDF.", "items": { "type": "object", "properties": { "page": { "type": "integer" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "page_width": { "type": "number" }, "page_height": { "type": "number" } } } } } } } }, "description": { "type": "string", "nullable": true, "description": "Etiqueta o motivo indicado por el analista para una solicitud de documento. `null` para las subidas normales." }, "is_requested": { "type": "boolean", "description": "True para los marcadores de posición de solicitudes de documentos creados por analistas que están pendientes de carga." }, "ocr_data": { "type": "object", "nullable": true }, "is_console_upload": { "type": "boolean", "description": "True para los documentos subidos desde la consola en lugar de desde el flujo del usuario final. Las cargas desde la consola nunca cambian el estado agregado a nivel de función." }, "is_confirmed": { "type": "boolean", "description": "Las cargas desde la consola empiezan en `false` y cambian a `true` cuando el administrador las confirma; las cargas del usuario final son siempre `true`." } } } }, "groups": { "type": "object", "description": "Contadores de progreso por grupo, indexados por nombre de grupo (p. ej. legal_presence, ownership_structure).", "additionalProperties": { "type": "object", "properties": { "total": { "type": "integer" }, "approved": { "type": "integer" }, "pending": { "type": "integer" }, "declined": { "type": "integer" }, "in_review": { "type": "integer" }, "other": { "type": "integer" }, "missing": { "type": "integer", "description": "Marcadores de posición solicitados que aún no tienen ningún archivo subido." } } } }, "required_groups": { "type": "array", "items": { "type": "string" } }, "warnings": { "type": "array", "items": { "type": "object" } } } } }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Si la sesión la creó una aplicación de producción (`live`) o una aplicación de sandbox (`sandbox`). Las sesiones de sandbox son gratuitas, totalmente simuladas y nunca consumen créditos." }, "sandbox_scenario": { "type": "string", "nullable": true, "description": "El escenario de sandbox con el que se creó la sesión. `null` para las sesiones en producción y para las sesiones de sandbox creadas sin escenario." }, "resubmissions": { "type": "array", "description": "Solo se devuelve con `include=resubmissions`, para sesiones de usuarios y de empresas. Una entrada por cada solicitud de reenvío, de la más antigua a la más reciente. Cada entrada contiene los resultados que devolvieron los pasos reenviados antes de la solicitud, de modo que los envíos anteriores siguen siendo legibles. Al eliminar la sesión se eliminan todos los envíos.", "items": { "type": "object", "properties": { "number": { "type": "integer", "description": "1 para el primer reenvío de la sesión, 2 para el segundo, y así sucesivamente." }, "created_at": { "type": "string", "format": "date-time", "description": "Fecha y hora en que se solicitó el reenvío." }, "previous_status": { "type": "string", "description": "El estado de la sesión justo antes de la solicitud." }, "nodes": { "type": "array", "description": "Los pasos del flujo devueltos al usuario.", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "feature": { "type": "string" } } } }, "reasons": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" }, "description": "El motivo indicado para cada paso, indexado por `node_id`." }, "requested_by": { "type": "object", "nullable": true, "description": "Quién solicitó el reenvío.", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "type": { "type": "string" } } }, "results": { "type": "object", "additionalProperties": true, "description": "Lo que devolvieron los pasos reenviados antes de la solicitud, con las mismas claves y la misma estructura que los resultados actuales de esta respuesta (`id_verifications`, `nfc_verifications`, `liveness_checks`, `face_matches`, `poa_verifications`, `phone_verifications`, `email_verifications`, `aml_screenings`, `ip_analyses`, `database_validations`, `questionnaire_responses`, `document_ai_documents`, `geolocation_checks`; en las sesiones de empresa, también `document_verifications`). Solo aparecen las claves de los pasos que se reenviaron." } } } }, "biometric_consent": { "type": "object", "nullable": true, "description": "Si la sesión exigió un consentimiento biométrico explícito antes de una captura facial, el motivo y la evidencia de la respuesta. Solo para sesiones de Verificación de usuarios (KYC); el mismo objeto está en la `decision` de los webhooks de sesión. `null` cuando la sesión nunca se evaluó, por ejemplo, en un flujo sin captura facial. Los campos sin valor registrado son `null`. Un SDK nativo anterior a la 4.10.0, o uno que no informa su versión, no puede mostrar el paso de consentimiento: sus capturas faciales se ejecutan como antes, y una sesión que exigía consentimiento informa entonces `status: \"pending\"` con `reason: \"BIOMETRIC_CONSENT_UNSUPPORTED_SDK\"`. Consulta [Consentimiento biométrico](/es/getting-started/biometric-consent).", "properties": { "required": { "type": "boolean", "description": "Whether the session must collect explicit biometric consent. Never goes back to `false`." }, "trigger": { "type": "string", "nullable": true, "enum": [ "declared_state", "ip_state", "ip_unknown", "document_issuer", "forced", "customer_collected" ], "description": "Por qué se requiere el consentimiento, o cómo se cumplió. `declared_state`: declaraste un estado cubierto (`user_state`, o una dirección de EE. UU. en `expected_details`). `ip_state`: la IP de la persona está en un estado cubierto (Illinois, Texas, Colorado). `ip_unknown`: la evidencia sitúa a la persona en EE. UU., pero no se puede determinar el estado (la IP está en EE. UU. sin estado, o no se puede localizar mientras tus datos o el documento sitúan a la persona en EE. UU.). `document_issuer`: el documento de identidad lo emitió un estado cubierto. `forced`: el modo de la aplicación es Siempre. `customer_collected`: enviaste `biometric_consent` al crear la sesión. `null` mientras no se requiere." }, "status": { "type": "string", "enum": [ "not_required", "pending", "given", "declined" ], "description": "`not_required`; `pending` (obligatorio y no otorgado: la persona aún no ha respondido, o `reason` indica por qué no se recogió); `given`; `declined` (se registró un rechazo y la sesión terminó como `Declined`; actualmente ninguna pantalla de Didit ofrece la opción de rechazarlo)." }, "given_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se dio el consentimiento. Para `customer_collected`, el `given_at` que enviaste." }, "declined_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se registró un rechazo." }, "text_version": { "type": "string", "nullable": true, "description": "ID de la versión del texto de consentimiento al que respondió la persona, o de la que enviaste." }, "text_hash": { "type": "string", "nullable": true, "description": "SHA-256 (hex) del texto de consentimiento exacto que se mostró, en el idioma en que se mostró." }, "locale": { "type": "string", "nullable": true, "description": "Idioma en el que se mostró el texto de consentimiento." }, "policy_url": { "type": "string", "format": "uri", "nullable": true, "description": "La política de datos biométricos a la que enlazó el paso de consentimiento." }, "step": { "type": "string", "nullable": true, "description": "Paso del flujo en el que se encontraba la sesión cuando la persona respondió, por ejemplo, `LIVENESS`." }, "node_id": { "type": "string", "nullable": true, "description": "Nodo del grafo del flujo en el que se encontraba la sesión cuando la persona respondió." }, "ip_address": { "type": "string", "nullable": true, "description": "IP desde la que llegó la respuesta." }, "ip_country_code": { "type": "string", "nullable": true, "description": "País de la IP de la respuesta en formato ISO 3166-1 alfa-2." }, "ip_state": { "type": "string", "nullable": true, "description": "Subdivisión ISO 3166-2 de la IP de la respuesta, por ejemplo `US-IL`." }, "ip_city": { "type": "string", "nullable": true, "description": "Ciudad de la IP desde la que se envió la respuesta." }, "user_agent": { "type": "string", "nullable": true, "description": "User agent de la solicitud de la respuesta." }, "detected_ip_address": { "type": "string", "nullable": true, "description": "La IP de la persona desde la que se evaluó el requisito por última vez. Puede diferir de `ip_address` cuando la persona respondió desde otro dispositivo." }, "detected_country_code": { "type": "string", "nullable": true, "description": "País ISO 3166-1 alpha-2 de la IP detectada." }, "detected_state": { "type": "string", "nullable": true, "description": "Subdivisión ISO 3166-2 de la IP detectada." }, "detected_city": { "type": "string", "nullable": true, "description": "Ciudad de la IP detectada." }, "declared_state": { "type": "string", "nullable": true, "description": "Subdivisión ISO 3166-2 que declaraste: `user_state` o el estado de una dirección de EE. UU. en `expected_details`." }, "document_state": { "type": "string", "nullable": true, "description": "Subdivisión ISO 3166-2 que emitió el documento de identidad, leída en la captura del documento." }, "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Estados de EE. UU. (códigos USPS, por ejemplo `IL`) cuya ley biométrica ampara a la persona. `US` cuando las pruebas sitúan a la persona en EE. UU. pero no se conoce el estado. Vacío cuando no aplica ninguno." }, "retention_months": { "type": "integer", "nullable": true, "description": "El límite de retención biométrica más corto, en meses, entre las `jurisdictions`. `null` cuando no se aplica ninguno." }, "reason": { "type": "string", "nullable": true, "enum": [ "BIOMETRIC_CONSENT_UNSUPPORTED_SDK", "BIOMETRIC_CONSENT_DECLINED" ], "description": "`BIOMETRIC_CONSENT_UNSUPPORTED_SDK`: el consentimiento era obligatorio y un SDK nativo anterior a la versión 4.10.0, o uno que no informó su versión, capturó un rostro sin el paso de consentimiento; `status` se mantiene en `pending`, o en `given` si la persona aceptó después en el flujo alojado. `BIOMETRIC_CONSENT_DECLINED`: se registró un rechazo (sustituye al motivo del SDK). `null` en los demás casos, y siempre `null` cuando la sesión no requería consentimiento." }, "decline_reason": { "type": "string", "nullable": true, "enum": [ "BIOMETRIC_CONSENT_DECLINED" ], "description": "`BIOMETRIC_CONSENT_DECLINED` cuando un rechazo registrado terminó la sesión; en caso contrario, `null`." }, "face_data_deleted_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo el rechazo eliminó las imágenes faciales, los vídeos y las plantillas faciales de la sesión. `null` salvo que se haya registrado un rechazo." } } }, "investigator": { "$ref": "#/components/schemas/InvestigatorBlock" }, "biometric_retention": { "$ref": "#/components/schemas/BiometricRetention" }, "fraud_check": { "type": "object", "nullable": true, "additionalProperties": true, "description": "El resultado de una llamada a la Fraud Check API. `null` para cualquier otra sesión." }, "full_session_video": { "type": "string", "format": "uri", "nullable": true, "description": "URL temporal de la grabación de la sesión completa. Solo se devuelve cuando tu organización graba vídeo de la sesión completa." }, "full_session_video_recorded_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se realizó la grabación de la sesión completa. Solo se devuelve cuando tu organización graba vídeo de la sesión completa." } } }, "WorkflowDetail": { "type": "object", "description": "Los campos siguientes están tipados; el objeto también incluye todas las demás columnas de la configuración del flujo (activación de funciones, umbrales, acciones ante advertencias, documentos permitidos, callbacks) como propiedades adicionales. Los campos que no se aplican al `workflow_type` son `null`.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador por versión (`settings_uuid`). Cada versión de un flujo tiene el suyo." }, "workflow_id": { "type": "string", "format": "uuid", "description": "Identificador estable compartido por todas las versiones del flujo. Las sesiones creadas con él usan la última versión publicada." }, "workflow_label": { "type": "string", "description": "Nombre visible del flujo." }, "workflow_type": { "type": "string", "nullable": true, "enum": [ "kyc", "kyb", "adaptive_age_verification", "biometric_authentication", "address_verification", "questionnaire_verification", "email_verification", "phone_verification", null ], "description": "Plantilla del flujo. `null` en los flujos de grafo creados sin plantilla." }, "is_default": { "type": "boolean", "description": "Si este es el flujo predeterminado de la aplicación." }, "is_archived": { "type": "boolean", "description": "Los flujos archivados no pueden iniciar nuevas sesiones." }, "version": { "type": "integer", "description": "Número de versión dentro del flujo." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Las versiones en borrador son editables; las versiones publicadas son inmutables y se usan para las nuevas sesiones." }, "published_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se publicó esta versión. `null` para los borradores." }, "is_simple_workflow": { "type": "boolean", "description": "`true` cuando el flujo no tiene un `workflow_graph` personalizado." }, "is_editable": { "type": "boolean", "description": "`true` solo para las versiones `draft`." }, "workflow_url": { "type": "string", "format": "uri", "description": "URL pública que inicia una sesión con este flujo." }, "workflow_graph": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Estructura de grafo del flujo de verificación (workflow) (nodos y aristas). `null` para flujos simples." }, "features": { "type": "string", "description": "Funciones habilitadas unidas con `\" + \"`, por ejemplo `\"OCR + LIVENESS\"`." }, "total_price": { "type": "number", "nullable": true, "description": "Precio por sesión; en los flujos de tipo grafo, la ruta más cara." }, "min_price": { "type": "number", "nullable": true, "description": "Precio de la ruta más económica del flujo." }, "max_price": { "type": "number", "nullable": true, "description": "Precio de la ruta más cara del flujo." }, "special_add_on_prices": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Precios de complementos específicos de la organización, o `null` si no hay ninguno configurado." }, "max_retry_attempts": { "type": "integer", "description": "Reintentos permitidos tras una verificación rechazada." }, "retry_window_days": { "type": "integer", "nullable": true, "description": "Días durante los que se permiten los reintentos." }, "session_expiration_time": { "type": "integer", "description": "Segundos antes de que expire una sesión sin finalizar." }, "questionnaire": { "type": "object", "nullable": true, "additionalProperties": true, "description": "El cuestionario asociado al flujo, o `null`." }, "kyb_role_settings": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Configuración de verificación por rol para las personas clave de KYB." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "signature_availability": { "type": "object", "description": "Qué niveles de Firma electrónica pueden firmar en este momento. Consúltalo antes de definir `signature_level`. Se devuelve en los flujos `kyc`, `kyb` y de grafo.", "properties": { "simple": { "type": "boolean", "description": "Simple siempre está disponible." }, "aes": { "type": "boolean", "description": "Indica si Avanzada (AES) ya puede firmar. Mientras sea `false`, guardar un nuevo paso con `signature_level: \"aes\"` se rechaza con `aes_not_available`." }, "qes": { "type": "boolean", "description": "Indica si Cualificada (QES) ya puede firmar. Es `false` hasta que se conecte un proveedor cualificado." } } }, "is_bank_verification_enabled": { "type": "boolean", "description": "Indica si un flujo de verificación (workflow) simple de KYC o KYB ejecuta la verificación bancaria. Se ejecuta después de los pasos de contacto (y de la verificación de ubicación) y antes de la validación de base de datos, el análisis AML y el análisis de IP. La verificación bancaria aún no está disponible de forma general: se rechaza su activación donde no esté habilitada." }, "bank_verification_config": { "type": "object", "additionalProperties": true, "description": "Configuración de verificación bancaria de un flujo simple, con las mismas claves que admite un nodo `BANK_VERIFICATION` (por ejemplo, `bank_countries` y `bank_method_order`). Las claves desconocidas se descartan. Todas las claves son opcionales y una clave ausente mantiene su valor predeterminado, por lo que `{}` significa todos los valores predeterminados. Consulta [Configuración de verificación bancaria](/es/management-api/workflows/feature-configs#verificación-bancaria).", "example": {} }, "is_geolocation_enabled": { "type": "boolean", "description": "Indica si un flujo de verificación (workflow) simple de KYC ejecuta la verificación de ubicación. Se ejecuta después de los pasos de contacto y antes de la verificación bancaria y la validación de base de datos. Los flujos de empresas (KYB) no pueden ejecutarla." }, "geolocation_config": { "type": "object", "additionalProperties": true, "description": "Configuración de verificación de ubicación de un flujo simple, con las mismas claves que admite un nodo `GEOLOCATION` (por ejemplo, `is_geolocation_geofencing_enabled` y `geolocation_max_attempts`). Las claves desconocidas se descartan. Todas las claves son opcionales y una clave ausente conserva su valor predeterminado, por lo que `{}` significa todos los valores predeterminados.", "example": {} } }, "additionalProperties": true }, "UserSessionListItem": { "title": "KYC session row (session_kind: user)", "type": "object", "description": "Fila de resumen de una sesión de Verificación de usuarios (KYC). Los campos de identidad (`full_name`, `country`, `document_type`, `portrait_image`, campos de contacto) se rellenan progresivamente a medida que el usuario completa los pasos de verificación y son `null` hasta que finaliza el paso correspondiente. Los campos restringidos por la configuración de atributos de respuesta del flujo también se devuelven como `null`.", "required": [ "session_id", "session_kind", "session_number", "session_url", "portrait_image", "document_type", "full_name", "country", "status", "vendor_data", "didit_internal_id", "created_at", "features", "phone_number", "email_address", "additional_details" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Identificador único de la sesión de verificación. Úsalo con `GET /v3/session/{sessionId}/decision/` para obtener el payload completo de la decisión.", "example": "5b3720ed-d429-42ef-b67f-37ea805f48ee" }, "session_kind": { "type": "string", "enum": [ "user" ], "description": "Discriminador de fila. Siempre `\"user\"` en las filas KYC; las filas de Verificación de empresas (KYB) tienen `\"business\"` y una estructura diferente.", "example": "user" }, "session_number": { "type": "integer", "description": "Número secuencial legible de la sesión dentro de tu aplicación. El parámetro `search` también lo busca.", "example": 720 }, "session_url": { "type": "string", "nullable": true, "description": "URL de verificación alojada que el usuario final abre para completar el flujo. `null` cuando la sesión no tiene URL alojada.", "example": "https://verify.didit.me/session/CuXoBYCYVO5Y" }, "portrait_image": { "type": "string", "nullable": true, "description": "URL temporal (prefirmada) del mejor retrato disponible: la foto del chip NFC cuando está disponible; si no, el retrato del documento de identidad; y si no, la imagen de referencia de la prueba de vida. `null` hasta que exista alguna de ellas. Descárgala cuanto antes; el enlace expira.", "example": "https:///portraits/5b3720ed.jpg?X-Amz-Expires=3600&X-Amz-Signature=..." }, "document_type": { "type": "string", "nullable": true, "enum": [ "Passport", "Identity Card", "Driver's License", "Residence Permit", "Health Insurance Card", "Tax Card" ], "description": "Tipo legible del documento de identidad verificado. `null` antes de que finalice la verificación del documento, y también `null` después de finalizar cuando el código verificado no tiene un valor de visualización asociado (`SSC`, `WP`, `VISA`, `PSC`, `BC`, `OTHER`). Nota: el parámetro de consulta `document_type` filtra por códigos cortos (`P`, `ID`, `DL`, `RP`, ...), no por estos valores de visualización.", "example": "Passport" }, "full_name": { "type": "string", "nullable": true, "description": "Mejor nombre completo disponible para la sesión. Se resuelve en este orden: OCR del documento de identidad, datos analizados en AML, datos analizados en la validación de base de datos, documento de prueba de domicilio y, por último, los datos esperados proporcionados al crear la sesión. `null` cuando aún no hay ninguno disponible.", "example": "Jane Marie Doe" }, "country": { "type": "string", "nullable": true, "description": "País ISO 3166-1 alpha-3 asociado a la sesión, determinado en este orden: estado emisor del documento de identidad, estado emisor de la validación de base de datos, estado emisor de la prueba de domicilio, datos esperados y, por último, el país del teléfono verificado. Puede diferir de la nacionalidad.", "example": "ESP" }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Estado global de la sesión. Consulta la página [Estados de verificación](/es/integration/verification-statuses) para ver el ciclo de vida.", "example": "Approved" }, "vendor_data": { "type": "string", "nullable": true, "description": "Tu propio identificador del usuario final, devuelto exactamente como se envió al crear la sesión.", "example": "your-user-id-123" }, "didit_internal_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Identificador interno de Didit del perfil de usuario verificado asociado a esta sesión. Es estable entre varias sesiones del mismo usuario; se puede filtrar mediante el parámetro de consulta `didit_internal_id`.", "example": "d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147" }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de tiempo UTC en la que se creó la sesión.", "example": "2026-06-09T12:26:54.328364Z" }, "features": { "type": "array", "description": "Estado por función de cada paso de verificación configurado en el flujo de la sesión, en el orden del flujo.", "items": { "type": "object", "required": [ "feature", "status" ], "properties": { "feature": { "type": "string", "enum": [ "ID_VERIFICATION", "NFC", "LIVENESS", "FACE_MATCH", "POA", "QUESTIONNAIRE", "EMAIL_VERIFICATION", "PHONE", "AML", "IP_ANALYSIS", "AGE_ESTIMATION", "DATABASE_VALIDATION", "GEOLOCATION" ], "description": "Identificador de la función de verificación.", "example": "ID_VERIFICATION" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estado de esta función. `Not Finished` hasta que se completa el paso.", "example": "Approved" } } } }, "phone_number": { "type": "object", "nullable": true, "description": "Teléfono asociado a la sesión: el teléfono verificado si se ejecutó la verificación de teléfono; si no, el teléfono de contacto indicado al crear la sesión. `null` cuando no existe ninguno de los dos.", "required": [ "number", "is_verified" ], "properties": { "number": { "type": "string", "description": "Número de teléfono en formato E.164.", "example": "+14155552671" }, "is_verified": { "type": "boolean", "description": "`true` solo cuando la función de verificación de teléfono aprobó este número.", "example": true } } }, "email_address": { "type": "object", "nullable": true, "description": "Correo electrónico asociado a la sesión: el correo verificado cuando se ejecutó la verificación de correo electrónico; en caso contrario, el correo de contacto proporcionado al crear la sesión. `null` cuando no existe ninguno.", "required": [ "email", "is_verified" ], "properties": { "email": { "type": "string", "format": "email", "example": "jane@example.com" }, "is_verified": { "type": "boolean", "description": "`true` solo cuando la función de verificación de correo electrónico aprobó esta dirección.", "example": true } } }, "additional_details": { "type": "object", "nullable": true, "description": "Datos adicionales compactos por función. Solo aparecen como claves las funciones que produjeron datos; es `null` cuando ninguna función produjo datos adicionales. Se omiten los campos excluidos por la configuración de atributos de respuesta del flujo.", "properties": { "aml": { "type": "object", "description": "Presente cuando se ejecutó el análisis AML.", "properties": { "total_hits": { "type": "integer", "description": "Número de coincidencias del análisis AML.", "example": 0 }, "entity_type": { "type": "string", "description": "Tipo de entidad analizada.", "example": "person" }, "is_adverse_media_fetched": { "type": "boolean", "example": false }, "screened_data": { "type": "object", "description": "Subconjunto de los datos analizados. Solo se incluyen las claves que no están vacías.", "properties": { "nationality": { "type": "string", "example": "ESP" }, "document_number": { "type": "string", "example": "XX1234567" }, "date_of_birth": { "type": "string", "example": "1990-05-21" } } } } }, "database_validation": { "type": "object", "description": "Presente cuando se ejecutó la validación de base de datos.", "properties": { "validation_type": { "type": "string", "example": "DOCUMENT_VALIDATION" }, "match_type": { "type": "string", "example": "FULL_MATCH" }, "identification_number": { "type": "string", "description": "Número fiscal, personal o de documento que se validó (el primero disponible).", "example": "12345678Z" } } }, "poa": { "type": "object", "description": "Presente cuando se ejecutó la prueba de domicilio.", "properties": { "document_type": { "type": "string", "example": "UTILITY_BILL" }, "issuer": { "type": "string", "example": "Energy Co" }, "address": { "type": "string", "example": "Calle Mayor 1, 28013 Madrid" }, "name_on_document": { "type": "string", "example": "Jane Marie Doe" } } }, "liveness": { "type": "object", "description": "Presente cuando se ejecutó una prueba de vida.", "properties": { "method": { "type": "string", "example": "PASSIVE" }, "score": { "type": "number", "description": "Puntuación de confianza de la prueba de vida, redondeada a 2 decimales.", "example": 0.98 } } }, "face_match": { "type": "object", "description": "Presente cuando se ejecutó la coincidencia facial.", "properties": { "score": { "type": "number", "description": "Puntuación de similitud de la coincidencia facial, redondeada a 2 decimales.", "example": 0.95 }, "source_image": { "type": "string", "description": "URL temporal (prefirmada) de la imagen facial de origen.", "example": "https:///faces/source.jpg?X-Amz-Expires=3600&..." }, "target_image": { "type": "string", "description": "URL temporal (prefirmada) de la imagen facial de destino.", "example": "https:///faces/target.jpg?X-Amz-Expires=3600&..." } } }, "phone_verification": { "type": "object", "description": "Presente cuando se ejecutó la verificación de teléfono.", "properties": { "country_code": { "type": "string", "description": "País ISO 3166-1 alpha-2 del número de teléfono.", "example": "US" }, "is_temporary": { "type": "boolean", "example": false }, "is_ported": { "type": "boolean", "example": false }, "is_blocked": { "type": "boolean", "example": false } } }, "email_verification": { "type": "object", "description": "Presente cuando se ejecutó la verificación de correo electrónico.", "properties": { "is_breached": { "type": "boolean", "example": false }, "is_disposable": { "type": "boolean", "example": false }, "is_undeliverable": { "type": "boolean", "example": false }, "is_blocklisted": { "type": "boolean", "example": false } } } } }, "assignee": { "type": "object", "nullable": true, "description": "El revisor de la consola al que está asignada la sesión, o `null` cuando nadie la tiene asignada.", "properties": { "email": { "type": "string", "format": "email" }, "assigned_at": { "type": "string", "format": "date-time", "nullable": true } } }, "waiting_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que la sesión empezó a esperar revisión. `null` salvo que la sesión esté en `In Review`." }, "sla_due_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha límite de la revisión, según el plazo de revisión configurado para tu aplicación en la Console. `null` salvo que la sesión esté en `In Review` y haya un plazo configurado." }, "top_warnings": { "type": "array", "description": "Unas pocas de las advertencias más importantes de la sesión, como máximo, para una vista rápida de triaje. La lista completa está en la decisión.", "items": { "type": "object", "properties": { "risk": { "type": "string", "description": "Código de advertencia, por ejemplo `FACE_MATCH_LOW_SIMILARITY`." }, "feature": { "type": "string", "description": "La función que la generó." }, "log_type": { "type": "string", "nullable": true, "description": "`error` o `warning`; `null` para una entrada heredada." }, "short_description": { "type": "string" } } } }, "warnings_count": { "type": "integer", "description": "Número de advertencias de la sesión." } } }, "BusinessSessionListItem": { "title": "KYB session row (session_kind: business)", "type": "object", "description": "Fila de resumen de una sesión de Verificación de empresas (KYB). Solo se devuelve cuando `session_kind` es `business` o `all`.", "required": [ "session_id", "session_kind", "session_number", "status", "vendor_data", "created_at", "workflow_id", "workflow_type", "workflow_label", "company_name", "registration_number", "country" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Identificador único de la sesión de verificación de empresas.", "example": "8a1f63c2-1b9e-4f3a-9c41-2f6a1f0b7d52" }, "session_kind": { "type": "string", "enum": [ "business" ], "description": "Discriminador de fila. Siempre `\"business\"` en las filas KYB.", "example": "business" }, "session_number": { "type": "integer", "description": "Número secuencial legible de la sesión de empresa dentro de tu aplicación. Se numera de forma independiente de las sesiones KYC.", "example": 42 }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Estado global de la sesión. Consulta la página [Estados de verificación](/es/integration/verification-statuses).", "example": "Approved" }, "vendor_data": { "type": "string", "nullable": true, "description": "Tu propio identificador de la empresa, devuelto exactamente como se envió al crear la sesión.", "example": "your-company-id-77" }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de tiempo UTC en la que se creó la sesión.", "example": "2026-06-08T09:14:02.118450Z" }, "workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Identificador del flujo con el que se creó esta sesión.", "example": "9f9b1234-aaaa-bbbb-cccc-1234567890ab" }, "workflow_type": { "type": "string", "nullable": true, "description": "Tipo de flujo. `kyb` para los flujos de empresas.", "example": "kyb" }, "workflow_label": { "type": "string", "nullable": true, "description": "Nombre visible del flujo.", "example": "Standard KYB" }, "company_name": { "type": "string", "nullable": true, "description": "Nombre de la empresa que se verifica, tomado de la empresa del registro vinculada a la sesión. `null` hasta que se seleccione una empresa.", "example": "Acme Holdings S.L." }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registro de la empresa, tomado de la empresa del registro vinculada a la sesión.", "example": "B12345678" }, "country": { "type": "string", "nullable": true, "description": "Código de país de la empresa del registro vinculada a la sesión.", "example": "ES" } } }, "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" ] }, "TransactionRuleActionAddScore": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "add_score" ] }, "value": { "type": "integer", "description": "Puntos que se suman a la puntuación de riesgo de la transacción. Pueden ser negativos." } }, "description": "Suma puntos a la puntuación de riesgo acumulada de la transacción; el total determina el estado según los umbrales de revisión/rechazo de la aplicación." }, "TransactionRuleActionChangeStatus": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "change_status" ] }, "value": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Estado que se establece de inmediato, independientemente de la puntuación. Clave alias: status." }, "workflow_id": { "type": "string", "format": "uuid", "description": "OBLIGATORIO cuando el valor es AWAITING_USER: el flujo de verificación que se pide completar al sujeto. Clave alias: remediation_workflow_id. Didit crea una sesión de remediación alojada para el sujeto cuando se dispara la regla." } }, "description": "Establece directamente el estado de la transacción. DECLINED siempre prevalece entre las reglas coincidentes." }, "TransactionRuleActionAddTags": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "add_tags" ] }, "tag_uuid": { "type": "string", "format": "uuid", "description": "Etiqueta existente de la aplicación que se va a asociar." }, "tag_name": { "type": "string", "description": "Nombre de la etiqueta que se asociará; se crea en el primer uso (se almacena en mayúsculas). Indica tag_uuid o tag_name." }, "tag_color": { "type": "string", "description": "Color hexadecimal que se usa cuando tag_name crea una etiqueta nueva, p. ej., #007AFE." } }, "description": "Adjunta una etiqueta de la aplicación a la transacción coincidente." }, "TransactionRuleActionAddNote": { "type": "object", "required": [ "type", "note" ], "properties": { "type": { "type": "string", "enum": [ "add_note" ] }, "note": { "type": "string", "description": "Texto de la nota adjunta a la transacción (autor: Rule Engine). Clave alias: value." } }, "description": "Adjunta una nota automática de analista a la transacción coincidente." }, "TransactionRuleActionAddToList": { "type": "object", "required": [ "type", "list_id" ], "properties": { "type": { "type": "string", "enum": [ "add_to_list" ] }, "list_id": { "type": "string", "format": "uuid", "description": "Lista a la que se añade el vendor_data del sujeto." } }, "description": "Añade el vendor_data del sujeto a una lista de bloqueo, una lista de permitidos o una lista personalizada." }, "TransactionRuleActionOpenCase": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "open_case" ] }, "blueprint": { "type": "string", "format": "uuid", "description": "UUID de la plantilla de caso; por defecto, la plantilla predeterminada de la aplicación." }, "grouping": { "type": "string", "enum": [ "by_applicant", "by_rule_and_applicant" ], "description": "Indica si las coincidencias repetidas se agrupan en un caso por solicitante o en uno por regla+solicitante." }, "attach_matched_transaction": { "type": "boolean", "description": "Adjunta la transacción coincidente al caso." } }, "description": "Abrir un caso de investigación (o añadir a uno). Solo se aplica la primera acción open_case de una regla." }, "KYBRegistrySearchResults": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "kyb_response_id": { "type": "string", "nullable": true, "description": "Identificador de este candidato: pásalo a `POST /v3/kyb/select/` para obtener el perfil completo. Es efímero y está limitado a esta búsqueda: no lo almacenes a largo plazo; vuelve a buscar para obtener uno nuevo.", "example": "69aeeb95febb0f1704042259" }, "name": { "type": "string", "nullable": true, "description": "Razón social registrada.", "example": "Tesco PLC" }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registro en el registro.", "example": "00445790" }, "status": { "type": "string", "nullable": true, "description": "Estado normalizado de la empresa en el registro (por ejemplo, `active`, `dissolved`, `inactive`, `struck off`).", "example": "active" }, "type": { "type": "string", "nullable": true, "description": "Forma jurídica según el registro.", "example": "Public Limited Company" }, "registered_address": { "type": "string", "nullable": true, "description": "Dirección registrada del candidato, cuando el registro la devuelve. Úsala, junto con el número de registro, para distinguir empresas con el mismo nombre: en Estados Unidos, un candidato puede figurar en el estado donde opera la empresa y no en el estado en el que buscaste.", "example": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, AL7 1GA" }, "risk_level": { "type": "string", "nullable": true, "description": "Nivel de riesgo según el registro, cuando está disponible. Normalmente es `null` en el momento de la búsqueda." }, "fetch_status": { "type": "string", "nullable": true, "description": "Siempre `pending` para los candidatos de búsqueda: el perfil completo de la empresa solo se obtiene (y se factura) cuando seleccionas el candidato.", "example": "pending" } } }, "description": "Lista de candidatos sin duplicados. Vacía mientras `search_resolved=false` (modo webhook) o cuando no hubo coincidencias." }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "description": "Número de candidatos devueltos." }, "page": { "type": "integer" }, "per_page": { "type": "integer", "example": 25 } } }, "search_status": { "type": "string", "nullable": true, "enum": [ "pending", "resolved" ], "description": "Estado del ciclo de vida de la búsqueda en el registro." }, "search_resolved": { "type": "boolean", "description": "`true` una vez que la lista de candidatos es definitiva." } } }, "KYBRegistryCandidateRequest": { "type": "object", "required": [ "kyb_response_id" ], "properties": { "kyb_response_id": { "type": "string", "maxLength": 1024, "description": "Identificador del candidato devuelto por `POST /v3/kyb/search/` (`kyb_registry.companies[].kyb_response_id`). Efímero: úsalo poco después de la búsqueda que lo generó. Los identificadores pueden ser largos, así que guarda y envía el valor exactamente como se devolvió, sin recortarlo ni suponer una longitud.", "example": "69aeeb95febb0f1704042259" }, "vendor_data": { "type": "string", "description": "Tu identificador de esta empresa; se devuelve en la respuesta y se almacena con la sesión de empresa." }, "metadata": { "type": "object", "nullable": true, "description": "JSON libre que se guarda con la sesión de empresa y se devuelve en la respuesta." }, "save_api_request": { "type": "boolean", "default": true, "description": "Debe ser `true` (el valor predeterminado). Las selecciones del registro KYB siempre se guardan para poder hacer el seguimiento de la facturación y la recuperación; `false` devuelve `400`." } } }, "WebhookEventEnvelope": { "type": "object", "description": "Campos que Didit añade a cada entrega de webhook firmada, sea cual sea el tipo de evento. Lee `webhook_type` para saber qué payload recibiste.", "required": [ "event_id", "webhook_type", "timestamp", "created_at", "application_id", "environment" ], "properties": { "event_id": { "type": "string", "format": "uuid", "description": "Identificador del evento. Todos los destinos reciben el mismo valor y una reentrega lo conserva, así que úsalo para deduplicar." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "timestamp": { "type": "integer", "description": "Tiempo Unix en segundos en que se firmó esta entrega. Es igual al encabezado `X-Timestamp`; una nueva entrega lleva un valor nuevo." }, "created_at": { "type": "integer", "description": "Tiempo Unix en segundos del cambio que generó el evento." }, "application_id": { "type": "string", "format": "uuid", "description": "La aplicación a la que pertenece el evento." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "`sandbox` para sesiones de sandbox y aplicaciones de sandbox; en caso contrario, `live`." } } }, "SessionWebhookEventData": { "type": "object", "description": "Campos de sesión de `status.updated` y `data.updated`. Los campos opcionales se omiten, nunca se envían como `null`, cuando no aplican. Las sesiones de empresa (KYB) añaden `business_session_id`, `session_kind` y `vendor_business_id`.", "required": [ "session_id", "status", "sandbox_scenario" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "La sesión de verificación." }, "business_session_id": { "type": "string", "format": "uuid", "description": "Solo sesiones de empresa (KYB): el mismo valor que `session_id`." }, "session_kind": { "type": "string", "enum": [ "business" ], "description": "Solo sesiones de empresa (KYB). Los eventos de sesiones de usuario (KYC) no incluyen `session_kind` en el nivel superior; lee `decision.session_kind` en su lugar." }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Estado de la sesión después del cambio." }, "trigger": { "type": "string", "description": "Presente cuando el evento no lo produjo el propio flujo de verificación, por ejemplo `manual_review`, `manual_step_update`, `ongoing_monitoring`, `webhook_reconciliation` (un `status.updated` reenviado porque el primer webhook terminal nunca se creó, así que puedes recibir un segundo evento para una decisión que ya recibiste: elimina duplicados por `session_id` y `status`), `manual_webhook_recovery`, `kyb_registry_change`, `biometric_retention` (un `data.updated` enviado cuando los datos biométricos activos de la sesión se eliminan según lo programado) o una edición `console_*` como `console_registry_edit`, `console_key_people_skip` o `console_key_people_regenerate`." }, "workflow_id": { "type": "string", "format": "uuid", "description": "El flujo de verificación de la sesión. Se omite cuando la sesión no tiene ninguno." }, "workflow_version": { "type": "integer", "description": "Versión del flujo que ejecutó la sesión. Se envía junto con `workflow_id`." }, "vendor_data": { "type": "string", "description": "Tu `vendor_data` para la sesión. Se omite cuando está vacío." }, "vendor_business_id": { "type": "string", "description": "Solo sesiones de empresa (KYB): la empresa a la que pertenece la sesión. Se omite cuando no hay ninguna." }, "metadata": { "type": "object", "additionalProperties": true, "description": "El `metadata` de tu sesión. Se omite cuando está vacío." }, "decision": { "$ref": "#/components/schemas/SessionDecision" }, "resubmit_info": { "type": "object", "description": "Solo cuando `status` es `Resubmitted`: los pasos que el usuario debe repetir y el motivo.", "required": [ "nodes_to_resubmit", "reasons" ], "properties": { "nodes_to_resubmit": { "type": "array", "items": { "type": "object", "required": [ "node_id", "feature" ], "properties": { "node_id": { "type": "string", "description": "Identificador del nodo tal como aparece en la definición del flujo de la sesión (por ejemplo, `feature_ocr`, `feature_liveness`).", "example": "feature_poa" }, "feature": { "type": "string", "description": "Tipo de función del nodo, por ejemplo `OCR`, `LIVENESS` o `PROOF_OF_ADDRESS`.", "example": "PROOF_OF_ADDRESS" } } }, "description": "Pasos del flujo que el usuario debe repetir. Las mismas entradas `{node_id, feature}` que `nodes_to_resubmit` en [Actualizar estado](#patch-/v3/session/-sessionId-/update-status/)." }, "reasons": { "type": "object", "additionalProperties": true, "description": "Motivo para cada `node_id` de `nodes_to_resubmit`." } } }, "sandbox_scenario": { "type": "string", "nullable": true, "description": "El resultado simulado configurado en una sesión de sandbox, o `null`. Siempre es `null` en las sesiones de producción." } } }, "SessionStatusUpdatedEvent": { "description": "Una sesión de verificación cambió de estado. `decision` solo se envía para `Approved`, `Declined`, `In Review` y `Abandoned`; tiene la forma de `GET /v3/session/{sessionId}/decision/` para los destinos con la versión 3 de webhook (la predeterminada), y la forma reducida anterior para los destinos con la versión 1 o 2. Las sesiones de empresa siempre reciben la decisión de empresa de la versión 3.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "$ref": "#/components/schemas/SessionWebhookEventData" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "status.updated" ], "description": "Siempre `status.updated`." } }, "required": [ "webhook_type" ] } ] }, "SessionDataUpdatedEvent": { "description": "Los datos de una sesión de verificación cambiaron sin que cambiara su estado, por ejemplo tras una edición en una revisión manual, la anulación de un paso o un nuevo análisis de la monitorización continua. `decision` solo se envía para `Approved`, `Declined`, `In Review` y `Abandoned`. Tiene la forma de `GET /v3/session/{sessionId}/decision/` para los destinos con la versión 3 de webhook (la predeterminada) y la forma reducida anterior para los destinos con la versión 1 o 2. Las sesiones de empresa siempre reciben la decisión de empresa de la versión 3.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "$ref": "#/components/schemas/SessionWebhookEventData" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "data.updated" ], "description": "Siempre `data.updated`." } }, "required": [ "webhook_type" ] } ] }, "UserStatusUpdatedEvent": { "description": "Un usuario cambió de estado. No se envía cuando se crea el usuario.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "user.status.updated" ], "description": "Siempre `user.status.updated`." }, "vendor_user_id": { "type": "string", "format": "uuid", "description": "El usuario al que se refiere el evento." }, "vendor_data": { "type": "string", "nullable": true, "description": "Tu `vendor_data` para el usuario, o `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Estado del usuario después del cambio." }, "previous_status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Estado antes del cambio." } }, "required": [ "webhook_type", "vendor_user_id", "vendor_data", "status", "previous_status" ] } ] }, "UserDataUpdatedEvent": { "description": "Cambiaron campos de un usuario. No se envía cuando se crea el usuario. Un mismo guardado puede generar tanto un evento de estado como uno de datos.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "user.data.updated" ], "description": "Siempre `user.data.updated`." }, "vendor_user_id": { "type": "string", "format": "uuid", "description": "El usuario al que se refiere el evento." }, "vendor_data": { "type": "string", "nullable": true, "description": "Tu `vendor_data` para el usuario, o `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Estado del usuario después del cambio." }, "changed_fields": { "type": "array", "items": { "type": "string", "enum": [ "vendor_data", "display_name", "full_name", "date_of_birth", "metadata", "portrait_image", "issuing_states", "approved_emails", "approved_phones", "features", "session_count", "approved_count", "declined_count", "in_review_count", "first_session_at", "last_session_at" ] }, "description": "Nombres de los campos que cambiaron." }, "changes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "previous": { "nullable": true, "description": "Valor antes del cambio. Las fechas son cadenas ISO 8601." }, "current": { "nullable": true, "description": "Valor después del cambio. Las fechas son cadenas ISO 8601." } } }, "description": "Valor anterior y actual de cada campo modificado, con el nombre del campo como clave. Los valores pueden ser datos personales (nombres, fechas de nacimiento, enlaces a retratos, correos electrónicos, números de teléfono); trátalos en consecuencia." } }, "required": [ "webhook_type", "vendor_user_id", "vendor_data", "status", "changed_fields", "changes" ] } ] }, "BusinessStatusUpdatedEvent": { "description": "Una empresa cambió de estado. No se envía cuando se crea la empresa.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "business.status.updated" ], "description": "Siempre `business.status.updated`." }, "vendor_business_id": { "type": "string", "format": "uuid", "description": "La empresa sobre la que trata el evento." }, "vendor_data": { "type": "string", "nullable": true, "description": "Tu `vendor_data` para la empresa, o `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Estado de la empresa tras el cambio." }, "previous_status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Estado antes del cambio." } }, "required": [ "webhook_type", "vendor_business_id", "vendor_data", "status", "previous_status" ] } ] }, "BusinessDataUpdatedEvent": { "description": "Cambiaron campos de una empresa. No se envía cuando se crea la empresa. Un mismo guardado puede generar tanto un evento de estado como uno de datos.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "business.data.updated" ], "description": "Siempre `business.data.updated`." }, "vendor_business_id": { "type": "string", "format": "uuid", "description": "La empresa sobre la que trata el evento." }, "vendor_data": { "type": "string", "nullable": true, "description": "Tu `vendor_data` para la empresa, o `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Estado de la empresa tras el cambio." }, "changed_fields": { "type": "array", "items": { "type": "string", "enum": [ "vendor_data", "display_name", "metadata", "legal_name", "registration_number", "country_code", "session_count", "approved_count", "declined_count", "in_review_count", "features", "first_session_at", "last_session_at" ] }, "description": "Nombres de los campos que cambiaron." }, "changes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "previous": { "nullable": true, "description": "Valor antes del cambio. Las fechas son cadenas ISO 8601." }, "current": { "nullable": true, "description": "Valor después del cambio. Las fechas son cadenas ISO 8601." } } }, "description": "Valor anterior y actual de cada campo modificado, con el nombre del campo como clave." } }, "required": [ "webhook_type", "vendor_business_id", "vendor_data", "status", "changed_fields", "changes" ] } ] }, "TransactionCreatedEvent": { "description": "Se creó y analizó una transacción. Solo se envía para aplicaciones en producción.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "transaction.created" ], "description": "Siempre `transaction.created`." }, "transaction_id": { "type": "string", "format": "uuid", "description": "Identificador de Didit de la transacción." }, "txn_id": { "type": "string", "nullable": true, "description": "El `transaction_id` que proporcionaste al crearla, o `null`." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Estado de la monitorización después del cambio." }, "score": { "type": "integer", "description": "Puntuación de riesgo acumulada por las reglas." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Gravedad del riesgo, o `null` hasta que una regla o un proveedor la establezca." }, "amount": { "type": "string", "description": "Importe de la transacción como cadena decimal. A diferencia de la API, no está normalizado, por lo que puede incluir ceros finales (hasta 18 decimales)." }, "currency": { "type": "string", "description": "Código de moneda o símbolo del criptoactivo de `amount`." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Sentido respecto al sujeto." }, "action_required": { "type": "object", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TransactionVerificationSessionAction" }, { "$ref": "#/components/schemas/TransactionWalletOwnershipAction" } ], "discriminator": { "propertyName": "type", "mapping": { "verification_session": "#/components/schemas/TransactionVerificationSessionAction", "wallet_ownership": "#/components/schemas/TransactionWalletOwnershipAction" } }, "description": "Acción pendiente del usuario final, o `null`. Es el mismo objeto que `action_required` en la transacción; `session_token` es una credencial, así que nunca la registres en logs." } }, "required": [ "webhook_type", "transaction_id", "txn_id", "status", "score", "severity", "amount", "currency", "direction", "action_required" ] } ] }, "TransactionStatusUpdatedEvent": { "description": "Una transacción cambió de estado, por una regla, una revisión o una acción del usuario final. Solo se envía para aplicaciones en producción.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "transaction.status.updated" ], "description": "Siempre `transaction.status.updated`." }, "transaction_id": { "type": "string", "format": "uuid", "description": "Identificador de Didit de la transacción." }, "txn_id": { "type": "string", "nullable": true, "description": "El `transaction_id` que proporcionaste al crearla, o `null`." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Estado de la monitorización después del cambio." }, "score": { "type": "integer", "description": "Puntuación de riesgo acumulada por las reglas." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Gravedad del riesgo, o `null` hasta que una regla o un proveedor la establezca." }, "amount": { "type": "string", "description": "Importe de la transacción como cadena decimal. A diferencia de la API, no está normalizado, por lo que puede incluir ceros finales (hasta 18 decimales)." }, "currency": { "type": "string", "description": "Código de moneda o símbolo del criptoactivo de `amount`." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Sentido respecto al sujeto." }, "action_required": { "type": "object", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TransactionVerificationSessionAction" }, { "$ref": "#/components/schemas/TransactionWalletOwnershipAction" } ], "discriminator": { "propertyName": "type", "mapping": { "verification_session": "#/components/schemas/TransactionVerificationSessionAction", "wallet_ownership": "#/components/schemas/TransactionWalletOwnershipAction" } }, "description": "Acción pendiente del usuario final, o `null`. Es el mismo objeto que `action_required` en la transacción; `session_token` es una credencial, así que nunca la registres en logs." } }, "required": [ "webhook_type", "transaction_id", "txn_id", "status", "score", "severity", "amount", "currency", "direction", "action_required" ] } ] }, "TravelRuleStatusUpdatedEvent": { "description": "Un intercambio de Travel Rule cambió de estado. Se envía en cada transición hasta `FINISHED`, `CANCELLED` o `EXPIRED`, incluidos, y nunca después. Se envía para aplicaciones en producción y, en el caso de los intercambios de Travel Rule, también para aplicaciones de sandbox (`environment: sandbox`). No hay un `status` de nivel superior.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "travel_rule.status.updated" ], "description": "Siempre `travel_rule.status.updated`." }, "transaction_id": { "type": "string", "format": "uuid", "description": "La transacción a la que pertenece el intercambio." }, "txn_id": { "type": "string", "nullable": true, "description": "El `transaction_id` que proporcionaste al crearla, o `null`." }, "travel_rule_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" ], "description": "Estado del intercambio tras el cambio." }, "rail": { "type": "string", "enum": [ "", "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL", "TEST_VASP" ], "description": "Red en la que se realiza el intercambio, o una cadena vacía cuando no se pudo determinar ninguna. `TEST_VASP` es una transferencia de sandbox a la que respondió el Didit Test VASP." }, "test_vasp": { "type": "boolean", "description": "Presente y con valor `true` solo en una transferencia de sandbox a la que respondió el Didit Test VASP." }, "test_vasp_scenario": { "type": "string", "description": "Presente solo con `test_vasp`: el escenario de sandbox que determinó el resultado, o una cadena vacía." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Sentido de la transferencia." } }, "required": [ "webhook_type", "transaction_id", "txn_id", "travel_rule_status", "rail", "direction" ] } ] }, "WorkflowComplianceChangedEvent": { "description": "El estado de cumplimiento de un flujo publicado cambió tras una reevaluación. Un evento por flujo. No hay `status` de nivel superior.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "workflow.compliance_changed" ], "description": "Siempre `workflow.compliance_changed`." }, "workflow_id": { "type": "string", "format": "uuid", "description": "El flujo que cambió." }, "workflow_version": { "type": "integer", "description": "Versión que se evaluó." }, "workflow_label": { "type": "string", "nullable": true, "description": "Nombre visible del flujo." }, "transition": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "type": "string", "enum": [ "compliant", "gaps_detected", "pending_change", "unknown_coverage", "not_evaluated" ], "description": "Estado antes de la reevaluación." }, "to": { "type": "string", "enum": [ "compliant", "gaps_detected", "pending_change", "unknown_coverage", "not_evaluated" ], "description": "Estado después de la reevaluación." } } }, "severity": { "type": "string", "enum": [ "actionable", "indicative", "informative" ], "description": "`actionable` cuando se detectaron carencias, `indicative` para un cambio pendiente e `informative` cuando se resolvieron las carencias." }, "kb_version": { "type": "string", "description": "Versión de la base de conocimiento regulatorio utilizada." } }, "required": [ "webhook_type", "workflow_id", "workflow_version", "workflow_label", "transition", "severity", "kb_version" ] } ] }, "WebhookEventPayload": { "description": "Cuerpo de una entrega de webhook firmada, diferenciado por `webhook_type`. Es posible suscribirse a `activity.created`, pero actualmente no se envía. Trata cualquier otro `webhook_type` como un tipo de evento nuevo y conserva el cuerpo sin procesar.", "oneOf": [ { "$ref": "#/components/schemas/SessionStatusUpdatedEvent" }, { "$ref": "#/components/schemas/SessionDataUpdatedEvent" }, { "$ref": "#/components/schemas/UserStatusUpdatedEvent" }, { "$ref": "#/components/schemas/UserDataUpdatedEvent" }, { "$ref": "#/components/schemas/BusinessStatusUpdatedEvent" }, { "$ref": "#/components/schemas/BusinessDataUpdatedEvent" }, { "$ref": "#/components/schemas/TransactionCreatedEvent" }, { "$ref": "#/components/schemas/TransactionStatusUpdatedEvent" }, { "$ref": "#/components/schemas/TravelRuleStatusUpdatedEvent" }, { "$ref": "#/components/schemas/WorkflowComplianceChangedEvent" }, { "$ref": "#/components/schemas/TransactionRuleSuggestionsCreatedEvent" } ], "discriminator": { "propertyName": "webhook_type", "mapping": { "status.updated": "#/components/schemas/SessionStatusUpdatedEvent", "data.updated": "#/components/schemas/SessionDataUpdatedEvent", "user.status.updated": "#/components/schemas/UserStatusUpdatedEvent", "user.data.updated": "#/components/schemas/UserDataUpdatedEvent", "business.status.updated": "#/components/schemas/BusinessStatusUpdatedEvent", "business.data.updated": "#/components/schemas/BusinessDataUpdatedEvent", "transaction.created": "#/components/schemas/TransactionCreatedEvent", "transaction.status.updated": "#/components/schemas/TransactionStatusUpdatedEvent", "travel_rule.status.updated": "#/components/schemas/TravelRuleStatusUpdatedEvent", "workflow.compliance_changed": "#/components/schemas/WorkflowComplianceChangedEvent", "transaction_rule_suggestions.created": "#/components/schemas/TransactionRuleSuggestionsCreatedEvent" } } }, "KYBRegistrySearchResolvedCallback": { "type": "object", "description": "Cuerpo del callback que se envía a la `webhook_url` de `POST /v3/kyb/search/` cuando se resuelve la búsqueda en el registro. No está firmado: la solicitud incluye `X-Didit-Unsigned-Callback: true` y ninguno de los encabezados de firma, así que confírmalo comparando `request_id` con una búsqueda que hayas iniciado. Usa `event_type`, no `webhook_type`.", "required": [ "event_id", "event_type", "request_id", "vendor_data", "metadata", "search_status", "search_resolved", "kyb_registry", "timestamp", "created_at" ], "properties": { "event_id": { "type": "string", "format": "uuid", "description": "Identificador del callback." }, "event_type": { "type": "string", "enum": [ "kyb.registry_search.resolved" ], "description": "Siempre `kyb.registry_search.resolved`." }, "request_id": { "type": "string", "format": "uuid", "description": "El `request_id` que devuelve `POST /v3/kyb/search/`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Devuelve el `vendor_data` que enviaste." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Devuelve el `metadata` que enviaste." }, "search_status": { "type": "string", "description": "Actualmente siempre `resolved`." }, "search_resolved": { "type": "boolean", "description": "`true` cuando `search_status` es `resolved`." }, "kyb_registry": { "$ref": "#/components/schemas/KYBRegistrySearchResults" }, "timestamp": { "type": "integer", "description": "Tiempo Unix en segundos en que se puso en cola el callback." }, "created_at": { "type": "integer", "description": "Tiempo Unix en segundos en que se puso en cola el callback." } } }, "AMLScreening": { "type": "object", "properties": { "node_id": { "type": "string", "description": "Identificador único de este paso AML en el grafo del flujo." }, "status": { "type": "string", "description": "Estado a nivel de función de este análisis AML. Es independiente del `status` de nivel superior de la sesión: una sesión puede alcanzar su decisión global mientras una función concreta sigue en `In Review`.", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ] }, "total_hits": { "type": "integer", "description": "Número total de coincidencias encontradas" }, "entity_type": { "type": "string", "description": "Tipo de entidad analizada: persona o empresa" }, "hits": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador estable de Didit para la coincidencia: `hit_` seguido de 24 caracteres hexadecimales. La misma entidad coincidente conserva el mismo `id` cuando el sujeto se vuelve a analizar. Pásalo como `hit_id` a los endpoints de revisión de coincidencias AML." }, "url": { "type": "string", "format": "uri", "description": "URL de origen de la coincidencia" }, "match": { "type": "boolean", "description": "Si se trata de una coincidencia confirmada" }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 1, "description": "Puntuación de coincidencia ponderada obsoleta en el rango 0-1 (p. ej., `0.73`). Usa `match_score` (0-100) en su lugar.", "deprecated": true }, "target": { "type": "boolean", "nullable": true, "description": "Si la entidad coincidente es el objetivo directo de la inclusión en la lista (y no una parte relacionada). `null` cuando la fuente no lo especifica." }, "caption": { "type": "string", "description": "Leyenda o título de la coincidencia" }, "datasets": { "type": "array", "items": { "type": "string", "enum": [ "PEP", "PEP Level 1", "PEP Level 2", "PEP Level 3", "PEP Level 4", "Sanctions", "Adverse Media", "Warnings and Regulatory Enforcement", "Fitness and Probity", "SIP", "SIE", "Insolvency", "Other Lists" ] }, "description": "Lista de categorías de conjuntos de datos en las que se encontró la coincidencia. Indica si la entidad apareció en listas PEP (con nivel), bases de datos de sanciones, medios adversos, advertencias o medidas regulatorias de cumplimiento, u otros conjuntos de datos de cumplimiento. `Other Lists` cuando la fuente de la entidad no indica ninguna de estas categorías." }, "features": { "type": "object", "nullable": true, "description": "Características adicionales de la coincidencia" }, "rca_name": { "type": "string", "description": "Nombre del RCA, si corresponde" }, "last_seen": { "type": "string", "format": "date-time", "description": "Fecha en que se detectó la coincidencia por última vez" }, "risk_view": { "type": "object", "properties": { "crimes": { "type": "object", "properties": { "score": { "type": "integer" }, "weightage": { "type": "integer" }, "risk_level": { "type": "string" }, "risk_scores": { "type": "object" } } }, "countries": { "type": "object", "properties": { "score": { "type": "integer" }, "weightage": { "type": "integer" }, "risk_level": { "type": "string" }, "risk_scores": { "type": "object" } } }, "categories": { "type": "object", "properties": { "score": { "type": "integer" }, "weightage": { "type": "integer" }, "risk_level": { "type": "string" }, "risk_scores": { "type": "object" } } }, "custom_list": { "type": "object" } } }, "first_seen": { "type": "string", "format": "date-time", "description": "Fecha en que se detectó la coincidencia por primera vez" }, "properties": { "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" } }, "alias": { "type": "array", "items": { "type": "string" } }, "notes": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string", "nullable": true }, "gender": { "type": "array", "items": { "type": "string" } }, "height": { "type": "string", "nullable": true }, "topics": { "type": "string", "nullable": true }, "weight": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "eyeColor": { "type": "string", "nullable": true }, "keywords": { "type": "string", "nullable": true }, "lastName": { "type": "array", "items": { "type": "string" } }, "position": { "type": "string", "nullable": true }, "religion": { "type": "string", "nullable": true }, "birthDate": { "type": "array", "items": { "type": "string" } }, "education": { "type": "array", "items": { "type": "string" } }, "ethnicity": { "type": "string", "nullable": true }, "firstName": { "type": "array", "items": { "type": "string" } }, "hairColor": { "type": "string", "nullable": true }, "weakAlias": { "type": "string", "nullable": true }, "birthPlace": { "type": "array", "items": { "type": "string" } }, "modifiedAt": { "type": "string", "nullable": true }, "wikidataId": { "type": "string", "nullable": true }, "citizenship": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true } } }, "match_score": { "type": "number", "description": "Puntuación de confianza de identidad ponderada (0-100), calculada a partir de la similitud del nombre, la fecha de nacimiento y la coincidencia de país. Se usa para determinar si un resultado es un falso positivo o una posible coincidencia.", "format": "float", "nullable": true }, "risk_score": { "type": "number", "description": "Puntuación de riesgo de la entidad (0-100). Se usa para determinar el estado AML final (Aprobado/En revisión/Rechazado) según el risk_score más alto entre las coincidencias que no son falsos positivos." }, "review_status": { "type": "string", "description": "Estado de revisión de esta coincidencia. Puede ser 'Unreviewed', 'Confirmed Match', 'False Positive' o 'Inconclusive'.", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ] }, "score_breakdown": { "type": "object", "description": "Desglose detallado de cómo se calculó match_score.", "properties": { "name_score": { "type": "integer", "description": "Porcentaje de similitud de nombre sin procesar (0-100)." }, "name_weight": { "type": "integer", "description": "Peso original del nombre según la configuración (0-100)." }, "name_weight_normalized": { "type": "number", "description": "Peso normalizado del nombre tras reponderar por datos faltantes (0-100)." }, "name_contribution": { "type": "number", "description": "Puntos que aporta el nombre a la puntuación total." }, "dob_score": { "type": "integer", "description": "Puntuación de coincidencia de la fecha de nacimiento (de -100 a 100)." }, "dob_weight": { "type": "integer", "description": "Peso original de la fecha de nacimiento según la configuración (0-100)." }, "dob_weight_normalized": { "type": "number", "description": "Peso normalizado de la fecha de nacimiento tras reponderar por datos faltantes (0-100)." }, "dob_contribution": { "type": "number", "description": "Puntos que aporta la fecha de nacimiento a la puntuación total." }, "country_score": { "type": "integer", "description": "Puntuación de coincidencia del país (de -100 a 100)." }, "country_weight": { "type": "integer", "description": "Peso original del país según la configuración (0-100)." }, "country_weight_normalized": { "type": "number", "description": "Peso normalizado del país tras reponderar por datos faltantes (0-100)." }, "country_contribution": { "type": "number", "description": "Puntos que aporta el país a la puntuación total." }, "document_number_match_type": { "type": "string", "description": "Resultado de la evaluación 'Golden Key' del número de documento.", "enum": [ "MATCH", "NEUTRAL", "HARD_MISMATCH" ] }, "document_number_effect": { "type": "string", "description": "Descripción legible del efecto del número de documento en la puntuación." }, "total_score": { "type": "integer", "description": "Puntuación de coincidencia ponderada final (0-100)." } } }, "pep_matches": { "type": "array", "items": { "type": "object", "properties": { "aliases": { "type": "array", "items": { "type": "string" } }, "education": { "type": "array", "items": { "type": "string" } }, "list_name": { "type": "string" }, "publisher": { "type": "string" }, "source_url": { "type": "string", "format": "uri" }, "description": { "type": "string" }, "matched_name": { "type": "string" }, "pep_position": { "type": "string" }, "date_of_birth": { "type": "string" }, "other_sources": { "type": "array", "items": { "type": "string" } }, "place_of_birth": { "type": "string" } } } }, "linked_entities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" } }, "active": { "type": "array", "items": { "type": "string" } }, "status": { "type": "array", "items": { "type": "string" } }, "details": { "type": "array", "items": { "type": "string" } }, "relation": { "type": "array", "items": { "type": "string" } } } } }, "warning_matches": { "type": "array", "description": "Lista de coincidencias de advertencias y medidas regulatorias de cumplimiento. Incluye entradas de las categorías: Warning, SIP, Warnings and Regulatory Enforcement, Fitness and Probity, SIE e Insolvency.", "items": { "type": "object", "properties": { "list_name": { "type": "string", "description": "Nombre del editor de la lista de advertencias" }, "matched_name": { "type": "string", "description": "Nombre que coincidió en la lista de advertencias" }, "description": { "type": "string", "description": "Descripción de la entrada de advertencia" }, "publisher": { "type": "string", "description": "Emisor o fuente de la advertencia" }, "source_url": { "type": "string", "format": "uri", "description": "URL de la fuente de la advertencia" }, "other_sources": { "type": "array", "items": { "type": "string" }, "description": "URL de fuentes adicionales" }, "countries": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Países asociados a la advertencia" }, "created_at": { "type": "string", "nullable": true, "description": "Fecha en que se creó la entrada de advertencia" }, "updated_at": { "type": "string", "nullable": true, "description": "Fecha de la última actualización de la entrada de advertencia" }, "additional_data": { "type": "object", "description": "Datos adicionales de la fuente de la advertencia. Puede contener un objeto `data` con un array `case_details`.", "properties": { "data": { "type": "object", "properties": { "case_details": { "type": "array", "description": "Detalles de los casos de advertencia asociados a esta coincidencia", "items": { "type": "object", "properties": { "case_type": { "type": "string", "description": "Tipo del caso de advertencia", "enum": [ "Accusation", "Arrest", "Bribery", "Criminal", "Fraud", "Illegal Fundraising", "Non-conviction Terror", "Proclaimed Offender", "Regulatory Enforcement", "Terrorism", "Terrorism-related", "Terrorism-related listing" ] } } } } } } } } } } }, "sanction_matches": { "type": "array", "description": "Lista de coincidencias en listas de sanciones encontradas para esta entidad.", "items": { "type": "object", "properties": { "list_name": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Nombre(s) de la(s) lista(s) de sanciones" }, "matched_name": { "type": "string", "description": "Nombre que coincidió en la lista de sanciones" }, "description": { "type": "string", "description": "Descripción de la entrada de sanción" }, "reason": { "type": "string", "nullable": true, "description": "Motivo en texto libre por el que se sancionó a la entidad. Se compone a partir de las entradas de motivo de la lista de sanciones. Ejemplos: 'Executive Order 13224 (Terrorism)', 'Support for actions undermining Ukraine's sovereignty', 'Listed due to national security concerns.'" }, "source_url": { "type": "string", "format": "uri", "description": "URL de la fuente de la sanción" }, "other_sources": { "type": "array", "items": { "type": "string" }, "description": "URL de fuentes adicionales" }, "details": { "type": "array", "items": { "type": "string" }, "description": "Detalles adicionales sobre la sanción" }, "legal_basis": { "type": "array", "items": { "type": "string" }, "description": "Fundamento jurídico de la sanción" }, "listed_on": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Fecha(s) en que la entidad se incluyó en la lista" }, "sanction_list": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Identificador(es) de la lista de sanciones" }, "sanction_program": { "type": "array", "items": { "type": "string" }, "description": "Programa(s) de sanciones en los que figura la entidad" }, "sanctioning_authority": { "type": "array", "items": { "type": "string" }, "description": "Autoridad o autoridades que impusieron la sanción" }, "updated_on": { "type": "array", "items": { "type": "string" }, "description": "Fecha(s) de la última actualización de la entrada de sanciones" }, "additional_data": { "type": "object", "description": "Datos adicionales de la fuente de la sanción que no se recogen en los campos principales" } } } }, "adverse_media_details": { "type": "object", "properties": { "sentiment": { "type": "string" }, "entity_type": { "type": "string" }, "sentiment_score": { "type": "integer" }, "adverse_keywords": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "adverse_media_matches": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string" }, "summary": { "type": "string" }, "headline": { "type": "string" }, "sentiment": { "type": "string" }, "thumbnail": { "type": "string", "format": "uri" }, "source_url": { "type": "string", "format": "uri" }, "author_name": { "type": "string", "nullable": true }, "other_sources": { "type": "array", "items": { "type": "string" } }, "adverse_keywords": { "type": "array", "items": { "type": "string" } }, "sentiment_score": { "type": "integer" }, "publication_date": { "type": "string", "format": "date-time" } } } }, "additional_information": { "type": "object" } } } }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Puntuación global del análisis AML: la puntuación de riesgo más alta entre todas las coincidencias (float, 0-100). `null` hasta que se calcula." }, "screened_data": { "type": "object", "properties": { "full_name": { "type": "string" }, "nationality": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "document_number": { "type": "string", "nullable": true } } }, "is_ongoing_monitoring_enabled": { "type": "boolean", "description": "Indica si la monitorización AML continua está activada para este análisis. Si es `true`, la entidad se vuelve a analizar periódicamente y cualquier nueva coincidencia actualiza el informe." }, "next_ongoing_monitoring_bill_date": { "type": "string", "format": "date", "nullable": true, "description": "Fecha (YYYY-MM-DD) en la que se facturará la próxima vez esta suscripción de monitorización continua. Se calcula como la fecha de la última facturación de monitorización continua más 365 días cuando `is_ongoing_monitoring_enabled = true`; en caso contrario, `null`. Es una fecha de facturación, no de análisis: para eso, usa `last_ongoing_screening_at`." }, "last_ongoing_screening_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo la monitorización continua completó por última vez un nuevo análisis de este registro, haya cambiado o no el resultado. `null` cuando el registro nunca se ha vuelto a analizar; nunca se rellena con la fecha de activación ni con la de facturación." }, "last_ongoing_screening_datasets_updated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "La fecha de la actualización más reciente del conjunto de datos AML que informó el proveedor en el momento de ese análisis. `null` cuando el proveedor no informó fechas del conjunto de datos; nunca se estima." }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string", "enum": [ "ID_VERIFICATION", "NFC", "LIVENESS", "FACEMATCH", "PROOF_OF_ADDRESS", "PHONE", "EMAIL", "AML", "LOCATION", "DATABASE_VALIDATION", "QUESTIONNAIRE", "DOCUMENT_AI", "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE", "GEOLOCATION", "SIGNATURE" ], "description": "La función que generó esta advertencia. El valor identifica el bloque de función al que pertenece la advertencia. En un análisis AML suele ser `AML`, pero el enum anterior es la referencia para todas las advertencias de funciones del payload de la decisión." }, "risk": { "type": "string" }, "additional_data": { "type": "object", "nullable": true }, "log_type": { "type": "string" }, "short_description": { "type": "string" }, "long_description": { "type": "string" }, "node_id": { "type": "string", "description": "El ID del nodo del grafo del flujo que generó esta advertencia" } } } } } }, "MonitoringEvent": { "type": "object", "description": "Un evento de monitorización almacenado tal como lo devuelven los endpoints de lista y de cronología del sujeto. La evidencia restringida (payload, contexto del dispositivo, evidencia de reglas) solo la devuelve `GET /v3/events/{event_uuid}/`.", "required": [ "event_uuid", "event_id", "event_category", "action_type", "occurred_at", "received_at", "status", "score", "subject_vendor_data", "subject_entity_type", "subject_uuid", "counterparty_vendor_data", "session_id", "device_fingerprint", "ip_address", "ip_country", "amount", "currency", "game_id", "round_id", "bonus_id", "affiliate_code", "payment_reference_id", "retention_class", "rules_matched_count", "correlation_pending", "is_droppable" ], "properties": { "event_uuid": { "type": "string", "format": "uuid", "description": "Identificador de Didit del evento. Úsalo como `{event_uuid}` en las llamadas de obtención y eliminación." }, "event_id": { "type": "string", "maxLength": 128, "description": "Tu propio identificador, la clave de idempotencia que enviaste." }, "event_category": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ], "description": "Categoría del evento." }, "action_type": { "type": "string", "maxLength": 128, "description": "Qué ocurrió dentro de la categoría, tal como lo enviaste." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Cuándo ocurrió el evento en tu lado." }, "received_at": { "type": "string", "format": "date-time", "description": "Cuándo aceptó Didit el evento." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "`ACCEPTED`: almacenado, ninguna regla coincidente cambió su estado (la respuesta normal para la mayoría de los eventos, y siempre la respuesta en una aplicación sandbox, donde no se ejecuta ninguna regla). `APPROVED`: una regla coincidió y la puntuación se mantuvo por debajo de tu umbral de revisión. `IN_REVIEW`: una regla hizo que la puntuación superara el umbral de revisión o fijó el estado. `DECLINED`: una regla lo rechazó o la puntuación superó tu umbral de rechazo." }, "score": { "type": "integer", "description": "Puntuación acumulada de las reglas. Empieza en 0; las acciones `add_score` de las reglas la modifican (se permiten incrementos negativos)." }, "subject_vendor_data": { "type": "string", "maxLength": 255, "description": "`subject.vendor_data` del evento: tu id para el usuario o la empresa." }, "subject_entity_type": { "type": "string", "description": "`individual` o `company`: qué tipo de sujeto nombra `subject_vendor_data`.", "example": "individual" }, "subject_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID del usuario (persona física) o de la empresa a la que se resolvió el evento, o null cuando ese registro ya no existe." }, "counterparty_vendor_data": { "type": "string", "nullable": true, "description": "El otro jugador de un evento P2P (promovido desde `payload.counterparty_vendor_data`).", "maxLength": 255 }, "session_id": { "type": "string", "nullable": true, "description": "`session.session_id` enviado con el evento.", "maxLength": 255 }, "device_fingerprint": { "type": "string", "nullable": true, "description": "`device_context.fingerprint` enviado con el evento.", "maxLength": 255 }, "ip_address": { "type": "string", "nullable": true, "description": "Dirección IP del evento. En el canal del servidor es `device_context.network_context.ip_address` tal como lo enviaste; en el canal del dispositivo es la IP de la solicitud.", "maxLength": 64 }, "ip_country": { "type": "string", "nullable": true, "description": "Código de país de `ip_address` obtenido del enriquecimiento de IP, o null cuando la dirección no se enriqueció (ausente, privada o telemetría de poco valor cuya dirección no se conocía ya).", "example": "ES" }, "amount": { "type": "string", "nullable": true, "description": "Importe como cadena decimal con 18 decimales, tomado de `transaction_context.amount`, `payload.amount` o `payload.stake_amount`, en ese orden.", "example": "250.000000000000000000" }, "currency": { "type": "string", "nullable": true, "description": "Moneda tomada de `transaction_context.currency` o `payload.currency`.", "maxLength": 10 }, "game_id": { "type": "string", "nullable": true, "description": "Se promueve desde `payload.game_id`.", "maxLength": 128 }, "round_id": { "type": "string", "nullable": true, "description": "Tomado de `payload.round_id`.", "maxLength": 128 }, "bonus_id": { "type": "string", "nullable": true, "description": "Se promueve desde `payload.bonus_id`.", "maxLength": 128 }, "affiliate_code": { "type": "string", "nullable": true, "description": "Se promueve desde `payload.affiliate_code`.", "maxLength": 128 }, "payment_reference_id": { "type": "string", "nullable": true, "description": "Referencia de pago tomada de `transaction_context.payment_reference_id` o de `payload.payment_reference_id`.", "maxLength": 255 }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Clase de retención. Los eventos de pago y de disputa son `monetary_or_compliance`; los eventos de seguridad y de juego responsable son `risk_relevant`; `session.page_view`, `session.sdk_heartbeat`, `session.sdk_loaded`, `session.device_seen`, `session.bot_signal_observed`, `bonus.promotion_viewed` y `affiliate.referral_clicked` son `low_value`; todo lo demás es `standard`. Un evento que coincide con una regla activa se promociona a `risk_relevant` (nunca se degrada)." }, "rules_matched_count": { "type": "integer", "minimum": 0, "description": "Número de reglas que coincidieron con el evento, incluidas las reglas en modo `TEST` (que registran evidencias pero no aplican ninguna acción)." }, "correlation_pending": { "type": "boolean", "description": "`true` mientras una regla asíncrona (correlación entre sujetos o una secuencia de más de 24 horas) aún tiene que ejecutarse para este evento. Se resuelve en minutos y `status`, `score` y `rules_matched_count` se actualizan en el mismo registro." }, "is_droppable": { "type": "boolean", "description": "Indica si un SDK con contrapresión puede descartar eventos de este tipo. `false` para todos los eventos `security`, `payment`, `dispute` y `responsible_gambling`, y para `gameplay.bet_placed`, `gameplay.bet_settled` y `gameplay.p2p_settlement`." } } }, "MonitoringEventDetail": { "description": "Un evento de monitorización con su envoltorio completo, su enriquecimiento y la evidencia de las reglas. Todos los campos de `MonitoringEvent` más los campos siguientes.", "allOf": [ { "$ref": "#/components/schemas/MonitoringEvent" }, { "type": "object", "required": [ "payload", "custom_values", "device_context", "field_sources", "session_sequence", "table_id", "hand_id", "match_id", "market_id", "side", "role", "net_result_amount", "payment_fingerprint", "instrument_reference_hash", "withdrawal_address_hash", "dispute_id", "chargeback_id", "changed_field", "identity_match_ref", "schema_version", "expires_at", "rules_evaluated_count", "rule_runs", "ip_enrichment", "subject_profile", "tags" ], "properties": { "payload": { "type": "object", "additionalProperties": true, "description": "Los campos de la categoría que enviaste en `payload`." }, "custom_values": { "type": "object", "additionalProperties": true, "description": "Los `custom_values` escalares que enviaste. Didit añade `vpn_or_proxy_detected: true` o `is_data_center: true` cuando el enriquecimiento de IP marca la dirección y tú no los estableciste." }, "device_context": { "type": "object", "additionalProperties": true, "description": "El contexto de dispositivo tal como se almacena: tu `device_context` (incluidos `fingerprint`, `persistent_device_id` y `bot_score` cuando se envían) con `network_context` completado mediante el enriquecimiento de IP (`ip_country`, `ip_country_code`, `ip_city`, `asn_number`, `asn_organization`, `is_vpn_or_tor`, `is_data_center`, `proxy_type`, `connection_type`) para las claves que dejaste vacías." }, "field_sources": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "customer", "sdk", "server" ] }, "description": "Mapa de ruta de campo a procedencia: `customer` (enviado por tu backend), `sdk` (enviado a través del canal del dispositivo) o `server` (derivado por Didit, como `received_at` y los campos de red enriquecidos). Compruébalo antes de actuar ante una coincidencia." }, "session_sequence": { "type": "integer", "format": "int64", "nullable": true, "description": "`session.sequence` enviado con el evento." }, "table_id": { "type": "string", "nullable": true, "description": "Tomado de `payload.table_id`.", "maxLength": 128 }, "hand_id": { "type": "string", "nullable": true, "description": "Se promueve desde `payload.hand_id`.", "maxLength": 128 }, "match_id": { "type": "string", "nullable": true, "description": "Tomado de `payload.match_id`.", "maxLength": 128 }, "market_id": { "type": "string", "nullable": true, "description": "Tomado de `payload.market_id`.", "maxLength": 128 }, "side": { "type": "string", "nullable": true, "description": "Tomado de `payload.side`.", "maxLength": 64 }, "role": { "type": "string", "nullable": true, "description": "Tomado de `payload.role`.", "maxLength": 64 }, "net_result_amount": { "type": "string", "nullable": true, "description": "Tomado de `payload.net_result_amount`, como cadena decimal con 18 decimales.", "example": "-120.000000000000000000" }, "payment_fingerprint": { "type": "string", "nullable": true, "description": "Tomado de `payload.payment_fingerprint`.", "maxLength": 255 }, "instrument_reference_hash": { "type": "string", "nullable": true, "description": "Tomado de `payload.instrument_reference_hash`.", "maxLength": 255 }, "withdrawal_address_hash": { "type": "string", "nullable": true, "description": "Tomado de `payload.withdrawal_address_hash` (o de `payload.destination_reference_hash`).", "maxLength": 255 }, "dispute_id": { "type": "string", "nullable": true, "description": "Se promueve desde `payload.dispute_id`.", "maxLength": 255 }, "chargeback_id": { "type": "string", "nullable": true, "description": "Se promueve desde `payload.chargeback_id`.", "maxLength": 255 }, "changed_field": { "type": "string", "nullable": true, "description": "Se promueve desde `payload.changed_field` (eventos de cambios de seguridad).", "maxLength": 128 }, "identity_match_ref": { "type": "string", "nullable": true, "description": "Se promueve desde `payload.identity_match_ref` (coincidencias en registros de juego responsable).", "maxLength": 255 }, "schema_version": { "type": "integer", "description": "Versión del esquema del sobre del evento. Actualmente, `1`.", "example": 1 }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo expira el evento según su clase de retención y se elimina: `occurred_at` más el periodo de la clase (14, 30 o 90 días por defecto, ajustable por aplicación). Nulo para los eventos `monetary_or_compliance`, que siguen la retención de transacciones." }, "rules_evaluated_count": { "type": "integer", "minimum": 0, "description": "Número de reglas de eventos evaluadas para este evento." }, "rule_runs": { "type": "array", "description": "Todas las reglas que coincidieron con el evento, de la más reciente a la más antigua.", "items": { "$ref": "#/components/schemas/MonitoringEventRuleRun" } }, "ip_enrichment": { "type": "object", "nullable": true, "description": "Enriquecimiento de la dirección IP del evento, o null si la dirección no se enriqueció. Consulta [Enriquecimiento de IP](https://docs.didit.me/es/transaction-monitoring/ip-enrichment).", "properties": { "ip_country_code": { "type": "string", "nullable": true, "description": "Código de país de la dirección." }, "ip_city": { "type": "string", "nullable": true, "description": "Ciudad de la dirección." }, "asn_number": { "type": "integer", "nullable": true, "description": "Número de sistema autónomo." }, "asn_organization": { "type": "string", "nullable": true, "description": "Organización que opera el sistema autónomo." }, "is_vpn_or_tor": { "type": "boolean", "description": "Si la dirección es un nodo de salida conocido de VPN o Tor." }, "is_data_center": { "type": "boolean", "description": "Si la dirección pertenece a una red de hosting o de centro de datos." }, "proxy_type": { "type": "string", "nullable": true, "description": "Clasificación de proxy de la dirección como cadena opaca, o null." }, "last_enriched_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se enriqueció la dirección por última vez." } }, "required": [ "ip_country_code", "ip_city", "asn_number", "asn_organization", "is_vpn_or_tor", "is_data_center", "proxy_type", "last_enriched_at" ] }, "subject_profile": { "type": "object", "nullable": true, "description": "Señales de riesgo de correo electrónico y teléfono del sujeto almacenadas en caché, o null cuando no existe ningún perfil para el sujeto.", "properties": { "email_risk_score": { "type": "integer", "nullable": true, "description": "Puntuación de riesgo del correo electrónico." }, "email_deliverability": { "type": "string", "nullable": true, "description": "Veredicto sobre la entregabilidad del correo electrónico." }, "email_is_disposable": { "type": "boolean", "nullable": true, "description": "Si la dirección de correo electrónico es desechable." }, "email_is_breached": { "type": "boolean", "nullable": true, "description": "Si la dirección de correo electrónico aparece en filtraciones de datos conocidas." }, "email_social_count": { "type": "integer", "nullable": true, "description": "Número de cuentas en línea vinculadas a la dirección de correo electrónico." }, "email_social_providers": { "type": "array", "items": { "type": "string" }, "description": "Nombres de los servicios en línea en los que se encontró una cuenta vinculada a la dirección de correo electrónico." }, "phone_risk_score": { "type": "integer", "nullable": true, "description": "Puntuación de riesgo del teléfono." }, "phone_line_type": { "type": "string", "nullable": true, "description": "Tipo de línea telefónica." }, "phone_carrier": { "type": "string", "nullable": true, "description": "Nombre del operador telefónico." }, "phone_social_count": { "type": "integer", "nullable": true, "description": "Número de cuentas en línea vinculadas al número de teléfono." }, "phone_social_providers": { "type": "array", "items": { "type": "string" }, "description": "Nombres de los servicios en línea en los que se encontró una cuenta vinculada al número de teléfono." }, "source_provider": { "type": "string", "nullable": true, "description": "Identificador opaco de la fuente del perfil." }, "last_enriched_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora de la última actualización del perfil." } }, "required": [ "email_risk_score", "email_deliverability", "email_is_disposable", "email_is_breached", "email_social_count", "email_social_providers", "phone_risk_score", "phone_line_type", "phone_carrier", "phone_social_count", "phone_social_providers", "source_provider", "last_enriched_at" ] }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Nombres de las etiquetas asociadas al evento (acciones `add_tags` de las reglas)." } } } ] }, "MonitoringEventRuleRun": { "type": "object", "properties": { "rule_uuid": { "type": "string", "format": "uuid", "description": "UUID de la regla de monitorización de transacciones." }, "rule_title": { "type": "string", "description": "Título de la regla." }, "library_key": { "type": "string", "nullable": true, "description": "Clave de la biblioteca cuando la regla se instaló desde la biblioteca de reglas; en caso contrario, null." }, "matched": { "type": "boolean", "description": "Siempre `true`: solo se registran las ejecuciones con coincidencia." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Modo de la regla cuando se ejecutó. Una ejecución `TEST` registra evidencias, pero no aplicó ninguna acción." }, "is_async": { "type": "boolean", "description": "`true` cuando la ejecución procede de la pasada de correlación asíncrona en lugar de la solicitud de ingesta." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Gravedad de la regla. Null para las ejecuciones `TEST` y para las reglas sin gravedad." }, "score_delta": { "type": "integer", "description": "Cuánto cambió esta ejecución la puntuación del evento (0 en las ejecuciones `TEST`)." }, "action_summary": { "type": "string", "nullable": true, "description": "Resumen breve de las acciones aplicadas, por ejemplo `score +40; add_tag:VPN_LOGIN`. Es null cuando no se aplicó nada." }, "matched_payload": { "type": "array", "description": "Las condiciones y agregaciones que coincidieron. Las entradas de condición llevan `field`, `operator`, `expected_value`, `current_value`, `matched`, `group_index`, `group_logic` y `field_source` (`server`, `sdk` o `customer`); las entradas de agregación llevan `metric`, `field`, `operator`, `expected_value`, `computed_value`, `window`, `filters`, `matched` y `sample_references`.", "items": { "type": "object", "additionalProperties": true } }, "created_at": { "type": "string", "format": "date-time", "description": "Fecha y hora en que se registró la ejecución de la regla." } }, "required": [ "rule_uuid", "rule_title", "library_key", "matched", "mode", "is_async", "severity", "score_delta", "action_summary", "matched_payload", "created_at" ] }, "MonitoringEventPage": { "type": "object", "description": "Una página de eventos de monitorización, con el `occurred_at` más reciente primero.", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Número de eventos coincidentes, exacto hasta 100 y limitado a 100 por encima de esa cifra. No calcules el número de páginas a partir de él; sigue `next` hasta que sea null." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la página siguiente, o null en la última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la página anterior, o null en la primera página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoringEvent" } } } }, "MonitoringEventCreateRequest": { "type": "object", "description": "El sobre del evento, igual para todas las categorías. Se aceptan alias en camelCase: `eventId`, `eventCategory` (o `category`), `actionType`, `occurredAt`, `timeZone` (o `zoneId`), `deviceContext` (o `device`), `transactionContext`, `customValues` (o `props`); dentro de `subject`: `vendorData`, `entityType`, `fullName`; dentro de `session`: `sessionId`, `pageUrl`; dentro de `transaction_context`: `paymentReferenceId`.", "required": [ "event_id", "event_category", "action_type", "occurred_at", "subject" ], "properties": { "event_id": { "type": "string", "maxLength": 128, "description": "Tu identificador para el evento, único por aplicación. Es la clave de idempotencia: reenviar los mismos `event_category`, `action_type`, `occurred_at`, `subject.vendor_data` y `payload` con este identificador es una repetición; cualquier diferencia es un conflicto.", "example": "login-2026-10-17-000001" }, "event_category": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ], "description": "Categoría del evento.", "example": "auth" }, "action_type": { "type": "string", "minLength": 1, "maxLength": 128, "description": "Qué ocurrió dentro de la categoría. Vocabulario abierto; las acciones gestionadas que se indican en [Ingesta de eventos](https://docs.didit.me/es/transaction-monitoring/events) (por ejemplo, `login`, `deposit_completed`, `chargeback_opened`) habilitan la validación tipada y los campos de regla gestionados. Se eliminan los espacios en blanco iniciales y finales.", "example": "login" }, "occurred_at": { "type": "string", "format": "date-time", "description": "Cuándo ocurrió el evento en tu lado, en ISO 8601 (un valor sin desfase se interpreta como UTC). No puede ser de hace más de 7 días ni de más de 5 minutos en el futuro.", "example": "2026-10-17T09:15:02.481Z" }, "time_zone": { "type": "string", "nullable": true, "maxLength": 64, "description": "Zona horaria del suceso en tu lado, por ejemplo `Europe/Madrid`. Se almacena con el evento; los endpoints de lectura no la devuelven." }, "subject": { "type": "object", "description": "El usuario o la empresa a la que pertenece el evento. Se resuelve al usuario (o empresa) con este `vendor_data` en tu aplicación; se crea uno cuando no existe ninguno.", "required": [ "vendor_data" ], "properties": { "vendor_data": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Tu ID para el sujeto.", "example": "user-42" }, "entity_type": { "type": "string", "maxLength": 32, "default": "individual", "description": "`company` resuelve el sujeto como empresa; cualquier otro valor (por defecto, `individual`) lo resuelve como persona física. El mismo `vendor_data` puede designar uno de cada tipo.", "example": "individual" }, "full_name": { "type": "string", "nullable": true, "maxLength": 512, "description": "Nombre visible, que solo se usa cuando este evento crea el usuario o la empresa." }, "email": { "type": "string", "format": "email", "nullable": true, "description": "Se valida como dirección de correo electrónico; no se almacena en el evento." }, "phone": { "type": "string", "nullable": true, "maxLength": 32, "description": "Se valida; no se almacena en el evento." }, "country": { "type": "string", "nullable": true, "maxLength": 3, "description": "Se valida; no se almacena en el evento." } } }, "business": { "type": "object", "description": "La empresa a la que pertenece el evento, cuando es distinta del sujeto. Solo se lee `vendor_data`.", "additionalProperties": true, "properties": { "vendor_data": { "type": "string", "maxLength": 255, "description": "Tu ID para la empresa. Se puede filtrar como `business_vendor_data`.", "example": "merchant-7" } } }, "session": { "type": "object", "description": "El contexto de tu sesión para el evento.", "properties": { "session_id": { "type": "string", "nullable": true, "maxLength": 255, "description": "Tu identificador de sesión. Se puede filtrar y se devuelve como `session_id`." }, "sequence": { "type": "integer", "nullable": true, "description": "Posición del evento dentro de la sesión. Se devuelve como `session_sequence`." }, "page_url": { "type": "string", "nullable": true, "maxLength": 2048, "description": "Se valida; no se almacena en el evento." }, "referrer": { "type": "string", "nullable": true, "maxLength": 2048, "description": "Se valida; no se almacena en el evento." } } }, "device_context": { "type": "object", "additionalProperties": true, "description": "Contexto de dispositivo y red. Se almacena tal como se envía y lo devuelve `GET /v3/events/{event_uuid}/`. En este canal de servidor, Didit no ve la conexión del usuario final. Por eso, la IP que se enriquece y que usan las reglas es `network_context.ip_address`, tal como la envías.", "properties": { "fingerprint": { "type": "string", "maxLength": 255, "description": "Huella digital del dispositivo. Se puede filtrar como `device_fingerprint`." }, "persistent_device_id": { "type": "string", "maxLength": 255, "description": "Tu identificador persistente del dispositivo." }, "bot_score": { "type": "integer", "description": "Puntuación de bot de tu propio sistema de detección, como número entero." }, "network_context": { "type": "object", "additionalProperties": true, "properties": { "ip_address": { "type": "string", "maxLength": 64, "description": "Dirección IP del usuario final. Las direcciones públicas se enriquecen una vez por cada dirección única.", "example": "203.0.113.42" } } } } }, "transaction_context": { "type": "object", "description": "Contexto monetario. Los valores no vacíos de este campo también cumplen las claves obligatorias del payload de la acción.", "properties": { "amount": { "type": "string", "nullable": true, "description": "Importe como cadena decimal (también se acepta un número).", "example": "1000.00" }, "currency": { "type": "string", "nullable": true, "maxLength": 10, "description": "Código de moneda." }, "direction": { "type": "string", "nullable": true, "maxLength": 16, "description": "Sentido del movimiento de dinero, por ejemplo `inbound` u `outbound`." }, "payment_reference_id": { "type": "string", "nullable": true, "maxLength": 255, "description": "Tu referencia de pago. Se puede filtrar como `payment_reference_id`." } } }, "payload": { "type": "object", "additionalProperties": true, "description": "Los campos de dominio de la categoría, como máximo 16384 bytes una vez codificados en JSON. Algunas acciones requieren claves (en `payload` o `transaction_context`): `gameplay.p2p_settlement` necesita `game_id`, `counterparty_vendor_data`, `stake_amount`, `net_result_amount`, `role` y uno de `hand_id`, `round_id`, `match_id`; `gameplay.bet_placed` y `gameplay.bet_settled` necesitan `game_id`; `payment.deposit_initiated`, `payment.deposit_completed`, `payment.withdrawal_requested` y `payment.withdrawal_completed` necesitan `payment_reference_id`, `amount`, `currency`, `payment_method`, `status`; `payment.withdrawal_address_changed` necesita `withdrawal_address_hash`; `dispute.chargeback_opened`, `dispute.chargeback_won` y `dispute.chargeback_lost` necesitan `payment_reference_id` y uno de `dispute_id`, `chargeback_id`; `session.bot_signal_observed` necesita `telemetry_schema_version` y uno de `bot_score`, `actions_per_minute`, `timing_variance_ms`, `pointer_entropy`, `keystroke_entropy`, `reaction_time_ms_p50`; `responsible_gambling.self_exclusion_match` necesita `registry_source`, `exclusion_status`, `identity_match_ref`. Toda acción `security` que termina en `_changed` necesita `changed_field`, además de `previous_reference_hash` o `new_reference_hash` cuando el campo es `password`, `mfa_method`, `mfa`, `email`, `phone`, `withdrawal_address`, `payout_method` o `api_key`. Envía hashes y referencias, nunca un número de tarjeta, una dirección de retiro completa, un hash de contraseña ni un secreto MFA." }, "custom_values": { "type": "object", "description": "Hasta 100 claves propias, accesibles desde las reglas como `custom_values.`. Los valores deben ser escalares (cadena, número, booleano o null); los objetos y arrays anidados se rechazan.", "additionalProperties": { "nullable": true, "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "example": { "event_id": "login-2026-10-17-000001", "event_category": "auth", "action_type": "login", "occurred_at": "2026-10-17T09:15:02.481Z", "time_zone": "Europe/Madrid", "subject": { "vendor_data": "user-42", "entity_type": "individual" }, "session": { "session_id": "web-session-abc", "sequence": 142 }, "device_context": { "fingerprint": "fp-a8c1", "network_context": { "ip_address": "203.0.113.42" } }, "payload": { "method": "password" }, "custom_values": { "vip_tier": "gold" } } }, "MonitoringEventIngestResult": { "type": "object", "description": "Resultado de la ingesta de un evento. Se devuelve la misma estructura para un evento nuevo y para una repetición idempotente.", "required": [ "event_uuid", "event_id", "status", "score", "rules_evaluated_count", "rules_matched_count", "correlation_pending", "retention_class", "expires_at", "idempotent_replay", "rule_matches" ], "properties": { "event_uuid": { "type": "string", "format": "uuid", "description": "Identificador de Didit del evento almacenado." }, "event_id": { "type": "string", "description": "Tu `event_id`." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "Estado después de ejecutar las reglas en tiempo real. Consulta `MonitoringEvent.status`." }, "score": { "type": "integer", "description": "Puntuación después de ejecutar las reglas en tiempo real." }, "rules_evaluated_count": { "type": "integer", "minimum": 0, "description": "Número de reglas de eventos evaluadas en la solicitud. 0 en una aplicación de sandbox, donde no se ejecuta ninguna regla." }, "rules_matched_count": { "type": "integer", "minimum": 0, "description": "Número de reglas que coincidieron, incluidas las reglas en modo `TEST`." }, "correlation_pending": { "type": "boolean", "description": "`true` cuando todavía falta ejecutar una regla asíncrona. Consulta `GET /v3/events/{event_uuid}/` unos minutos después para obtener el `status` y el `score` finales." }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Clase de retención, tras cualquier promoción por una regla coincidente." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo expira el evento según su clase de retención y se elimina. Nulo para los eventos `monetary_or_compliance` (pagos y disputas)." }, "idempotent_replay": { "type": "boolean", "description": "`true` cuando ya se había almacenado un evento con este `event_id` y el mismo contenido; los valores son los del evento almacenado y no se volvió a ejecutar ninguna regla." }, "rule_matches": { "type": "array", "description": "Reglas que coincidieron con el evento.", "items": { "type": "object", "required": [ "rule_id", "library_key", "mode", "is_async" ], "properties": { "rule_id": { "type": "string", "format": "uuid", "description": "UUID de la regla." }, "library_key": { "type": "string", "nullable": true, "description": "Clave de la biblioteca cuando la regla se instaló desde la biblioteca de reglas; en caso contrario, null." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Las reglas `TEST` registran la coincidencia, pero no aplican ninguna acción." }, "is_async": { "type": "boolean", "description": "`true` cuando la coincidencia procede de la pasada asíncrona." } } } } } }, "ComplianceList": { "type": "object", "description": "Una lista de bloqueo, lista de permitidos o lista personalizada de una aplicación.", "required": [ "uuid", "name", "description", "list_type", "entry_type", "is_system", "entry_count", "last_entry_added_at", "created_at", "updated_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador de la lista. Úsalo como `list_uuid` en los endpoints de listas y de entradas, y como valor de una condición de regla de flujo o de transacción con `value_type: \"list\"`." }, "name": { "type": "string", "maxLength": 255, "description": "Nombre de la lista, único entre las listas de la aplicación." }, "description": { "type": "string", "description": "Descripción en texto libre. Cadena vacía cuando no está definida." }, "list_type": { "type": "string", "enum": [ "blocklist", "allowlist", "custom" ], "description": "`blocklist`: una coincidencia rechaza la sesión o la transacción (solo listas del sistema, una por tipo de entrada). `allowlist`: los elementos que coinciden se consideran de confianza; por ejemplo, una lista de permitidos de rostros omite la acción de rostro duplicado; nunca anula una coincidencia de una lista de bloqueo. `custom`: se usa en las condiciones de las reglas de flujos y de transacciones (`value_type: \"list\"`)." }, "entry_type": { "type": "string", "enum": [ "face", "document", "phone", "email", "ip_address", "device_fingerprint", "wallet_address", "bank_account", "country", "user", "business", "key" ], "description": "Qué contiene la lista: `face`, `document` (número de documento), `phone`, `email`, `ip_address` (dirección IP o rango CIDR), `device_fingerprint`, `wallet_address`, `bank_account`, `country` (ISO 3166-1 alfa-3), `user` o `business` (tu `vendor_data`), o `key` (cualquier cadena). Determina cómo se validan y comparan los valores de las entradas." }, "is_system": { "type": "boolean", "description": "`true` para las listas que crea Didit: una lista de bloqueo por tipo de entrada (`face`, `document`, `phone`, `email`, `ip_address`, `device_fingerprint`, `wallet_address`, `bank_account`, `user`, `business`), la lista personalizada **High Risk Countries** y las listas de permitidos del sistema. Las listas del sistema no se pueden renombrar, editar ni eliminar; puedes añadir y eliminar sus entradas." }, "entry_count": { "type": "integer", "minimum": 0, "description": "Número de entradas que hay actualmente en la lista." }, "last_entry_added_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que se añadió la entrada vigente más reciente. `null` si la lista está vacía." }, "created_at": { "type": "string", "format": "date-time", "description": "Fecha y hora en que se creó la lista." }, "updated_at": { "type": "string", "format": "date-time", "description": "Fecha y hora de la última actualización de la lista." } } }, "ComplianceListEntry": { "type": "object", "description": "Un valor de una lista.", "required": [ "uuid", "value", "display_label", "comment", "added_by", "reference_session_id", "reference_session_number", "reference_session_type", "reference_object_uuid", "metadata", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador de la entrada. Úsalo como `entry_uuid` en Eliminar una entrada de lista." }, "value": { "type": "string", "description": "El valor incluido en la lista: un número de teléfono en formato E.164, una dirección de correo electrónico, un número de documento, una dirección IP o un rango CIDR, una huella de dispositivo, una dirección de wallet, una cuenta bancaria, un código de país ISO 3166-1 alfa-3, un `vendor_data`, cualquier cadena en una lista `key`, o el UUID del rostro almacenado en una lista de rostros. Los valores que envías se almacenan en minúsculas, excepto los números de teléfono y los códigos de país. La coincidencia no distingue entre mayúsculas y minúsculas." }, "display_label": { "type": "string", "nullable": true, "maxLength": 512, "description": "Etiqueta legible. Didit la completa en las entradas tomadas de una sesión (por ejemplo, el nombre del titular y el número de documento) cuando no envías ninguna." }, "comment": { "type": "string", "description": "Nota en texto libre. Cadena vacía cuando no está definida." }, "added_by": { "type": "string", "nullable": true, "description": "Quién añadió la entrada: `api` (una clave de API), el correo electrónico de un usuario de la consola o `console`, `system` o `migration` (entradas creadas por Didit), o `rule` (una acción de una regla de transacciones o de monitorización)." }, "reference_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Sesión de verificación de la que se tomó la entrada. `null` cuando la entrada se añadió por valor." }, "reference_session_number": { "type": "integer", "nullable": true, "description": "Número de esa sesión dentro de la aplicación, tal como se muestra en la consola." }, "reference_session_type": { "type": "string", "nullable": true, "enum": [ "kyc", "kyb", null ], "description": "`kyc` para una sesión de verificación de una persona, `kyb` para una sesión de verificación de una empresa, `null` cuando no hay sesión." }, "reference_object_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "El registro que representa la entrada: el registro de rostro, documento, teléfono o correo electrónico leído de una sesión, el rostro creado con Subir un rostro a una lista, o el UUID que enviaste (por ejemplo, el UUID de una transacción o el `didit_internal_id` de un usuario)." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Contexto adicional. Contiene las claves que establece Didit (enumeradas aquí) combinadas con cualquier `metadata` que enviaste al crear la entrada, devueltas tal como se almacenaron. `null` cuando no hay ninguna.", "properties": { "reference_image_url": { "type": "string", "description": "Entradas de rostro: URL firmada de corta duración, que se emite de nuevo en cada llamada; `null` para una clave de API con alcance limitado sin `media: read`. No aparece cuando ninguna imagen pertenece a la entrada." }, "front_image_url": { "type": "string", "description": "Entradas de documento que incluyen una imagen del anverso del documento: URL firmada de corta duración, que se emite de nuevo en cada llamada; `null` para una clave de API con alcance limitado sin `media: read`." }, "full_name": { "type": "string", "description": "Entradas de documento tomadas de una sesión: nombre completo del titular." }, "issuing_state": { "type": "string", "description": "Entradas de documento tomadas de una sesión: país emisor en formato ISO 3166-1 alfa-3." }, "document_type": { "type": "string", "description": "Entradas de documento tomadas de una sesión: código del tipo de documento, por ejemplo `P`, `ID` o `DL`." }, "region": { "type": "string", "description": "Entradas de documento tomadas de una sesión: estado o provincia emisora de un documento de emisión regional; vacío cuando no aplica. No lo establece Añadir elementos de la sesión a la lista de bloqueo." }, "document_number": { "type": "string", "description": "Entradas de documento tomadas de una sesión: el número de documento." }, "face_image_source": { "type": "string", "enum": [ "front_image_camera_front", "back_image_camera_front" ], "description": "Entradas de rostro tomadas de una selfie de captura de documento: qué selfie es. No aparece en los rostros de prueba de vida." }, "reference_node_id": { "type": "string", "nullable": true, "description": "Entradas de rostro tomadas de una selfie de captura de documento: el nodo de verificación de identidad del que procede la selfie." }, "fingerprint_tier": { "type": "string", "nullable": true, "enum": [ "persistent_id", "composite_hash", "legacy_fp", "unknown", null ], "description": "Entradas de huella digital del dispositivo tomadas de una sesión: indican cómo se derivó la huella. `persistent_id` identifica un único dispositivo; `composite_hash` y `legacy_fp` pueden ser compartidos por dispositivos del mismo modelo." }, "sandbox": { "type": "boolean", "description": "`true` en una entrada facial subida en una aplicación de sandbox; esa entrada no coincide con nada." }, "reference_type": { "type": "string", "enum": [ "transaction", "vendor_user", "vendor_business" ], "description": "Lo defines tú: a qué apunta `reference_object_uuid`, para que la consola enlace de vuelta a él." }, "reference_id": { "type": "string", "description": "Lo defines tú: identificador del registro de origen." } } }, "created_at": { "type": "string", "format": "date-time", "description": "Cuándo se añadió la entrada." } } }, "BlocklistedItem": { "type": "object", "description": "Un rostro, documento de identidad, número de teléfono o dirección de correo electrónico de una sesión de verificación incluido en la lista de bloqueo. Los campos que no se aplican al `type` del elemento son `null`.", "required": [ "type", "session_id", "session_number", "blocklisted_at", "face_image", "document_type", "document_number", "front_image", "phone_number", "country_code", "email" ], "properties": { "type": { "type": "string", "enum": [ "face", "document", "phone", "email" ], "description": "Qué se añadió a la lista de bloqueo." }, "session_id": { "type": "string", "format": "uuid", "description": "Sesión de verificación a la que pertenece el elemento." }, "session_number": { "type": "integer", "nullable": true, "description": "Número de esa sesión dentro de la aplicación, tal como se muestra en la consola." }, "blocklisted_at": { "type": "string", "format": "date-time", "description": "Fecha y hora en que el elemento se añadió por última vez a la lista de bloqueo." }, "face_image": { "type": "string", "nullable": true, "description": "Elementos de rostro: URL firmada de corta duración, que se emite de nuevo en cada llamada; `null` para una clave de API con alcance limitado sin `media: read`. También es `null` cuando no hay ninguna imagen de referencia almacenada." }, "document_type": { "type": "string", "nullable": true, "description": "Elementos de documento: código del tipo de documento, por ejemplo `P` (pasaporte), `ID` (documento nacional de identidad), `DL` (licencia de conducir) o `RP` (permiso de residencia)." }, "document_number": { "type": "string", "nullable": true, "description": "Elementos de documento: el número de documento o, si el documento no tiene, el número personal." }, "front_image": { "type": "string", "nullable": true, "description": "Elementos de documento: imagen del anverso del documento, URL firmada de corta duración, que se emite de nuevo en cada llamada; `null` para una clave de API con alcance limitado sin `media: read`." }, "phone_number": { "type": "string", "nullable": true, "description": "Elementos de teléfono: el número de teléfono en formato E.164." }, "country_code": { "type": "string", "nullable": true, "description": "Elementos de teléfono: país del número en ISO 3166-1 alfa-2." }, "email": { "type": "string", "nullable": true, "description": "Elementos de correo electrónico: la dirección de correo electrónico." } } }, "TransactionNote": { "type": "object", "description": "Una nota en la cronología de revisión de una transacción monitorizada.", "required": [ "uuid", "note", "actor_email", "actor_name", "metadata", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador de la nota." }, "note": { "type": "string", "description": "Cuerpo de la nota en texto plano." }, "actor_email": { "type": "string", "format": "email", "nullable": true, "description": "Correo electrónico del usuario de la consola que escribió la nota o cambió el estado. `null` para las notas creadas con una clave de API y para las notas que Didit añade automáticamente." }, "actor_name": { "type": "string", "nullable": true, "description": "Nombre visible del usuario de la Console (su correo electrónico si no tiene nombre). `Rule Engine` en las notas que Didit añade automáticamente. `null` en las notas creadas con una clave de API." }, "metadata": { "type": "object", "description": "Distingue los tipos de nota. Las notas escritas mediante la API o la consola incluyen `mentioned_emails`. Un cambio de estado realizado en la consola incluye `type: status_change` con `previous_status`, `new_status`, `reason_code` y `reason_label`. Las notas que añade Didit incluyen `source`: `rule_action` (con `rule_uuid`) para la acción `add_note` de una regla, o `remediation_session` para un problema al crear la sesión de verificación de acción del usuario.", "properties": { "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Miembros de la organización mencionados, en minúsculas y sin duplicados. Vacío cuando no se mencionó a nadie." }, "type": { "type": "string", "enum": [ "status_change" ], "description": "Presente en las notas que registran un cambio de estado realizado en la Console." }, "previous_status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Estado antes del cambio." }, "new_status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Estado después del cambio." }, "reason_code": { "type": "string", "nullable": true, "description": "Código de motivo indicado con el cambio." }, "reason_label": { "type": "string", "nullable": true, "description": "Etiqueta de motivo indicada con el cambio." }, "source": { "type": "string", "enum": [ "rule_action", "remediation_session" ], "description": "Presente en las notas que Didit añade automáticamente." }, "rule_uuid": { "type": "string", "format": "uuid", "description": "Regla cuya acción `add_note` escribió la nota (con `source: rule_action`)." } } }, "created_at": { "type": "string", "format": "date-time", "description": "Fecha y hora en que se almacenó la nota." } } }, "TransactionSummary": { "type": "object", "description": "Resumen de una transacción monitorizada, con la estructura que lista `GET /v3/transactions/`. Llama a `GET /v3/transactions/{transaction_id}/` con `uuid` para obtener las partes, las alertas y las ejecuciones de reglas.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID de transacción de Didit. Úsalo como `{transaction_id}` en los endpoints de transacciones." }, "transaction_number": { "type": "integer", "nullable": true, "description": "Número secuencial dentro de la aplicación que se muestra en la consola." }, "txn_id": { "type": "string", "nullable": true, "description": "Tu propio identificador de la llamada de creación. Único por aplicación." }, "transaction_type": { "type": "string", "description": "Categoría tal como se almacena: `finance`, `kyc`, `travelRule`, `userPlatformEvent`, `gamblingBet`, `gamblingLimitChange`, `gamblingBonusChange` o `auditTrailEvent`." }, "action_type": { "type": "string", "description": "Subtipo dentro de la categoría, por ejemplo `withdrawal`." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Veredicto de monitorización actual." }, "source": { "type": "string", "enum": [ "LIVE", "IMPORTED" ], "description": "`LIVE` para las transacciones enviadas a monitorización, `IMPORTED` para las importaciones históricas." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Sentido respecto al sujeto." }, "amount": { "type": "string", "description": "Importe como cadena decimal sin ceros finales (hasta 18 decimales)." }, "currency": { "type": "string", "description": "Código de moneda o símbolo del criptoactivo de `amount`." }, "currency_type": { "type": "string", "nullable": true, "description": "`fiat` o `crypto` cuando se conoce." }, "preferred_currency_amount": { "type": "string", "nullable": true, "description": "`amount` convertido a la moneda preferida de la aplicación, cuando había un tipo de cambio disponible." }, "preferred_currency_code": { "type": "string", "nullable": true, "description": "Moneda de `preferred_currency_amount`." }, "payment_details": { "type": "string", "nullable": true, "description": "Referencia de pago en texto libre." }, "txn_date": { "type": "string", "format": "date-time", "description": "Cuándo se produjo la transacción." }, "created_at": { "type": "string", "format": "date-time", "description": "Cuándo lo registró Didit." }, "score": { "type": "integer", "description": "Puntuación de riesgo. Cuanto más alta, mayor riesgo." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Gravedad del riesgo; `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`." }, "tags": { "type": "array", "description": "Etiquetas de la transacción.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string", "description": "Color hexadecimal, por ejemplo `#F59E0B`." }, "description": { "type": "string", "nullable": true }, "source": { "type": "string", "enum": [ "didit", "custom" ], "description": "Etiqueta predefinida de Didit o personalizada." } } } }, "subject_name": { "type": "string", "nullable": true, "description": "Nombre completo de la parte `APPLICANT`." }, "subject_vendor_data": { "type": "string", "nullable": true, "description": "Tu `vendor_data` para el solicitante." }, "subject_type": { "type": "string", "nullable": true, "enum": [ "user", "business", null ], "description": "Si el solicitante está vinculado a un usuario o a una empresa de Didit; `null` cuando no está vinculado a ninguno." }, "subject_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID del usuario o la empresa de Didit al que está vinculado el solicitante." }, "subject_country": { "type": "string", "nullable": true, "description": "Código de país del solicitante." }, "counterparty_name": { "type": "string", "nullable": true, "description": "Nombre completo de la parte `COUNTERPARTY`, si la hay." }, "counterparty_vendor_data": { "type": "string", "nullable": true, "description": "Tu `vendor_data` para la contraparte." }, "counterparty_country": { "type": "string", "nullable": true, "description": "Código de país de la contraparte." }, "assigned_to_name": { "type": "string", "nullable": true, "description": "Nombre del revisor de la consola asignado a la transacción." }, "travel_rule_status": { "type": "string", "nullable": true, "description": "Estado de la transferencia de Travel Rule de la transacción, o `null` cuando no tiene ninguna." }, "application_id": { "type": "string", "format": "uuid", "description": "Aplicación a la que pertenece la transacción." }, "application_name": { "type": "string", "nullable": true, "description": "Nombre de esa aplicación." }, "organization_id": { "type": "string", "format": "uuid", "description": "Organización propietaria de la aplicación." }, "organization_name": { "type": "string", "nullable": true, "description": "Nombre de esa organización." } } }, "ApplicationAnalyticsDataPoint": { "type": "object", "description": "Recuento de sesiones de un día, por fecha de creación (UTC). Cada recuento refleja el estado actual de la sesión. Los puntos del período anterior incluyen al menos los campos obligatorios.", "required": [ "rounded_date", "total", "approved", "declined", "canceled", "pending" ], "properties": { "rounded_date": { "type": "string", "format": "date", "description": "El día, `YYYY-MM-DD`." }, "total": { "type": "integer", "description": "Sesiones creadas ese día." }, "approved": { "type": "integer", "description": "De ellas, las sesiones `Approved` o `Kyc Expired`." }, "declined": { "type": "integer", "description": "Sesiones `Declined`." }, "canceled": { "type": "integer", "description": "Sesiones `Expired` o `Abandoned`." }, "pending": { "type": "integer", "description": "Sesiones `Not Started`, `In Progress` o `In Review`." }, "in_review": { "type": "integer", "description": "Sesiones `In Review`." }, "expired": { "type": "integer", "description": "Sesiones `Expired`." }, "abandoned": { "type": "integer", "description": "Sesiones `Abandoned`." }, "in_progress": { "type": "integer", "description": "Sesiones `In Progress`." }, "not_started": { "type": "integer", "description": "Sesiones `Not Started`." }, "manually_approved": { "type": "integer", "description": "Sesiones que un revisor aprobó después de que el flujo diera otro veredicto." }, "manually_declined": { "type": "integer", "description": "Sesiones que un revisor rechazó después de que el flujo diera otro veredicto." } } }, "ApplicationAnalyticsRequestBreakdown": { "type": "object", "description": "Totales por estado para el rango. El desglose del período anterior incluye al menos los campos obligatorios.", "required": [ "total_approved", "total_in_review", "total_declined", "total_canceled", "total_pending" ], "properties": { "total_approved": { "type": "integer", "description": "Sesiones `Approved` o `Kyc Expired`." }, "total_in_review": { "type": "integer", "description": "Sesiones `In Review`." }, "total_declined": { "type": "integer", "description": "Sesiones `Declined`." }, "total_canceled": { "type": "integer", "description": "Sesiones `Expired` o `Abandoned`." }, "total_pending": { "type": "integer", "description": "Sesiones `Not Started`, `In Progress` o `In Review` (incluye `total_in_review`)." }, "total_expired": { "type": "integer", "description": "Sesiones `Expired`." }, "total_abandoned": { "type": "integer", "description": "Sesiones `Abandoned`." }, "total_in_progress": { "type": "integer", "description": "Sesiones `In Progress`." }, "total_not_started": { "type": "integer", "description": "Sesiones `Not Started`." }, "total_manually_approved": { "type": "integer", "description": "Aprobado por un revisor." }, "total_manually_declined": { "type": "integer", "description": "Rechazado por un revisor." } } }, "ApplicationAnalyticsCountryCount": { "type": "object", "properties": { "country": { "type": "string", "description": "Nombre del país." }, "country_code": { "type": "string", "description": "Código de país de dos letras." }, "session_count": { "type": "integer", "description": "Sesiones de ese país." } } }, "ApplicationAnalyticsLocationStats": { "type": "object", "properties": { "ip_countries": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsCountryCount" }, "description": "Países de las direcciones IP de los usuarios, ordenados de más a menos sesiones." }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsCountryCount" }, "description": "La misma lista que `ip_countries`." }, "id_countries": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsCountryCount" }, "description": "Países emisores de los documentos de identidad verificados, ordenados de más a menos sesiones." }, "conversion_by_country": { "type": "array", "description": "Por país emisor del documento: sesiones finalizadas (aprobadas, rechazadas o en revisión) y cuántas se aprobaron. Primero, los que tienen más sesiones finalizadas.", "items": { "type": "object", "properties": { "country": { "type": "string" }, "country_code": { "type": "string" }, "finished": { "type": "integer" }, "approved": { "type": "integer" } } } }, "cities": { "type": "array", "description": "Hasta 100 ciudades de IP, empezando por las que tienen más sesiones.", "items": { "type": "object", "properties": { "location": { "type": "string", "description": "`City, Country`." }, "session_count": { "type": "integer" }, "latitude": { "type": "number", "nullable": true }, "longitude": { "type": "number", "nullable": true } } } } } }, "ApplicationAnalyticsDemographicStats": { "type": "object", "properties": { "age_distribution": { "type": "object", "description": "Sesiones por franja de edad según el documento de identidad. Vacío cuando no hay datos.", "properties": { "under_18": { "type": "integer" }, "18_24": { "type": "integer" }, "25_34": { "type": "integer" }, "35_44": { "type": "integer" }, "45_64": { "type": "integer" }, "65_plus": { "type": "integer" } }, "additionalProperties": { "type": "integer" } }, "gender_distribution": { "type": "object", "description": "Sesiones por código de género del documento: `M`, `F` o `U` (desconocido).", "additionalProperties": { "type": "integer" } } } }, "ApplicationAnalyticsDeviceDetails": { "type": "object", "description": "Los cinco primeros de cada uno, ordenados de más a menos sesiones.", "properties": { "device_models": { "type": "array", "description": "Marcas de dispositivo: `Apple`, `Android` y `LG`. Todas las demás se agrupan como `Other`.", "items": { "type": "object", "properties": { "device": { "type": "string" }, "count": { "type": "integer" } } } }, "browsers": { "type": "array", "description": "Navegadores: `Chrome`, `Safari`, `Didit App`, `Firefox`; todos los demás se agrupan como `Other`.", "items": { "type": "object", "properties": { "browser": { "type": "string" }, "count": { "type": "integer" } } } }, "operating_systems": { "type": "array", "description": "Sistemas operativos.", "items": { "type": "object", "properties": { "os": { "type": "string" }, "count": { "type": "integer" } } } } } }, "ApplicationAnalyticsWorkflowFunnel": { "type": "object", "description": "Indexado por ID de flujo. `total` son las sesiones iniciadas en ese flujo; `steps` cuenta las sesiones que llegaron a cada paso (`OCR`, `LIVENESS`, `FACE_MATCH`, `AML`, `POA`, `PHONE`, `EMAIL`, `NFC`, `DATABASE_VALIDATION`, `QUESTIONNAIRE`, `IP_ANALYSIS`, `AGE_ESTIMATION`, `KYB_REGISTRY`, `KYB_DOCUMENTS`, `KYB_KEY_PEOPLE`). Llegar a un paso no significa superarlo.", "additionalProperties": { "type": "object", "properties": { "total": { "type": "integer" }, "steps": { "type": "object", "additionalProperties": { "type": "object", "properties": { "reached": { "type": "integer" } } } } } } }, "ApplicationAnalyticsVerificationTimeStats": { "type": "object", "description": "Tiempo activo que los usuarios dedicaron a verificarse, sin contar los periodos de inactividad. Un objeto vacío cuando no hay datos.", "properties": { "overall_avg_seconds": { "type": "number", "description": "Promedio por sesión, con un decimal." }, "overall_count": { "type": "integer", "description": "Sesiones medidas." }, "per_feature": { "type": "object", "description": "Indexado por función, por ejemplo `OCR` o `LIVENESS`.", "additionalProperties": { "type": "object", "properties": { "avg_seconds": { "type": "number" }, "total_seconds": { "type": "number" }, "count": { "type": "integer" } } } }, "per_sub_step": { "type": "object", "description": "Indexado por función y luego por subpaso, por ejemplo `front_id_photo`.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "properties": { "avg_seconds": { "type": "number" }, "total_seconds": { "type": "number" }, "count": { "type": "integer" } } } } } } }, "ApplicationAnalyticsResubmissionStats": { "type": "object", "properties": { "first_pass": { "type": "integer", "description": "Sesiones finalizadas sin reenvíos." }, "second": { "type": "integer", "description": "Sesiones finalizadas que se reenviaron una vez." }, "third_plus": { "type": "integer", "description": "Sesiones finalizadas que se reenviaron dos o más veces." }, "abandoned": { "type": "integer", "description": "Sesiones abandonadas." } } }, "ApplicationAnalyticsOriginalStatusStats": { "type": "object", "description": "El veredicto automático del flujo, antes de que un revisor lo cambiara.", "properties": { "approved": { "type": "integer" }, "in_review": { "type": "integer" }, "declined": { "type": "integer" } } }, "ApplicationAnalyticsWarningStats": { "type": "object", "description": "Indexado por función (`ID_VERIFICATION`, `LIVENESS`, `FACEMATCH`, `AML`, `PROOF_OF_ADDRESS`, `PHONE`, `EMAIL`, `NFC`, `LOCATION`, `DATABASE_VALIDATION`, `QUESTIONNAIRE` y las funciones KYB). `total` son las sesiones que llegaron a la función; `risks` cuenta las sesiones por código y nivel de advertencia.", "additionalProperties": { "type": "object", "properties": { "total": { "type": "integer" }, "risks": { "type": "object", "additionalProperties": { "type": "object", "properties": { "error": { "type": "integer" }, "warning": { "type": "integer" }, "information": { "type": "integer" } } } } } } }, "ApplicationAnalyticsDemographicPoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Clave del período: `YYYY-MM-DD` para un día o para el lunes de una semana, o `YYYY-MM` para un mes, según `grouping_mode`." }, "age_distribution": { "type": "object", "additionalProperties": { "type": "integer" } }, "gender_distribution": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "ApplicationAnalyticsDevicePoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Clave del período: `YYYY-MM-DD` para un día o para el lunes de una semana, o `YYYY-MM` para un mes, según `grouping_mode`." }, "devices": { "type": "object", "additionalProperties": { "type": "integer" } }, "browsers": { "type": "object", "additionalProperties": { "type": "integer" } }, "operating_systems": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "ApplicationAnalyticsVerificationTimePoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Clave del período: `YYYY-MM-DD` para un día o para el lunes de una semana, o `YYYY-MM` para un mes, según `grouping_mode`." }, "overall_avg": { "type": "number", "description": "Promedio de segundos activos por sesión." }, "per_feature": { "type": "object", "description": "Promedio de segundos activos por función.", "additionalProperties": { "type": "number" } } } }, "ApplicationAnalyticsResubmissionPoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Clave del período: `YYYY-MM-DD` para un día o para el lunes de una semana, o `YYYY-MM` para un mes, según `grouping_mode`." }, "first_pass": { "type": "integer" }, "second": { "type": "integer" }, "third_plus": { "type": "integer" }, "abandoned": { "type": "integer" } } }, "ApplicationAnalyticsOriginalStatusPoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Clave del período: `YYYY-MM-DD` para un día o para el lunes de una semana, o `YYYY-MM` para un mes, según `grouping_mode`." }, "approved": { "type": "integer" }, "in_review": { "type": "integer" }, "declined": { "type": "integer" } } }, "ApplicationAnalyticsSummary": { "type": "object", "description": "Resumen de verificación de usuarios (KYC), que se devuelve cuando no se envía ni `scope` ni `widget_keys`.", "required": [ "data_points", "request_breakdown", "previous_data_points", "previous_request_breakdown", "conversion_rate", "location_stats", "demographic_stats", "device_details", "workflow_funnel_stats", "verification_time_stats", "resubmission_stats", "warning_stats", "original_status_stats", "grouping_mode", "demographic_time_series", "device_time_series", "verification_time_time_series", "resubmission_time_series", "original_status_time_series" ], "properties": { "data_points": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDataPoint" }, "description": "Un punto por día, desde el primer día con sesiones dentro del rango hasta `end_date`. Siempre diario, independientemente de lo que indique `grouping_mode`." }, "request_breakdown": { "$ref": "#/components/schemas/ApplicationAnalyticsRequestBreakdown" }, "previous_data_points": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDataPoint" }, "description": "Puntos diarios del período de la misma duración inmediatamente anterior a `start_date`." }, "previous_request_breakdown": { "$ref": "#/components/schemas/ApplicationAnalyticsRequestBreakdown" }, "conversion_rate": { "type": "number", "nullable": true, "description": "`total_approved / (total_approved + total_declined + total_in_review) x 100`, con un decimal. `null` cuando no ha finalizado nada." }, "location_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsLocationStats" }, "demographic_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsDemographicStats" }, "device_details": { "$ref": "#/components/schemas/ApplicationAnalyticsDeviceDetails" }, "workflow_funnel_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsWorkflowFunnel" }, "verification_time_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsVerificationTimeStats" }, "resubmission_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsResubmissionStats" }, "warning_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsWarningStats" }, "original_status_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsOriginalStatusStats" }, "grouping_mode": { "type": "string", "enum": [ "day", "week", "month" ], "description": "Cómo se agrupan las listas `*_time_series`: `day` hasta 14 días, `week` hasta 90 y `month` a partir de ahí. Se mide desde el primer día con sesiones en el rango." }, "demographic_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDemographicPoint" } }, "device_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDevicePoint" } }, "verification_time_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsVerificationTimePoint" } }, "resubmission_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsResubmissionPoint" } }, "original_status_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsOriginalStatusPoint" } } } }, "ApplicationAnalyticsWidget": { "type": "object", "description": "Un widget del panel. Todos los widgets tienen `kind` y `title`; los demás campos dependen de `kind`. Los widgets de sesiones reutilizan los objetos de resumen (`data_points`, `request_breakdown`, `workflow_funnel_stats`, etc.); los widgets de lista colocan sus entradas en `items`; las métricas de transacciones usan `value`.", "required": [ "kind", "title" ], "properties": { "kind": { "type": "string", "enum": [ "sessions_volume", "workflow_funnel", "average_verification_time", "country_distribution", "warning_insights", "conversion_rate", "conversion_by_country", "resubmission_insights", "original_status_distribution", "database_validation_coverage", "database_validation_latency", "demographics", "device_details", "horizontal_bar", "kyb_registry_coverage", "kyb_registry_data_completeness", "metric", "time_series", "breakdown", "status_time_series", "leaderboard", "histogram" ], "description": "Tipo de widget." }, "title": { "type": "string", "description": "Título visible, por ejemplo `Verification volume`." }, "grouping_mode": { "type": "string", "enum": [ "day", "week", "month" ], "description": "Cómo se agrupan las listas `*_time_series`: `day` hasta 14 días, `week` hasta 90 y `month` a partir de ahí. Se mide desde el primer día con sesiones en el rango." }, "data_points": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDataPoint" } }, "request_breakdown": { "$ref": "#/components/schemas/ApplicationAnalyticsRequestBreakdown" }, "previous_data_points": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDataPoint" } }, "previous_request_breakdown": { "$ref": "#/components/schemas/ApplicationAnalyticsRequestBreakdown" }, "conversion_rate": { "type": "number", "nullable": true }, "workflow_funnel_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsWorkflowFunnel" }, "verification_time_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsVerificationTimeStats" }, "verification_time_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsVerificationTimePoint" } }, "warning_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsWarningStats" }, "resubmission_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsResubmissionStats" }, "resubmission_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsResubmissionPoint" } }, "original_status_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsOriginalStatusStats" }, "original_status_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsOriginalStatusPoint" } }, "demographic_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsDemographicStats" }, "demographic_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDemographicPoint" } }, "device_details": { "$ref": "#/components/schemas/ApplicationAnalyticsDeviceDetails" }, "device_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDevicePoint" } }, "items": { "type": "array", "description": "Entradas de un widget de lista. `country_distribution` (KYC): `country`, `country_code`, `session_count`. `conversion_by_country`: `country`, `country_code`, `finished`, `approved`. `time_series`: `date`, `value`. `status_time_series`: `date`, `approved`, `declined`, `flagged`. `breakdown`: `transaction_type` o `action_type` con `count` y `volume`, o bien `tag_id`, `tag_name`, `count`. `leaderboard`: `rule_title`, `trigger_count` o `assignee`, `handled_count`, `average_processing_seconds`, cada uno con `approved_percentage`, `declined_percentage`, `flagged_percentage`. `histogram`: `score`, `count`.", "items": { "type": "object", "additionalProperties": {} } }, "previous_items": { "type": "array", "description": "Serie temporal de transacciones del periodo de la misma duración inmediatamente anterior a `start_date`.", "items": { "type": "object", "additionalProperties": {} } }, "value": { "type": "number", "description": "Widgets `metric`: la cifra del rango." }, "currency": { "type": "string", "nullable": true, "description": "Widgets de volumen e importe de transacciones: la moneda de transacción predeterminada de la aplicación." }, "thresholds": { "type": "object", "description": "Widget `histogram`: los umbrales de puntuación de revisión y de rechazo de la aplicación.", "properties": { "review": { "type": "integer" }, "decline": { "type": "integer" } } }, "search": { "type": "object", "description": "Widget `kyb_registry_coverage`: totales de búsquedas en registros.", "properties": { "searches_total": { "type": "integer" }, "searches_with_no_candidates": { "type": "integer" } } } } }, "ApplicationAnalyticsWidgetResponse": { "type": "object", "description": "Widgets del panel, que se devuelven cuando se envía `scope` o `widget_keys`.", "required": [ "scope", "available_widget_keys", "requested_widget_keys", "widgets" ], "properties": { "scope": { "type": "string", "enum": [ "home", "kyc", "kyb", "transactions" ], "description": "Pestaña del panel." }, "available_widget_keys": { "type": "array", "items": { "type": "string" }, "description": "Todas las claves de widget que acepta este ámbito." }, "requested_widget_keys": { "type": "array", "items": { "type": "string" }, "description": "Las claves del widget respondidas, en orden: tus `widget_keys` válidas o los valores predeterminados del ámbito." }, "widgets": { "type": "object", "description": "Indexado por clave de widget, en el orden de `requested_widget_keys`.", "additionalProperties": { "$ref": "#/components/schemas/ApplicationAnalyticsWidget" } } } }, "ApplicationAnalyticsToday": { "type": "object", "description": "Verificaciones de hoy por hora local frente al mismo día de la semana de la semana pasada.", "required": [ "time_zone", "date", "current_hour", "previous_date", "hours", "previous_hours", "total", "previous_total_so_far", "outcomes" ], "properties": { "time_zone": { "type": "string", "description": "La zona horaria IANA en la que están el día y sus horas.", "example": "Europe/Madrid" }, "date": { "type": "string", "format": "date", "description": "La fecha de hoy en esa zona horaria.", "example": "2026-10-30" }, "current_hour": { "type": "integer", "minimum": 0, "maximum": 23, "description": "La hora local actual.", "example": 14 }, "previous_date": { "type": "string", "format": "date", "description": "El día de comparación: el mismo día de la semana, una semana antes.", "example": "2026-10-23" }, "hours": { "type": "array", "items": { "type": "integer", "minimum": 0 }, "minItems": 24, "maxItems": 24, "description": "Verificaciones creadas hoy, por hora local desde las 00:00. Las horas que aún no han llegado valen 0." }, "previous_hours": { "type": "array", "items": { "type": "integer", "minimum": 0 }, "minItems": 24, "maxItems": 24, "description": "Verificaciones creadas en el día de comparación, por hora local desde las 00:00." }, "total": { "type": "integer", "minimum": 0, "description": "Verificaciones creadas hoy hasta el momento.", "example": 165 }, "previous_total_so_far": { "type": "integer", "minimum": 0, "description": "Verificaciones creadas en el día de comparación hasta la misma hora local.", "example": 151 }, "outcomes": { "type": "object", "description": "De las verificaciones de hoy, cuántas están aprobadas, en espera de revisión y rechazadas en este momento. El resto aún no ha terminado.", "required": [ "approved", "in_review", "declined" ], "properties": { "approved": { "type": "integer", "minimum": 0 }, "in_review": { "type": "integer", "minimum": 0 }, "declined": { "type": "integer", "minimum": 0 } } } } }, "WebhookConfigDestination": { "type": "object", "description": "Un destino de webhook tal como aparece en la configuración de webhooks, sin métricas de entrega. `GET /v3/webhook/destinations/{destination_uuid}/` añade su resumen de entregas.", "required": [ "uuid", "label", "url", "enabled", "webhook_version", "secret_shared_key", "subscribed_events", "created_at", "updated_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID del destino." }, "label": { "type": "string", "maxLength": 255, "description": "Nombre legible." }, "url": { "type": "string", "format": "uri", "maxLength": 2000, "description": "Endpoint HTTPS al que Didit envía los eventos." }, "enabled": { "type": "boolean", "description": "`false` pausa las entregas a este destino." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Versión del payload que se envía a este destino." }, "secret_shared_key": { "type": "string", "description": "El secreto de firma de este destino (token URL-safe de 43 caracteres). Verifica cada webhook con el secreto del destino al que se envió. Quienes llaman con clave de API siempre lo reciben completo; los usuarios de la Console sin `read:webhooks` reciben una cadena vacía." }, "subscribed_events": { "type": "array", "uniqueItems": true, "description": "Tipos de evento que se entregan a este destino. Está vacío si el destino se creó sin eventos; en ese caso no recibe nada.", "items": { "$ref": "#/components/schemas/WebhookEvent" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "WebhookConfig": { "type": "object", "description": "Configuración de webhooks a nivel de aplicación, política de retención y hosts de retorno de la wallet de Digital ID, con todos los destinos de webhook.", "required": [ "webhook_url", "webhook_version", "secret_shared_key", "capture_method", "data_retention_months", "face_retention_policy", "face_retention_days", "available_events", "allowed_return_hosts", "endpoints" ], "properties": { "webhook_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL de webhook a nivel de aplicación (heredada). Didit envía a ella solo mientras la aplicación no tiene ningún destino de webhook habilitado, y en ese caso solo `status.updated` y `data.updated`. Cada vez que se crea, actualiza o elimina un destino, se establece en la URL del destino habilitado más antiguo, o en `null` si no hay ninguno habilitado." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Versión del payload de la `webhook_url` heredada. Cada destino tiene su propia `webhook_version`." }, "secret_shared_key": { "type": "string", "description": "Secreto de firma a nivel de aplicación (token de 43 caracteres seguro para URL). Solo firma las entregas al `webhook_url` heredado; cada destino firma con su propio `secret_shared_key`. Quien llama con una clave de API siempre lo recibe completo; los usuarios de la consola sin `read:webhooks` reciben una cadena vacía." }, "capture_method": { "type": "string", "enum": [ "MOBILE", "MOBILE_AND_DESKTOP" ], "description": "Configuración heredada de la aplicación. El flujo de verificación no la lee: las opciones de captura se configuran por flujo." }, "data_retention_months": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 120, "description": "Plazo de eliminación automática. Las sesiones de verificación de usuarios creadas hace más de este número de meses (un mes equivale a 30 días) se eliminan automáticamente, y esa eliminación es irreversible. `null` significa que las sesiones nunca se eliminan automáticamente. Consulta [Retención de datos](https://docs.didit.me/es/console/data-retention)." }, "face_retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "Qué ocurre con el embedding facial de una sesión cuando se elimina la sesión. `delete_with_session` (valor predeterminado) lo elimina junto con la sesión. `retain_until_user_deleted` es la [retención de plantillas biométricas](https://docs.didit.me/es/console/data-retention#retención-de-plantillas-biométricas) opcional: una plantilla biométrica sin imágenes vinculada al User se gestiona por separado hasta que finaliza su periodo de retención, se elimina el User o la purgas." }, "face_retention_days": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 3650, "description": "Periodo de retención, en días, de las plantillas biométricas con `retain_until_user_deleted`. Obligatorio cuando se define esa política." }, "biometric_consent_mode": { "type": "string", "enum": [ "auto", "always", "never" ], "description": "Cuándo el flujo alojado y los SDK nativos piden a la persona su consentimiento biométrico explícito antes de capturar el rostro. `auto` (predeterminado) lo pide solo donde aplica un disparador: un estado declarado, la IP de la persona o el emisor del documento de identidad está en Illinois, Texas o Colorado, o la persona parece estar en EE. UU. sin un estado conocido. `always` lo pide a toda persona cuyo flujo capture el rostro. `never` nunca muestra el paso, y tú mismo recoges el consentimiento antes del selfie. Cada cambio se registra en el registro de auditoría. Consulta [Consentimiento biométrico](https://docs.didit.me/es/getting-started/biometric-consent)." }, "available_events": { "type": "array", "description": "Todos los tipos de evento a los que se puede suscribir un destino, con una etiqueta visible.", "items": { "type": "object", "required": [ "value", "label" ], "properties": { "value": { "$ref": "#/components/schemas/WebhookEvent" }, "label": { "type": "string", "description": "Etiqueta visible, por ejemplo `Session status updated`." } } } }, "allowed_return_hosts": { "type": "array", "maxItems": 20, "description": "Nombres de host (coincidencia exacta, solo HTTPS) a los que una verificación independiente de wallet de Digital ID puede devolver al usuario con su `return_url`. Tu dominio de marca blanca también está siempre permitido. Consulta [Registra tu destino de retorno](https://docs.didit.me/es/standalone-apis/digital-id-wallets#registra-tu-destino-de-retorno).", "items": { "type": "string", "maxLength": 253 } }, "endpoints": { "type": "array", "description": "Todos los destinos de webhook de la aplicación, del más antiguo al más reciente, cada uno con su secreto de firma. Aquí solo se pueden leer: gestiona los destinos con los endpoints `/v3/webhook/destinations/`.", "items": { "$ref": "#/components/schemas/WebhookConfigDestination" } }, "allowed_domains": { "type": "array", "maxItems": 50, "items": { "type": "string", "maxLength": 300 }, "description": "Orígenes (por ejemplo `https://app.example.com`; `http` solo para `localhost`) en los que puede incrustarse el flujo de verificación alojado y a los que puede devolver al usuario con un callback de sesión. Las llamadas de servidor a servidor no se ven afectadas. Una lista vacía significa que no hay restricción. Didit almacena cada origen en minúsculas y sin puerto predeterminado. Una entrada no válida falla con `400` en `allowed_domains`.", "example": [ "https://app.example.com" ] } } }, "WebhookDestinationDelivery": { "type": "object", "description": "Un intento de entrega a un destino de webhook. El primer envío de un evento, cada reintento automático y cada reenvío son entregas independientes.", "required": [ "uuid", "session_id", "request_url", "response_status", "response_time_ms", "status", "webhook_type", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID de entrega, para las llamadas de detalle y de reenvío." }, "session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Sesión de verificación de usuario a la que se refiere el evento. `null` para los eventos de sesiones de empresa, usuarios, empresas, transacciones, Travel Rule y flujos." }, "request_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL a la que se envió la entrega: la URL del destino en el momento en que se generó el evento." }, "response_status": { "type": "integer", "nullable": true, "description": "Estado HTTP que devolvió tu endpoint. `null` mientras la entrega está en cola y aún no se ha intentado. Cuando no se recibe ninguna respuesta HTTP, Didit registra un estado propio: `504` cuando tu endpoint no respondió en 5 segundos, `503` para un fallo de conexión, `400` cuando la URL se rechazó por no ser segura (por ejemplo, una dirección privada o interna) y `404` para cualquier otro error de la solicitud. `400` o superior cuenta como entrega fallida." }, "response_time_ms": { "type": "integer", "nullable": true, "minimum": 0, "description": "Tiempo que tardó el intento, en milisegundos. `null` mientras la entrega está en cola." }, "status": { "type": "string", "nullable": true, "description": "Estado que informó el evento cuando se generó: el estado de la sesión para los eventos de sesión (por ejemplo, `Approved` o `In Review`), el estado de la persona o de la empresa para los eventos de usuario y de empresa, y el estado de la transacción para los eventos de transacción. `null` para los eventos que no incluyen ningún estado." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "created_at": { "type": "string", "format": "date-time", "description": "Cuándo se creó la entrega." } } }, "WebhookDestinationDeliveryDetail": { "type": "object", "description": "Un intento de entrega a un destino de webhook, con los encabezados y el cuerpo exactos de la solicitud que envió Didit.", "required": [ "uuid", "session_id", "request_url", "response_status", "response_time_ms", "status", "webhook_type", "created_at", "request_header", "request_body" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID de entrega, para las llamadas de detalle y de reenvío." }, "session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Sesión de verificación de usuario a la que se refiere el evento. `null` para los eventos de sesiones de empresa, usuarios, empresas, transacciones, Travel Rule y flujos." }, "request_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL a la que se envió la entrega: la URL del destino en el momento en que se generó el evento." }, "response_status": { "type": "integer", "nullable": true, "description": "Estado HTTP que devolvió tu endpoint. `null` mientras la entrega está en cola y aún no se ha intentado. Cuando no se recibe ninguna respuesta HTTP, Didit registra un estado propio: `504` cuando tu endpoint no respondió en 5 segundos, `503` para un fallo de conexión, `400` cuando la URL se rechazó por no ser segura (por ejemplo, una dirección privada o interna) y `404` para cualquier otro error de la solicitud. `400` o superior cuenta como entrega fallida." }, "response_time_ms": { "type": "integer", "nullable": true, "minimum": 0, "description": "Tiempo que tardó el intento, en milisegundos. `null` mientras la entrega está en cola." }, "status": { "type": "string", "nullable": true, "description": "Estado que informó el evento cuando se generó: el estado de la sesión para los eventos de sesión (por ejemplo, `Approved` o `In Review`), el estado de la persona o de la empresa para los eventos de usuario y de empresa, y el estado de la transacción para los eventos de transacción. `null` para los eventos que no incluyen ningún estado." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "created_at": { "type": "string", "format": "date-time", "description": "Cuándo se creó la entrega." }, "request_header": { "type": "string", "description": "Texto JSON (una cadena) de los encabezados de la solicitud que envió Didit: `Content-Type`, `X-Signature`, `X-Signature-V2`, `X-Signature-Simple`, `X-Timestamp` y `User-Agent`. Analízalo con un parser JSON. Contiene firmas, nunca el secreto de firma." }, "request_body": { "type": "string", "description": "Texto JSON (una cadena) del payload exacto que envió Didit, con las claves ordenadas, incluidos `event_id` y `timestamp`. Analízalo con un parser JSON; consulta [Estructura del payload](https://docs.didit.me/es/integration/webhooks#estructura-del-payload). Para una clave con alcance limitado sin `media: read`, las URL de medios que contiene son `null`; sin `sessions: write`, los tokens de sesión y los enlaces de verificación alojados son `null`. Un cuerpo modificado de esa forma ya no coincide con sus firmas. Didit no registra el cuerpo de la respuesta que devolvió tu endpoint." } } }, "SessionWebhookDelivery": { "type": "object", "description": "Un intento de entrega de webhook registrado para una sesión de verificación, con los encabezados y el cuerpo exactos de la solicitud que envió Didit.", "required": [ "uuid", "session_id", "request_url", "response_status", "status", "webhook_type", "request_header", "request_body", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID de entrega. Úsalo como `{webhook_uuid}` para obtener o reenviar esta entrega." }, "session_id": { "type": "string", "format": "uuid", "description": "La sesión a la que pertenece la entrega (la sesión de la ruta)." }, "request_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL a la que se envió la entrega." }, "response_status": { "type": "integer", "nullable": true, "description": "Estado HTTP que devolvió tu endpoint. `null` mientras la entrega está en cola y aún no se ha intentado. Cuando no se recibe ninguna respuesta HTTP, Didit registra un estado propio: `504` cuando tu endpoint no respondió en 5 segundos, `503` para un fallo de conexión, `400` cuando la URL se rechazó por no ser segura (por ejemplo, una dirección privada o interna) y `404` para cualquier otro error de la solicitud. `400` o superior cuenta como entrega fallida." }, "status": { "type": "string", "nullable": true, "description": "Estado de la sesión cuando se generó el evento, por ejemplo `In Progress`, `Approved` o `Declined`." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "request_header": { "type": "string", "description": "Texto JSON (una cadena) de los encabezados de la solicitud que envió Didit: `Content-Type`, `X-Signature`, `X-Signature-V2`, `X-Signature-Simple`, `X-Timestamp` y `User-Agent`. Analízalo con un parser JSON. Contiene firmas, nunca el secreto de firma." }, "request_body": { "type": "string", "description": "Texto JSON (una cadena) del payload exacto que envió Didit, con las claves ordenadas, incluidos `event_id` y `timestamp`. Analízalo con un parser JSON; consulta [Estructura del payload](https://docs.didit.me/es/integration/webhooks#estructura-del-payload). Para una clave con alcance limitado sin `media: read`, las URL de medios que contiene son `null`; sin `sessions: write`, los tokens de sesión y los enlaces de verificación alojados son `null`. Un cuerpo modificado de esa forma ya no coincide con sus firmas. Didit no registra el cuerpo de la respuesta que devolvió tu endpoint." }, "created_at": { "type": "string", "format": "date-time", "description": "Cuándo se creó la entrega." } } }, "SessionEvent": { "type": "object", "description": "Una entrada de la cronología de eventos de una sesión de verificación.", "required": [ "uuid", "event_type", "created_at", "component", "feature_step", "step", "details", "ip_address", "user_agent", "device_info", "file_url", "sent_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador del evento." }, "event_type": { "type": "string", "enum": [ "SESSION_CREATED", "SESSION_COMPLETED", "SESSION_STATUS_CHANGED", "LINK_OPENED", "FORM_SUBMITTED", "BUTTON_CLICKED", "FILE_UPLOADED", "ATTEMPT_FAILED", "FEATURE_STEP_CHANGED", "STEP_RENDERED", "NOTE_ADDED", "MANUAL_REVIEW_STARTED", "WORKFLOW_BRANCH_EVALUATED", "WORKFLOW_STATUS_NODE_REACHED", "LOG" ], "description": "Qué ocurrió. Notificados por el dispositivo durante el flujo alojado o el SDK: `LINK_OPENED`, `STEP_RENDERED`, `BUTTON_CLICKED`, `FORM_SUBMITTED`, `FILE_UPLOADED`, `ATTEMPT_FAILED` y `LOG` (depuración). Registrados por el servidor: `SESSION_CREATED`, `SESSION_STATUS_CHANGED` (`details.old_status`, `details.current_status`), `FEATURE_STEP_CHANGED` (`details.old_feature_step`, `details.current_feature_step`), `WORKFLOW_BRANCH_EVALUATED` y `WORKFLOW_STATUS_NODE_REACHED` (la traza de enrutamiento del flujo). `SESSION_COMPLETED`, `NOTE_ADDED` y `MANUAL_REVIEW_STARTED` pueden aparecer en sesiones más antiguas." }, "created_at": { "type": "string", "format": "date-time", "description": "Cuándo almacenó Didit el evento. Los eventos se almacenan de forma asíncrona, unos segundos después de `sent_at`." }, "component": { "type": "string", "nullable": true, "description": "Componente de la interfaz que informó del evento (solo eventos de dispositivo)." }, "feature_step": { "type": "string", "nullable": true, "enum": [ "OCR", "OCR_BACK", "NFC", "AML", "FACE", "LIVENESS", "FACE_MATCH", "IP_ANALYSIS", "AGE_ESTIMATION", "PROOF_OF_ADDRESS", "PHONE_VERIFICATION", "EMAIL_VERIFICATION", "FACE_SEARCH", "DATABASE_VALIDATION", "QUESTIONNAIRE", "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE", "DOCUMENT_AI", "GEOLOCATION", null ], "description": "Función de verificación en la que se encontraba la sesión cuando ocurrió el evento." }, "step": { "type": "string", "nullable": true, "description": "Pantalla dentro de la función, por ejemplo `DOCUMENT_CAPTURE_FRONT` o `FACE_PASSIVE_LIVENESS`." }, "details": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Datos específicos del evento. Las claves dependen de `event_type`." }, "ip_address": { "type": "string", "nullable": true, "description": "Dirección IP desde la que el dispositivo informó del evento. `null` para los eventos registrados por el servidor." }, "user_agent": { "type": "string", "nullable": true, "description": "User agent del dispositivo. `null` para los eventos registrados por el servidor." }, "device_info": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Detalles del dispositivo que informó el SDK o el navegador." }, "file_url": { "type": "string", "format": "uri", "nullable": true, "description": "Enlace prefirmado de corta duración a un archivo adjunto al evento (por ejemplo, una imagen capturada). `null` cuando no hay ninguno, y siempre `null` para una clave de API con alcance limitado sin `media: read`." }, "sent_at": { "type": "integer", "format": "int64", "description": "Cuándo ocurrió el evento, como marca de tiempo Unix en milisegundos. Los resultados se ordenan por este valor." } } }, "AMLDatasetSourceFreshness": { "type": "object", "description": "Actualidad de una familia de conjuntos de datos AML.", "required": [ "last_updated_at", "oldest_updated_at", "dataset_count", "dated_dataset_count" ], "properties": { "last_updated_at": { "type": "string", "format": "date-time", "description": "Actualización más reciente de cualquier conjunto de datos de la familia." }, "oldest_updated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Límite de antigüedad: todos los conjuntos de datos de la familia están, como mínimo, así de actualizados. `null` cuando al menos un conjunto de datos de la familia no informó una fecha de actualización, porque en ese caso el límite es desconocido." }, "dataset_count": { "type": "integer", "description": "Número de conjuntos de datos de la familia." }, "dated_dataset_count": { "type": "integer", "description": "Número de esos conjuntos de datos que informaron una fecha de actualización." } } }, "AMLDatasetFreshness": { "type": "object", "description": "Qué tan actualizados estaban los conjuntos de datos AML cuando se ejecutó un análisis. Las fechas nunca se estiman.", "required": [ "captured_at", "provider", "catalog_version", "sources" ], "properties": { "captured_at": { "type": "string", "format": "date-time", "description": "Cuándo leyó Didit el catálogo de conjuntos de datos del que procede este dato de actualización." }, "provider": { "type": "string", "description": "Identificador opaco de la fuente de datos AML. Trátalo como una cadena opaca; no bases ninguna lógica condicional en él.", "example": "aml_data_source" }, "catalog_version": { "type": "string", "nullable": true, "description": "Identificador de versión del catálogo de conjuntos de datos, cuando la fuente lo indica." }, "sources": { "type": "object", "description": "Actualidad por familia de conjuntos de datos. Una familia cuyos conjuntos de datos no informaron ninguna fecha de actualización no aparece, en lugar de rellenarse con `null`.", "properties": { "sanctions": { "$ref": "#/components/schemas/AMLDatasetSourceFreshness" }, "pep": { "$ref": "#/components/schemas/AMLDatasetSourceFreshness" }, "warnings": { "$ref": "#/components/schemas/AMLDatasetSourceFreshness" }, "adverse_media": { "$ref": "#/components/schemas/AMLDatasetSourceFreshness" } } } } }, "AMLScreeningRun": { "type": "object", "description": "Un reanálisis completado de la monitorización continua de una comprobación AML.", "required": [ "uuid", "run_id", "completed_at", "started_at", "outcome", "trigger", "provider", "status", "score", "total_hits", "new_hits", "entities_screened", "dataset_freshness" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador de esta ejecución del análisis." }, "run_id": { "type": "string", "format": "uuid", "description": "La ejecución de monitorización a la que pertenece este análisis. Todas las verificaciones analizadas en la misma ejecución la comparten." }, "completed_at": { "type": "string", "format": "date-time", "description": "Cuándo terminó el nuevo análisis de este sujeto. Los resultados se ordenan por este valor, del más reciente al más antiguo." }, "started_at": { "type": "string", "format": "date-time", "description": "Fecha y hora en que comenzó el lote de monitorización al que pertenece este nuevo análisis." }, "outcome": { "type": "string", "enum": [ "NO_CHANGE", "CHANGED", "FAILED" ], "description": "`NO_CHANGE`: completado y el resultado no cambió. `CHANGED`: completado y cambiaron la puntuación, el estado, el número de coincidencias o las coincidencias. `FAILED`: no hubo ninguna respuesta utilizable para este sujeto, así que la comprobación se dejó como estaba." }, "trigger": { "type": "string", "enum": [ "ONGOING_MONITORING" ], "description": "Qué inició el análisis. Actualmente siempre es `ONGOING_MONITORING`." }, "provider": { "type": "string", "description": "Identificador opaco de la fuente de datos AML que respondió. Trátalo como una cadena opaca; no bases ninguna lógica condicional en él.", "example": "aml_data_source" }, "status": { "type": "string", "nullable": true, "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested", null ], "description": "Estado en el que esta ejecución dejó el análisis AML." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Puntuación AML con la que esta ejecución dejó el análisis." }, "total_hits": { "type": "integer", "nullable": true, "description": "Número de coincidencias con las que esta ejecución dejó la comprobación." }, "new_hits": { "type": "integer", "nullable": true, "description": "Número de coincidencias encontradas en esta ejecución que la comprobación no tenía antes. `0` cuando no se encontró nada nuevo; `null` cuando la ejecución falló o se registró antes de que existiera este recuento." }, "entities_screened": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Número de entidades analizadas en esta ejecución para la verificación: `1` cuando se analizó al sujeto, `0` cuando la ejecución falló." }, "dataset_freshness": { "allOf": [ { "$ref": "#/components/schemas/AMLDatasetFreshness" } ], "nullable": true, "description": "Actualidad del conjunto de datos usado en esta ejecución, o `null` cuando no había fechas disponibles." } } }, "KYBKeyPeopleParty": { "type": "object", "description": "Una parte de Personas clave de una sesión de Verificación de empresas (KYB), con su verificación secundaria. La misma parte aparece en `key_people_checks[].submitted.parties[]` de la decisión de la sesión de empresa.", "required": [ "uuid", "entity_type", "source", "name", "is_active", "is_skipped", "requires_verification", "roles", "kyc_session_deleted", "kyb_sub_session_deleted" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador de la parte." }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Si la parte es una persona física o una empresa." }, "source": { "type": "string", "enum": [ "REGISTRY", "USER" ], "description": "`REGISTRY`: obtenido del registro de empresas. `USER`: introducido en la pantalla Personas clave." }, "name": { "type": "string", "description": "Nombre visible de la parte." }, "first_name": { "type": "string", "nullable": true, "description": "Nombre (personas)." }, "last_name": { "type": "string", "nullable": true, "description": "Apellido (personas)." }, "company_name": { "type": "string", "nullable": true, "description": "Nombre de la empresa (partes que son empresas)." }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registro de la empresa (partes que son empresas)." }, "email": { "type": "string", "format": "email", "nullable": true, "description": "Correo electrónico al que se envía el enlace de verificación." }, "nationality": { "type": "string", "nullable": true, "description": "Nacionalidad para personas, país de constitución para empresas." }, "phone_number": { "type": "string", "nullable": true, "description": "Número de teléfono recopilado para la parte." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Fecha de nacimiento (personas)." }, "position": { "type": "string", "nullable": true, "description": "Cargo en texto libre (personas)." }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Campos personalizados definidos en el flujo y recopilados para la parte, indexados por la clave del campo." }, "is_active": { "type": "boolean", "description": "Si la parte está activa." }, "is_skipped": { "type": "boolean", "description": "Si la parte está exenta de verificación. Al regenerar, este valor se borra." }, "requires_verification": { "type": "boolean", "description": "Si las reglas de rol y propiedad exigen una verificación para esta parte." }, "roles": { "type": "array", "description": "Roles que tiene la parte en la empresa.", "items": { "type": "object", "required": [ "role", "ownership_percent", "voting_percent" ], "properties": { "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ], "description": "Código del rol." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Porcentaje de propiedad correspondiente a este rol, cuando se conoce." }, "voting_percent": { "type": "number", "nullable": true, "description": "Porcentaje de derechos de voto para este rol, cuando se conoce." } } } }, "kyc_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Sesión KYC individual secundaria (personas)." }, "kyc_session_status": { "type": "string", "nullable": true, "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User", null ], "description": "Estado de la sesión KYC hija. Una sesión eliminada conserva el estado que tenía cuando se eliminó." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "Enlace alojado de la sesión KYC secundaria. `null` cuando no existe o se eliminó, y para una clave de API con alcance limitado sin `sessions: write`." }, "kyc_session_deleted": { "type": "boolean", "description": "La sesión KYC hija se eliminó, por lo que nunca podrá resolverse." }, "kyb_sub_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Sesión KYB secundaria (partes que son empresas)." }, "kyb_sub_session_status": { "type": "string", "nullable": true, "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User", null ], "description": "Estado de la sesión KYB hija." }, "kyb_sub_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "Enlace alojado de la sesión KYB secundaria, con las mismas reglas de `null` que `kyc_session_url`." }, "kyb_sub_session_deleted": { "type": "boolean", "description": "Equivalente de `kyc_session_deleted` para las partes de tipo empresa." }, "verification_workflow_type": { "type": "string", "nullable": true, "enum": [ "kyc", "kyb", "adaptive_age_verification", "biometric_authentication", "address_verification", "questionnaire_verification", "email_verification", "phone_verification", null ], "description": "Tipo del flujo que ejecuta la sesión secundaria." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Flujo que ejecuta la sesión hija." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Etiqueta de ese flujo." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Funciones del flujo de la sesión hija con su estado actual.", "items": { "type": "object", "required": [ "feature", "status" ], "properties": { "feature": { "type": "string", "description": "Código de la función, por ejemplo `ID_VERIFICATION` o `LIVENESS`." }, "status": { "type": "string", "description": "Estado de la función; es `Not Finished` hasta que se ejecuta." } } } }, "didit_internal_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Identificador de Didit de la persona verificada, una vez conocido." } } }, "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.\nCuando 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" ] }, "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" } } }, "NetworkListCounts": { "type": "object", "description": "Recuentos de redes para las vistas y las opciones de filtro de la lista; cada red se cuenta una sola vez. Solo se devuelven cuando `summary` no es `false`. `scopes` cuenta todas las redes visibles para la aplicación. `views` cuenta las redes visibles dentro del `scope` seleccionado. `facets` cuenta las redes del `scope` y la vista de `status` seleccionados (las redes descartadas quedan fuera salvo que `status` las incluya). Los demás filtros de la lista no modifican estos recuentos.", "properties": { "scopes": { "type": "object", "description": "Redes visibles por producto.", "properties": { "all": { "type": "integer" }, "identity": { "type": "integer", "description": "Todas las demás redes." }, "transactions": { "type": "integer", "description": "Redes cuyos miembros son todos partes de transacciones." } } }, "views": { "type": "object", "description": "Redes visibles dentro del `scope` seleccionado, por estado, más dos vistas guardadas.", "properties": { "all": { "type": "integer" }, "active": { "type": "integer" }, "in_review": { "type": "integer" }, "resolved": { "type": "integer" }, "dismissed": { "type": "integer" }, "mine": { "type": "integer", "description": "Redes asignadas al miembro de la consola que realiza la llamada. Siempre 0 para una clave de API." }, "high_risk": { "type": "integer", "description": "Redes con una puntuación de riesgo de 80 o más que no están descartadas." } } }, "facets": { "type": "object", "description": "Recuentos de cada opción de filtro, dentro del `scope` seleccionado y de la vista de estado.", "properties": { "total": { "type": "integer", "description": "Redes del `scope` y la vista de estado seleccionados." }, "last_activity_days": { "type": "object", "description": "Redes con actividad en los últimos 7, 30 y 90 días, indexadas por el número de días.", "properties": { "7": { "type": "integer" }, "30": { "type": "integer" }, "90": { "type": "integer" } } }, "risk_min": { "type": "object", "description": "Redes con una puntuación de riesgo de al menos 50 y de al menos 80, indexadas por el umbral.", "properties": { "50": { "type": "integer" }, "80": { "type": "integer" } } }, "signal_types": { "type": "object", "description": "Redes con al menos una señal de cada tipo.", "properties": { "ip_address": { "type": "integer" }, "device": { "type": "integer" }, "face": { "type": "integer" }, "document_number": { "type": "integer" }, "phone": { "type": "integer" }, "email": { "type": "integer" }, "address": { "type": "integer" } } }, "priority": { "type": "object", "description": "Redes por prioridad. `none` cuenta las redes sin prioridad.", "properties": { "low": { "type": "integer" }, "medium": { "type": "integer" }, "high": { "type": "integer" }, "none": { "type": "integer" } } }, "assignee": { "type": "object", "description": "Redes por persona asignada.", "properties": { "me": { "type": "integer", "description": "Asignados al miembro de la consola que hace la llamada. Siempre es 0 para una clave de API." }, "unassigned": { "type": "integer", "description": "Sin asignar." }, "users": { "type": "array", "description": "Una entrada por persona asignada, de más a menos redes.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "full_name": { "type": "string", "description": "El nombre de la persona asignada, o su correo electrónico cuando no tiene un nombre definido." }, "email": { "type": "string" }, "count": { "type": "integer" } } } } } }, "has_case": { "type": "integer", "description": "Redes para las que esta aplicación abrió un caso." }, "min_size": { "type": "object", "description": "Redes con al menos 10 miembros, indexadas por el tamaño mínimo.", "properties": { "10": { "type": "integer" } } } } } } }, "NetworkTag": { "type": "object", "description": "Una de las etiquetas de tu aplicación en la red.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "El UUID de la etiqueta, el mismo valor que pasas como `tag_uuid`." }, "name": { "type": "string" }, "color": { "type": "string", "description": "Color hexadecimal, por ejemplo `#6366F1`." }, "source": { "type": "string", "enum": [ "didit", "custom" ], "description": "`didit` para una etiqueta predefinida de Didit, `custom` para una etiqueta que creó tu equipo." }, "added_by": { "type": "string", "nullable": true, "description": "Correo electrónico del miembro de la consola que añadió la etiqueta. Null cuando la añadió una clave de API." }, "added_at": { "type": "string", "format": "date-time" } } }, "NetworkOutcomes": { "type": "object", "description": "Estado de las personas y empresas de la red. Cada miembro que puedes ver cuenta una vez, según el estado de su verificación más reciente que llegó a una decisión. Las partes de las transacciones no se cuentan.", "properties": { "approved": { "type": "integer", "description": "Miembros cuya verificación decidida más reciente fue aprobada." }, "declined": { "type": "integer", "description": "Miembros cuya verificación decidida más reciente fue rechazada." }, "in_review": { "type": "integer", "description": "Miembros cuya verificación decidida más reciente está en revisión." }, "total": { "type": "integer", "description": "Miembros con al menos una verificación, decidida o no. Un miembro cuyas verificaciones están todas sin decidir (no iniciadas, en curso, expiradas o abandonadas) se cuenta aquí y en ninguna otra clave." } } }, "NetworkPatternScore": { "type": "object", "description": "Qué tan parecido es un tipo de datos de los miembros en toda la red. Un patrón no es una señal: ningún valor compartido vincula a los miembros.", "properties": { "type": { "type": "string", "enum": [ "background" ], "description": "`background`: la similitud media de cada par de fondos de las selfies de los miembros, con la persona enmascarada. Lee la selfie más reciente de cada persona, como máximo las 50 más recientes, y excluye las sesiones de verificación de edad. Abarca toda la red, no solo los miembros de tus aplicaciones." }, "score": { "type": "number", "nullable": true, "minimum": 0, "maximum": 1, "description": "De 0 a 1, redondeado a 4 decimales. Null cuando `reason` está definido." }, "members": { "type": "integer", "nullable": true, "description": "Cuántas selfies de miembros comparó la puntuación. Una selfie que no se puede leer, o que muestra muy poco fondo, no se compara. Null mientras sea `computing`; 0 o 1 con `not_enough_selfies`." }, "reason": { "type": "string", "enum": [ "computing", "not_enough_selfies" ], "nullable": true, "description": "Por qué no hay puntuación. `computing`: se está calculando la puntuación de los miembros actuales; vuelve a leer la red más tarde. `not_enough_selfies`: menos de dos miembros tienen una selfie utilizable. Es null cuando hay puntuación." }, "computed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que se calculó la puntuación. Nulo mientras está en `computing`." } } }, "NetworkDetailResponse": { "description": "El detalle de la red, junto con el modo de compartición de la organización, si se le aplican las señales entre organizaciones, las etiquetas de tu aplicación en la red, los resultados de los miembros y las puntuaciones de patrones.", "allOf": [ { "$ref": "#/components/schemas/NetworkDetail" }, { "type": "object", "properties": { "sharing_mode": { "type": "string", "enum": [ "off", "private", "global" ], "description": "El modo de uso compartido entre organizaciones de la organización. Solo `global` compara redes entre organizaciones; `private` y `off` las limitan al historial propio de la organización.", "example": "global" }, "cross_org_available": { "type": "boolean", "description": "Indica si las señales entre organizaciones se aplican a esta organización. Requieren tanto el plan Enterprise como el modo de compartición `global`.", "example": true }, "cross_org_unavailable_reason": { "type": "string", "enum": [ "plan", "sharing_mode" ], "nullable": true, "description": "Por qué no se aplican las señales entre organizaciones, comprobado en este orden. `plan`: el plan de la organización no incluye la red de fraude entre organizaciones (requiere el plan Enterprise), sea cual sea el modo de compartición. `sharing_mode`: el plan la incluye, pero el modo de compartición es `private` u `off`. Null cuando `cross_org_available` es `true`.", "example": null }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTag" }, "description": "Las etiquetas de tu aplicación en la red, de la más antigua a la más reciente. Cada aplicación solo ve sus propias etiquetas. `fraud_tags` es independiente y no cambia: son las etiquetas que tienen los miembros de la red." }, "outcomes": { "$ref": "#/components/schemas/NetworkOutcomes" }, "patterns": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkPatternScore" }, "description": "Puntuaciones de patrones sobre toda la red. Actualmente, un elemento: `background`." } } } ] }, "NetworkTagRequest": { "type": "object", "required": [ "tag_uuid" ], "properties": { "tag_uuid": { "type": "string", "format": "uuid", "description": "UUID de una de las etiquetas de tu aplicación." } }, "example": { "tag_uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7" } }, "NetworkTimeline": { "title": "Default timeline (no contract)", "type": "object", "description": "Sin `contract`: los eventos propios de la red, del más antiguo al más reciente, sin paginar.", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTimelineEvent" } } } }, "NetworkTimelinePage": { "title": "Typed timeline page (contract=2)", "type": "object", "description": "Con `contract=2`: una página de eventos tipados, del más reciente al más antiguo.", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTypedTimelineEvent" } }, "next_cursor": { "type": "string", "nullable": true, "description": "Pásalo como `cursor` para leer la página siguiente. Es null en la última página." } } }, "NetworkTypedTimelineEvent": { "type": "object", "description": "Un evento tipado de la línea de tiempo: los cuatro campos predeterminados, además de su id, cuándo lo almacenó Didit, la cuenta de miembro y el registro a los que pertenece, y el bloque de detalle de su tipo de evento. Los demás bloques de detalle son null.", "properties": { "id": { "type": "string", "description": "`:`, único dentro de la línea de tiempo.", "example": "session:3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "event_type": { "type": "string", "enum": [ "network_detected", "signal_observed", "network_active", "network_in_review", "network_resolved", "network_dismissed", "verification_attempt", "transaction", "login", "rule_hit", "case_linked", "note_added" ] }, "occurred_at": { "type": "string", "format": "date-time", "description": "Cuándo ocurrió." }, "ingested_at": { "type": "string", "format": "date-time", "description": "Cuándo lo almacenó Didit." }, "label": { "type": "string", "description": "Una etiqueta breve en inglés, por ejemplo `Verification attempt 2 of 3`." }, "metadata": { "type": "object", "description": "En los eventos propios de la red, los mismos metadatos que la cronología predeterminada. Vacío en caso contrario." }, "account": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineAccount" } ], "nullable": true, "description": "La cuenta de miembro. Null para los eventos propios de la red, `case_linked` y `note_added`." }, "source_ref": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineSourceRef" } ], "nullable": true, "description": "El registro de origen. Es null para los eventos propios de la red y para `note_added`." }, "verification_attempt": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineAttempt" } ], "nullable": true, "description": "Se establece en los eventos `verification_attempt`." }, "transaction": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineTransaction" } ], "nullable": true, "description": "Se establece en los eventos `transaction`." }, "login": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineLogin" } ], "nullable": true, "description": "Se establece en los eventos `login`." }, "rule_hit": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineRuleHit" } ], "nullable": true, "description": "Se establece en los eventos `rule_hit`." }, "case_linked": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineCaseLinked" } ], "nullable": true, "description": "Se establece en los eventos `case_linked`." }, "note_added": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineNoteAdded" } ], "nullable": true, "description": "Se establece en los eventos `note_added`. Nunca se devuelve a una clave de API." } } }, "NetworkTimelineAccount": { "type": "object", "description": "La cuenta de miembro a la que pertenece el evento.", "properties": { "node_id": { "type": "string", "description": "`:`, donde kind es `vendor_user`, `vendor_business` o `transaction_party`.", "example": "vendor_user:3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "node_type": { "type": "string", "enum": [ "account", "business_account", "transaction_party" ] }, "uuid": { "type": "string", "format": "uuid" }, "vendor_data": { "type": "string", "nullable": true }, "display_name": { "type": "string", "nullable": true }, "ownership": { "type": "string", "enum": [ "owned", "organization" ], "description": "`owned` cuando el registro pertenece a la aplicación a la que llamaste (para un miembro de la consola, a una aplicación a la que se le concedió acceso). `organization` cuando pertenece a otra aplicación de tu organización." }, "route": { "$ref": "#/components/schemas/NetworkTimelineRoute" } } }, "NetworkTimelineSourceRef": { "type": "object", "description": "El registro del que se leyó el evento.", "properties": { "kind": { "type": "string", "enum": [ "session", "business_session", "transaction", "monitoring_event", "case" ] }, "id": { "type": "string", "format": "uuid" }, "ownership": { "type": "string", "enum": [ "owned", "organization" ], "description": "`owned` cuando el registro pertenece a la aplicación a la que llamaste (para un miembro de la consola, a una aplicación a la que se le concedió acceso). `organization` cuando pertenece a otra aplicación de tu organización." }, "route": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineRoute" } ], "description": "No aparece para `monitoring_event` ni para `case`." } } }, "NetworkTimelineRoute": { "type": "object", "description": "Desde dónde se abre el registro: su tipo, su UUID y la aplicación a la que pertenece.", "properties": { "kind": { "type": "string", "description": "`user`, `business` o `transaction_party` para una cuenta; `session`, `business_session` o `transaction` para un registro de origen." }, "id": { "type": "string", "format": "uuid" }, "application_id": { "type": "string", "format": "uuid" } } }, "NetworkTimelineAttempt": { "type": "object", "description": "Una sesión de verificación de la cuenta.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "El UUID de la sesión, o el UUID de la sesión de empresa en el caso de una empresa." }, "session_number": { "type": "integer", "nullable": true }, "attempt": { "type": "integer", "description": "La posición de esta sesión entre las sesiones de la cuenta, en orden de creación." }, "attempt_count": { "type": "integer", "description": "Cuántas sesiones tiene la cuenta." }, "status": { "type": "string", "description": "El estado de la sesión, por ejemplo `Approved` o `Declined`." }, "status_changed_at": { "type": "string", "format": "date-time", "nullable": true }, "decline_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTimelineDeclineReason" }, "description": "Solo en una sesión rechazada: sus advertencias, de la más antigua a la más reciente, una vez por advertencia. Vacío en caso contrario." } } }, "NetworkTimelineDeclineReason": { "type": "object", "properties": { "risk": { "type": "string", "description": "El código de advertencia." }, "feature": { "type": "string", "description": "La función que generó la advertencia." }, "short_description": { "type": "string" } } }, "NetworkTimelineTransaction": { "type": "object", "description": "Una transacción en la que participó una cuenta miembro, fechada según su fecha de transacción.", "properties": { "transaction_id": { "type": "string", "format": "uuid" }, "transaction_number": { "type": "integer", "nullable": true }, "transaction_type": { "type": "string" }, "action_type": { "type": "string" }, "amount": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineAmount" } ], "nullable": true, "description": "Null cuando la transacción no tiene importe." }, "status": { "type": "string" }, "decision_reason_code": { "type": "string", "nullable": true }, "decision_reason_label": { "type": "string", "nullable": true }, "party_role": { "type": "string", "description": "El rol de la cuenta en la transacción: `APPLICANT`, `REMITTER`, `BENEFICIARY` o `COUNTERPARTY`." } } }, "NetworkTimelineAmount": { "type": "object", "properties": { "value": { "type": "string", "description": "Importe decimal como cadena." }, "currency": { "type": "string" }, "direction": { "type": "string", "nullable": true } } }, "NetworkTimelineLogin": { "type": "object", "description": "Un evento de inicio de sesión que publicaste para una persona a través de la API de eventos.", "properties": { "action": { "type": "string", "description": "`.`: `auth.login` o `security.login_succeeded` para un inicio de sesión, `auth.login_failed` o `security.login_failed` para uno fallido." }, "succeeded": { "type": "boolean" }, "status": { "type": "string", "description": "El estado del evento." }, "ip": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineIP" } ], "nullable": true, "description": "Null cuando el evento no tiene dirección IP." }, "device": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineDevice" } ], "nullable": true, "description": "Null cuando el evento no tiene huella digital ni contexto del dispositivo." }, "is_first_login": { "type": "boolean", "description": "El primer inicio de sesión correcto registrado de la cuenta." }, "is_new_device": { "type": "boolean", "description": "Un inicio de sesión correcto desde un dispositivo que no se usó en ninguno de los inicios de sesión correctos anteriores de la cuenta. Nunca es true en el primer inicio de sesión." } } }, "NetworkTimelineIP": { "type": "object", "properties": { "address": { "type": "string" }, "country_code": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "connection_type": { "type": "string", "nullable": true, "description": "La etiqueta del tipo de conexión de la dirección, como texto libre." }, "is_vpn_or_tor": { "type": "boolean" }, "is_data_center": { "type": "boolean" } } }, "NetworkTimelineDevice": { "type": "object", "properties": { "fingerprint": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true, "description": "Una etiqueta de dispositivo legible creada a partir del contexto de dispositivo del evento." } } }, "NetworkTimelineRuleHit": { "type": "object", "description": "Una regla en producción que coincidió con una transacción o un evento de un miembro. No se incluyen las coincidencias en modo de prueba.", "properties": { "rule_id": { "type": "string", "format": "uuid" }, "rule_title": { "type": "string" }, "rule_category": { "type": "string" }, "rule_source": { "type": "string" }, "severity": { "type": "string", "nullable": true }, "score_delta": { "type": "integer" }, "status_target": { "type": "string", "nullable": true }, "action_summary": { "type": "string", "nullable": true } } }, "NetworkTimelineCaseLinked": { "type": "object", "description": "Un caso abierto para la red en tu organización. `source_ref.ownership` indica si pertenece a la aplicación a la que llamaste.", "properties": { "case_id": { "type": "string", "format": "uuid" }, "case_number": { "type": "string", "nullable": true }, "status": { "type": "string" }, "author_email": { "type": "string", "nullable": true }, "author_name": { "type": "string", "nullable": true } } }, "NetworkTimelineNoteAdded": { "type": "object", "description": "Una nota dejada en la red. No se incluye el texto de la nota.", "properties": { "note_id": { "type": "string", "format": "uuid" }, "author_email": { "type": "string" } } }, "FeatureStatusOverride": { "type": "object", "description": "Una modificación manual del estado de una comprobación (función) realizada con `PATCH /v3/session/{sessionId}/features/{nodeId}/update-status/`: qué cambia, si se aplicó o sigue a la espera de que la persona termine el flujo, quién la solicitó y por qué.", "required": [ "id", "node_id", "feature_type", "feature_model", "previous_status", "new_status", "state", "forced", "reason", "requested_by", "requested_at", "applied_at", "cancelled_at", "cancel_reason" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Identificador de la anulación. Pásalo al endpoint de cancelación.", "example": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }, "node_id": { "type": "string", "description": "El nodo del flujo que indicó la solicitud (`default` para un paso sin nodo).", "example": "feature_ocr_1" }, "feature_type": { "type": "string", "description": "El `feature_type` que se pasó en la solicitud, o una cadena vacía si no se pasó ninguno.", "example": "" }, "feature_model": { "type": "string", "description": "El tipo de comprobación que se anuló, por ejemplo `KYC`, `Face`, `AML` o `GeolocationCheck`.", "example": "KYC" }, "previous_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "El estado de la comprobación cuando se solicitó la anulación manual.", "example": "In Review" }, "new_status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "El estado que establece la anulación.", "example": "Approved" }, "state": { "type": "string", "enum": [ "applied", "pending_until_flow_finishes", "cancelled" ], "description": "`applied`: la comprobación tiene el nuevo estado. `pending_until_flow_finishes`: la anulación queda en espera y se aplica cuando la persona termina el flujo. `cancelled`: quedó en espera y nunca se aplicó (consulta `cancel_reason`).", "example": "applied" }, "forced": { "type": "boolean", "description": "`true` cuando la anulación se aplicó de inmediato mientras la persona seguía en el flujo.", "example": false }, "reason": { "type": "string", "nullable": true, "description": "El `comment` enviado con la solicitud, o `null`.", "example": "Document manually verified by compliance." }, "requested_by": { "type": "object", "nullable": true, "description": "Quién solicitó la anulación, o `null` cuando no se conoce.", "properties": { "email": { "type": "string", "format": "email", "nullable": true, "description": "Correo electrónico del usuario de la consola, o `null` para las claves de API y el sistema.", "example": "reviewer@example.com" }, "name": { "type": "string", "nullable": true, "description": "Nombre visible del solicitante, o `null`.", "example": "Alex Reviewer" }, "type": { "type": "string", "enum": [ "CONSOLE_USER", "API_KEY", "SYSTEM" ], "description": "Quién hizo la solicitud: un usuario de la consola, una clave de API o la propia Didit.", "example": "CONSOLE_USER" } } }, "requested_at": { "type": "string", "format": "date-time", "description": "Fecha y hora en que se solicitó la anulación.", "example": "2026-10-13T09:15:00Z" }, "applied_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo la comprobación adoptó el nuevo estado, o `null` mientras espera o una vez cancelada.", "example": "2026-10-13T09:15:00Z" }, "cancelled_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se canceló una anulación en espera, o `null`.", "example": null }, "cancel_reason": { "type": "string", "nullable": true, "enum": [ "cancelled_by_reviewer", "replaced", "check_changed", "session_closed", null ], "description": "Por qué nunca se aplicó una anulación en espera, o `null`. `cancelled_by_reviewer`: se canceló con el endpoint de cancelación. `replaced`: una anulación más reciente sobre la misma comprobación la reemplazó. `check_changed`: la persona volvió a hacer la comprobación antes de terminar el flujo. `session_closed`: la sesión salió del flujo antes de que la persona lo terminara (abandonada, expirada o decidida a mitad del flujo).", "example": null } } }, "SandboxSimulateRequest": { "type": "object", "description": "Fuerza el estado de una sesión de sandbox. Todos los campos son opcionales, pero se requiere al menos uno de `new_status`, `scenario` o `risk`.", "properties": { "new_status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Abandoned" ], "description": "El estado que se establecerá. Si lo omites, se usa por defecto el estado predeterminado del caso de riesgo (`risk`, o el primer riesgo que incluyan los valores mágicos del escenario) y, en su defecto, el estado predeterminado del escenario.", "example": "Declined" }, "comment": { "type": "string", "maxLength": 500, "description": "Nota añadida a la entrada de actividad que registra el cambio de estado.", "example": "Testing the decline path" }, "scenario": { "type": "string", "maxLength": 100, "description": "Un slug de escenario del catálogo (`GET /v1/sandbox/scenarios/`). Proporciona el estado predeterminado y, sin `risk`, la advertencia que llevan sus valores mágicos. Un slug desconocido devuelve `400`.", "example": "decline_aml_hit" }, "risk": { "type": "string", "maxLength": 128, "description": "Un caso de riesgo del catálogo. Su advertencia se añade a la sesión, con un tipo de registro que depende de `new_status`. Un valor desconocido devuelve `400`.", "example": "POSSIBLE_MATCH_FOUND" }, "node_id": { "type": "string", "maxLength": 128, "description": "Nodo del flujo al que está asociada la advertencia de riesgo. De forma predeterminada, es el nodo actual de la sesión.", "example": "feature_aml_1" }, "send_webhooks": { "type": "boolean", "default": true, "description": "`true` envía exactamente los webhooks que un cambio de estado real envía a los destinos de la aplicación de sandbox: `status.updated`, además de los eventos `user.status.updated` / `user.data.updated` (o `business.status.updated` / `business.data.updated`) que provoca el cambio, a los destinos suscritos a ellos. `false` cambia el estado sin registrar ni enviar ningún webhook: la recuperación de webhooks perdidos nunca reenvía esa decisión, la consola se sigue actualizando en tiempo real y el siguiente cambio de estado de la sesión envía webhooks como de costumbre.", "example": true } } }, "SandboxSimulateResponse": { "type": "object", "required": [ "session_id", "previous_status", "status", "scenario", "risk", "send_webhooks" ], "properties": { "session_id": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "previous_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "El estado de la sesión antes de la simulación.", "example": "In Progress" }, "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Abandoned" ], "description": "El estado que estableció la simulación.", "example": "Declined" }, "scenario": { "type": "string", "nullable": true, "description": "El slug del escenario que pasaste, o `null`.", "example": "decline_aml_hit" }, "risk": { "type": "string", "nullable": true, "description": "El caso de riesgo aplicado (`risk`, o el tomado del escenario), o `null` si no hay ninguno.", "example": "POSSIBLE_MATCH_FOUND" }, "send_webhooks": { "type": "boolean", "description": "El valor de `send_webhooks` que aplicó la simulación.", "example": false } } }, "CaseTeamSummary": { "type": "object", "nullable": true, "description": "El equipo de revisión responsable del caso, o null si ningún equipo es responsable. El enrutamiento lo establece cuando una regla de enrutamiento asigna el caso a uno de sus equipos. Cámbialo o bórralo con `PATCH .../cases/{case_uuid}/` (`team`).", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "CaseChecker": { "type": "object", "nullable": true, "description": "El miembro designado para aprobar o rechazar la resolución pendiente. Solo tiene valor mientras una resolución con principio de cuatro ojos espera a un verificador designado. Null cuando no hay nada pendiente, mientras la resolución pendiente espera en la cola de verificadores, y una vez que la resolución se aprueba, se rechaza o se devuelve para una nueva revisión porque las pruebas cambiaron.", "properties": { "member_uuid": { "type": "string", "format": "uuid", "description": "El uuid de usuario del miembro: el valor que pasas como `checker` cuando resuelves el caso." }, "name": { "type": "string", "nullable": true, "description": "El nombre completo del miembro, o null si no se conoce." }, "email": { "type": "string", "format": "email" } } }, "ServiceStatusFeed": { "type": "object", "description": "Estado público del servicio: el estado de cada servicio de Didit, el estado general y los incidentes en curso o resueltos en los últimos 7 días.", "required": [ "status", "updated_at", "services", "incidents" ], "properties": { "status": { "type": "string", "enum": [ "operational", "degraded", "down" ], "description": "El peor estado de cualquier servicio en este momento, determinado solo por las incidencias en curso.", "example": "degraded" }, "updated_at": { "type": "string", "format": "date-time", "description": "Cuándo generó Didit esta respuesta (ISO 8601, UTC). Las respuestas se almacenan en caché durante 30 segundos, por lo que puede tener hasta 30 segundos de antigüedad.", "example": "2026-10-13T09:41:07.512345Z" }, "services": { "type": "array", "description": "Una entrada por servicio; todos los servicios aparecen siempre.", "items": { "$ref": "#/components/schemas/ServiceStatusService" } }, "incidents": { "type": "array", "description": "Primero el `started_at` más reciente. Todos los incidentes en curso, más los incidentes resueltos en los últimos 7 días (como máximo 50 incidentes resueltos). Vacío cuando no ha ocurrido nada en ese periodo.", "items": { "$ref": "#/components/schemas/ServiceStatusIncident" } } } }, "ServiceStatusService": { "type": "object", "required": [ "key", "name", "status" ], "properties": { "key": { "type": "string", "enum": [ "service_id_verification", "service_liveness_face_match", "service_aml_screening", "service_kyb_registries", "service_database_validation", "service_phone_delivery", "service_email_delivery", "service_transaction_monitoring" ], "description": "Clave de servicio estable. Compara con este valor, nunca con el nombre visible. `service_id_verification`: Verificación de identidad, `service_liveness_face_match`: Prueba de vida y coincidencia facial, `service_aml_screening`: Análisis AML, `service_kyb_registries`: Registros KYB, `service_database_validation`: Validación de base de datos, `service_phone_delivery`: Entrega de la verificación de teléfono, `service_email_delivery`: Entrega de la verificación de correo electrónico, `service_transaction_monitoring`: Monitorización de transacciones.", "example": "service_database_validation" }, "name": { "type": "string", "description": "Nombre visible en inglés del servicio.", "example": "Database validation" }, "status": { "type": "string", "enum": [ "operational", "degraded", "down" ], "description": "`operational` cuando no hay ningún incidente en curso para el servicio; en caso contrario, el peor estado de sus incidentes en curso.", "example": "degraded" } } }, "ServiceStatusIncident": { "type": "object", "required": [ "id", "service", "service_name", "state", "status", "title", "body", "affected", "country_name", "started_at", "resolved_at", "duration_minutes" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "ID del incidente.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "service": { "type": "string", "enum": [ "service_id_verification", "service_liveness_face_match", "service_aml_screening", "service_kyb_registries", "service_database_validation", "service_phone_delivery", "service_email_delivery", "service_transaction_monitoring" ], "description": "Clave del servicio afectado (consulta `services[].key`).", "example": "service_database_validation" }, "service_name": { "type": "string", "description": "Nombre visible en inglés del servicio afectado.", "example": "Database validation" }, "state": { "type": "string", "enum": [ "degraded", "down" ], "description": "Cómo se ve afectado el servicio. Un incidente resuelto conserva el último estado que tuvo.", "example": "degraded" }, "status": { "type": "string", "enum": [ "ongoing", "resolved" ], "description": "`ongoing` hasta que el servicio se recupere; después, `resolved`.", "example": "ongoing" }, "title": { "type": "string", "description": "Titular en inglés. Para traducirlo, crea tu propio texto a partir de `service`, `state` y `country_name`.", "example": "Database validation is degraded in Brazil." }, "body": { "type": "string", "description": "Línea de detalle en inglés: desde cuándo las comprobaciones pueden ser lentas o fallar, o cuándo se recuperó el servicio.", "example": "Checks against Brazil (CPF) may be slow or fail since 08:55 UTC." }, "affected": { "type": "string", "description": "Países o registros afectados, por ejemplo `Brazil (CPF)`. Vacío cuando la incidencia no está vinculada a un país o registro.", "example": "Brazil (CPF)" }, "country_name": { "type": "string", "description": "País afectado, en inglés. Vacío cuando la incidencia no está vinculada a un país.", "example": "Brazil" }, "started_at": { "type": "string", "format": "date-time", "description": "Fecha y hora en que comenzó el incidente (ISO 8601, UTC).", "example": "2026-10-13T08:55:00Z" }, "resolved_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que se recuperó el servicio (ISO 8601, UTC). `null` mientras el incidente sigue en curso." }, "duration_minutes": { "type": "integer", "nullable": true, "description": "Minutos completos desde `started_at` hasta `resolved_at`. `null` mientras el incidente sigue en curso." } } }, "TravelRuleJoinInvitation": { "type": "object", "description": "Lo que muestra la página para unirse antes de que se escriba nada.", "properties": { "email": { "type": "string", "format": "email", "description": "La dirección a la que se envió la invitación." }, "vasp_name": { "type": "string" }, "source": { "type": "string", "description": "De dónde procede la invitación, por ejemplo `pickup`." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true }, "prefill": { "type": "object", "properties": { "vasp_id": { "type": "string", "format": "uuid", "nullable": true }, "legal_name": { "type": "string" }, "lei": { "type": "string" }, "jurisdiction": { "type": "string" }, "domains": { "type": "array", "items": { "type": "string" } } } } } }, "TravelRuleJoinRegisterRequest": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "type": "string", "format": "email", "maxLength": 254, "description": "Debe ser la dirección a la que se envió la invitación." }, "password": { "type": "string", "minLength": 8, "maxLength": 128 } } }, "TravelRuleJoinVerifyRequest": { "type": "object", "required": [ "email", "code" ], "properties": { "email": { "type": "string", "format": "email", "maxLength": 254 }, "code": { "type": "string", "minLength": 6, "maxLength": 6, "description": "El código de 6 caracteres enviado por correo electrónico tras el registro." } } }, "TravelRuleJoinCredentials": { "type": "object", "description": "La nueva organización gratuita y las credenciales con las que su aplicación llama a la API.", "properties": { "organization": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } } }, "application": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } } }, "client_id": { "type": "string" }, "api_key": { "type": "string", "description": "Envíala como encabezado `x-api-key` en los endpoints del espacio de trabajo." } } }, "TravelRuleWorkspaceClaimRequest": { "type": "object", "required": [ "vasp_id" ], "properties": { "vasp_id": { "type": "string", "format": "uuid", "description": "La entrada del directorio que corresponde a este espacio de trabajo. Obtén los ids de `GET /v3/travel-rule/vasps/`." } } }, "TravelRuleWorkspaceDomainConfirmRequest": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "minLength": 6, "maxLength": 6 } } }, "TravelRuleWorkspaceBillingRequest": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true, "description": "Solo se acepta `true`: la facturación saliente no se puede volver a desactivar a través de la API." } } }, "TravelRuleWorkspaceDomainCodeResponse": { "type": "object", "properties": { "domain": { "type": "string" }, "status": { "type": "string", "enum": [ "unverified", "code_sent", "verified" ] }, "txt": { "$ref": "#/components/schemas/TravelRuleWorkspaceTxtRecord" } } }, "TravelRuleWorkspaceTxtRecord": { "type": "object", "description": "El registro TXT que debes publicar para la prueba de DNS. Vacío hasta que se inicia una prueba.", "properties": { "host": { "type": "string", "example": "didit-tr-verify.example.com" }, "value": { "type": "string" } } }, "TravelRuleWorkspace": { "type": "object", "description": "El espacio de trabajo gratuito de Travel Rule de una aplicación que se unió de forma gratuita.", "properties": { "joined_free": { "type": "boolean" }, "work_email": { "type": "string", "format": "email" }, "joined_at": { "type": "string", "format": "date-time", "nullable": true }, "claim": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "unclaimed", "pending_review", "claimed", "rejected" ] }, "proved_by_domain": { "type": "boolean" }, "claimed_at": { "type": "string", "format": "date-time", "nullable": true }, "reviewed_at": { "type": "string", "format": "date-time", "nullable": true }, "review_note": { "type": "string" }, "vasp_id": { "type": "string", "format": "uuid", "nullable": true }, "vasp_name": { "type": "string" } } }, "prefill": { "type": "object", "description": "Valores del perfil tomados de la entrada del directorio: `vasp_id`, `legal_name`, `lei`, `jurisdiction`, `compliance_email`, `domains`. No se escribe nada hasta que se realiza la reclamación." }, "domain": { "type": "object", "properties": { "domain": { "type": "string" }, "status": { "type": "string", "enum": [ "unverified", "code_sent", "verified" ] }, "verified_at": { "type": "string", "format": "date-time", "nullable": true }, "txt": { "$ref": "#/components/schemas/TravelRuleWorkspaceTxtRecord" } } }, "billing_enabled": { "type": "boolean", "description": "Recibir datos de la Travel Rule es gratis. El envío solo se factura después de activar la facturación." }, "billing_enabled_at": { "type": "string", "format": "date-time", "nullable": true }, "didit_network": { "type": "object", "description": "Indica si la red de Didit incluye este VASP y, si no lo incluye, cada condición que aún no cumple." }, "settings": { "$ref": "#/components/schemas/TravelRuleSettingsDetail" } } }, "InvestigatorDecision": { "type": "object", "description": "Cómo salió el elemento de la cola de Investigator. `decided_by`, `original_outcome` y `overrides` los devuelven los endpoints de aceptación y anulación y el informe; el bloque `investigator` de la decisión de una sesión incluye los demás campos.", "properties": { "outcome": { "type": "string", "enum": [ "accepted", "edited", "overridden", "decided_elsewhere", "automated" ], "description": "`accepted` o `edited` adoptaron la recomendación (`edited` con una narrativa reescrita), `overridden` adoptó otra acción, `decided_elsewhere` es una decisión tomada fuera del Investigator mientras el informe estaba abierto y `automated` es una decisión que el Investigator tomó por su cuenta." }, "action": { "type": "string", "enum": [ "approve", "decline", "escalate", "request" ] }, "actor_email": { "type": "string", "nullable": true }, "actor_name": { "type": "string", "nullable": true }, "override_category": { "type": "string", "enum": [ "missing_context", "needs_information", "policy_differs", "evidence_misread", "other", "" ], "nullable": true }, "override_reason": { "type": "string", "nullable": true }, "final_status": { "type": "string", "description": "El estado del elemento después de la decisión." }, "agreed": { "type": "boolean", "description": "Si la decisión coincidió con la recomendación.", "nullable": true }, "decided_at": { "type": "string", "format": "date-time" }, "billed": { "type": "boolean", "description": "Se cobró la revisión." }, "decided_by": { "type": "string", "enum": [ "investigator", "member" ] }, "original_outcome": { "type": "object", "description": "La decisión que tomó el Investigator por su cuenta, sin cambios por anulaciones posteriores. Null para una decisión que tomó el equipo.", "properties": { "action": { "type": "string" }, "final_status": { "type": "string" }, "decided_at": { "type": "string", "format": "date-time" } }, "nullable": true }, "overrides": { "type": "array", "description": "Todas las anulaciones de decisiones que el Investigator tomó por su cuenta, de la más antigua a la más reciente.", "items": { "type": "object", "properties": { "action": { "type": "string" }, "actor_email": { "type": "string", "nullable": true }, "actor_name": { "type": "string", "nullable": true }, "override_category": { "type": "string" }, "override_reason": { "type": "string" }, "previous_status": { "type": "string" }, "final_status": { "type": "string" }, "agreed": { "type": "boolean", "nullable": true }, "overridden_at": { "type": "string", "format": "date-time" } } } } } }, "InvestigatorBlock": { "type": "object", "nullable": true, "description": "La revisión más reciente del elemento en Investigator, o null si nunca tuvo una. La incluyen la decisión de sesión V3 y la decisión de sesión de empresa (y, por tanto, los webhooks `status.updated`).", "properties": { "run_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "running", "completed", "failed" ] }, "stage": { "type": "string", "enum": [ "shadow", "live" ] }, "queue": { "type": "string", "enum": [ "kyc", "kyb", "aml", "transactions", "cases" ] }, "is_open": { "type": "boolean" }, "recommendation": { "type": "string", "enum": [ "approve", "decline", "escalate", "request" ], "nullable": true }, "recommendation_detail": { "type": "string", "nullable": true }, "confidence": { "type": "string", "enum": [ "high", "moderate", "low" ], "nullable": true }, "summary": { "type": "string", "nullable": true }, "ready_to_accept": { "type": "boolean" }, "prepared_at": { "type": "string", "format": "date-time", "nullable": true }, "automated": { "type": "boolean", "description": "El Investigator decidió por sí solo, aunque la decisión se anulara después." }, "decided_by": { "type": "string", "enum": [ "investigator", "member" ], "nullable": true }, "decision": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/InvestigatorDecision" } ], "type": "object" } } }, "InvestigatorQueueRow": { "type": "object", "properties": { "run_id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "session", "business_session", "transaction", "case" ] }, "queue": { "type": "string", "enum": [ "kyc", "kyb", "aml", "transactions", "cases" ] }, "stage": { "type": "string", "enum": [ "shadow", "live" ] }, "subject": { "type": "object", "description": "El elemento en revisión: `id`, `number`, `status`, `name` y, según el tipo, `country`, `workflow`, `vendor_data`, `txn_id`, `amount`, `currency`, `direction`, `title` o `priority`.", "additionalProperties": true }, "recommendation": { "type": "string", "enum": [ "approve", "decline", "escalate", "request" ] }, "recommendation_detail": { "type": "string" }, "confidence": { "type": "string", "enum": [ "high", "moderate", "low" ] }, "summary": { "type": "string" }, "sources_count": { "type": "integer" }, "ready_to_accept": { "type": "boolean" }, "guardrails": { "description": "Las salvaguardas bloqueadas que retienen este elemento, si las hay." }, "waiting_since": { "type": "string", "format": "date-time", "nullable": true }, "due_at": { "type": "string", "format": "date-time", "nullable": true }, "prepared_at": { "type": "string", "format": "date-time", "nullable": true } } }, "InvestigatorRunDetail": { "allOf": [ { "$ref": "#/components/schemas/InvestigatorQueueRow" }, { "type": "object", "properties": { "status": { "type": "string" }, "is_open": { "type": "boolean" }, "lookups": { "type": "integer", "description": "Cuántas secciones y registros vinculados leyó." }, "duration_ms": { "type": "integer", "nullable": true }, "agent_version": { "type": "string" }, "prepared_before_opened": { "type": "boolean", "nullable": true }, "report": { "type": "object", "additionalProperties": true, "description": "El informe: razonamiento, puntos de evidencia con su veredicto (`ok`, `risk`, `look`, `explained`, `context`) y fuentes citadas, veredictos de las coincidencias del análisis (`same`, `not_same`, `unclear`) y siguientes pasos sugeridos." }, "trail": { "description": "Qué revisé: el resumen, las secciones y los registros que leyó, en orden." }, "decision": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/InvestigatorDecision" } ], "type": "object" }, "autonomy": { "type": "object", "additionalProperties": true, "description": "Qué concluyó la autonomía sobre el informe (`result`, `reason`, `tier`, `policy_version`, `rule`, `agreement`, `decisions`, `threshold`, `at`). Es null cuando la cola no está automatizada.", "nullable": true } } } ] }, "InvestigatorAcceptRequest": { "type": "object", "properties": { "narrative": { "type": "string", "maxLength": 4000, "description": "Una narrativa reescrita. Enviarla registra la decisión como editada y aceptada." }, "send_email": { "type": "boolean", "default": false, "description": "Envía a la persona un correo electrónico sobre la decisión." }, "email_address": { "type": "string", "format": "email", "description": "Obligatorio cuando `send_email` es true." }, "email_language": { "type": "string", "default": "en", "maxLength": 16 } } }, "InvestigatorOverrideRequest": { "type": "object", "required": [ "action", "category", "reason" ], "properties": { "action": { "type": "string", "enum": [ "approve", "decline", "escalate", "request" ] }, "category": { "type": "string", "enum": [ "missing_context", "needs_information", "policy_differs", "evidence_misread", "other" ] }, "reason": { "type": "string", "minLength": 10, "maxLength": 500 }, "send_email": { "type": "boolean", "default": false, "description": "Envía a la persona un correo electrónico sobre la decisión." }, "email_address": { "type": "string", "format": "email", "description": "Obligatorio cuando `send_email` es true." }, "email_language": { "type": "string", "default": "en", "maxLength": 16 } } }, "InvestigatorBatchAcceptRequest": { "type": "object", "required": [ "run_ids" ], "properties": { "run_ids": { "type": "array", "minItems": 1, "maxItems": 50, "items": { "type": "string", "format": "uuid" } } } }, "InvestigatorBatchAcceptResponse": { "type": "object", "properties": { "accepted": { "type": "integer" }, "skipped": { "type": "integer" }, "results": { "type": "array", "items": { "type": "object", "properties": { "run_id": { "type": "string", "format": "uuid" }, "result": { "type": "string", "enum": [ "accepted", "skipped" ] }, "reason": { "type": "string", "enum": [ "not_found", "forbidden", "already_decided", "not_ready", "guardrail", "invalid" ] }, "detail": {}, "action": { "type": "string" }, "final_status": { "type": "string" } } } } } }, "InvestigatorSettings": { "type": "object", "properties": { "stage": { "type": "string", "enum": [ "none", "shadow", "live" ] }, "stage_changed_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "stage_changed_by": { "type": "string", "readOnly": true }, "monthly_spend_limit": { "type": "string", "format": "decimal", "description": "Límite mensual en tu moneda de facturación, de 0.01 a 1,000,000. Con null se desactiva.", "nullable": true }, "spend_limit": { "type": "object", "readOnly": true, "properties": { "enabled": { "type": "boolean" }, "limit": { "type": "string", "format": "decimal", "nullable": true }, "spent": { "type": "string", "format": "decimal" }, "reviews": { "type": "integer" }, "reserved": { "type": "string", "format": "decimal", "description": "El precio de cada informe abierto en producción, retenido porque aceptarlo genera el cargo." }, "currency": { "type": "string" }, "paused": { "type": "boolean", "description": "En el límite: no se inicia ninguna nueva revisión." } } } } }, "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." } } }, "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" } } } }, "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`)." } } }, "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." } } }, "WalletAddressImportRow": { "type": "object", "description": "Una wallet para importar: por su `address`, su `address_hash` o ambos. También se aceptan las formas camelCase de estos campos, así como `walletAddress`, `walletAddressHash`, `destinationTag` y `externalUserId`.", "properties": { "address": { "type": "string", "maxLength": 128, "description": "La dirección de la wallet. Alias: `walletAddress`." }, "address_hash": { "type": "string", "description": "SHA-256 de la dirección en minúsculas, como 64 caracteres hexadecimales o 44 caracteres base64. Envíalo solo para registrar una wallet sin revelar su dirección; si se envía junto con `address`, debe ser el hash de esa dirección. Alias: `walletAddressHash`." }, "chain": { "type": "string", "maxLength": 32 }, "memo": { "type": "string", "maxLength": 256, "description": "La etiqueta de destino o 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: indicar uno en ellas produce un `400`." }, "holder_name": { "type": "string", "maxLength": 255 }, "holder_vendor_data": { "type": "string", "maxLength": 255, "description": "Tu identificador interno del titular. Alias: `externalUserId`." }, "entity_type": { "type": "string", "enum": [ "individual", "company" ], "default": "individual" }, "label": { "type": "string", "maxLength": 255 }, "owner_type": { "type": "string", "enum": [ "customer", "internal", "vasp" ], "default": "customer" }, "travel_address": { "type": "string", "maxLength": 512 }, "self_declared": { "type": "boolean", "default": false, "description": "Crea la entrada ya verificada mediante una autodeclaración, cuando tu configuración lo permita." } } }, "WalletAddressImportReport": { "type": "object", "description": "Qué ocurrió con cada fila de una importación, en el orden en que se enviaron.", "properties": { "total": { "type": "integer" }, "created": { "type": "integer" }, "existing": { "type": "integer" }, "duplicate": { "type": "integer" }, "failed": { "type": "integer" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "row": { "type": "integer", "description": "El número de la fila, empezando por 1." }, "status": { "type": "string", "enum": [ "created", "existing", "duplicate", "failed" ], "description": "`created`: se añadió al libro. `existing`: la wallet ya está en el libro y no se modificó. `duplicate`: repite una fila anterior de esta importación. `failed`: consulta `errors`." }, "entry_id": { "type": "string", "format": "uuid", "nullable": true, "description": "La entrada de la libreta de direcciones que la fila creó o encontró." }, "errors": { "type": "object", "description": "Errores de campo de una fila `failed`; vacío en caso contrario." }, "duplicate_of_row": { "type": "integer", "nullable": true, "description": "En una fila `duplicate`, la fila que repite." } } } } } }, "TravelRuleCounterpartyContact": { "type": "object", "description": "Una dirección de cumplimiento a la que escribe el canal EMAIL para una entrada del directorio.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "counterparty": { "type": "string", "format": "uuid", "description": "El `id` de la entrada del directorio, tal como lo muestra GET /v3/travel-rule/vasps/." }, "counterparty_name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string", "description": "Etiqueta opcional, por ejemplo el nombre del equipo." }, "source": { "type": "string", "enum": [ "staff", "application", "learned" ], "description": "staff: seleccionada por Didit. learned: una dirección en uno de los dominios propios del VASP que respondió a una solicitud mediante su enlace de respuesta. application: añadida por tu aplicación." }, "scope": { "type": "string", "enum": [ "platform", "application" ], "description": "platform: seleccionado por Didit o aprendido de una respuesta verificada, se usa para todos los clientes de Didit y es de solo lectura para ti. application: privado de tu aplicación." }, "created_by": { "type": "string", "description": "Vacío para los contactos de la plataforma y para los contactos que añadió una clave de API." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo respondió esta dirección por última vez a una solicitud mediante su enlace de respuesta." }, "is_invalid": { "type": "boolean", "description": "true una vez que la dirección rebotó o registró una queja; el canal EMAIL la omite." }, "invalid_reason": { "type": "string", "enum": [ "", "hard_bounce", "soft_bounce", "spam_complaint", "suppressed" ] }, "invalid_detail": { "type": "string", "description": "El motivo del servidor de correo receptor, cuando indicó uno." }, "invalid_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" } } }, "TravelRuleCounterpartyContactCreate": { "type": "object", "required": [ "counterparty", "email" ], "properties": { "counterparty": { "type": "string", "format": "uuid", "description": "El `id` de la entrada del directorio." }, "email": { "type": "string", "format": "email", "maxLength": 254 }, "name": { "type": "string", "description": "Etiqueta opcional.", "maxLength": 255 } } }, "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`." } } }, "TravelRuleTransferRow": { "type": "object", "description": "Una transferencia de Travel Rule tal como la muestra la lista de transferencias: solo nombres de VASP, wallets y memos, nunca los datos personales del ordenante ni del beneficiario.", "properties": { "id": { "type": "string", "format": "uuid", "description": "El id de la transferencia." }, "transaction_id": { "type": "string", "format": "uuid", "description": "La transacción de Didit a la que pertenece la transferencia." }, "txn_id": { "type": "string", "nullable": true, "description": "Tu propio id para la transacción. Las transferencias que Didit registra por ti, como una transferencia entrante de Didit Test VASP, llevan uno generado." }, "txn_date": { "type": "string", "format": "date-time" }, "kind": { "type": "string", "enum": [ "withdrawal", "deposit", "message" ], "description": "withdrawal: saliente. message: una transferencia entrante que un canal creó a partir del mensaje de una contraparte (una consulta TRP, el tramo entrante INTERNAL, o un mensaje de GTR, VerifyVASP o Sygna Bridge). deposit: cualquier otra transferencia entrante." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "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" ] }, "reason": { "type": "string", "description": "Por qué está bloqueada una transferencia `COUNTERPARTY_VASP_NOT_FOUND` o `COUNTERPARTY_VASP_NOT_REACHABLE`; es el mismo valor que el `reason` de la propia transferencia, de modo que la lista distingue un correo de cumplimiento rebotado de una contraparte sin ruta sin abrir cada transferencia. `\"\"` para cualquier otro estado. Consulta [Por qué está bloqueada una transferencia](/es/transaction-monitoring/travel-rule#por-qué-una-transferencia-está-bloqueada)." }, "rail": { "type": "string", "nullable": true, "enum": [ "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL", "TEST_VASP", null ] }, "asset": { "type": "string", "description": "La moneda de la transacción." }, "amount": { "type": "string", "description": "El importe como decimal simple, por ejemplo \"1.25\"." }, "originator_vasp": { "type": "string", "description": "Saliente: el nombre legal de tu VASP. Entrante: el nombre de la contraparte, tomado de su entrada en el directorio, del miembro de la red de Didit, del remitente TRP, del Didit Test VASP o del nombre declarado en la transferencia. Vacío cuando no se conoce ninguno." }, "beneficiary_vasp": { "type": "string", "description": "Saliente: el nombre de la contraparte, determinado de la misma forma. Entrante: el nombre legal de tu VASP." }, "originator_wallet": { "type": "string" }, "beneficiary_wallet": { "type": "string" }, "originator_memo": { "type": "string", "description": "Memo o etiqueta de destino; vacío en las cadenas que no lo usan." }, "beneficiary_memo": { "type": "string" }, "originator_wallet_type": { "type": "string", "enum": [ "vasp", "self_hosted", "own" ], "description": "vasp, self_hosted (declarada sin custodia) u own (una wallet que tu libreta de direcciones registra como tuya). Tu propio lado es siempre vasp." }, "beneficiary_wallet_type": { "type": "string", "enum": [ "vasp", "self_hosted", "own" ] }, "matched_transaction_id": { "type": "string", "format": "uuid", "nullable": true, "description": "La otra parte de un depósito que asociaste manualmente a una transferencia anunciada." }, "deadline_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo expira la transferencia si sigue esperando a su contraparte. Se establece en cada transferencia que creas con `POST /v3/transactions/` que requiere un intercambio, saliente o entrante. Es null por debajo del umbral, en un pago Lightning al que no se aplica la Travel Rule y en las transferencias entrantes que Didit crea cuando una contraparte se pone en contacto contigo (una consulta TRP entrante, un mensaje de red o el tramo entrante INTERNAL)." }, "created_at": { "type": "string", "format": "date-time" } } }, "BankAccountCheckHolder": { "description": "El nombre con el que se verifica la cuenta. Envía exactamente uno de `full_name` y `business_name`.", "oneOf": [ { "$ref": "#/components/schemas/BankAccountCheckPersonHolder" }, { "$ref": "#/components/schemas/BankAccountCheckBusinessHolder" } ] }, "BankAccountCheckRequest": { "type": "object", "required": [ "country", "account", "holder" ], "properties": { "country": { "type": "string", "minLength": 3, "maxLength": 3, "description": "El país de la cuenta, como código ISO 3166-1 alfa-3, por ejemplo `GBR`. Se aceptan minúsculas.", "example": "GBR" }, "account": { "type": "object", "description": "La cuenta tal como la escribe su país: un `iban`, o un `account_number` con el código de banco o de sucursal que necesita el país (`sort_code`, `routing_number`, `transit_institution`, `bsb`, `ifsc`, `bank_code` o `bic`). México admite una `clabe` y Argentina un `cbu_cvu`, que ya identifican el banco. Una cuenta de empresa añade un `registration_id` cuando el país lo exige. Se ignoran los espacios, guiones y puntos. Se ignoran las claves que la comprobación del país no utiliza; si falta una clave que necesita, se devuelve un `400` que la indica.", "properties": { "iban": { "type": "string", "maxLength": 64, "description": "El IBAN, en un país que usa IBAN. Debe pertenecer a `country`." }, "account_number": { "type": "string", "maxLength": 64, "description": "El número de cuenta, en un país que escribe la cuenta con un código de banco o de sucursal aparte." }, "sort_code": { "type": "string", "maxLength": 64, "description": "Reino Unido: el sort code de 6 dígitos." }, "routing_number": { "type": "string", "maxLength": 64, "description": "Estados Unidos: el número de ruta ABA de 9 dígitos." }, "transit_institution": { "type": "string", "maxLength": 64, "description": "Canadá: el número de tránsito e institución de 8 dígitos." }, "bsb": { "type": "string", "maxLength": 64, "description": "Australia: el BSB de 6 dígitos." }, "ifsc": { "type": "string", "maxLength": 64, "description": "India: el IFSC de 11 caracteres." }, "bank_code": { "type": "string", "maxLength": 64, "description": "El código del banco, cuando el país lo requiere, por ejemplo en Nigeria." }, "bic": { "type": "string", "maxLength": 64, "description": "El BIC del banco, cuando la comprobación del país lo requiere." }, "clabe": { "type": "string", "maxLength": 64, "description": "México: la CLABE de 18 dígitos. Ya identifica al banco." }, "cbu_cvu": { "type": "string", "maxLength": 64, "description": "Argentina: el CBU o CVU de 22 dígitos. Ya identifica el banco." }, "registration_id": { "type": "string", "maxLength": 64, "description": "El número de registro de una cuenta de empresa, cuando el país lo exige." } }, "additionalProperties": { "type": "string", "maxLength": 64 }, "example": { "sort_code": "20-45-67", "account_number": "31926819" } }, "holder": { "$ref": "#/components/schemas/BankAccountCheckHolder" }, "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta comprobación, devuelta sin cambios.", "example": "payout_20481" } } }, "BankAccountCheckResponse": { "type": "object", "required": [ "request_id", "result", "holder_name", "account", "vendor_data", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "El ID de esta comprobación." }, "result": { "type": "string", "enum": [ "match", "close_match", "no_match", "cannot_verify" ], "description": "`match`: el banco tiene la cuenta registrada con el nombre que enviaste. `close_match`: con un nombre parecido, por ejemplo, sin el segundo nombre o con una errata. `no_match`: con otro nombre, o no existe esa cuenta. `cannot_verify`: el banco respondió sin comparar el nombre, por ejemplo, en una cuenta bloqueada o cerrada." }, "holder_name": { "type": "string", "nullable": true, "description": "Solo en un `close_match`, y solo cuando el banco lo devolvió: el nombre de la cuenta tal como lo tiene registrado el banco. `null` en caso contrario." }, "account": { "type": "string", "description": "La cuenta, enmascarada salvo sus últimos 4 caracteres." }, "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia, tal como la enviaste." }, "created_at": { "type": "string", "format": "date-time", "description": "Cuándo se ejecutó la comprobación, en UTC." } } }, "BankAccountCheckError": { "type": "object", "required": [ "detail" ], "properties": { "detail": { "type": "string", "description": "Qué falló, en inglés." }, "code": { "type": "string", "description": "Un código estable sobre el que ramificar la lógica. No está presente en `401` ni en `403`." }, "field": { "type": "string", "description": "Solo con `400`: el campo del cuerpo que hay que corregir, como ruta con puntos, por ejemplo `account.sort_code`." }, "reason": { "type": "string", "enum": [ "required", "length", "format", "checksum", "country_mismatch", "rejected" ], "description": "Solo con `400`: el motivo por el que se rechazó el campo. `required`, `length`, `format`, `checksum` y `country_mismatch` (un IBAN de otro país) son comprobaciones propias de Didit; `rejected` significa que el banco rechazó la cuenta tal como se envió." } } }, "BankVerificationResult": { "type": "object", "description": "El resultado de un paso de Verificación bancaria, para Verificación de usuarios y Verificación de empresas. `method` indica cómo se verificó la cuenta, y `none`, que la persona continuó sin banco antes de que se evaluara ningún intento. `continued_without_bank` indica que la persona continuó sin banco, también después de un intento evaluado. Consulta [Métodos de verificación bancaria](/es/core-technology/bank-verification/verification-methods) y [Cuando la persona no puede verificar su banco](/es/core-technology/bank-verification/fallbacks).", "properties": { "schema_version": { "type": "integer", "description": "Versión de la estructura de este resultado. Actualmente, `1`." }, "bank_verification_id": { "type": "string", "format": "uuid", "description": "El ID de este resultado." }, "node_id": { "type": "string", "description": "El nodo del flujo al que pertenece este resultado." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Expired" ], "description": "El veredicto del paso, después de sus acciones y reglas de estado." }, "original_status": { "type": "string", "nullable": true, "description": "El primer veredicto al que llegó el paso, antes de cualquier cambio posterior, como una revisión manual." }, "method": { "type": "string", "nullable": true, "enum": [ "open_banking", "account_lookup", "microdeposits", "statement", "none" ], "description": "Cómo se verificó la cuenta: `open_banking` (inicio de sesión bancario: la persona inició sesión en su banco), `account_lookup` (comprobación de cuenta: la persona escribió los datos de la cuenta y el banco confirmó el nombre), `microdeposits` o `statement` (subida de un extracto). `none` cuando la persona continuó sin banco antes de que se evaluara ningún intento, por lo que no se verificó ninguna cuenta. Tras un intento evaluado, se mantiene el método de ese intento. `null` hasta que se evalúa una cuenta, y cuando el flujo limita los datos que devuelve. Las reglas del flujo leen el mismo valor como `bank.method`." }, "provider": { "type": "string", "nullable": true, "description": "La clave de la ruta que ejecutó la conexión. Para saber cómo se verificó la cuenta, consulta `method`, no esta clave." }, "credential_source": { "type": "string", "nullable": true, "enum": [ "native", "byok" ], "description": "`native`: la ruta propia de Didit, facturada a tu saldo de Didit. `byok`: un proveedor del marketplace que conectaste con tus propias credenciales." }, "route": { "type": "object", "nullable": true, "description": "La ruta elegida antes del consentimiento. Nunca cambia después.", "properties": { "provider_key": { "type": "string", "nullable": true, "description": "La clave de la ruta." }, "credential_source": { "type": "string", "enum": [ "native", "byok" ] }, "is_fallback": { "type": "boolean", "description": "Indica si la ruta propia de Didit sustituyó a un proveedor del marketplace que no pudo conectarse." }, "provider_connection_id": { "type": "string", "nullable": true, "description": "La conexión del marketplace utilizada, para `byok`." }, "requested_scopes": { "type": "array", "items": { "type": "string" }, "description": "Los datos que solicitó la conexión, por ejemplo `ownership` o `balances`." } } }, "connection": { "type": "object", "nullable": true, "description": "La conexión del último intento. `null` antes del primer intento.", "properties": { "status": { "type": "string", "enum": [ "pending", "connected", "cancelled", "timeout", "failed", "unsupported", "revoked", "expired" ] }, "institution_id": { "type": "string", "nullable": true, "description": "El ID del banco. `null` para una comprobación de cuenta, en la que no se elige ningún banco." }, "institution_name": { "type": "string", "nullable": true, "description": "El nombre del banco. `null` para una comprobación de cuenta." }, "institution_country": { "type": "string", "nullable": true, "description": "El país de la cuenta, en ISO 3166-1 alfa-3." }, "oauth": { "type": "boolean", "nullable": true, "description": "Si el inicio de sesión en el banco se realizó mediante OAuth o de aplicación a aplicación. `null` para una comprobación de cuenta." }, "connected_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se estableció correctamente la conexión." }, "consent_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo finaliza el consentimiento bancario, para el inicio de sesión bancario." }, "last_refreshed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se volvieron a leer por última vez los datos financieros." }, "attempts": { "type": "integer", "description": "Los intentos que la persona empleó en este paso, sumando todos los métodos." }, "reason_code": { "type": "string", "nullable": true, "description": "Por qué la conexión no es simplemente `connected`, por ejemplo `USER_CANCELLED`, `INSTITUTION_DOWN`, `ACCOUNT_NOT_FOUND`, `REFERENCE_IDENTITY_MISSING` o `VERIFICATION_COMPLETED`." } } }, "account": { "type": "object", "nullable": true, "description": "La cuenta evaluada. `null` hasta que se evalúa una cuenta.", "properties": { "account_id_masked": { "type": "string", "nullable": true, "description": "El número de cuenta, enmascarado." }, "iban_masked": { "type": "string", "nullable": true, "description": "El IBAN, enmascarado." }, "sort_code": { "type": "string", "nullable": true, "description": "El código de clasificación bancaria (sort code), en el Reino Unido." }, "routing_number_masked": { "type": "string", "nullable": true, "description": "El número de ruta bancaria, enmascarado." }, "type": { "type": "string", "nullable": true, "enum": [ "checking", "current", "savings", "business", "other" ] }, "subtype": { "type": "string", "nullable": true, "description": "El subtipo de cuenta propio del banco." }, "currency": { "type": "string", "nullable": true, "description": "Moneda ISO 4217 de la cuenta." }, "holder_type": { "type": "string", "nullable": true, "enum": [ "person", "business", "unknown" ] }, "holders_count": { "type": "integer", "nullable": true }, "is_joint": { "type": "boolean", "nullable": true }, "is_business": { "type": "boolean", "nullable": true } } }, "ownership": { "type": "object", "nullable": true, "description": "Cómo se comparó el titular de la cuenta con la identidad verificada. `null` hasta que se evalúa una cuenta.", "properties": { "result": { "type": "string", "enum": [ "match", "partial_match", "no_match", "unknown", "not_verifiable" ], "description": "`partial_match` es una coincidencia cercana. `not_verifiable`: el banco respondió sin un titular con el que comparar. `unknown`: no se pudo leer la evidencia o no había ninguna identidad con la que comparar." }, "reference_identity_source": { "type": "string", "nullable": true, "description": "El paso con cuya identidad se comparó al titular: `kyc`, `database_validation`, `expected_details`, `questionnaire`, `document_ai` o `kyb`." }, "name_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "Puntuación de Didit del nombre del titular." }, "provider_name_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "La puntuación propia del banco para el nombre del titular, cuando devolvió una." }, "address_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "La puntuación de la dirección del titular, cuando se ejecutó la comparación de direcciones." }, "email_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "La puntuación del correo electrónico del titular, cuando se ejecutó la comparación de correos electrónicos." }, "phone_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "La puntuación del teléfono del titular, cuando se ejecutó la comparación de teléfonos." }, "dob_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "La puntuación de la fecha de nacimiento del titular, cuando el banco compartió una." }, "close_match": { "type": "boolean", "nullable": true, "description": "Si el nombre quedó en la franja de coincidencia cercana." }, "holder_confirmation": { "type": "string", "nullable": true, "enum": [ "pending", "confirmed", "rejected" ], "description": "La respuesta de la persona cuando se le pidió confirmar un nombre con coincidencia cercana. `null` si nunca se le preguntó." }, "method": { "type": "string", "nullable": true, "enum": [ "exact", "token_set", "nickname", "transliteration", "fuzzy", "provider_only", "microdeposits" ], "description": "Qué comparación de nombres produjo la puntuación. No es el método de verificación: para eso, consulta el `method` de nivel superior." }, "matched_holder_index": { "type": "integer", "nullable": true }, "holders": { "type": "array", "items": { "type": "object" }, "description": "Cada titular que indicó el banco, con sus puntuaciones." }, "owner_identity_available": { "type": "boolean", "nullable": true }, "evidence_freshness": { "type": "string", "nullable": true, "enum": [ "live", "cached", "refreshed" ] }, "evaluated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se calculó el veredicto." } } }, "financial_data": { "type": "object", "description": "Los datos financieros que leyó el paso. Solo el inicio de sesión bancario los lee.", "properties": { "balances": { "type": "object", "nullable": true, "description": "Con el ámbito `balances`." }, "transactions": { "type": "object", "nullable": true, "description": "Con el ámbito `transactions`." }, "income": { "type": "object", "nullable": true, "description": "Con el ámbito `income`." }, "categorization": { "type": "object", "nullable": true, "description": "Categorización de Didit de las transacciones leídas. `null` si no las hay." }, "not_collected": { "type": "array", "items": { "type": "string", "enum": [ "balances", "income", "transactions" ] }, "description": "Los datos que solicitó el paso y que no recopila el método con el que se verificó la cuenta. Los saldos, las transacciones y los ingresos solo provienen del inicio de sesión bancario, por lo que una cuenta verificada mediante comprobación de cuenta los incluye aquí. Nunca es un fallo. Vacío en caso contrario." } } }, "billing": { "type": "object", "nullable": true, "properties": { "route": { "type": "string", "enum": [ "native", "byok" ] }, "billed": { "type": "boolean" }, "marketplace_fee": { "type": "string", "nullable": true, "description": "La comisión de plataforma del marketplace cobrada, para `byok`." }, "usage_type": { "type": "string", "nullable": true, "description": "La línea de uso en la que se registró el cargo: `bank_verification` para un inicio de sesión bancario o una comprobación de cuenta, `bank_statement_upload` para la subida de un extracto sin un intento bancario cobrado antes, y `bank_byok_fee` para la comisión del marketplace por usar tu propio proveedor. `null` cuando no se facturó nada." } } }, "reference_identity": { "type": "object", "nullable": true, "description": "La identidad con la que se comparó al titular, junto con su fuente." }, "signals": { "type": "object", "nullable": true, "description": "Señales de la cuenta obtenidas del historial de transacciones, cuando el paso las ha leído." }, "connection_abandoned": { "type": "boolean", "nullable": true, "description": "Si el paso terminó sin coincidencia después de que la persona abandonara en su banco." }, "not_covered": { "type": "boolean", "nullable": true, "description": "Si no se pudo acceder al banco o al país de la persona en este paso. También es `true` cuando la persona continuó sin banco porque ningún método podía verificar su país o su banco." }, "continued_without_bank": { "type": "boolean", "description": "Si la persona salió del paso con **Continue without your bank**. En ese caso, `continuation` indica el motivo. `method` es `none` cuando no se evaluó ningún intento antes de que continuara. Tras un intento evaluado, como un titular que no coincide, `method` sigue siendo el método de ese intento, y su veredicto y sus códigos de motivo se mantienen. Se devuelve incluso cuando el flujo limita los datos que devuelve." }, "continuation": { "type": "object", "nullable": true, "description": "Cómo continuó la persona sin banco. `null` cuando no lo hizo. Cuando el flujo limita los datos que devuelve, `reason` se sigue devolviendo y todas las demás claves son `null`.", "properties": { "reason": { "type": "string", "enum": [ "no_route", "institution_unsupported", "attempts_exhausted", "person_choice" ], "description": "Por qué, según lo determinó Didit cuando la persona continuó: `no_route` (ningún inicio de sesión bancario ni comprobación de cuenta da servicio a su país), `institution_unsupported` (el banco que eligió no se puede usar en este paso), `attempts_exhausted` (ya se habían agotado todos los intentos y ninguno estaba en curso) o `person_choice` (había una forma de verificar y eligió continuar, también cuando no se pudo acceder a su banco en ese momento). `no_route` e `institution_unsupported` siguen `bank_unsupported_action`, `attempts_exhausted` sigue `bank_attempts_exhausted_action` y `person_choice` sigue `bank_skipped_action`, salvo que un intento evaluado ya haya decidido el paso." }, "country": { "type": "string", "nullable": true, "description": "El país en el que la persona se estaba verificando, en ISO 3166-1 alpha-3. `null` cuando continuó antes de elegir uno." }, "offered": { "type": "array", "items": { "type": "string", "enum": [ "statement", "microdeposits" ] }, "nullable": true, "description": "Las otras formas de verificación que ese país ofreció a la persona cuando continuó, en el orden en que las ofreció: `statement` (la carga de un extracto) y luego `microdeposits`. Vacío cuando no ofreció ninguna." }, "institution_id": { "type": "string", "nullable": true, "description": "Para `institution_unsupported`, el ID del banco que la persona no pudo usar: el banco que eligió o el banco en el que terminó su último intento. Didit lo toma de su propia lista de bancos, nunca del dispositivo de la persona, por lo que un banco que no está en esa lista es `null`. `null` para cualquier otro motivo." }, "institution_name": { "type": "string", "nullable": true, "description": "Para `institution_unsupported`, el nombre de ese banco, de la misma lista que `institution_id`. `null` cuando esa lista no incluye el banco, y para cualquier otro motivo." }, "continued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Fecha y hora en que la persona continuó." } } }, "evidence_purged_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se eliminó la evidencia bancaria según `bank_evidence_retention_days`. `null` en caso contrario." }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Códigos informativos, por ejemplo `holder_declared`. Una advertencia nunca cambia el estado por sí sola." }, "reason_codes": { "type": "array", "items": { "type": "string" }, "description": "Por qué el veredicto resultó así, por ejemplo `OWNER_NAME_PARTIAL`. Pueden aplicarse varios. `NOT_COVERED`: la persona continuó sin banco porque ningún método podía verificar su país o su banco. `SKIPPED`: la persona eligió continuar sin banco aunque había una forma de verificar. No se añade ninguno de los dos cuando un intento evaluado ya decidió el paso." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "BankAccountCheckPersonHolder": { "type": "object", "description": "La persona que debería ser titular de la cuenta.", "required": [ "full_name" ], "properties": { "full_name": { "type": "string", "maxLength": 255, "description": "El nombre completo de la persona que debe ser titular de la cuenta.", "example": "Maria Oliveira" } } }, "BankAccountCheckBusinessHolder": { "type": "object", "description": "La empresa que debería ser titular de la cuenta. Verifica una cuenta de empresa.", "required": [ "business_name" ], "properties": { "business_name": { "type": "string", "maxLength": 255, "description": "El nombre de la empresa que debería ser titular de la cuenta. Verifica una cuenta de empresa." } } }, "BankVerificationPricing": { "type": "object", "description": "Precios de lista públicos de la verificación bancaria: la carga del extracto, la tarifa por usar tu propia clave de proveedor y los métodos de cada país.", "required": [ "currency", "statement_upload", "own_provider_fee_usd", "countries" ], "properties": { "currency": { "type": "string", "enum": [ "USD" ], "description": "Moneda de todos los precios de la respuesta.", "example": "USD" }, "statement_upload": { "$ref": "#/components/schemas/BankStatementUploadPricing" }, "own_provider_fee_usd": { "type": "string", "description": "Tarifa por cada comprobación de propiedad facturable en una ruta que usa tu propio contrato con el proveedor en lugar del de Didit, cobrada sea cual sea el resultado. Una conexión cancelada, que agota el tiempo de espera o abandonada no se factura. Cadena decimal con 4 decimales, en USD.", "example": "0.0200" }, "countries": { "type": "object", "description": "Todos los países, indexados por su código ISO 3166-1 alfa-3.", "additionalProperties": { "$ref": "#/components/schemas/BankVerificationPricingCountry" } } } }, "BankStatementUploadPricing": { "type": "object", "description": "Cómo se cobra la subida del extracto bancario.", "required": [ "price_usd", "included_after_charged_bank_attempt", "standalone_available" ], "properties": { "price_usd": { "type": "string", "description": "Precio de la carga de un extracto tras un intento bancario cobrado. Cadena decimal con 4 decimales, en USD.", "example": "0.0000" }, "included_after_charged_bank_attempt": { "type": "boolean", "description": "`true` cuando la carga se incluye sin cargo adicional tras un intento bancario cobrado en la misma sesión.", "example": true }, "standalone_available": { "type": "boolean", "description": "`true` cuando la subida de un extracto puede realizarse por sí sola, sin un intento bancario previo. `false` en producción; las sesiones de sandbox pueden probarlo sin facturación.", "example": false } } }, "BankVerificationPricingCountry": { "type": "object", "description": "Los métodos de verificación bancaria de un país y sus precios de lista.", "required": [ "name", "methods" ], "properties": { "name": { "type": "string", "description": "Nombre del país en inglés.", "example": "United Kingdom" }, "methods": { "$ref": "#/components/schemas/BankVerificationPricingMethods" } } }, "BankVerificationPricingMethods": { "type": "object", "description": "Los dos métodos de Bank Verification de un país.", "required": [ "open_banking", "account_lookup" ], "properties": { "open_banking": { "$ref": "#/components/schemas/BankSignInPricing" }, "account_lookup": { "$ref": "#/components/schemas/BankAccountCheckPricing" } } }, "BankSignInPricing": { "type": "object", "description": "Inicio de sesión en el banco: la persona inicia sesión en su banco. El precio depende del mercado y es el mismo para todos los bancos de ese mercado.", "required": [ "available", "market", "price_usd", "add_ons" ], "properties": { "available": { "type": "boolean", "description": "`true` solo donde Didit ofrece el inicio de sesión bancario en este país en producción.", "example": true }, "market": { "type": "string", "nullable": true, "description": "El mercado cuyo precio se aplica. `null` cuando no está disponible.", "example": "UK and EEA" }, "price_usd": { "type": "string", "nullable": true, "description": "Precio de lista de un inicio de sesión bancario. `null` cuando no está disponible. Cadena decimal con 4 decimales, en USD.", "example": "0.7900" }, "add_ons": { "type": "object", "description": "Complementos con precio en este país, cada uno como cadena decimal con 4 decimales en USD, que se suman al precio del inicio de sesión bancario. Solo se listan los complementos que ofrece el país; está vacío cuando el inicio de sesión bancario no está disponible.", "properties": { "balance": { "type": "string", "description": "Complemento de saldo de la cuenta.", "example": "0.3500" }, "transactions": { "type": "string", "description": "Complemento de transacciones.", "example": "1.3000" } } } } }, "BankAccountCheckPricing": { "type": "object", "description": "Verificación de cuenta: la persona introduce su número de cuenta y Didit lo comprueba con el banco. Precio por país.", "required": [ "available", "price_usd" ], "properties": { "available": { "type": "boolean", "description": "`true` solo donde Didit ofrece la comprobación de cuenta en este país en producción.", "example": true }, "price_usd": { "type": "string", "nullable": true, "description": "Precio de lista de una comprobación de cuenta que responde el banco. `null` cuando no está disponible. Cadena decimal con 4 decimales, en USD.", "example": "0.4000" } } }, "ImportProvider": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "sumsub", "jumio", "veriff", "onfido", "persona", "metamap", "socure", "idnow", "shufti", "idenfy", "ondato", "trulioo", "au10tix", "complycube", "other" ] }, "name": { "type": "string" }, "mode": { "type": "string", "enum": [ "api_list", "api_ids", "export_file" ], "description": "`api_list`: Didit lista los registros con la clave. `api_ids`: sube los ID de registro de una exportación. `export_file`: sube una exportación en el formato de Didit." }, "record_noun": { "type": "string" }, "credential_fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "secret": { "type": "boolean" } } } }, "regions": { "type": "array", "items": { "type": "string" } }, "required_permissions": { "type": "array", "items": { "type": "string" } }, "docs_url": { "type": "string", "nullable": true }, "status_mapping": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Not Finished", "Abandoned" ] } } } }, "ImportJobSummary": { "type": "object", "description": "Un trabajo de importación de cualquier tipo, con la forma que lee el panel lateral de trabajos de importación de la consola.", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "sessions", "businesses", "users", "status_rules", "transactions" ] }, "source": { "type": "string", "enum": [ "file", "api", "provider" ] }, "provider": { "type": "string", "nullable": true }, "provider_name": { "type": "string", "nullable": true }, "filename": { "type": "string", "nullable": true }, "state": { "type": "string", "enum": [ "ready", "queued", "running", "paused", "completed", "errors", "failed", "cancelled" ], "description": "El estado del trabajo tal como lo muestra la consola; `errors` es un trabajo completado con filas rechazadas." }, "status": { "type": "string" }, "is_dry_run": { "type": "boolean" }, "credential_hint": { "type": "string", "nullable": true }, "resumes_at": { "type": "string", "format": "date-time", "nullable": true }, "last_error": { "type": "string", "nullable": true }, "started_by": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } } }, "progress": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "processed": { "type": "integer", "format": "int64" }, "imported": { "type": "integer", "format": "int64" }, "updated": { "type": "integer", "format": "int64" }, "already_in_didit": { "type": "integer", "format": "int64" }, "failed": { "type": "integer", "format": "int64" }, "not_finished": { "type": "integer", "format": "int64" }, "same_person": { "type": "integer", "format": "int64" } } }, "face_templates": { "type": "object", "nullable": true, "properties": { "enabled": { "type": "boolean" }, "built": { "type": "integer", "format": "int64" }, "duplicates": { "type": "integer", "format": "int64" }, "blocklisted": { "type": "integer", "format": "int64" } } }, "eta_seconds": { "type": "integer", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "started_at": { "type": "string", "format": "date-time", "nullable": true }, "completed_at": { "type": "string", "format": "date-time", "nullable": true } } }, "FiledRegulatoryReport": { "type": "object", "description": "Un informe regulatorio finalizado que impide la eliminación solicitada.", "required": [ "uuid", "report_number", "report_type", "case_uuid" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID del informe." }, "report_number": { "type": "string", "description": "Número de informe que se muestra en la consola (por ejemplo, SAR-0001)." }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ], "description": "Tipo de informe regulatorio." }, "case_uuid": { "type": "string", "format": "uuid", "description": "Caso al que pertenece el informe." } } }, "FiledReportTransaction": { "type": "object", "description": "Una transacción que no se puede eliminar porque figura en un informe regulatorio finalizado.", "required": [ "uuid", "transaction_id", "reports" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID de transacción de Didit." }, "transaction_id": { "type": "string", "description": "El identificador de la transacción proporcionado al crear la transacción." }, "reports": { "type": "array", "items": { "$ref": "#/components/schemas/FiledRegulatoryReport" }, "description": "Informes finalizados que incluyen esta transacción." } } }, "InFiledReportError": { "type": "object", "description": "La eliminación se rechaza porque los datos seleccionados están en un informe regulatorio finalizado. No se elimina nada. Elimina el informe y luego repite la solicitud.", "required": [ "detail", "code" ], "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "in_filed_report" ], "description": "Código de error estable para una eliminación bloqueada por un informe regulatorio finalizado." }, "reports": { "type": "array", "items": { "$ref": "#/components/schemas/FiledRegulatoryReport" }, "description": "Informes que impiden eliminar una persona, empresa, caso o sesión." }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/FiledReportTransaction" }, "description": "Transacciones que bloquean la eliminación de una transacción, cada una con los informes que la incluyen." } } }, "TravelRuleNetworkParticipantSummary": { "type": "object", "nullable": true, "description": "El participante propio de esta aplicación en la red, o null cuando no tiene ninguno.", "properties": { "mode": { "type": "string", "enum": [ "platform", "own" ], "description": "platform: a través de la membresía de Didit; own: incorporado con la membresía propia de la aplicación." }, "status": { "type": "string", "enum": [ "not_requested", "questionnaire_pending", "submitted_to_network", "active", "suspended", "rejected" ], "description": "not_requested: nunca se solicitó, o la red rechazó la primera solicitud (consulta last_error); questionnaire_pending: a la espera de que se apruebe el cuestionario de diligencia debida; submitted_to_network: entregado al onboarding de la red; active: la red asignó a esta aplicación su propio código de participante; suspended / rejected: Didit lo suspendió o lo rechazó." }, "participant_code": { "type": "string", "description": "El código que la red asignó a esta aplicación (en GTR, su código de VASP). Los mensajes salientes llevan este código, nunca el de Didit." }, "requested_at": { "type": "string", "format": "date-time", "nullable": true }, "activated_at": { "type": "string", "format": "date-time", "nullable": true }, "last_error": { "type": "string", "description": "La respuesta de la red cuando rechazó el registro; vacío en caso contrario." } } }, "TravelRuleNetworkState": { "type": "object", "description": "Cómo se enviarían los mensajes de Travel Rule en una red para esta aplicación y por qué no pueden enviarse. Es un estado de configuración, no una comprobación en vivo del estado ni de la entrega.", "properties": { "rail": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA" ] }, "mode": { "type": "string", "enum": [ "own", "didit", "off", "unavailable" ], "description": "own: se usa la membresía conectada de la aplicación; didit: la membresía de Didit incluye a la aplicación como su propio participante activo; off: enrutamiento de plataforma desactivado en disabled_networks y sin membresía propia; unavailable: todavía no hay nada que pueda enviar en esta red (consulta state y reason)." }, "state": { "type": "string", "enum": [ "own_membership", "live_through_didit", "off", "didit_onboarding", "questionnaire_needed", "questionnaire_in_review", "request_access", "request_sent", "unavailable", "error" ], "description": "own_membership: envía tu membresía conectada; live_through_didit: envía tu propio participante a través de la membresía de Didit; off: desactivaste el enrutamiento de plataforma; didit_onboarding: la membresía propia de Didit en esta red aún no está activa, por lo que no puede dar servicio a nadie; questionnaire_needed / questionnaire_in_review: el cuestionario de diligencia debida debe enviarse o está en manos de Didit; request_access: el cuestionario está aprobado, solicita la red; request_sent: tu participante está en proceso de onboarding; unavailable: consulta reason; error: consulta reason." }, "reason": { "type": "string", "enum": [ "own_membership_connected", "platform_network_switched_off", "own_membership_only", "sandbox_application", "didit_membership_not_live", "participant_suspended", "participant_rejected", "questionnaire_not_submitted", "questionnaire_submitted", "questionnaire_changes_requested", "questionnaire_rejected", "participant_not_requested", "participant_active", "participant_key_missing", "participant_key_unresolved", "provisioning_failed", "questionnaire_pending", "submitted_to_network" ], "description": "Detalle legible por máquina del estado. own_membership_only: Didit no gestiona aplicaciones en esta red (TRUST), conecta tu propia membresía; sandbox_application: las transferencias de sandbox nunca llegan a una red; provisioning_failed: la red rechazó el registro, el last_error del participante indica el motivo y volver a solicitar la red lo reintenta." }, "platform_available": { "type": "boolean", "description": "Indica si está configurada la membresía propia de Didit en esta red; no es una comprobación de estado en tiempo real." }, "connected": { "type": "boolean", "description": "Indica si existe una membresía de cliente conectada. Las credenciales se validan localmente; la validación en la red se produce en un intercambio real." }, "participant": { "$ref": "#/components/schemas/TravelRuleNetworkParticipantSummary" }, "vasps_reachable": { "type": "integer", "description": "VASP del directorio accesibles en esta red." }, "routed_30d": { "type": "integer", "description": "Las transferencias de esta aplicación realizadas en esta red en los últimos 30 días." } } }, "TravelRuleNetworkQuestionnaireAnswers": { "type": "object", "description": "Cuestionario de diligencia debida de la red de Didit. Los guardados son parciales: cada guardado conserva todas las respuestas que no incluye. Para enviarlo se requieren todos los campos excepto lei y data_protection_contact_email, y las tres declaraciones en true.", "properties": { "legal_name": { "type": "string", "maxLength": 255 }, "registration_number": { "type": "string", "maxLength": 255 }, "incorporation_country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Código de país ISO 3166-1 alfa-2." }, "registered_address": { "type": "string", "maxLength": 1000 }, "website": { "type": "string", "format": "uri", "maxLength": 500 }, "lei": { "type": "string", "maxLength": 20, "description": "Opcional. Un LEI ISO 17442 válido cuando se proporciona." }, "licences": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "regulator", "jurisdiction", "licence_type", "licence_number" ], "properties": { "regulator": { "type": "string", "maxLength": 255 }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Código de país ISO 3166-1 alfa-2." }, "licence_type": { "type": "string", "maxLength": 255 }, "licence_number": { "type": "string", "maxLength": 255 } } }, "description": "Todas las licencias o registros que tiene el VASP." }, "operating_jurisdictions": { "type": "array", "minItems": 1, "maxItems": 250, "items": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Código de país ISO 3166-1 alfa-2." } }, "compliance_officer_name": { "type": "string", "maxLength": 255 }, "compliance_officer_email": { "type": "string", "format": "email" }, "aml_ctf_policy_attested": { "type": "boolean", "description": "Debe ser true para enviar." }, "sanctions_screening_attested": { "type": "boolean", "description": "Debe ser true para enviar." }, "data_protection_attested": { "type": "boolean", "description": "Debe ser true para enviar." }, "data_protection_contact_email": { "type": "string", "format": "email", "description": "Opcional." }, "expected_monthly_transfers": { "type": "integer", "minimum": 0 }, "expected_monthly_volume_usd": { "type": "string", "format": "decimal", "description": "Volumen mensual esperado en USD, con hasta 2 decimales. Se devuelve como cadena." }, "assets": { "type": "array", "minItems": 1, "maxItems": 200, "items": { "type": "string", "maxLength": 32 }, "description": "Tickers de los activos, almacenados en mayúsculas, ordenados y sin duplicados." } } }, "TravelRuleNetworkQuestionnaire": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "draft", "submitted", "changes_requested", "approved", "rejected" ], "description": "Las respuestas pueden guardarse mientras el estado es draft o changes_requested; los estados submitted, approved y rejected solo los cambia Didit." }, "answers": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaireAnswers" }, "submitted_at": { "type": "string", "format": "date-time", "nullable": true }, "reviewed_at": { "type": "string", "format": "date-time", "nullable": true }, "review_note": { "type": "string", "description": "Nota de Didit sobre su última decisión, por ejemplo, qué cambiar." }, "history": { "type": "array", "readOnly": true, "description": "Todos los cambios de estado, del más antiguo al más reciente.", "items": { "type": "object", "properties": { "at": { "type": "string", "format": "date-time" }, "from": { "type": "string" }, "to": { "type": "string" }, "note": { "type": "string", "description": "Nota de revisión o respuesta de la red, cuando la hay." } } } }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } }, "TravelRuleNetworkParticipant": { "type": "object", "description": "El participante propio de esta aplicación en una red.", "properties": { "network": { "type": "string", "enum": [ "gtr", "trust", "verifyvasp", "sygna" ] }, "rail": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA" ] }, "mode": { "type": "string", "enum": [ "platform", "own" ] }, "status": { "type": "string", "enum": [ "not_requested", "questionnaire_pending", "submitted_to_network", "active", "suspended", "rejected" ], "description": "not_requested: nunca se solicitó, o la red rechazó la primera solicitud (consulta last_error); questionnaire_pending: a la espera de que se apruebe el cuestionario de diligencia debida; submitted_to_network: entregado al onboarding de la red; active: la red asignó a esta aplicación su propio código de participante; suspended / rejected: Didit lo suspendió o lo rechazó." }, "participant_code": { "type": "string" }, "requested_at": { "type": "string", "format": "date-time", "nullable": true }, "submitted_at": { "type": "string", "format": "date-time", "nullable": true }, "activated_at": { "type": "string", "format": "date-time", "nullable": true }, "suspended_at": { "type": "string", "format": "date-time", "nullable": true }, "last_error": { "type": "string", "description": "La respuesta de la red cuando rechazó el registro; vacío en caso contrario." }, "history": { "type": "array", "readOnly": true, "description": "Todos los cambios de estado, del más antiguo al más reciente.", "items": { "type": "object", "properties": { "at": { "type": "string", "format": "date-time" }, "from": { "type": "string" }, "to": { "type": "string" }, "note": { "type": "string", "description": "Nota de revisión o respuesta de la red, cuando la hay." } } } } } }, "TravelRuleNetworksOverview": { "type": "object", "properties": { "platform_networks_enabled": { "type": "boolean", "description": "Indica si el acceso a la red a través de la membresía de Didit está abierto. Mientras sea false, los guardados de cuestionarios, los envíos y las solicitudes a la red responden 403." }, "questionnaire": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleNetworkParticipant" } }, "networks": { "type": "object", "readOnly": true, "description": "Por cada red, cómo enviaría esta aplicación y por qué no puede hacerlo. Ninguna red, incluida GTR, se incluye de forma predeterminada: una red es accesible a través de tu propia membresía conectada, o a través de la membresía de Didit una vez que la membresía de Didit en esa red esté activa y tu propio participante en ella esté activo. No es una comprobación en tiempo real del estado ni de la entrega.", "properties": { "gtr": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "trust": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "verifyvasp": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "sygna": { "$ref": "#/components/schemas/TravelRuleNetworkState" } } } } }, "AddressValidationResult": { "type": "object", "description": "El resultado de una validación de dirección: si la dirección existe y su forma normalizada. Solo confirma la dirección; nunca la vincula a una persona.", "required": [ "status", "verification_level", "address", "formatted_address", "latitude", "longitude" ], "properties": { "status": { "type": "string", "enum": [ "verified", "partially_verified", "not_verified", "unavailable" ], "description": "`verified`: la dirección se confirmó hasta el edificio (o el piso o el apartado de correos). `partially_verified`: se confirmó solo hasta la calle, o hasta el nivel más preciso que contienen los datos postales de referencia para ese lugar. `not_verified`: solo coincidió la región o la ciudad, o no coincidió nada. `unavailable`: la validación no pudo ejecutarse (por ejemplo, el servicio de referencia no respondió); no se cobra y nunca afecta a una verificación." }, "verification_level": { "type": "string", "nullable": true, "enum": [ "administrative_area", "locality", "thoroughfare", "premise", "delivery_point", null ], "description": "El nivel más preciso con el que coincidió la dirección. `null` cuando no hubo ninguna coincidencia o `status` es `unavailable`." }, "address": { "type": "object", "nullable": true, "description": "La dirección normalizada. `null` cuando `status` es `unavailable`.", "properties": { "address_line_1": { "type": "string", "nullable": true, "description": "Primera línea de la dirección de entrega, escrita según el formato del país.", "example": "1600 Amphitheatre Pkwy" }, "address_line_2": { "type": "string", "nullable": true, "description": "Segunda línea de entrega (un piso, edificio o barrio), cuando la dirección la tiene." }, "city": { "type": "string", "nullable": true, "example": "Mountain View" }, "region": { "type": "string", "nullable": true, "description": "Estado, provincia o región.", "example": "CA" }, "postal_code": { "type": "string", "nullable": true, "example": "94043-1351" }, "country": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alfa-2.", "example": "US" } } }, "formatted_address": { "type": "string", "nullable": true, "description": "La dirección normalizada en una sola línea.", "example": "1600 Amphitheatre Pkwy, Mountain View CA 94043-1351" }, "latitude": { "type": "number", "nullable": true, "example": 37.422022 }, "longitude": { "type": "number", "nullable": true, "example": -122.08429 } } }, "AddressValidationRequest": { "type": "object", "required": [ "country" ], "description": "Una dirección: en una sola línea (`address`) o como campos estructurados con al menos `address_line_1`, nunca ambas cosas.", "properties": { "address": { "type": "string", "maxLength": 500, "description": "La dirección completa en una sola línea.", "example": "Paseo de la Castellana 259, 28046 Madrid" }, "address_line_1": { "type": "string", "maxLength": 255, "description": "Calle y número.", "example": "1600 Amphitheatre Pkwy" }, "address_line_2": { "type": "string", "maxLength": 255, "description": "Apartamento, oficina, planta o edificio." }, "city": { "type": "string", "maxLength": 128, "description": "Ciudad o localidad.", "example": "Mountain View" }, "region": { "type": "string", "maxLength": 128, "description": "Estado, provincia o región.", "example": "CA" }, "postal_code": { "type": "string", "maxLength": 32, "example": "94043" }, "country": { "type": "string", "maxLength": 3, "description": "Código ISO 3166-1 alpha-2 o alpha-3 del país de la dirección.", "example": "US" } } }, "AddressValidationResponse": { "type": "object", "required": [ "request_id", "address_validation", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Identificador de esta solicitud; indícalo al contactar con soporte. No se crea ninguna sesión." }, "address_validation": { "$ref": "#/components/schemas/AddressValidationResult" }, "created_at": { "type": "string", "format": "date-time" } } }, "TravelRuleWalletProofFailureReason": { "type": "string", "enum": [ "", "SIGNATURE_INVALID", "SIGNATURE_UNSUPPORTED_SCHEME", "DEPOSIT_NOT_FOUND", "DEPOSIT_UNCONFIRMED", "DEPOSIT_LOOKUP_FAILED", "DEPOSIT_MISMATCH", "DEPOSIT_STALE", "TXID_REUSED", "CHAIN_UNSUPPORTED", "WINDOW_EXPIRED", "OWNERSHIP_CHANGED", "METHOD_SWITCHED", "REVIEW_REJECTED", "ABANDONED" ], "description": "Por qué una prueba de propiedad de wallet, o su último intento, no llegó a VERIFIED. Vacío cuando nada falló. Una prueba PENDING puede tener uno: el último intento falló y el usuario final puede volver a intentarlo. DEPOSIT_MISMATCH, DEPOSIT_STALE, TXID_REUSED y REVIEW_REJECTED cierran la prueba como REJECTED. SIGNATURE_INVALID: la firma no coincide con la wallet y el desafío. SIGNATURE_UNSUPPORTED_SCHEME: la wallet firmó en un formato que Didit no verifica. DEPOSIT_NOT_FOUND, DEPOSIT_UNCONFIRMED, DEPOSIT_LOOKUP_FAILED: el depósito de prueba no se puede leer o aún no está confirmado; Didit sigue comprobándolo hasta que se cierra la ventana de prueba. DEPOSIT_MISMATCH: la transacción no envía el importe esperado desde la wallet a la dirección de depósito. DEPOSIT_STALE: la transacción es anterior al desafío. TXID_REUSED: la transacción ya sirvió como prueba de otra wallet. CHAIN_UNSUPPORTED: el método no está disponible en esta cadena. WINDOW_EXPIRED: se cerró la ventana de prueba. OWNERSHIP_CHANGED: el titular de la wallet cambió, o la wallet se eliminó de tu libreta de direcciones, después de que se generara la sesión del widget. METHOD_SWITCHED: el usuario final eligió otro método antes de terminar este. REVIEW_REJECTED: tu revisor rechazó la captura de pantalla. ABANDONED: la sesión del widget caducó antes de que el usuario final terminara." }, "TravelRuleWidgetProofError": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensaje legible en inglés." }, "code": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "Motivo legible por máquina, para que un cliente pueda mostrar su propio mensaje traducido." }, "status": { "type": "string", "enum": [ "PENDING", "VERIFIED", "REJECTED", "EXPIRED" ], "description": "Presente cuando la prueba está cerrada: REJECTED por el depósito que se acaba de enviar (400), o REJECTED o EXPIRED cuando se envía evidencia a una prueba que ya está cerrada (409)." }, "proof_id": { "type": "string", "format": "uuid", "description": "Presente con status: la prueba cerrada." }, "method": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SATOSHI_TEST", "SCREENSHOT", "SELF_DECLARATION" ], "description": "Presente con status: el método de la prueba cerrada." }, "max_attempts": { "type": "integer", "description": "Presente con status: pruebas de wallet rechazadas que permite esta sesión." }, "attempts_used": { "type": "integer", "description": "Presente con status: pruebas rechazadas hasta el momento." }, "attempts_remaining": { "type": "integer", "description": "Presente con status: cuando es 0, iniciar otra prueba responde 409 y debes crear una nueva sesión del widget." } } }, "TravelRuleWidgetProofCreate": { "type": "object", "required": [ "method" ], "properties": { "method": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SATOSHI_TEST", "SCREENSHOT", "SELF_DECLARATION" ], "description": "El método de prueba que eligió el usuario final. Debe ser uno de los allowed_methods del contexto." }, "wallet_address": { "type": "string", "maxLength": 128, "description": "Por defecto, el wallet_address de la sesión. Debe coincidir con la wallet de la transferencia cuando la sesión está vinculada a una transferencia." }, "chain": { "type": "string", "maxLength": 32, "description": "Por defecto, la blockchain de la sesión." } } }, "TravelRuleWidgetProofVerifyResult": { "type": "object", "properties": { "proof_id": { "type": "string", "format": "uuid" }, "method": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SATOSHI_TEST", "SCREENSHOT", "SELF_DECLARATION" ] }, "status": { "type": "string", "enum": [ "PENDING", "VERIFIED", "REJECTED", "EXPIRED" ] }, "is_ownership_verified": { "type": "boolean", "description": "Presente cuando la prueba está VERIFIED: la entrada de la libreta de direcciones tiene ahora la propiedad verificada." }, "transfer_status": { "type": "string", "nullable": true, "description": "Presente cuando la prueba está VERIFIED: el estado de la transferencia vinculada, null si no hay ninguna." }, "detail": { "type": "string", "description": "Presente mientras la prueba sigue en PENDING: una captura de pantalla enviada a la espera de revisión, o un depósito de prueba que aún no está confirmado." }, "code": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "Presente en un depósito de prueba pendiente: indica por qué aún no está confirmado." } } }, "TravelRuleWalletProofReview": { "type": "object", "properties": { "proof_id": { "type": "string", "format": "uuid" }, "method": { "type": "string", "enum": [ "SCREENSHOT" ] }, "status": { "type": "string", "enum": [ "PENDING", "VERIFIED", "REJECTED", "EXPIRED" ] }, "wallet_address": { "type": "string" }, "chain": { "type": "string", "description": "Identificador canónico de la cadena, p. ej., ETH, BTC, SOL, TRX." }, "holder_name": { "type": "string" }, "is_ownership_verified": { "type": "boolean", "description": "Si la entrada de la libreta de direcciones tiene la propiedad verificada, mediante esta prueba u otra." }, "transaction_id": { "type": "string", "format": "uuid", "nullable": true, "description": "La transacción para cuya transferencia de Travel Rule se creó la sesión del widget. Es null para una sesión creada sin transaction_id." }, "file_name": { "type": "string", "nullable": true }, "content_type": { "type": "string", "nullable": true }, "screenshot_url": { "type": "string", "nullable": true, "description": "Enlace de validez limitada a la captura de pantalla subida. Vuelve a listar la cola para obtener un enlace nuevo." }, "attempts": { "type": "integer", "description": "Cuántos archivos subió el usuario final para esta prueba." }, "failure_reason": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "REVIEW_REJECTED tras un rechazo, OWNERSHIP_CHANGED cuando la wallet cambió de titular o se eliminó antes de una decisión. Vacío en caso contrario." }, "method_chosen_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo el usuario final eligió el método de captura de pantalla." }, "decided_at": { "type": "string", "format": "date-time", "nullable": true }, "decided_by": { "type": "string", "description": "Quién cerró la prueba: review: para un revisor de la consola, review para una decisión tomada con una clave de API, widget o sweeper cuando Didit la cerró automáticamente. Vacío mientras está en PENDING." }, "review_note": { "type": "string", "description": "La nota enviada con la decisión. Vacía cuando no hay ninguna." }, "created_at": { "type": "string", "format": "date-time" } } }, "TravelRuleWalletProofDecision": { "type": "object", "required": [ "decision" ], "properties": { "decision": { "type": "string", "enum": [ "approve", "reject" ] }, "note": { "type": "string", "maxLength": 512, "description": "Opcional. Se guarda con la prueba y se devuelve como review_note." } } }, "DigitalIdWalletApiWalletDigitalCredentialsRequest": { "type": "object", "properties": { "protocol": { "type": "string", "description": "openid4vp-v1-signed." }, "request": { "type": "object", "additionalProperties": {}, "description": "Pásalo tal cual: navigator.credentials.get({digital: request}) en el navegador, o JSON.stringify(request) como requestJson de GetDigitalCredentialOption en Android. Firmado por Didit para tu aplicación." } }, "required": [ "protocol", "request" ] }, "DigitalIdWalletApiGoogleWalletWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificación con Google Wallet (USA, GBR, BRA, SGP, TWN).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Tu propia referencia para esta verificación (p. ej., tu id de usuario). Se devuelve en los resultados y en los webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional que se almacena con la verificación y se devuelve en los resultados y los webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Solo aplicaciones sandbox: el resultado simulado, 'wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'; con cualquier otro escenario (o ninguno) se verifica. Se rechaza en aplicaciones en producción. El catálogo completo está disponible en GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiGoogleWalletWalletVerificationStartCountryEnum" } ], "description": "País ISO 3166-1 alfa-3 de la identidad de Google Wallet.\n\n* `USA` - USA\n* `GBR` - GBR\n* `BRA` - BRA\n* `SGP` - SGP\n* `TWN` - TWN" }, "origin": { "type": "string", "minLength": 1, "description": "Desde dónde le hará la solicitud a la wallet tu página o app: el origen https de tu página (su host debe estar en allowed_return_hosts de la aplicación o ser su dominio de marca blanca), p. ej., https://app.example.com, o android:apk-key-hash:. La wallet rechaza la solicitud desde cualquier otro origen.", "maxLength": 256 } }, "required": [ "country", "origin" ] }, "DigitalIdWalletApiGoogleWalletWalletVerificationStartCountryEnum": { "enum": [ "USA", "GBR", "BRA", "SGP", "TWN" ], "type": "string", "description": "* `USA` - USA\n* `GBR` - GBR\n* `BRA` - BRA\n* `SGP` - SGP\n* `TWN` - TWN" }, "DigitalIdWalletApiWalletDigitalCredentialResponseRequest": { "type": "object", "description": "Lo que la wallet respondió a tu página o aplicación, en una verificación ``request_digital_credential``.", "properties": { "response": { "type": "object", "additionalProperties": {}, "description": "Exactamente lo que devolvió la wallet: el {protocol, data} de la DigitalCredential obtenida con navigator.credentials.get, o el credentialJson analizado de la DigitalCredential de Android. Está cifrado para Didit; no lo modifiques." } }, "required": [ "response" ] }, "SessionFilesExport": { "type": "object", "description": "Un ZIP con todos los archivos de una sesión, en calidad original.", "required": [ "export_id", "session_id", "status", "file_count", "size_bytes", "download_url", "expires_at", "error", "created_at", "completed_at" ], "properties": { "export_id": { "type": "string", "format": "uuid", "description": "ID de la exportación. Pásalo a `GET /v3/session/{sessionId}/files-export/{exportId}/`." }, "session_id": { "type": "string", "format": "uuid", "description": "La sesión de la que proceden los archivos." }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "READY", "FAILED", "EXPIRED" ], "description": "`PENDING` y `PROCESSING` mientras se prepara el ZIP, `READY` cuando ya se puede descargar, `FAILED` cuando no se pudo preparar (solicita una nueva exportación), `EXPIRED` cuando el ZIP se eliminó." }, "file_count": { "type": "integer", "nullable": true, "description": "Archivos del ZIP. Solo se rellena mientras `status` es `READY`." }, "size_bytes": { "type": "integer", "format": "int64", "nullable": true, "description": "Tamaño del ZIP en bytes. Solo se establece mientras `status` es `READY`." }, "download_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL firmada del ZIP, válida durante poco tiempo. Solo se establece mientras `status` es `READY`; vuelve a leer la exportación para obtener una nueva." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo se elimina el ZIP, 24 horas después de estar listo. Solo se define mientras `status` es `READY`." }, "error": { "type": "string", "nullable": true, "description": "Por qué falló la exportación, cuando `status` es `FAILED`." }, "created_at": { "type": "string", "format": "date-time", "description": "Cuándo se solicitó la exportación." }, "completed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Cuándo estuvo listo el ZIP o cuándo falló la exportación." } } }, "TransactionRuleSuggestionsCreatedEvent": { "description": "Una ejecución de sugerencias de reglas de transacción propuso nuevos cambios de reglas para tu aplicación. Se envía cuando la configuración de sugerencias de reglas tiene activadas las notificaciones por webhook. No hay un `status` de nivel superior.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "transaction_rule_suggestions.created" ], "description": "Siempre `transaction_rule_suggestions.created`." }, "run_id": { "type": "string", "format": "uuid", "description": "La ejecución de sugerencias que generó las nuevas sugerencias." }, "open_count": { "type": "integer", "description": "Número de sugerencias que siguen abiertas después de esta ejecución, incluidas las nuevas." }, "suggestions": { "type": "array", "description": "Las sugerencias que creó esta ejecución.", "items": { "type": "object", "required": [ "suggestion_id", "kind", "title", "rule_id", "expected_impact" ], "properties": { "suggestion_id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "ADD", "TWEAK", "DISABLE" ], "description": "`ADD` propone una regla nueva, `TWEAK` modifica una existente y `DISABLE` desactiva una." }, "title": { "type": "string" }, "rule_id": { "type": "string", "format": "uuid", "nullable": true, "description": "La regla a la que se aplica una sugerencia `TWEAK` o `DISABLE`; `null` para `ADD`." }, "expected_impact": { "type": "object", "additionalProperties": true, "description": "Qué haría el cambio, tal como lo muestra la sugerencia en la Console." } } } } }, "required": [ "webhook_type", "run_id", "open_count", "suggestions" ] } ] }, "GeolocationCheck": { "type": "object", "description": "Un resultado de verificación de ubicación: el intento aceptado de un nodo del flujo. La medición, la incertidumbre y la autenticidad son claves separadas, de modo que una ubicación precisa sin certificar se interpreta de forma distinta a una imprecisa certificada.", "properties": { "node_id": { "type": "string", "nullable": true, "description": "Nodo del flujo que generó este resultado, para que un flujo con dos pasos de verificación de ubicación siga siendo legible." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estado a nivel de función de este paso de verificación de ubicación, determinado a partir de sus advertencias. Es independiente del `status` de la sesión." }, "outcome": { "type": "string", "nullable": true, "description": "Qué ocurrió en este intento.", "enum": [ "verified", "low_accuracy", "accuracy_undetermined", "stale", "approximate", "denied", "restricted", "unavailable", "timeout", "mock_detected", "outside_geofence", "in_blocked_area", "anonymizer_detected", "skipped", "replay_rejected", "unsupported_client", null ] }, "permission": { "type": "string", "nullable": true, "description": "Lo que concedió el sistema operativo o el navegador. `not_requested` significa que el paso usa solo la ubicación IP de la conexión, por lo que nunca se pide ningún permiso a la persona.", "enum": [ "granted_precise", "granted_approximate", "denied", "restricted", "unavailable", "timeout", "dismissed", "not_requested", null ] }, "latitude": { "type": "number", "nullable": true, "description": "Latitud WGS84 de la posición. `null` cuando no hay posición.", "format": "double" }, "longitude": { "type": "number", "nullable": true, "description": "Longitud WGS84 de la posición. `null` cuando no hay posición.", "format": "double" }, "accuracy_m": { "type": "number", "nullable": true, "description": "Radio de incertidumbre en metros, con el nivel de confianza indicado en `accuracy_confidence`.", "format": "double" }, "accuracy_confidence": { "type": "string", "nullable": true, "description": "Nivel de confianza que la plataforma asigna a `accuracy_m`: `p95` (navegadores), `p68` (Android) o `unspecified` (iOS).", "enum": [ "p95", "p68", "unspecified", null ] }, "measured_at": { "type": "string", "nullable": true, "description": "Cuándo el dispositivo obtuvo la posición, según su propio reloj.", "format": "date-time" }, "age_seconds": { "type": "integer", "nullable": true, "description": "Segundos entre que el dispositivo obtiene la ubicación y Didit la recibe." }, "source": { "type": "string", "nullable": true, "description": "De dónde procede la posición, cuando la plataforma lo indica. `ip` significa que la posición es la ubicación IP de la conexión.", "enum": [ "gps", "fused", "network", "wifi", "cell", "browser", "unknown", "ip", null ] }, "platform": { "type": "string", "nullable": true, "description": "El cliente que obtuvo la ubicación.", "enum": [ "web", "ios", "android", "react_native", "flutter", null ] }, "sdk_version": { "type": "string", "nullable": true, "description": "Versión del SDK que generó la corrección." }, "is_mock": { "type": "boolean", "nullable": true, "description": "`true` cuando el dispositivo indica que la posición procede de un proveedor de ubicación simulada o de un software de simulación. `null` cuando la plataforma no lo informa (los navegadores no pueden saberlo); `null` no equivale a `false`." }, "produced_by_accessory": { "type": "boolean", "nullable": true, "description": "Solo iOS: `true` cuando la ubicación procede de un accesorio externo. `null` en los demás casos." }, "integrity": { "type": "string", "enum": [ "attested", "not_attested", "failed", "unsupported", "not_determined" ], "description": "Indica si la atestación del dispositivo respalda la posición obtenida. `unsupported` es lo que informan los navegadores, porque la web no tiene mecanismo de atestación; no es un fallo." }, "country_code": { "type": "string", "nullable": true, "description": "País ISO 3166-1 alpha-2 en el que se encuentra la ubicación." }, "region_code": { "type": "string", "nullable": true, "description": "Subdivisión ISO 3166-2 en la que se encuentra la ubicación." }, "city": { "type": "string", "nullable": true, "description": "Localidad poblada más cercana, una etiqueta para los revisores." }, "geofence": { "type": "object", "description": "Resultado de las reglas de país y zona del paso.", "properties": { "enabled": { "type": "boolean", "description": "Si el paso aplica alguna regla de país o de zona." }, "result": { "type": "string", "nullable": true, "description": "Situación de la posición respecto a las reglas. `undetermined` significa que el círculo de precisión cruza la frontera o que la posición no se resolvió en ningún país; no es prueba de estar fuera.", "enum": [ "inside", "outside", "undetermined", null ] } } }, "inside_geofence": { "type": "boolean", "nullable": true, "description": "`true` cuando `geofence.result` es `inside`, `false` cuando es `outside` y `null` en cualquier otro caso." }, "geofence_basis": { "type": "string", "nullable": true, "description": "Desde qué posición se evaluó el resultado del área: la posición obtenida del `device` o la ubicación `ip` de la conexión.", "enum": [ "device", "ip", null ] }, "inside_areas": { "type": "array", "items": { "type": "string" }, "description": "Ids de las áreas permitidas configuradas dentro de las que se encuentra la posición." }, "blocked_areas": { "type": "array", "items": { "type": "string" }, "description": "Ids de las áreas bloqueadas configuradas en las que se encuentra la posición." }, "position_source": { "type": "string", "nullable": true, "description": "De dónde toma el paso la posición, según la configuración: el dispositivo contrastado con la ubicación de la IP, solo el dispositivo o solo la ubicación de la IP.", "enum": [ "device_and_ip", "device_only", "ip_only", null ] }, "anonymizers": { "type": "object", "nullable": true, "description": "Cómo son la conexión y el dispositivo: cada valor es `true`, `false` o `null` cuando la fuente no puede determinarlo.", "properties": { "vpn": { "type": "boolean", "nullable": true }, "proxy": { "type": "boolean", "nullable": true }, "tor": { "type": "boolean", "nullable": true }, "spoofing": { "type": "boolean", "nullable": true }, "emulator": { "type": "boolean", "nullable": true } } }, "ip_distance_km": { "type": "number", "nullable": true, "description": "Distancia a la ubicación IP de la sesión tras restar ambos radios de incertidumbre; `0` cuando se solapan.", "format": "double" }, "ip_distance_uncertainty_km": { "type": "number", "nullable": true, "description": "Radio combinado que se restó: el radio de la ubicación de la IP más la precisión de esta posición.", "format": "double" }, "ip_consistent": { "type": "boolean", "nullable": true, "description": "Indica si `ip_distance_km` está dentro de la distancia configurada en el paso. `null` cuando se desconoce alguno de los dos lados." }, "document_distance_km": { "type": "number", "nullable": true, "description": "Distancia a la dirección geocodificada del documento de identidad o de la prueba de domicilio. `null` cuando no hay ninguna dirección registrada.", "format": "double" }, "travel_excused": { "type": "boolean", "nullable": true, "description": "Si la tolerancia de desplazamiento del paso justificó la distancia respecto a la dirección. `null` cuando la tolerancia está desactivada." }, "consecutive_mismatches": { "type": "integer", "nullable": true, "description": "En el último intento: esta comprobación más las discrepancias anteriores consecutivas de la misma persona." }, "attempts": { "type": "integer", "description": "Número de este intento dentro del nodo, empezando por 1." }, "consent": { "type": "object", "nullable": true, "description": "El consentimiento que dio la persona antes del aviso del sistema, registrado con la versión del texto y el idioma que vio.", "properties": { "accepted_at": { "type": "string", "format": "date-time" }, "version": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true } } }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string", "enum": [ "ID_VERIFICATION", "NFC", "LIVENESS", "FACEMATCH", "PROOF_OF_ADDRESS", "PHONE", "EMAIL", "AML", "LOCATION", "DATABASE_VALIDATION", "QUESTIONNAIRE", "DOCUMENT_AI", "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE", "GEOLOCATION", "SIGNATURE" ], "description": "La función que generó esta advertencia. El valor identifica el bloque de función al que pertenece la advertencia. El array de advertencias de cada módulo suele usar el valor que corresponde a su módulo (por ejemplo, `PHONE` dentro de `phone_verifications[].warnings`), pero el enum anterior es la referencia para todas las advertencias de funciones del payload de la decisión." }, "risk": { "type": "string" }, "additional_data": { "type": "object", "nullable": true }, "log_type": { "type": "string" }, "short_description": { "type": "string" }, "long_description": { "type": "string" }, "node_id": { "type": "string", "description": "El ID del nodo del grafo del flujo que generó esta advertencia" } } }, "description": "Advertencias que generó este paso de verificación de ubicación, con `feature` establecido en `GEOLOCATION`. Los códigos de advertencia empiezan por `LOCATION_`." } } }, "GeolocationAttempt": { "type": "object", "description": "Un intento de un paso de verificación de ubicación: las mismas claves que `geolocation_checks[]` excepto `warnings`, más el momento en que Didit lo recibió.", "properties": { "node_id": { "type": "string", "nullable": true, "description": "Nodo del flujo que generó este resultado, para que un flujo con dos pasos de verificación de ubicación siga siendo legible." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estado a nivel de función de este paso de verificación de ubicación, determinado a partir de sus advertencias. Es independiente del `status` de la sesión." }, "outcome": { "type": "string", "nullable": true, "description": "Qué ocurrió en este intento.", "enum": [ "verified", "low_accuracy", "accuracy_undetermined", "stale", "approximate", "denied", "restricted", "unavailable", "timeout", "mock_detected", "outside_geofence", "in_blocked_area", "anonymizer_detected", "skipped", "replay_rejected", "unsupported_client", null ] }, "permission": { "type": "string", "nullable": true, "description": "Lo que concedió el sistema operativo o el navegador. `not_requested` significa que el paso usa solo la ubicación IP de la conexión, por lo que nunca se pide ningún permiso a la persona.", "enum": [ "granted_precise", "granted_approximate", "denied", "restricted", "unavailable", "timeout", "dismissed", "not_requested", null ] }, "latitude": { "type": "number", "nullable": true, "description": "Latitud WGS84 de la posición. `null` cuando no hay posición.", "format": "double" }, "longitude": { "type": "number", "nullable": true, "description": "Longitud WGS84 de la posición. `null` cuando no hay posición.", "format": "double" }, "accuracy_m": { "type": "number", "nullable": true, "description": "Radio de incertidumbre en metros, con el nivel de confianza indicado en `accuracy_confidence`.", "format": "double" }, "accuracy_confidence": { "type": "string", "nullable": true, "description": "Nivel de confianza que la plataforma asigna a `accuracy_m`: `p95` (navegadores), `p68` (Android) o `unspecified` (iOS).", "enum": [ "p95", "p68", "unspecified", null ] }, "measured_at": { "type": "string", "nullable": true, "description": "Cuándo el dispositivo obtuvo la posición, según su propio reloj.", "format": "date-time" }, "age_seconds": { "type": "integer", "nullable": true, "description": "Segundos entre que el dispositivo obtiene la ubicación y Didit la recibe." }, "source": { "type": "string", "nullable": true, "description": "De dónde procede la posición, cuando la plataforma lo indica. `ip` significa que la posición es la ubicación IP de la conexión.", "enum": [ "gps", "fused", "network", "wifi", "cell", "browser", "unknown", "ip", null ] }, "platform": { "type": "string", "nullable": true, "description": "El cliente que obtuvo la ubicación.", "enum": [ "web", "ios", "android", "react_native", "flutter", null ] }, "sdk_version": { "type": "string", "nullable": true, "description": "Versión del SDK que generó la corrección." }, "is_mock": { "type": "boolean", "nullable": true, "description": "`true` cuando el dispositivo indica que la posición procede de un proveedor de ubicación simulada o de un software de simulación. `null` cuando la plataforma no lo informa (los navegadores no pueden saberlo); `null` no equivale a `false`." }, "produced_by_accessory": { "type": "boolean", "nullable": true, "description": "Solo iOS: `true` cuando la ubicación procede de un accesorio externo. `null` en los demás casos." }, "integrity": { "type": "string", "enum": [ "attested", "not_attested", "failed", "unsupported", "not_determined" ], "description": "Indica si la atestación del dispositivo respalda la posición obtenida. `unsupported` es lo que informan los navegadores, porque la web no tiene mecanismo de atestación; no es un fallo." }, "country_code": { "type": "string", "nullable": true, "description": "País ISO 3166-1 alpha-2 en el que se encuentra la ubicación." }, "region_code": { "type": "string", "nullable": true, "description": "Subdivisión ISO 3166-2 en la que se encuentra la ubicación." }, "city": { "type": "string", "nullable": true, "description": "Localidad poblada más cercana, una etiqueta para los revisores." }, "geofence": { "type": "object", "description": "Resultado de las reglas de país y zona del paso.", "properties": { "enabled": { "type": "boolean", "description": "Si el paso aplica alguna regla de país o de zona." }, "result": { "type": "string", "nullable": true, "description": "Situación de la posición respecto a las reglas. `undetermined` significa que el círculo de precisión cruza la frontera o que la posición no se resolvió en ningún país; no es prueba de estar fuera.", "enum": [ "inside", "outside", "undetermined", null ] } } }, "inside_geofence": { "type": "boolean", "nullable": true, "description": "`true` cuando `geofence.result` es `inside`, `false` cuando es `outside` y `null` en cualquier otro caso." }, "geofence_basis": { "type": "string", "nullable": true, "description": "Desde qué posición se evaluó el resultado del área: la posición obtenida del `device` o la ubicación `ip` de la conexión.", "enum": [ "device", "ip", null ] }, "inside_areas": { "type": "array", "items": { "type": "string" }, "description": "Ids de las áreas permitidas configuradas dentro de las que se encuentra la posición." }, "blocked_areas": { "type": "array", "items": { "type": "string" }, "description": "Ids de las áreas bloqueadas configuradas en las que se encuentra la posición." }, "position_source": { "type": "string", "nullable": true, "description": "De dónde toma el paso la posición, según la configuración: el dispositivo contrastado con la ubicación de la IP, solo el dispositivo o solo la ubicación de la IP.", "enum": [ "device_and_ip", "device_only", "ip_only", null ] }, "anonymizers": { "type": "object", "nullable": true, "description": "Cómo son la conexión y el dispositivo: cada valor es `true`, `false` o `null` cuando la fuente no puede determinarlo.", "properties": { "vpn": { "type": "boolean", "nullable": true }, "proxy": { "type": "boolean", "nullable": true }, "tor": { "type": "boolean", "nullable": true }, "spoofing": { "type": "boolean", "nullable": true }, "emulator": { "type": "boolean", "nullable": true } } }, "ip_distance_km": { "type": "number", "nullable": true, "description": "Distancia a la ubicación IP de la sesión tras restar ambos radios de incertidumbre; `0` cuando se solapan.", "format": "double" }, "ip_distance_uncertainty_km": { "type": "number", "nullable": true, "description": "Radio combinado que se restó: el radio de la ubicación de la IP más la precisión de esta posición.", "format": "double" }, "ip_consistent": { "type": "boolean", "nullable": true, "description": "Indica si `ip_distance_km` está dentro de la distancia configurada en el paso. `null` cuando se desconoce alguno de los dos lados." }, "document_distance_km": { "type": "number", "nullable": true, "description": "Distancia a la dirección geocodificada del documento de identidad o de la prueba de domicilio. `null` cuando no hay ninguna dirección registrada.", "format": "double" }, "travel_excused": { "type": "boolean", "nullable": true, "description": "Si la tolerancia de desplazamiento del paso justificó la distancia respecto a la dirección. `null` cuando la tolerancia está desactivada." }, "consecutive_mismatches": { "type": "integer", "nullable": true, "description": "En el último intento: esta comprobación más las discrepancias anteriores consecutivas de la misma persona." }, "attempts": { "type": "integer", "description": "Número de este intento dentro del nodo, empezando por 1." }, "consent": { "type": "object", "nullable": true, "description": "El consentimiento que dio la persona antes del aviso del sistema, registrado con la versión del texto y el idioma que vio.", "properties": { "accepted_at": { "type": "string", "format": "date-time" }, "version": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true } } }, "received_at": { "type": "string", "nullable": true, "description": "Cuándo recibió Didit el intento.", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" } } }, "BiometricRetention": { "type": "object", "description": "Fecha y hora en que se eliminan los datos biométricos en vivo de esta sesión.", "required": [ "jurisdictions", "deletes_at" ], "properties": { "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Códigos de los estados de EE. UU. cuyas normas biométricas establecen un plazo de eliminación para esta persona (`US` cuando se desconoce el estado). Vacío cuando no aplica ninguno." }, "deletes_at": { "type": "string", "format": "date-time", "nullable": true, "description": "La fecha en que se eliminan los datos biométricos en vivo (imágenes faciales y plantillas) de esta sesión, según la configuración de retención de tu aplicación y, cuando corresponda, el límite legal de la jurisdicción de la persona. `null` cuando todavía no aplica ninguna fecha." } } }, "TravelRuleManualMatchRequest": { "type": "object", "required": [ "transaction_id" ], "properties": { "transaction_id": { "type": "string", "format": "uuid", "description": "El `transaction_id` del mensaje de Travel Rule recibido (una fila con `kind: message`)." } } }, "TravelRuleManualMatchResponse": { "type": "object", "required": [ "deposit", "message" ], "properties": { "deposit": { "$ref": "#/components/schemas/TravelRuleTransferRow" }, "message": { "$ref": "#/components/schemas/TravelRuleTransferRow" } } } }, "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." }, "TransactionTokenAuth": { "type": "apiKey", "in": "header", "name": "X-Transaction-Token", "description": "Token de corta duración y alcance limitado que tu backend genera mediante POST /v3/transactions/sdk-token/. Lo usan los SDK de Didit en los endpoints /v1/transactions/ orientados al dispositivo." }, "SessionTokenAuth": { "type": "apiKey", "in": "header", "name": "Session-Token", "description": "Token de corta duración devuelto en el campo `session_token` de POST /v3/session/. Lo usa el flujo de verificación alojado (y las interfaces personalizadas de sandbox) para llamar a endpoints con alcance de sesión en nombre del usuario que se verifica, sin tu clave de API del lado del servidor." }, "BearerAuth": { "type": "http", "scheme": "bearer", "description": "El token de acceso de credenciales de cliente de la aplicación." }, "CaseRequestToken": { "type": "apiKey", "in": "header", "name": "X-Case-Request-Token", "description": "Credencial específica de la solicitud procedente del enlace seguro. Otorga acceso solo a esta solicitud." } }, "responses": { "Unauthorized": { "description": "No autorizado", "content": { "application/json": { "examples": { "Invalid API Key": { "summary": "Clave de API no válida", "value": { "detail": "Invalid API Key." } } } } } }, "Forbidden": { "description": "Prohibido", "content": { "application/json": { "examples": { "No Permission": { "summary": "Sin permiso", "value": { "detail": "You do not have permission to perform this action." } }, "Not Enough Credits": { "summary": "Créditos insuficientes", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "NotFound": { "description": "No encontrado", "content": { "application/json": { "examples": { "Not Found": { "summary": "No encontrado", "value": { "detail": "Resource not found." } } } } } }, "PhoneRiskValidationError": { "description": "Falló la validación de la solicitud.", "content": { "application/json": { "examples": { "Missing phone number": { "summary": "Falta el número de teléfono", "value": { "phone_number": [ "This field is required." ] } }, "Invalid phone number": { "summary": "Número de teléfono no válido", "value": { "phone_number": [ "Invalid phone number provided." ] } }, "Invalid signal IP": { "summary": "IP de la señal no válida", "value": { "signals": { "ip": [ "Enter a valid IPv4 or IPv6 address." ] } } } } } } }, "EmailRiskValidationError": { "description": "Falló la validación de la solicitud.", "content": { "application/json": { "examples": { "Missing email": { "summary": "Falta el correo electrónico", "value": { "email": [ "This field is required." ] } }, "Invalid email": { "summary": "Correo electrónico no válido", "value": { "email": [ "Enter a valid email address." ] } }, "Invalid country hint": { "summary": "Indicación de país no válida", "value": { "country_code": [ "Ensure this field has no more than 3 characters." ] } } } } } }, "IPRiskValidationError": { "description": "Falló la validación de la solicitud.", "content": { "application/json": { "examples": { "Missing IP address": { "summary": "Falta la dirección IP", "value": { "ip_address": [ "This field is required." ] } }, "Invalid IP address": { "summary": "Dirección IP no válida", "value": { "ip_address": [ "Enter a valid IPv4 or IPv6 address." ] } }, "Country hint too long": { "summary": "Indicación de país demasiado larga", "value": { "claimed_country": [ "Ensure this field has no more than 3 characters." ] } } } } } }, "RiskPermissionDenied": { "description": "Falta la clave de API o no es válida, o la organización no puede cubrir la consulta en tiempo real. Esta API nunca devuelve `401`.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Falta el encabezado `x-api-key`, o la clave no es válida o está revocada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de la organización no cubre el precio de la consulta", "value": { "error": "You don't have enough credits to perform this request." } } } } } }, "RateLimitedWrite": { "description": "Se superó el límite de escritura compartido de 300 solicitudes por minuto por clave de API. Respeta `Retry-After` antes de reintentar.", "content": { "application/json": { "schema": { "type": "object", "required": [ "detail" ], "properties": { "detail": { "type": "string" } } }, "example": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } }, "AddressValidationValidationError": { "description": "El cuerpo de la solicitud no es válido: falta `country` o es desconocido, no hay dirección, o se enviaron tanto `address` como los campos estructurados.", "content": { "application/json": { "examples": { "Unknown country": { "value": { "country": [ "Use an ISO 3166-1 alpha-2 or alpha-3 country code, e.g. 'US' or 'USA'." ] } }, "No address": { "value": { "address": [ "Send the address: 'address' on one line, or the structured fields with 'address_line_1'." ] } }, "Both shapes": { "value": { "address": [ "Send either 'address' or the structured fields (address_line_1, ...), not both." ] } } } } } }, "AddressValidationPermissionDenied": { "description": "Falta la clave de API o no es válida, una clave con alcance limitado no tiene acceso de escritura a `sessions`, o la organización no puede cubrir la validación. Esta API nunca devuelve `401`.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "value": { "detail": "You don't have enough credits to perform this request. Please top up at https://business.didit.me", "code": "insufficient_credits" } } } } } } }, "parameters": { "WebhookSignature": { "name": "X-Signature", "in": "header", "required": true, "schema": { "type": "string" }, "description": "HMAC-SHA256 en hexadecimal en minúsculas, con el secreto del destino como clave, del cuerpo sin procesar exacto de la solicitud." }, "WebhookSignatureV2": { "name": "X-Signature-V2", "in": "header", "required": true, "schema": { "type": "string" }, "description": "HMAC-SHA256 en hexadecimal en minúsculas, con el secreto del destino como clave, del JSON canónico del cuerpo (claves ordenadas, sin espacios en blanco, caracteres no ASCII sin escapar). Recomendado, porque resiste el middleware que vuelve a codificar el cuerpo." }, "WebhookSignatureSimple": { "name": "X-Signature-Simple", "in": "header", "required": true, "deprecated": true, "schema": { "type": "string" }, "description": "HMAC-SHA256 en hexadecimal en minúsculas, con el secreto del destino como clave, de `{timestamp}:{session_id}:{status}:{webhook_type}` (los campos ausentes, como cadenas vacías). Cubre solo el sobre, nunca el payload." }, "WebhookTimestamp": { "name": "X-Timestamp", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Tiempo Unix en segundos, igual al `timestamp` del cuerpo. Rechaza las entregas con una antigüedad de más de unos minutos." } } }, "x-webhooks": { "status.updated": { "post": { "summary": "Estado de la sesión modificado", "description": "Una sesión de verificación cambió de estado. `decision` solo se envía para `Approved`, `Declined`, `In Review` y `Abandoned`; tiene la forma de `GET /v3/session/{sessionId}/decision/` para los destinos con la versión 3 de webhook (la predeterminada), y la forma reducida anterior para los destinos con la versión 1 o 2. Las sesiones de empresa siempre reciben la decisión de empresa de la versión 3.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionStatusUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Cualquier respuesta 2xx confirma la entrega. Las demás respuestas y los tiempos de espera agotados se reintentan; consulta https://docs.didit.me/integration/webhooks." } } } }, "data.updated": { "post": { "summary": "Datos de la sesión modificados", "description": "Los datos de una sesión de verificación cambiaron sin que cambiara su estado, por ejemplo tras una edición en una revisión manual, la anulación de un paso o un nuevo análisis de la monitorización continua. `decision` solo se envía para `Approved`, `Declined`, `In Review` y `Abandoned`. Tiene la forma de `GET /v3/session/{sessionId}/decision/` para los destinos con la versión 3 de webhook (la predeterminada) y la forma reducida anterior para los destinos con la versión 1 o 2. Las sesiones de empresa siempre reciben la decisión de empresa de la versión 3.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionDataUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Cualquier respuesta 2xx confirma la entrega. Las demás respuestas y los tiempos de espera agotados se reintentan; consulta https://docs.didit.me/integration/webhooks." } } } }, "user.status.updated": { "post": { "summary": "Estado del usuario modificado", "description": "Un usuario cambió de estado. No se envía cuando se crea el usuario.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserStatusUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Cualquier respuesta 2xx confirma la entrega. Las demás respuestas y los tiempos de espera agotados se reintentan; consulta https://docs.didit.me/integration/webhooks." } } } }, "user.data.updated": { "post": { "summary": "Datos del usuario modificados", "description": "Cambiaron campos de un usuario. No se envía cuando se crea el usuario. Un mismo guardado puede generar tanto un evento de estado como uno de datos.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDataUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Cualquier respuesta 2xx confirma la entrega. Las demás respuestas y los tiempos de espera agotados se reintentan; consulta https://docs.didit.me/integration/webhooks." } } } }, "business.status.updated": { "post": { "summary": "Estado de la empresa modificado", "description": "Una empresa cambió de estado. No se envía cuando se crea la empresa.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessStatusUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Cualquier respuesta 2xx confirma la entrega. Las demás respuestas y los tiempos de espera agotados se reintentan; consulta https://docs.didit.me/integration/webhooks." } } } }, "business.data.updated": { "post": { "summary": "Datos de la empresa modificados", "description": "Cambiaron campos de una empresa. No se envía cuando se crea la empresa. Un mismo guardado puede generar tanto un evento de estado como uno de datos.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessDataUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Cualquier respuesta 2xx confirma la entrega. Las demás respuestas y los tiempos de espera agotados se reintentan; consulta https://docs.didit.me/integration/webhooks." } } } }, "transaction.created": { "post": { "summary": "Transacción creada", "description": "Se creó y analizó una transacción. Solo se envía para aplicaciones en producción.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionCreatedEvent" } } } }, "responses": { "2XX": { "description": "Cualquier respuesta 2xx confirma la entrega. Las demás respuestas y los tiempos de espera agotados se reintentan; consulta https://docs.didit.me/integration/webhooks." } } } }, "transaction.status.updated": { "post": { "summary": "Estado de la transacción modificado", "description": "Una transacción cambió de estado, por una regla, una revisión o una acción del usuario final. Solo se envía para aplicaciones en producción.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatusUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Cualquier respuesta 2xx confirma la entrega. Las demás respuestas y los tiempos de espera agotados se reintentan; consulta https://docs.didit.me/integration/webhooks." } } } }, "travel_rule.status.updated": { "post": { "summary": "Estado de Travel Rule modificado", "description": "Un intercambio de Travel Rule cambió de estado. Se envía en cada transición hasta `FINISHED`, `CANCELLED` o `EXPIRED`, incluidos, y nunca después. Se envía para aplicaciones en producción y, en el caso de los intercambios de Travel Rule, también para aplicaciones de sandbox (`environment: sandbox`). No hay un `status` de nivel superior.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleStatusUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Cualquier respuesta 2xx confirma la entrega. Las demás respuestas y los tiempos de espera agotados se reintentan; consulta https://docs.didit.me/integration/webhooks." } } } }, "workflow.compliance_changed": { "post": { "summary": "Cumplimiento del flujo modificado", "description": "El estado de cumplimiento de un flujo publicado cambió tras una reevaluación. Un evento por flujo. No hay `status` de nivel superior.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowComplianceChangedEvent" } } } }, "responses": { "2XX": { "description": "Cualquier respuesta 2xx confirma la entrega. Las demás respuestas y los tiempos de espera agotados se reintentan; consulta https://docs.didit.me/integration/webhooks." } } } }, "kyb.registry_search.resolved": { "post": { "summary": "Búsqueda de empresa resuelta (callback sin firmar)", "description": "Cuerpo del callback que se envía a la `webhook_url` de `POST /v3/kyb/search/` cuando se resuelve la búsqueda en el registro. No está firmado: la solicitud incluye `X-Didit-Unsigned-Callback: true` y ninguno de los encabezados de firma, así que confírmalo comparando `request_id` con una búsqueda que hayas iniciado. Usa `event_type`, no `webhook_type`.", "tags": [ "Webhook" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KYBRegistrySearchResolvedCallback" } } } }, "responses": { "2XX": { "description": "Cualquier respuesta 2xx confirma la entrega. Las demás respuestas y los tiempos de espera agotados se reintentan; consulta https://docs.didit.me/integration/webhooks." } } } }, "transaction_rule_suggestions.created": { "post": { "summary": "Sugerencias de reglas de transacciones creadas", "description": "Una ejecución de sugerencias de reglas de transacción propuso nuevos cambios de reglas para tu aplicación. Se envía cuando la configuración de sugerencias de reglas tiene activadas las notificaciones por webhook. No hay un `status` de nivel superior.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleSuggestionsCreatedEvent" } } } }, "responses": { "2XX": { "description": "Cualquier respuesta 2xx confirma la entrega. Las demás respuestas y los tiempos de espera agotados se reintentan; consulta https://docs.didit.me/integration/webhooks." } } } } } }