{ "openapi": "3.0.0", "info": { "version": "3.0.0", "title": "Didit Verification API", "description": "API de verificació d'identitat. Autentica't amb la capçalera x-api-key." }, "servers": [ { "url": "https://verification.didit.me" } ], "tags": [], "paths": { "/system/healthcheck": { "get": { "summary": "Comprovació d'estat del servei (pública, sense autenticació)", "description": "Sonda de disponibilitat pública sense autenticació. Retorna `HTTP 200` amb `{status: \"ok\", timestamp}` quan el servei, la base de dades, la memòria cau i el broker funcionen correctament.", "operationId": "get_system_healthcheck", "x-didit-sdk": { "resource": "system", "method": "healthcheck", "auth": "public", "server": false }, "tags": [ "System" ], "security": [ {} ], "parameters": [], "responses": { "200": { "description": "El servei està en bon estat i accepta sol·licituds. El cos sempre és `{\"status\": \"ok\", \"timestamp\": \"\"}`.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "timestamp" ], "properties": { "status": { "type": "string", "enum": [ "ok" ], "description": "Marcador de la prova de vida. Sempre la cadena literal `\"ok\"` en una resposta 200.", "example": "ok" }, "timestamp": { "type": "string", "format": "date-time", "description": "Hora del servidor en què es va avaluar la comprovació d'estat, en ISO 8601 amb precisió de mil·lisegons i un sufix `Z` (UTC).", "example": "2026-04-21T16:42:50.445Z" } } }, "examples": { "Healthy": { "summary": "El servei està actiu", "value": { "status": "ok", "timestamp": "2026-04-21T16:42:50.445Z" } } } } } }, "503": { "description": "El servei no està en bon estat: un dels connectors de comprovació d'estat configurats (base de dades, memòria cau, intermediari) està fallant. El cos de la resposta és intencionadament mínim; l'estat HTTP és el senyal principal. Reintenta amb una espera exponencial." }, "5XX": { "description": "El servei de verificació està degradat o és inaccessible. Tracta qualsevol resposta que no sigui 2xx com a \"no saludable\" i reintenta amb un retrocés 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ó de risc d'una adreça de correu electrònic", "description": "Retorna senyals de lliurabilitat, adreça d'un sol ús, filtracions, coincidència entre sessions i intel·ligència de risc normalitzada sense enviar cap OTP. L'endpoint crea una sessió d'API i retorna el seu identificador com a `request_id`.\n\n**Decisió.** El `status` de nivell superior reflecteix `email.status`. Normalment és `Approved`; l'avaluació de risc pot produir `In Review` o `Declined`.\n\n**Àlies de compatibilitat.** Les respostes de producció exposen l'objecte d'intel·ligència normalitzat tant com a `email.email_intelligence` com a `email.enrichment`. Els valors són idèntics. Les noves integracions poden llegir `email.enrichment`. Ambdues claus són absents quan no s'ha retornat cap dada d'intel·ligència utilitzable.\n\n**Facturació.** Les crides en producció utilitzen els preus d'Email Risk API. La sol·licitud és facturable un cop comença la cerca, fins i tot si alguns camps que es calculen amb el millor esforç no estan disponibles.\n\n**Sandbox.** Les claus de sandbox validen la sol·licitud i retornen dades aprovades deterministes sense enviar cap correu electrònic, consumir crèdits, crear cap sessió ni contribuir a Networks.\n\n**Autenticació.** Envia la clau d'API de la teva aplicació a `x-api-key`. Les credencials absents o no vàlides retornen `403`; aquesta API mai retorna `401`.\n\n**Límit de freqüència.** Pressupost d'escriptura compartit de 300 sol·licituds per minut per clau d'API entre els endpoints POST/PATCH/DELETE (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost separat de 600).\n\n**Empremta social.** Estableix `enable_social` a `true` per afegir un bloc `email_social`: les plataformes en línia on aquesta adreça està registrada, amb recomptes per categoria i els detalls de perfil disponibles. `profiles_registered: 0` significa que les plataformes s'han comprovat i l'adreça no s'ha trobat en cap d'elles: una resposta vàlida i facturable. El bloc és absent quan no s'ha sol·licitat el complement o la comprovació no s'ha pogut completar, i en aquest cas no es factura. La facturació afegeix una unitat de `email_social` per sol·licitud a sobre del preu propi d'aquest 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": "Puntua una adreça amb els valors per defecte", "value": { "email": "alice@example.com" } }, "Full context": { "summary": "Puntua amb senyals, indicació de país i identificadors de correlació", "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": "S'ha completat l'avaluació de risc. Inspecciona `status` per conèixer la decisió; la resposta HTTP sempre és `200` per a consultes completades.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRiskResponse" }, "examples": { "Clean address": { "summary": "Adreça que admet lliuraments sense exposició a filtracions", "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": "Adreça trobada en filtracions conegudes", "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ó de risc d'una adreça IP", "description": "Retorna geolocalització, titularitat de la xarxa, indicadors de VPN/Tor i centre de dades, dades d'amenaces i `country_mismatch` per a una adreça proporcionada. L'endpoint crea una sessió d'API i retorna el seu identificador com a `request_id`.\n\n**Decisió.** `status` és `In Review` quan el país resolt entra en conflicte amb `claimed_country`, o quan l'adreça està associada amb infraestructura de VPN, Tor o centre de dades. En cas contrari, és `Approved`.\n\n**Millor esforç.** L'enriquiment d'IP es fa amb el millor esforç. Si cap font d'enriquiment no retorna dades utilitzables, l'endpoint retorna una resposta aprovada amb `ip.ip_address: null`, `ip.country_mismatch: null` i un objecte `ip.threat` buit.\n\n**Facturació.** Les crides en producció utilitzen els preus d'IP Risk API. La sol·licitud és facturable un cop comença la cerca.\n\n**Sandbox.** Les claus de sandbox validen la sol·licitud i retornen dades aprovades deterministes sense consumir crèdits, crear cap sessió ni contribuir a Networks.\n\n**Autenticació.** Envia la clau d'API de la teva aplicació a `x-api-key`. Les credencials absents o no vàlides retornen `403` - aquesta API mai retorna `401`.\n\n**Límit de freqüència.** Pressupost d'escriptura compartit de 300 sol·licituds per minut per clau d'API entre els endpoints POST/PATCH/DELETE (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost separat de 600).", "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": "Puntua una adreça amb els valors per defecte", "value": { "ip_address": "8.8.8.8" } }, "With claimed country": { "summary": "Puntua amb un país declarat per a la detecció de discrepàncies", "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": "S'ha completat l'avaluació de risc. Inspecciona `status` per conèixer la decisió; la resposta HTTP sempre és `200` per a consultes completades.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPRiskResponse" }, "examples": { "Clean residential IP": { "summary": "Adreça de residència, el país declarat coincideix", "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": "Adreça del centre de dades en conflicte amb el país declarat", "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ó de risc d'un número de telèfon", "description": "Resol un número de telèfon i retorna l'operador, el tipus de línia, la portabilitat, si és un número d'un sol ús, la coincidència entre sessions i senyals d'intel·ligència de risc normalitzats sense enviar cap OTP. L'endpoint crea una sessió d'API i en retorna l'id com a `request_id`.\n\n**Decisió.** L'estat `status` de nivell superior reflecteix `phone.status`. Normalment és `Approved`; l'avaluació de risc pot generar `In Review` o `Declined`.\n\n**Àlies de compatibilitat.** Les respostes de producció exposen l'objecte d'intel·ligència normalitzat tant com a `phone.phone_intelligence` com a `phone.enrichment`. Els valors són idèntics. Les noves integracions poden llegir `phone.enrichment`. Ambdues claus són absents quan no s'han retornat dades d'intel·ligència utilitzables.\n\n**Facturació.** Les crides a producció utilitzen els preus de l'API de Phone Risk. La sol·licitud és facturable un cop comença la cerca, fins i tot quan alguns camps de millor esforç no estan disponibles.\n\n**Sandbox.** Les claus de sandbox validen la sol·licitud i retornen dades deterministes aprovades sense enviar cap OTP, consumir crèdits, crear una sessió ni contribuir a Networks.\n\n**Autenticació.** Envia la clau d'API de la teva aplicació a `x-api-key`. Si les credencials són absents o no vàlides, es retorna `403` - aquesta API no retorna mai `401`.\n\n**Límit de freqüència.** Pressupost d'escriptura compartit de 300 sol·licituds per minut per clau d'API en els endpoints POST/PATCH/DELETE (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost separat de 600).\n\n**Petjada social.** Estableix `enable_social` a `true` per afegir un bloc `phone_social`: les plataformes en línia on està registrat aquest número, amb recomptes per categoria i els detalls de perfil disponibles. `profiles_registered: 0` significa que s'han consultat les plataformes i el número no s'ha trobat en cap d'elles - una resposta vàlida i facturable. El bloc és absent quan no s'ha sol·licitat el complement o no s'ha pogut completar la comprovació, i en aquest cas no es factura. La facturació afegeix una unitat de `phone_social` per sol·licitud a sobre del preu propi d'aquest 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": "Puntua un número amb els valors per defecte", "value": { "phone_number": "+14155552671" } }, "Full context": { "summary": "Puntua amb senyals, indicació de país i identificadors de correlació", "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": "S'ha completat l'avaluació de risc. Inspecciona `status` per conèixer la decisió; la resposta HTTP sempre és `200` per a consultes completades.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneRiskResponse" }, "examples": { "Clean mobile number": { "summary": "Número de mòbil net amb cobertura d'intel·ligència", "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 d'un sol ús o virtual marcat per a revisió", "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": "Crea una sessió de verificació", "description": "Crea una sessió de Verificació d'usuaris (KYC) o de Verificació d'empreses (KYB) i rep una `url` de verificació allotjada juntament amb un `session_token` per redirigir o incrustar per al teu usuari final. El `workflow_id` selecciona quins passos de verificació s'executen i si la sessió és de KYC o de KYB.\n\nCrida aquest endpoint des del teu backend (mai des del navegador — la clau d'API és un secret) sempre que calgui verificar un usuari o una empresa: en registrar-se, abans d'una acció sensible o quan calgui una reverificació. Prerequisits: un flux de treball publicat (creat a la pàgina [Workflows](https://docs.didit.me/ca/console/workflows) de la consola) i una clau d'API d'aplicació amb crèdits disponibles. Les aplicacions de sandbox ometen la comprovació de crèdit.\n\n**Idempotència:** quan es proporciona `vendor_data` i ja existeix una sessió no finalitzada (`Not Started`, `In Progress`, `Resubmitted` o `Awaiting User`) amb el mateix `vendor_data` a l'**última versió publicada actual** del flux de treball (i aquesta sessió ja té una URL de verificació allotjada), es retorna la sessió existent (igualment `201`) en lloc de crear-ne una de duplicada — amb el seu `callback` i `metadata` actualitzats als nous valors proporcionats. Una sessió no finalitzada creada en una versió anterior del flux de treball (que s'hagi tornat a publicar des de llavors) **no** es reutilitza; en comptes d'això, es crea una nova sessió vinculada a l'última versió publicada. Les sessions en estat `Approved`, `Declined`, `In Review`, `Expired`, `Abandoned` o `Kyc Expired` no es reutilitzen mai.\n\n**Efectes secundaris:** es genera i s'emmagatzema la URL de verificació allotjada; si `contact_details.send_notification_emails` és `true` i es facilita un correu electrònic, s'envia un correu d'invitació a la verificació. La sessió caduca després del temps de caducitat de sessió configurat al flux de treball. En els fluxos de treball de KYB, s'ignoren `contact_details.phone` i `expected_details`.", "operationId": "post_v3_session_create", "x-didit-sdk": { "resource": "sessions", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "responses": { "201": { "description": "Sessió creada (o retornada, si ja existeix una sessió inacabada amb el mateix `vendor_data` a l'última versió publicada del flux de treball). La resposta és la sessió serialitzada, incloent-hi la `url` de verificació allotjada a la qual redirigir l'usuari.", "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 únic de la sessió de verificació. Utilitza aquest id en cridar `GET /v3/session/{sessionId}/decision/`.", "example": "11111111-2222-3333-4444-555555555555" }, "session_number": { "type": "integer", "description": "Número seqüencial i fàcil de llegir assignat a la sessió dins de la teva aplicació. Útil per a suport i taulers.", "example": 43762 }, "session_token": { "type": "string", "description": "Token segur per a URL de 12 caràcters que autoritza l'usuari final a accedir al flux de verificació allotjat a `url`. Vàlid fins que caduqui la sessió. Tracta'l com un secret: qualsevol persona que el tingui pot obrir el flux de verificació d'aquesta sessió.", "example": "3FaJ9wLqX2Mz" }, "url": { "type": "string", "format": "uri", "description": "URL de verificació allotjada a la qual redirigir l'usuari final. L'URL incrusta el `session_token` i, si està configurat, utilitza el teu domini de marca blanca. Quan la sol·licitud inclou `language`, l'URL conté un segment de ruta d'idioma — `https://verify.didit.me/{language}/session/{session_token}` (p. ex. `/es/session/...`); sense `language`, el segment s'omet.", "example": "https://verify.didit.me/session/3FaJ9wLqX2Mz" }, "vendor_data": { "type": "string", "nullable": true, "description": "Identificador que has passat a la sol·licitud per vincular la sessió a un usuari o a una empresa del teu propi sistema. Es retorna exactament igual. Null quan no s'ha proporcionat.", "example": "user-123" }, "metadata": { "description": "Payload JSON arbitrari que vas emmagatzemar amb la sessió en el moment de la creació. Es retorna literalment: qualsevol valor JSON que hagis enviat (objecte, cadena, número, matriu) es retorna tal qual, tot i que es recomana un objecte JSON. No es mostra a l'usuari final. Sempre present a les respostes; `null` quan no s'ha proporcionat en crear-la.", "example": { "user_type": "premium", "account_id": "ABC123" } }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Les etiquetes de la sessió, per nom.", "example": [ "VIP", "ONBOARDING Q4" ] }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Estat actual de la sessió. Les sessions acabades de crear retornen `Not Started`. Si ja existia una sessió no finalitzada per al mateix `vendor_data` a l'última versió publicada del flux de treball, l'estat retornat reflecteix aquesta sessió existent.", "example": "Not Started" }, "callback": { "type": "string", "format": "uri", "nullable": true, "description": "URL de redirecció final a la qual s'envia l'usuari després de completar el flux. Didit afegeix `?verificationSessionId={session_id}&status={status}` a aquesta URL. Si no s'indica a la sol·licitud, s'utilitza per defecte la URL de callback configurada al flux de treball; serà `null` si no se n'ha configurat cap de les dues. Si l'aplicació té dominis permesos i aquesta URL és una URL web externa a aquests dominis (per exemple, un valor per defecte del flux de treball configurat abans que canviés la llista), el flux allotjat no hi redirigeix l'usuari.", "example": "https://example.com/verification/callback" }, "workflow_id": { "type": "string", "format": "uuid", "description": "Identificador estable del flux de treball en què s'executa aquesta sessió. Sempre és l'identificador de grup estable del flux de treball: fins i tot si has fet referència a un UUID de versió de flux de treball específic a la sol·licitud (cerca compatible amb versions anteriors), la resposta conté el `workflow_id` estable. Utilitza'l per correlacionar la sessió amb el flux de treball que hagis configurat a la Console.", "example": "11111111-2222-3333-4444-555555555555" }, "workflow_version": { "type": "integer", "description": "Número de versió de la versió publicada del flux de treball a la qual es va fixar la sessió en crear-se. Didit resol `workflow_id` a la darrera versió publicada del flux de treball quan es crea la sessió, i la sessió continua executant aquesta versió encara que el flux de treball es torni a publicar més endavant.", "example": 3 } } }, "examples": { "KYC session": { "summary": "Sessió de 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": "Sessió de 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": "Sol·licitud incorrecta — el payload no ha superat la validació (`workflow_id` absent o desconegut, `language` no vàlid, `vendor_data` a la llista de bloqueig, `portrait_image` amb format incorrecte, `address` sense `country`/`poa_country`, `sandbox_scenario` no vàlid, documents de `sign`, camps o valors que el pas de Signatura electrònica del flux de treball rebutja, com ara `signature_document_not_supported`, `signature_document_conversion_failed`, `field_anchor_not_found` o `field_value_missing`, etc.) o la teva organització no té prou crèdits per iniciar la sessió.\n\nEl cos és un objecte indexat pel nom del camp afectat (o `detail` per a errors no vinculats a un camp). Els valors són una **matriu de cadenes** per a fallades de validació d'entrada (p. ex., camp obligatori absent, idioma no vàlid, imatge de retrat massa gran) i una **cadena simple** per a fallades detectades en crear la sessió (`workflow_id` desconegut, `vendor_data` a la llista de bloqueig, cap cara de referència disponible per a un flux de treball de Coincidència facial). Gestiona ambdós formats.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir per a errors no relacionats amb camps (p. ex., crèdits insuficients). Els errors a nivell de camp utilitzen el nom del camp com a clau, amb un valor de tipus cadena o una matriu de cadenes.", "example": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } }, "examples": { "Missing workflow_id": { "summary": "S'ha omès un camp obligatori (format de matriu de cadenes)", "value": { "workflow_id": [ "This field is required." ] } }, "Invalid workflow_id": { "summary": "workflow_id desconegut (format de cadena de text plana)", "value": { "workflow_id": "Invalid workflow_id." } }, "Insufficient credits": { "summary": "L'organització s'ha quedat sense crèdits", "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 és a la llista de bloqueig", "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ó de mida", "value": { "portrait_image": [ "Image size exceeds 2MB." ] } }, "No stored face for vendor_data": { "summary": "Flux de treball de Coincidència facial sense portrait_image i sense cara emmagatzemada per a l'usuari 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": "Flux de treball de Coincidència facial sense portrait_image i sense 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": "L'autenticació o l'autorització han fallat. Una clau incorrecta, revocada o caducada retorna `401`. L'endpoint retorna `403` quan falta la capçalera `x-api-key` o la clau d'API és vàlida però el client no té permís per crear sessions en aquesta aplicació (per exemple, la clau d'API pertany a una organització diferent). Aquestes fallades comparteixen el cos `{\"detail\": \"You do not have permission to perform this action.\"}`. Comprova que la capçalera `x-api-key` estigui present i pertanyi a l'aplicació prevista, torna a obtenir la clau d'API de l'aplicació mitjançant l'[Auth API](/ca/auth-api/get-credentials) si cal, i reintenta-ho.\n\n**Aplicació eliminada:** durant uns minuts després d'eliminar una aplicació, una sol·licitud feta amb una de les seves claus d'API pot respondre `{\"detail\": \"This application was deleted.\", \"code\": \"application_deleted\"}`. No ho reintentis: l'aplicació i les seves claus d'API ja no existeixen. Després d'aquests minuts, la clau es rebutja com qualsevol altra clau 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": "Motiu llegible per màquina, present només en algunes fallades. `application_deleted`: la clau d'API pertany a una aplicació que s'ha suprimit.", "example": "application_deleted" } }, "required": [ "detail" ] }, "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key` o clau d'API no vàlida", "value": { "detail": "You do not have permission to perform this action." } }, "No permission": { "summary": "El client no pot crear sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Application deleted": { "summary": "Clau d'API d'una aplicació suprimida", "value": { "detail": "This application was deleted.", "code": "application_deleted" } } } } } }, "429": { "description": "S'ha superat el límit de freqüència: més de 600 sol·licituds de creació de sessió en una finestra de 60 segons des de la mateixa clau d'API / IP. Revisa `Retry-After` i redueix la freqüència abans de reintentar.\n\n**Nota:** El codi font també defineix un `FREE_SESSION_RATE_LIMIT` de 10 crides/minut juntament amb `PAID_SESSION_RATE_LIMIT=600` (`sessions/serializers/session.py`), però aquest sostre del pla gratuït **no s'aplica a aquest endpoint V3**; el middleware de límit de freqüència aplica el `SESSION_CREATE_RATE_LIMIT` de 600/min independentment del pla. 600/min és l'únic límit amb què et pots trobar aquí.", "headers": { "Retry-After": { "description": "Segons que el client ha d'esperar abans de reintentar la sol·licitud.", "schema": { "type": "integer", "minimum": 1, "example": 42 } }, "X-RateLimit-Limit": { "description": "Nombre màxim de sol·licituds permeses a la finestra actual de 60 segons per al límit superat (600 per a la creació de sessions). Absent a la variant sandbox-quota.", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Nombre de sol·licituds que encara es permeten a la finestra actual per al límit superat. Absent a la variant sandbox-quota.", "schema": { "type": "integer", "minimum": 0, "example": 0 } }, "X-RateLimit-Reset": { "description": "Segons d'època UTC en què es reinicia la finestra actual de límit de freqüència. Absent a la variant de quota de sandbox.", "schema": { "type": "integer", "minimum": 0, "example": 1747497600 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Explicació fàcil de llegir de la superació del límit de freqüència. Utilitza aquest missatge per distingir quin dels tres límits s'ha assolit.", "example": "Session creation rate limit exceeded. You can make up to 600 requests per minute." } } }, "examples": { "Session-create limit": { "summary": "Més de 600 sol·licituds de creació de sessió per minut", "value": { "detail": "Session creation rate limit exceeded. You can make up to 600 requests per minute." } }, "Sandbox session quota": { "summary": "L'aplicació de sandbox ha superat les 500 sessions en 24 hores", "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 flux de treball que defineix quins passos de verificació executarà la sessió. Els fluxos de treball es creen i es gestionen a la pàgina [Workflows](/ca/console/workflows) de la Console. El `workflow_id` també selecciona implícitament si la sessió és de KYC o de KYB.", "example": "11111111-2222-3333-4444-555555555555", "x-readme-id": "0.0" }, "vendor_data": { "type": "string", "description": "Un identificador únic per a l'usuari que s'està verificant, com ara un UUID, correu electrònic o ID d'usuari intern. Aquest camp s'utilitza per a: (1) **Agrupament d'usuaris**: les sessions amb el mateix vendor_data s'enllacen al mateix perfil d'usuari a la pestanya Usuaris. (2) **Detecció de duplicats entre sessions**: quan es cerquen cares, documents, números de telèfon, correus electrònics, adreces IP o empremtes digitals de dispositiu duplicades, les sessions amb el mateix vendor_data es tracten com el mateix usuari i s'exclouen de les coincidències. Sense vendor_data, cada sessió es tracta com un usuari únic i es mostren tots els possibles duplicats. Recomanem fermament proporcionar sempre un vendor_data per reduir el soroll en la detecció de duplicats.", "example": "user-123", "x-readme-id": "0.1" }, "multi_account_segment": { "type": "string", "maxLength": 64, "description": "Àmbit opcional de detecció de duplicats dins de la teva organització. Les comprovacions de cares duplicades comparen aquesta sessió només amb altres sessions que tinguin el mateix segment, de manera que bases de comptes separades (comptes personals i d'empresa, o un per cada subclient B2B) no marquin una persona que legítimament té un compte a cadascuna. Omet-lo per utilitzar l'únic àmbit per defecte, que és el que utilitzen totes les sessions actualment. Les coincidències de llista de bloqueig i de llista d'admesos ignoren aquest camp.", "example": "business-accounts" }, "callback": { "type": "string", "description": "URL a la qual redirigir l'usuari un cop completada la verificació. Didit afegeix automàticament `verificationSessionId` i `status` (Approved, Declined, In Review) com a paràmetres de consulta. S'admeten esquemes d'URL personalitzats (p. ex., `myapp://`) per a callbacks mòbils. Si s'omet, s'utilitza la `callback_url` per defecte del flux de treball. Quan l'aplicació té dominis permesos (`allowed_domains` a `PATCH /v3/webhook/`), un callback `http` o `https` ha de pertànyer a un d'aquests orígens (mateix esquema, amfitrió i port); en cas contrari, la sol·licitud falla amb un error 400 a `callback`: `callback must be on one of the application's allowed domains: https://app.example.com`. Els esquemes d'URL personalitzats sempre s'accepten.", "example": "https://example.com/verification/callback", "x-readme-id": "0.2" }, "callback_method": { "type": "string", "description": "Determina quin dispositiu ha de gestionar la redirecció a la URL de callback proporcionada. Utilitza `initiator` per redirigir només el dispositiu que ha iniciat el flux, `completer` per al dispositiu que el finalitza o `both` per permetre que qualsevol dels dos dispositius activi el callback. Si mai observes que el callback no s'activa de manera fiable, et recomanem establir aquest valor a `both`.", "enum": [ "initiator", "completer", "both" ], "default": "initiator", "example": "both", "x-readme-id": "0.3" }, "metadata": { "description": "JSON arbitrari emmagatzemat amb la sessió i retornat en la resposta i als webhooks. S'accepta qualsevol valor JSON (objecte, cadena, número, matriu), però es recomana un objecte JSON de parells clau/valor. No es mostra a l'usuari final. Utilitza'l per passar els teus propis identificadors de correlació, variants A/B o context empresarial.", "example": { "user_type": "premium", "account_id": "ABC123" }, "x-readme-id": "0.4" }, "tags": { "type": "array", "items": { "type": "string", "maxLength": 50 }, "maxItems": 10, "description": "Etiquetes afegides a la sessió quan es crea, pel seu nom. Fins a 10, de fins a 50 caràcters cadascuna. Els noms no distingeixen majúscules de minúscules i s'emmagatzemen en majúscules. Un nom que encara no existeixi a l'aplicació es crea com a etiqueta nova. Les etiquetes es mostren a la sessió a la consola, on pots filtrar-hi.", "example": [ "VIP", "ONBOARDING Q4" ] }, "language": { "type": "string", "description": "Codi d'idioma (ISO 639-1) per a la interfície del procés de verificació. Controla l'idioma mostrat a l'usuari final durant la verificació. Si no s'indica, l'idioma del navegador es detectarà automàticament i s'utilitzarà. Consulta tots els idiomes admesos [aquí](/ca/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ó de contacte de l'usuari que es pot utilitzar per a notificacions, emplenament previ de formularis de verificació i verificació de telèfon. Això inclou l'adreça de correu electrònic, l'idioma preferit per a les comunicacions i el número de telèfon.", "example": { "email": "john.doe@example.com", "send_notification_emails": true, "email_lang": "en", "phone": "+14155552671" }, "properties": { "email": { "type": "string", "format": "email", "description": "Adreça de correu electrònic de l'usuari (p. ex., \"john.doe@example.com\") que s'utilitzarà durant el pas de [Verificació de correu electrònic](/ca/core-technology/email-verification/overview). Si no es proporciona, l'usuari l'haurà d'introduir durant el flux de verificació.", "example": "john.doe@example.com", "x-readme-id": "1.0" }, "send_notification_emails": { "type": "boolean", "default": false, "description": "Si és true i es proporciona un correu electrònic, Didit envia el correu inicial \"Verifica la teva identitat\" de manera asíncrona quan es crea la sessió de Verificació d'usuaris (KYC) o Verificació d'empreses (KYB). Didit també envia notificacions sobre l'estat de la verificació a l'adreça de correu electrònic proporcionada per a les sessions que requereixen revisió manual (p. ex., de 'En revisió' a 'Aprovada' o 'Rebutjada'). Això ajuda els usuaris a tornar a la teva aplicació un cop finalitzada la verificació. Si tens la marca blanca activada per a la sessió, el correu enviat serà de marca blanca.", "example": true, "x-readme-id": "1.1" }, "email_lang": { "type": "string", "description": "Codi d'idioma (ISO 639-1) per a les notificacions per correu electrònic. Controla l'idioma de totes les comunicacions per correu electrònic (p. ex., \"en\", \"es\", \"fr\"). No hi ha cap valor per defecte desat: quan s'omet, el correu electrònic d'invitació a la verificació simplement torna a l'anglès (`en`) en el moment de l'enviament. L'enum següent és una instantània; la font de referència activa dels valors acceptats és el document d'[idiomes admesos](/ca/integration/supported-languages); consulta'l sempre abans de confiar en un codi específic.", "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èfon en format E.164 (p. ex., \"+14155552671\") que s'utilitzarà durant el pas de [Verificació de telèfon](/ca/core-technology/phone-verification/overview). Si no es proporciona, l'usuari l'haurà d'introduir durant el flux de verificació. S'ignora per als fluxos de treball de Verificació d'empreses (KYB). **Important:** aquest número de telèfon només s'aplica si és un número de telèfon E.164 vàlid. Si el número proporcionat no és vàlid o no es pot analitzar, s'ignorarà i l'usuari podrà introduir qualsevol número de telèfon vàlid durant el pas de Verificació de telèfon.", "example": "+14155552671", "x-readme-id": "1.3" } }, "x-readme-id": "0.4" }, "expected_details": { "type": "object", "description": "Detalls d'usuari esperats utilitzats per a la validació creuada amb les dades extretes del document d'identitat de l'usuari, el Comprovant de domicili i altres passos de verificació. Les discrepàncies es mostren com a advertències a la decisió; alguns camps (p. ex. `id_country`, `expected_document_types`) també modifiquen el flux visible per a l'usuari. En fluxos de treball de Verificació d'empreses (KYB) només s'utilitzen els camps de l'empresa (`company_name`, `registry_country`, `registration_number`) —emplenen prèviament la cerca al registre mercantil per a l'usuari— i s'ignoren tots els camps de nivell de 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": "Nom de pila de l'usuari. Per exemple, `John`. La coincidència utilitza una comparació aproximada, i pots ajustar el nivell d'exigència configurant el llindar de la puntuació de coincidència de noms a la consola tant per als fluxos de treball de Document d'identitat com de Comprovant de domicili.", "example": "John", "x-readme-id": "1.0" }, "last_name": { "type": "string", "description": "Cognom de l'usuari. Per exemple, `Doe`. La coincidència utilitza una comparació aproximada, i pots ajustar el nivell d'exigència configurant el llindar de la puntuació de coincidència de noms a la consola tant per als fluxos de treball de Document d'identitat com de Comprovant de domicili.", "example": "Doe", "x-readme-id": "1.1" }, "date_of_birth": { "type": "string", "format": "date", "description": "Data de naixement de l'usuari en format: YYYY-MM-DD. Per exemple, `1990-05-15`.", "example": "1990-05-15", "x-readme-id": "1.2" }, "gender": { "type": "string", "nullable": true, "enum": [ "M", "F" ], "default": null, "description": "Gènere de l'usuari. Ha de ser 'M', 'F' o null.", "example": "M", "x-readme-id": "1.3" }, "nationality": { "type": "string", "description": "Codi de país ISO 3166-1 alpha-3 que representa el país d'origen del sol·licitant. Per exemple, `USA`. Consulta la [llista completa de codis de país admesos](https://docs.didit.me/ca/core-technology/id-verification/supported-documents-id-verification#documents-admesos-per-país).", "example": "USA", "x-readme-id": "1.4" }, "country": { "type": "string", "description": "Codi de país ISO 3166-1 alpha-3 utilitzat com a alternativa per a les comprovacions de discrepància de país tant de Verificació d'identitat com de Comprovant de domicili. Obligatori quan es proporciona `address` i no s'ha definit ni `id_country` ni `poa_country`.", "example": "USA", "x-readme-id": "1.4.1" }, "id_country": { "type": "string", "description": "Codi de país ISO 3166-1 alpha-3 que representa el país esperat del document d'identitat del sol·licitant, que pot ser diferent de la nacionalitat. Per exemple, `GBR`. Té prioritat sobre `country` per a les comprovacions de discrepància de país de Verificació d'identitat. Consulta la [llista completa de codis de país admesos](https://docs.didit.me/ca/core-technology/id-verification/supported-documents-id-verification#documents-admesos-per-país).", "example": "GBR", "x-readme-id": "1.5" }, "poa_country": { "type": "string", "description": "Codi de país ISO 3166-1 alpha-3 que representa el país esperat del document del comprovant de domicili. Per exemple, `USA`. Té prioritat sobre `country` per a les comprovacions de discrepància de país del comprovant de domicili. Consulta la [llista completa de codis de país admesos](https://docs.didit.me/ca/core-technology/id-verification/supported-documents-id-verification#documents-admesos-per-país).", "example": "USA", "x-readme-id": "1.5.1" }, "address": { "type": "string", "description": "L'adreça en un format llegible per humans, que inclou tanta informació com sigui possible. Per exemple, `123 Main St, San Francisco, CA 94105, USA`. Quan es proporciona, també has d'enviar `country` o `poa_country`, altrament la sol·licitud falla amb un `400`.", "example": "123 Main St, San Francisco, CA 94105, USA", "x-readme-id": "1.6" }, "identification_number": { "type": "string", "description": "El número de document, número personal o identificador fiscal de l'usuari. Per exemple, `123456789`.", "example": "123456789", "x-readme-id": "1.7" }, "ip_address": { "type": "string", "description": "Adreça IP esperada per a la sessió, en format IPv4 o IPv6. Si l'adreça IP real difereix d'aquest valor, es registrarà una advertència. Per exemple, `192.168.1.100` o `2001:db8::1`.", "example": "192.168.1.100", "x-readme-id": "1.8" }, "expected_document_types": { "type": "array", "description": "Restringeix els tipus de document que l'usuari pot presentar durant el pas de verificació d'identitat (OCR). Quan s'estableix, la pantalla de selecció de documents només mostra els tipus sol·licitats i el valor retornat `documents_allowed` es filtra en conseqüència. Els valors no distingeixen entre majúscules i minúscules i es desdupliquen; els valors desconeguts es rebutgen amb `400`. Codis permesos: `P` (passaport), `ID` (document d'identitat nacional), `DL` (permís de conduir), `RP` (permís de residència), `HIC` (targeta d'assegurança mèdica), `TC` (targeta d'identificació fiscal), `SSC` (targeta de la seguretat 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": "Raó social esperada de l'empresa que s'està verificant. Per exemple, `Tesco PLC`. Emplena prèviament el camp del nom de l'empresa de la cerca al registre mercantil en fluxos de treball de Verificació d'empreses (KYB); quan també es proporciona `registration_number`, la cerca al registre mercantil combina tots dos identificadors. S'ignora en fluxos de treball de KYC.", "example": "Tesco PLC", "x-readme-id": "1.10" }, "registry_country": { "type": "string", "maxLength": 10, "description": "Codi ISO 3166-1 alfa-2 del país en el registre mercantil del qual està inscrita l'empresa. Per exemple, `GB`. On els registres mercantils operen a escala d'estat o província, afegeix el codi de subdivisió ISO 3166-2 en format `XX-YY`: `US-CA` s'adreça al registre de Califòrnia. El mateix format que `country_code` a la [KYB Registry Search API](https://docs.didit.me/ca/standalone-apis/kyb-registry-search). Preselecciona el país del registre als fluxos de treball de Verificació d'empreses (KYB); s'ignora per als fluxos de treball de KYC.", "example": "US-CA", "x-readme-id": "1.11" }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registre esperat de l'empresa al registre mercantil. Per exemple, `00445790`. Emplena prèviament el camp del número de registre de la cerca al registre mercantil en fluxos de treball de Verificació d'empreses (KYB); quan també es proporciona `company_name`, la cerca al registre mercantil combina tots dos identificadors. S'ignora en fluxos de treball de KYC.", "example": "00445790", "x-readme-id": "1.12" } }, "x-readme-id": "0.5" }, "portrait_image": { "type": "string", "format": "byte", "description": "Imatge de retrat de la cara de l'usuari final codificada en base64 (màx. 2 MB; JPEG, PNG, WebP o TIFF). S'utilitza com a imatge de referència per comparar-la amb la captura de prova de vida quan el flux de treball és de tipus `Biometric Authentication` amb Coincidència facial activada, o qualsevol flux de treball en graf on Coincidència facial s'executi abans de Verificació d'identitat (OCR). Opcional quan l'usuari de `vendor_data` ja té una imatge facial emmagatzemada: Didit la reutilitza automàticament, seguint aquest ordre de prioritat: cara de prova de vida aprovada, foto del xip de l'ePassport, retrat del document d'identitat, cara del perfil registrada manualment (només es reutilitzen cares de sessions aprovades o cares que hagis registrat tu mateix). Quan es proporciona, `portrait_image` sempre té prioritat sobre la cara emmagatzemada. Si s'omet i no existeix cap cara emmagatzemada (o no s'envia `vendor_data`), la creació de la sessió falla amb `400`. S'ignora per a altres tipus de flux de treball.", "example": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=", "x-readme-id": "0.6" }, "sandbox_scenario": { "type": "string", "description": "Slug de l'escenari només per al sandbox. Només s'accepta quan la clau d'API pertany a una aplicació en mode sandbox; es rebutja en aplicacions de producció. Quan s'estableix, el flux de creació desplega els valors màgics inclosos de l'escenari als camps d'entrada de la sessió (contact_details, expected_details) perquè els proveïdors simulats reprodueixin el resultat de l'escenari a través de la canalització del flux de treball real. Consulta el catàleg d'escenaris a GET /v1/sandbox/scenarios/ o [Sandbox i dades de prova](/ca/integration/sandbox-testing). També pots activar (o reactivar) un escenari després de la creació mitjançant POST /v3/session/{sessionId}/sandbox/arm/, sempre que la sessió estigui encara en estat `Not Started`. Per a cerques sense document, utilitza `lookup_partial_match`, `lookup_no_match` o `lookup_provider_error` per provar el pressupost d'intents configurat i l'alternativa. Per a carteres d'identitat, utilitza `wallet_cancelled`, `wallet_timeout` o `wallet_provider_error`; `approve` simula una cartera verificada. Totes les carteres del catàleg es poden provar al sandbox, inclosos els esquemes no disponibles en aplicacions de producció. Els intents simulats no es cobren.", "example": "decline_document_expired" }, "sign": { "type": "object", "description": "Entrada de signatura electrònica per a aquesta sessió. `documents` són els documents que cal signar, per a un flux de treball el pas de Signatura electrònica del qual agafa documents de la sessió (`signature_documents_source` `session` o `both`): fins a 20 documents i 50 MB en total. `field_values` emplena els camps el `prefill` dels quals és `api.`, tant en documents del flux de treball com de la sessió. Crear una sessió de nou per al mateix `workflow_id` i `vendor_data` retorna la sessió pendent; si aquesta crida envia `sign`, els seus documents, camps i valors han de ser idèntics als primers, i qualsevol diferència retorna `400` amb `{\"sign\": \"signature_document_changed\"}`. Consulta [Documents de signatura electrònica](/ca/sessions-api/create-session#documents-de-signatura-electrònica).", "properties": { "documents": { "type": "array", "minItems": 1, "maxItems": 20, "items": { "$ref": "#/components/schemas/SessionSignDocument" } }, "field_values": { "type": "object", "description": "Valors indexats per la `` de cada font d'emplenament previ `api.`: cadenes d'1 a 500 caràcters per a camps `text` i `data`, booleans per a un `checkbox`. Retorna `400` amb `field_value_unknown` per a una clau que cap camp no utilitza, `field_value_missing` per a un camp obligatori sense el seu valor i `field_value_invalid` per a un valor que no supera la validació del seu camp.", "additionalProperties": { "oneOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "boolean" } ] }, "example": { "credit_limit": "3,000 EUR" } } } }, "user_state": { "type": "string", "maxLength": 16, "description": "On viu la persona, quan es coneix: un codi de subdivisió ISO 3166-2 (`US-IL`, `ES-M`) o un codi o nom d'estat dels EUA (`IL`, `Illinois`). Un estat la legislació del qual requereixi el consentiment biomètric explícit (Illinois, Texas, Colorado) fa que el flux de verificació el sol·liciti abans de capturar una cara, amb l'activador `declared_state`. Un valor no reconegut retorna `400`. Consulta [Consentiment biomètric](/ca/getting-started/biometric-consent).", "example": "US-IL" }, "biometric_consent": { "type": "object", "description": "Consentiment biomètric explícit que ja has recollit de la persona. Compleix el requisit, de manera que el flux de verificació no el torna a demanar, i la decisió el registra com a `status: \"given\"` amb l'activador `customer_collected`. Mai se substitueix una resposta que la persona ja hagi donat al flux. Consulta [Consentiment biomètric](/ca/getting-started/biometric-consent).", "required": [ "given_at", "text_version" ], "properties": { "given_at": { "type": "string", "format": "date-time", "description": "Quan la persona va donar el consentiment biomètric explícit (ISO 8601). No pot ser en el futur." }, "text_version": { "type": "string", "maxLength": 64, "description": "Identificador de versió del text de consentiment que la persona ha acceptat, en els teus propis registres." } } } }, "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 complet del cas d'èxit per a una sessió de Verificació d'usuaris (KYC)", "description": "Crida de creació realista que utilitza tots els camps habituals: selecció del flux de treball, vinculació del proveïdor, encaminament de callbacks, metadades, configuració regional, emplenament previ de contacte i dades esperades de l'usuari. Copia i enganxa això directament a l'exemple de cURL superior.", "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 cas d'èxit per a una sessió de Verificació d'empreses (KYB)", "description": "La mateixa estructura que la crida de KYC; el `workflow_id` és el que fa que la sessió sigui de KYB. `vendor_data` normalment fa referència a l'empresa al teu sistema i `contact_details.email` s'adreça al representant legal que completarà el flux. `expected_details` accepta els camps d'empresa (`company_name`, `registry_country`, `registration_number`), que emplenen prèviament la cerca al registre mercantil; els camps de persona i `contact_details.phone` s'ignoren per als fluxos de treball 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": "Crea una tasca d'importació de verificacions", "description": "Crea una feina d'importació asíncrona per a sessions històriques de Verificació d'usuaris, sessions de Verificació d'empreses, registres de monitoratge de transaccions o regles d'estat personalitzat de fluxos de treball. Estableix `source=provider` per migrar des d'un altre proveïdor: Didit llegeix Sumsub, Onfido, Persona i ComplyCube amb la teva clau de només lectura, llegeix els registres de Veriff, iDenfy i MetaMap mitjançant els ID que pugis a `file`, i importa un fitxer d'exportació en el format de Didit per a la resta de proveïdors. Els ID dels registres s'organitzen en espais de noms per proveïdor (`sumsub:`), de manera que una nova execució omet tot allò que ja es troba a Didit, i els registres importats mitjançant un fitxer amb l'ID simple del proveïdor també es reconeixen en ambdues direccions; així, passar d'una importació per fitxer a una migració des de proveïdor mai no importa un registre dues vegades. Una aplicació pot executar fins a 4 feines d'importació alhora; una feina interrompuda per un desplegament o un reinici d'un procés de treball continua automàticament des de la seva darrera fila importada. Les importacions estan inhabilitades per defecte i Didit les ha d'habilitar per organització.", "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: sessions històriques de Verificació d'usuaris, sessions històriques de Verificació d'empreses, regles d'estat personalitzades del flux de treball o registres històrics de monitoratge de transaccions." }, "workflow_id": { "type": "string", "format": "uuid", "description": "UUID del flux de treball al qual s'han d'adjuntar les sessions o regles d'estat importades. Obligatori per a user_verification, business_verification i status_rules. Omet-ho per a les transaccions." }, "source_format": { "type": "string", "enum": [ "csv", "ndjson" ], "description": "Opcional. S'infereix de l'extensió del fitxer penjat quan s'omet." }, "file": { "type": "string", "format": "binary", "description": "Fitxer canònic en format CSV o NDJSON. Fes servir NDJSON per a importacions grans. Mida màxima de càrrega de 25 MB (fes servir `source_file_url` per a fitxers més grans). Mútuament excloent amb `source_file_url`." }, "source_file_url": { "type": "string", "format": "uri", "description": "Alternativa a la càrrega de fitxers. Ha de ser una URL HTTPS que apunti a una adreça pública (es rebutgen les xarxes privades o de loopback). Mútuament excloent amb `file`." }, "source": { "type": "string", "enum": [ "file", "provider" ], "description": "`provider` fa que això sigui una migració des d'un altre proveïdor de verificació d'identitat. Omet-ho per a una importació de fitxers." }, "provider": { "type": "string", "enum": [ "sumsub", "jumio", "veriff", "onfido", "persona", "metamap", "socure", "idnow", "shufti", "idenfy", "ondato", "trulioo", "au10tix", "complycube", "other" ], "description": "Origen de la migració, de `GET /v3/session/imports/providers/`. Obligatori quan `source` és `provider`." }, "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "La clau de només lectura del proveïdor, amb els noms de camp que enumera `credential_fields`. Xifrada en repòs, mai no es retorna i s'elimina quan finalitza la importació. Envia-la com una cadena JSON a multipart." }, "options": { "type": "object", "properties": { "region": { "type": "string", "description": "La regió del proveïdor, una de les seves `regions` (Onfido: `eu`, `us`, `ca`)." } } }, "status_mapping": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Not Finished", "Abandoned" ] }, "description": "Modificacions del mapatge d'estats per defecte del proveïdor: de l'estat d'origen a l'estat de Didit. `Not Finished` i `Abandoned` s'ometen i es comptabilitzen, mai s'importen." }, "dry_run": { "type": "boolean", "default": false, "description": "Compta el que importaria la migració (per estat, ja a Didit, mateixa persona, no finalitzat) i no escriu res. La tasca acaba en `READY`; inicia-la amb `POST /v3/session/imports/{importId}/start/`." }, "face_templates": { "type": "boolean", "default": false, "description": "Genera plantilles biomètriques a partir de les selfies importades i cerca-les a les cares i la llista de bloqueig de l'aplicació. Les coincidències només es marquen per a revisió. Requereix `lawful_basis_confirmed`." }, "lawful_basis_confirmed": { "type": "boolean", "default": false, "description": "Confirma que disposes d'una base jurídica per compartir aquestes selfies amb Didit com a encarregat del tractament." } } } }, "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: sessions històriques de Verificació d'usuaris, sessions històriques de Verificació d'empreses, regles d'estat personalitzades del flux de treball o registres històrics de monitoratge de transaccions." }, "workflow_id": { "type": "string", "format": "uuid", "description": "UUID del flux de treball al qual s'han d'adjuntar les sessions o regles d'estat importades. Obligatori per a user_verification, business_verification i status_rules. Omet-ho per a les transaccions." }, "source_format": { "type": "string", "enum": [ "csv", "ndjson" ], "description": "Opcional. S'infereix de l'extensió de fitxer de la URL quan s'omet." }, "source_file_url": { "type": "string", "format": "uri", "description": "Alternativa a la càrrega de fitxers. Ha de ser una URL HTTPS que apunti a una adreça pública (es rebutgen les xarxes privades o de loopback). Mútuament excloent amb `file`." }, "source": { "type": "string", "enum": [ "file", "provider" ], "description": "`provider` fa que això sigui una migració des d'un altre proveïdor de verificació d'identitat. Omet-ho per a una importació de fitxers." }, "provider": { "type": "string", "enum": [ "sumsub", "jumio", "veriff", "onfido", "persona", "metamap", "socure", "idnow", "shufti", "idenfy", "ondato", "trulioo", "au10tix", "complycube", "other" ], "description": "Origen de la migració, de `GET /v3/session/imports/providers/`. Obligatori quan `source` és `provider`." }, "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "La clau de només lectura del proveïdor, amb els noms de camp que enumera `credential_fields`. Xifrada en repòs, mai no es retorna i s'elimina quan finalitza la importació. Envia-la com una cadena JSON a multipart." }, "options": { "type": "object", "properties": { "region": { "type": "string", "description": "La regió del proveïdor, una de les seves `regions` (Onfido: `eu`, `us`, `ca`)." } } }, "status_mapping": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Not Finished", "Abandoned" ] }, "description": "Modificacions del mapatge d'estats per defecte del proveïdor: de l'estat d'origen a l'estat de Didit. `Not Finished` i `Abandoned` s'ometen i es comptabilitzen, mai s'importen." }, "dry_run": { "type": "boolean", "default": false, "description": "Compta el que importaria la migració (per estat, ja a Didit, mateixa persona, no finalitzat) i no escriu res. La tasca acaba en `READY`; inicia-la amb `POST /v3/session/imports/{importId}/start/`." }, "face_templates": { "type": "boolean", "default": false, "description": "Genera plantilles biomètriques a partir de les selfies importades i cerca-les a les cares i la llista de bloqueig de l'aplicació. Les coincidències només es marquen per a revisió. Requereix `lawful_basis_confirmed`." }, "lawful_basis_confirmed": { "type": "boolean", "default": false, "description": "Confirma que disposes d'una base jurídica per compartir aquestes selfies amb Didit com a encarregat del tractament." } } }, "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": "Tasca d'importació acceptada. Consulta periòdicament l'`uuid` retornat fins que `status` sigui `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": "Flux de treball, tipus de fitxer, mida de fitxer, URL d'origen o combinació de selectors no vàlids. Una migració la clau de la qual és rebutjada pel proveïdor respon amb `code` (`invalid_credentials`, `missing_permission`, `wrong_region`, `provider_unavailable`, `rate_limited`, `ids_required`, `record_not_found`), `missing_permissions` i `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": "Importacions no habilitades, aplicació de sandbox o falta la clau d'API (una clau incorrecta, revocada o caducada rep un `401`). Les importacions de verificacions estan inhabilitades per defecte i Didit les ha d'habilitar per a cada organització.", "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": "L'aplicació ja té 4 tasques d'importació actives (PENDING/PROCESSING/PAUSED), el màxim que pot executar alhora. Espera que una finalitzi abans d'iniciar-ne una altra.", "content": { "application/json": { "examples": { "Active job": { "value": { "detail": "This application already has 4 active import jobs, the most it can run at once. Wait for one 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": "Baixa la plantilla d'importació de verificacions", "description": "Descarrega la capçalera CSV canònica per a importacions de verificació. El conjunt de columnes ve determinat per `import_type`. La primera columna de les plantilles de sessió és la clau d'idempotència `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": "Fitxer de plantilla CSV.", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Clau d'API absent, no vàlida o revocada, o bé la clau no pot baixar plantilles d'importació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "summary": "Falta la clau d'API, no és vàlida o està 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": "Recuperar una tasca d'importació de verificacions", "description": "Recupera els comptadors de progrés de la importació i l'estat terminal d'una feina. Consulta periòdicament fins que `status` sigui `COMPLETED` o `FAILED`; un valor de `failed_count` > 0 indica que s'han rebutjat algunes files; consulta-les mitjançant l'endpoint d'errors.", "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": "Estat de la tasca d'importació.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "404": { "description": "No s'ha trobat la tasca d'importació per a aquesta aplicació.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "403": { "description": "Clau d'API absent, no vàlida o revocada, o bé la clau no pot llegir tasques d'importació per a aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "summary": "Falta la clau d'API, no és vàlida o està 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": "Llista els errors de fila de la importació de verificacions", "description": "Llista els errors a nivell de fila d'una tasca d'importació de verificacions, ordenats per `row_number`. Fes servir aquest endpoint per generar un fitxer de reintent corregit que contingui només les files fallides.", "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": "Mida de la pàgina. Per defecte és 50 si s'omet." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Desplaçament basat en zero del primer registre a retornar." } ], "responses": { "200": { "description": "Errors de fila paginats.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Nombre de files d'error: exacte fins a 100, limitat a 100 a partir d'aquí. Confia que `next` sigui `null` per detectar la darrera pàgina." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta de la pàgina següent, o `null` a l'última pàgina." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta de la pàgina anterior, o `null` a 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 s'ha trobat la tasca d'importació per a aquesta aplicació.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "403": { "description": "Clau d'API absent, no vàlida o revocada, o bé la clau no pot llegir tasques d'importació per a aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "summary": "Falta la clau d'API, no és vàlida o està 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": "Recupera la decisió completa d'una sessió de verificació", "description": "Recupera l'informe de decisió complet d'una sessió de verificació: l'`status` consolidat de la sessió més un informe per cada funcionalitat de verificació que hagi executat el flux de treball. Aquest és l'endpoint de lectura canònic tant per a sessions de Verificació d'usuaris (KYC) com de Verificació d'empreses (KYB): la mateixa ruta serveix per a totes dues, i el discriminador de primer nivell `session_kind` indica quina estructura has rebut (`\"user\"` o `\"business\"`).\n\n**Cada informe de funcionalitat és un array en plural.** Els fluxos de treball V3 són grafs que poden executar la mateixa funcionalitat més d'una vegada, de manera que cada bloc (`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`) és un array JSON en què cada element conté un `node_id` que identifica el node del graf del flux de treball que l'ha generat. Llegeix NFC com a `response.nfc_verifications[0]`, mai com un camp singular `nfc`. Un bloc és `null` fins que el flux de treball ha executat aquesta funcionalitat almenys una vegada; les funcionalitats que el flux de treball no inclou mai apareixen amb dades. Els resultats de Signatura electrònica es troben a `signatures`, que només és present quan el flux de treball té un pas de Signatura electrònica.\n\n**Quan cridar-lo.** El patró recomanat es basa en esdeveniments: espera el webhook `status.updated` que es dispara quan la sessió arriba a una decisió (`Approved`, `Declined`, `In Review`), i després crida aquest endpoint una vegada per obtenir l'informe complet. El sondeig també funciona: l'endpoint es pot cridar en qualsevol moment del cicle de vida de la sessió i retorna les dades generades fins aleshores, però el patró de webhook i posterior consulta és més econòmic i ràpid. Els URL multimèdia de la resposta (imatges de documents, vídeos, PDF) són enllaços presignats de curta durada: recupera'ls ràpidament o torna a sol·licitar la decisió per obtenir-ne de nous, i no els conservis com a referències a llarg termini.\n\n**Estats.** L'`status` de primer nivell és l'estat del cicle de vida de la sessió (`Not Started`, `In Progress`, `Awaiting User`, `In Review`, `Approved`, `Declined`, `Resubmitted`, `Expired`, `Kyc Expired`, `Abandoned`). Cada element de funcionalitat inclou, a més, el seu propi `status` a nivell de funcionalitat (`Not Finished`, `Approved`, `Declined`, `In Review`, ...). Una sessió pot estar en estat general `Approved` mentre una funcionalitat individual està `In Review`, segons les regles de decisió del flux de treball.\n\n**Autenticació i visibilitat.** Autentica't amb la clau d'API de l'aplicació a la capçalera `x-api-key` (també funciona un token Bearer d'usuari de la consola amb el permís `read:sessions`). Només són visibles les sessions propietat de l'aplicació autenticada. Si el teu flux de treball restringeix els atributs de resposta, els camps no permesos dins dels elements de funcionalitat es retornen com a `null`, mentre que `status`, `warnings` i `node_id` es conserven sempre.\n\n**Límits de freqüència.** Les sol·licituds GET estan limitades a 600 per minut per clau d'API. Superar el límit retorna `429` amb les capçaleres `Retry-After` i `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 complet de decisió. `session_kind` distingeix les dues estructures: les sessions `user` inclouen les matrius de funcionalitats de KYC que es mostren a continuació; en canvi, les sessions `business` inclouen `registry_checks`, `document_verifications` i `key_people_checks` juntament amb les matrius compartides. Les matrius de funcionalitats són `null` fins que el flux de treball hagi executat aquesta funcionalitat; les URL dels fitxers multimèdia són enllaços presignats de curta durada.", "content": { "application/json": { "examples": { "Example": { "summary": "Exemple complet", "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": "Exemple de sessió d'empresa (KYB)", "description": "Una decisió de `session_kind = \"business\"`: les sessions de KYB substitueixen les matrius de funcionalitats de KYC per `registry_checks`, `document_verifications` i `key_people_checks`, alhora que comparteixen `aml_screenings`, `phone_verifications`, `email_verifications`, `questionnaire_responses`, `ip_analyses`, `reviews` i l'embolcall de la sessió.", "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": "verified", "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": "Ha fallat l'autenticació o l'autorització. Si falta la clau, es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`. Dues cadenes de `detail` distingeixen els tipus d'error:\n\n- `\"Authentication credentials were not provided or are invalid.\"` — no hi ha cap capçalera `x-api-key` (ni cap token `Authorization: Bearer`), o la credencial proporcionada no ha superat la introspecció (revocada, caducada o malformada).\n- `\"You do not have permission to perform this action.\"` — la credencial és vàlida però no té permís per llegir aquesta sessió: a un token Bearer d'usuari de la consola li falta el permís `read:sessions` o no pot accedir a l'aplicació propietària, o bé una clau d'API pertany a una organització diferent de la de la sessió.\n\nTingues en compte que per a un `sessionId` completament desconegut, l'endpoint resol l'aplicació propietària abans de validar les credencials; per tant, una sessió que no existeix retorna `404` fins i tot quan la credencial falta o no és 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 la capçalera x-api-key, o la clau ha fallat la introspecció", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Insufficient permissions": { "summary": "Credencial vàlida sense read:sessions o sense accés a l'aplicació propietària", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Sessió no trobada. Es retorna quan cap sessió activa coincideix amb el `sessionId` proporcionat com a sessió de Verificació d'usuaris (KYC) o de Verificació d'empreses (KYB) — una sessió que s'ha suprimit també arriba aquí. El cos és l'embolcall estàndard `{\"detail\": ...}`.\n\n**Dues cadenes `detail` diferents.** Si el `sessionId` és desconegut tant com a sessió de KYC com de KYB, la cerca del titular prèvia a l'autenticació falla i reps `{\"detail\": \"Not found.\"}` — això passa abans de la validació de credencials, per la qual cosa es retorna fins i tot per a crides no autenticades. Si la sessió existeix però no es pot recuperar sota l'aplicació autenticada (per exemple, un registre obsolet o que s'acaba de suprimir), la vista retorna `{\"detail\": \"Session not found.\"}`. Totes dues indiquen el mateix resultat — la sessió no és accessible —, així que fes la comprovació amb el codi d'estat `404` en lloc de la cadena.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Not found." } } }, "examples": { "Unknown session id": { "summary": "Aquesta aplicació no reconeix sessionId", "value": { "detail": "Not found." } }, "Session not retrievable": { "summary": "La sessió existeix però no es pot recuperar per a aquesta aplicació", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Les sol·licituds GET estan limitades a **600 per minut per credencial** (clau d'API, token Bearer o IP d'origen si no s'ha autenticat). Revisa `Retry-After` / `X-RateLimit-Reset` i redueix la freqüència abans de reintentar. Si assoleixes aquest límit mentre consultes les decisions periòdicament, canvia al webhook `status.updated` i obtén la decisió un sol cop per cada canvi d'estat.", "headers": { "Retry-After": { "description": "Segons d'espera abans de reintentar la sol·licitud.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Nombre màxim de sol·licituds permeses a la finestra actual (600 per a sol·licituds GET).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Marca de temps Unix (segons) en què es reinicia la finestra actual.", "schema": { "type": "integer", "example": 1750000000 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Explicació fàcil de llegir de la superació del límit de freqüència.", "example": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } }, "examples": { "Throttled": { "summary": "Més de 600 sol·licituds GET en un minut des de la mateixa 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 sessió de verificació de la qual vols recuperar la decisió. Aquest és el `session_id` retornat per `POST /v3/session/`. La mateixa ruta funciona tant per a sessions de Verificació d'usuaris (KYC) com de Verificació d'empreses (KYB); el servidor resol l'id per a tots dos tipus de sessió.\n\n**Ha de ser un UUID vàlid.** La ruta només coincideix amb UUIDs ben formats, de manera que el router d'URLs rebutja un valor mal format abans que s'executi qualsevol codi d'aplicació i la resposta és una pàgina **HTML** `404` en lloc de l'embolcall JSON `{\"detail\": ...}` que es mostra a continuació. Valida el format de l'UUID al costat del client per poder distingir un error d'entrada d'un `404` genuí perquè la sessió no existeix.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "include", "in": "query", "required": false, "description": "Llista separada per comes de seccions addicionals del payload. Valors admesos: `events` i `resubmissions`, sols o junts (`events,resubmissions`). Quan es passa `include=events`, la resposta conté a més el cronograma d'esdeveniments de la sessió (`events`, inclosos els esdeveniments d'encaminament `WORKFLOW_BRANCH_EVALUATED` / `WORKFLOW_STATUS_NODE_REACHED` descrits a la pàgina Recuperar la sessió), el registre d'activitat complet (`activity_reviews`), indicadors de llista de bloqueig (`blocklisted`), un `cost_breakdown` per sessió, metadades del flux de treball (`workflow_type`, `workflow_version`, `workflow_version_id` i `workflow_terminal_node_id`: l'últim node d'estat del flux de treball registrat que va establir un estat de la sessió, o `null` si no se n'ha registrat cap; procedència històrica que no s'esborra amb aprovacions manuals, rebutjos o reenviaments, i que se substitueix per un node d'estat del flux de treball posterior) i metadades de la sessió (`api_service` — cadena o `null`, establert només per a sessions d'API independent; `session_type` — `API`, `HOSTED` o `MIGRATED`; `has_device_nfc_support` — booleà). Dos camps canvien respecte a l'estructura bàsica: el discriminador de nivell superior `session_kind` s'**omet** (l'estructura d'esdeveniments només existeix per a sessions d'usuari) i la matriu `features` passa de cadenes simples a objectes `{feature, node_id}`, on la funcionalitat de correu electrònic es comunica com a `EMAIL` en comptes de `EMAIL_VERIFICATION`. Aquesta estructura ampliada la fa servir principalment la consola Didit; la majoria d'integracions d'API haurien d'ometre aquest paràmetre. **Limitació de KYB:** `include=events` només s'aplica a sessions d'usuari (KYC). Les sessions d'empresa (`session_kind = \"business\"`) sempre retornen l'estructura de decisió d'empresa estàndard: `events`, `activity_reviews`, `blocklisted`, `cost_breakdown` i les metadades addicionals de `workflow_*`/sessió mai no es retornen per a sessions d'empresa, i la seva matriu `features` continua sent una matriu de cadenes simples. Amb `include=resubmissions` (tant per a sessions d'usuari com d'empresa) la resposta també conté `resubmissions`: una entrada per sol·licitud de reenviament, de més antiga a més recent, cadascuna amb `number`, `created_at`, `previous_status`, `nodes`, `reasons`, `requested_by` i `results` (el que van retornar els passos reenviats abans de la sol·licitud, sota les mateixes claus i amb la mateixa estructura que els resultats actuals). Cada element de `cost_breakdown` inclou `usage_type`, `price`, `details` i `created_at`: un pas reenviat que s'executa de nou es factura com un element nou.", "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": "Elimina una sessió de verificació (KYC o KYB)", "description": "Elimina una sola sessió de verificació, Verificació d'usuaris (KYC) o Verificació d'empreses (KYB), pel seu `session_id`. L'identificador es resol primer amb les sessions de KYC i després amb les de KYB, de manera que tots dos tipus s'eliminen a través d'aquesta única URL.\n\n**Què s'elimina:**\n- La sessió i cada intent de verificació que conté, inclosos els resultats que un reenviament va substituir: la decisió, les dades extretes, tots els registres de funcionalitats relacionades (verificació d'identitat, cara, prova de vida, coincidència facial, AML, comprovacions de registres, anàlisi d'IP, etc.), les seves revisions i el seu registre d'activitat.\n- Tots els fitxers emmagatzemats propietat de la sessió: fotos de l'anvers/revers del document (variants completes, retallades i desenfocades per privacitat), vídeos de captura de documents, retalls de retrats, imatges de retrat i signatura del xip NFC, imatges de referència facial, vídeos de prova de vida, imatges d'origen/destinació de coincidència facial, documents de Comprovant de domicili i qualsevol fitxer addicional pujat (KYC); documents d'empresa pujats i fitxers addicionals (KYB). Documents de Signatura electrònica, PDF signats, PDF de proves i imatges de signatures (KYC i KYB): les seves rutes de baixada deixen de funcionar. Les URL de mitjans emeses anteriorment (`https:///...`) deixen de resoldre's.\n- Les dades facials de la sessió. El seu embedding facial també s'elimina, tret que triïs conservar una plantilla sense imatges (consulta **Dades biomètriques facials**).\n- Els lliuraments de webhook encara en cua per a la sessió i els seus reintents. Els webhooks ja lliurats no es veuen afectats.\n- Per a una sessió de Verificació d'empreses (KYB): les verificacions que va crear per a les seves persones clau (KYC) i els seus propietaris corporatius (KYB), de manera recursiva, notificades com a `deleted_child_verifications`. Una verificació a la qual només enllaça, com ara un KYC aprovat existent que hagi reutilitzat, no s'elimina.\n\nLa sessió desapareix de tots els endpoints de lectura immediatament: `GET /v3/session/{sessionId}/decision/` retorna `404` i `GET /v3/sessions/` deixa de llistar-la. El monitoratge AML continu i el monitoratge de registres mercantils de KYB iniciats per les verificacions eliminades s'aturen.\n\n**Què no es veu afectat:** les entrades a la llista de bloqueig creades a partir d'aquesta sessió (facials o de documents) **no** s'eliminen; gestiona-les amb els endpoints de la llista de bloqueig. Els tokens de compartició emesos per a la sessió no es revoquen, però ja no queda res per importar: una importació amb un d'ells retorna `400` amb `{\"share_token\": [\"Original session does not exist.\"]}`. Els crèdits ja consumits **no** es reemborsen. L'entitat d'usuari o d'empresa principal **no** s'elimina; fes servir `POST /v3/users/delete/` o `POST /v3/businesses/delete/` per a aquests casos. Si el retrat de perfil de l'usuari procedia d'aquesta sessió, el retrat s'elimina conjuntament.\n\n**Dades biomètriques facials:** per defecte, l'embedding facial de la sessió s'elimina amb la sessió (`face_retention_outcome: deleted`). Una aplicació que hagi activat la conservació de plantilles biomètriques (`face_retention_policy: retain_until_user_deleted` a `PATCH /v3/webhook/`), o una sol·licitud amb `retain_face_embeddings: true`, conserva una plantilla biomètrica facial gestionada per separat i sense imatges ancorada a l'usuari de la sessió (`retained_with_user`) perquè la detecció de duplicats, la Cerca facial i l'autenticació biomètrica continuïn funcionant. La plantilla mai conté la imatge de la cara, fitxers multimèdia, camps d'identitat, la decisió ni l'id de la sessió eliminada; com a dada biomètrica, s'elimina a `biometric_template_expires_at`, o abans si s'elimina l'usuari, per supressió per motius de privacitat o per una purga explícita a través de `/v3/biometric-templates/`. Una sessió sense un usuari vinculat no pot conservar cap plantilla (`ineligible_no_vendor_user`). Envia `deletion_instruction: privacy_erasure` per a sol·licituds dels titulars de les dades: purga totes les plantilles conservades per a aquest usuari i mai en conserva cap de nova.\n\n**Irreversible:** l'eliminació és permanent i no hi ha cap endpoint de restauració. Exporta tot el que necessitis (per exemple, un PDF de decisió) abans de cridar-lo.\n\n**Efectes secundaris:** no s'emet cap webhook per a les eliminacions.\n\n**Resposta:** `200 OK` un cop completada l'eliminació, amb un cos JSON que informa de `face_retention_outcome`, la caducitat de la plantilla conservada i, per a una sessió de KYB, `deleted_child_verifications`. Les versions anteriors d'aquest endpoint retornaven `204 No Content`; actualitza els clients que verifiquin `204`. Guarda el teu `instruction_id` al teu propi registre de supressió.\n\n**Idempotència:** no és idempotent a nivell d'HTTP: la primera crida retorna `200`; repetir-la retorna `404` perquè la sessió ja no es resol. Després d'un `503`, la sessió continua existint; repeteix la mateixa sol·licitud per acabar d'eliminar-la.\n\n**Autenticació:** envia la clau d'API de la teva aplicació a la capçalera `x-api-key`; la sessió ha de pertànyer a aquesta aplicació. Els tokens d'accés d'usuari de la Console (`Authorization: Bearer ...`) també poden cridar aquest endpoint quan disposen del permís `delete:sessions`. Els errors d'autenticació i de permisos retornen tots dos `403`; aquesta API mai retorna `401`.\n\n**Límit de freqüència:** pressupost d'escriptura compartit de 300 sol·licituds/min per clau d'API entre tots els endpoints POST/PATCH/DELETE; superar-lo retorna `429`.\n\nPer eliminar de manera massiva sessions de KYC pel seu `session_number` numèric, fes servir `POST /v3/sessions/delete/` en el seu lloc.\n\n**Informes regulatoris presentats:** si les dades seleccionades formen part d'un informe regulatori finalitzat, tota la sol·licitud es rebutja amb `409` i no s'elimina res. El cos utilitza `code: in_filed_report` i identifica cada informe amb `uuid`, `report_number`, `report_type` i `case_uuid`. Elimina els informes i després repeteix la sol·licitud.", "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 sessió de Verificació d'usuaris (KYC) o de Verificació d'empreses (KYB) que cal suprimir, tal com es va retornar en crear la sessió. Ha de ser un UUID canònic separat per guions; un valor que no sigui un UUID no coincideix amb la ruta i retorna `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "responses": { "200": { "description": "Sessió suprimida. El cos informa de què ha passat amb les dades biomètriques facials de la sessió i, per a una sessió de KYB, quantes verificacions que va crear es van suprimir amb ella.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "La sessió eliminada." }, "session_number": { "type": "integer", "nullable": true, "description": "El número de la sessió eliminada." }, "face_retention_outcome": { "type": "string", "enum": [ "retained_with_user", "deleted", "none", "ineligible_no_vendor_user" ], "description": "Què ha passat amb les dades biomètriques facials de la sessió. `deleted`: l'embedding facial s'ha suprimit amb la sessió (per defecte). `retained_with_user`: la sessió se suprimeix i una plantilla biomètrica sense imatges es manté vinculada a l'usuari; consulta `biometric_template_uuid`. `none`: la sessió no tenia cap embedding facial (per exemple, una sessió de KYB o una sessió de KYC sense selfie de prova de vida). `ineligible_no_vendor_user`: s'ha sol·licitat la conservació però la sessió no té cap usuari enllaçat, de manera que l'embedding s'ha suprimit amb la sessió. Una fallada a l'emmagatzematge biomètric mai es notifica mitjançant aquest camp en aquest endpoint: retorna `503` i la sessió no se suprimeix." }, "biometric_template_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "ID de la plantilla biomètrica conservada quan `face_retention_outcome` és `retained_with_user`; `null` en cas contrari. Gestiona-la mitjançant `/v3/biometric-templates/{template_uuid}/`." }, "biometric_template_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan s'elimina la plantilla biomètrica conservada, quan `face_retention_outcome` és `retained_with_user`; `null` quan no es conserva cap plantilla." }, "deleted_child_verifications": { "type": "integer", "description": "Per a una sessió de Verificació d'empreses (KYB): quantes verificacions que va crear (les sessions de KYC de les seves persones clau i les sessions de KYB dels seus propietaris corporatius, de forma recursiva) s'han eliminat amb ella. Sempre `0` per a una sessió de 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": "Conservació de dades sol·licitada en una sessió creada sense 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ó d'empresa eliminada juntament amb les tres verificacions que va crear per a les seves persones clau" } } } } }, "400": { "description": "Error de validació — no s'elimina res.", "content": { "application/json": { "examples": { "Privacy erasure cannot retain": { "value": { "retain_face_embeddings": [ "Privacy erasure cannot retain biometric templates." ] } }, "No finite retention duration": { "summary": "Conservació de dades sol·licitada sense face_retention_days a la sol·licitud o a l'aplicació", "value": { "detail": "A finite biometric-template retention duration is required." } } } } } }, "403": { "description": "Fallada d'autenticació o de permís. Si falta la clau també es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`. Excepció: quan el `sessionId` no es resol en una sessió activa, la cerca de titularitat prèvia a l'autenticació retorna primer `404`, fins i tot si falten les credencials o no són vàlides.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid API key": { "summary": "Falta la capçalera x-api-key, o la clau no és vàlida", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Insufficient permission": { "summary": "Token d'usuari sense delete:sessions, o credencials d'una aplicació que no és propietària de la sessió", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap sessió activa de KYC o KYB amb aquest `session_id` — l'id és desconegut o la sessió ja s'havia suprimit (repetir una supressió satisfactòria porta aquí).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not Found": { "summary": "Sessió desconeguda o ja suprimida", "value": { "detail": "Not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència d'escriptura compartit (300 sol·licituds POST/PATCH/DELETE per minut per clau d'API). Revisa les capçaleres de resposta `Retry-After` i `X-RateLimit-*` abans de reintentar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Pressupost d'escriptura esgotat", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } }, "503": { "description": "L'eliminació no s'ha pogut completar perquè un servei d'emmagatzematge, un magatzem biomètric o un proveïdor de monitoratge no estaven disponibles. La sessió continua al seu lloc; repeteix la mateixa sol·licitud fins que retorni `200`. És possible que alguns dels seus fitxers emmagatzemats o el seu embedding facial ja s'hagin eliminat, de manera que no hi confiïs després d'un `503`. Els reintents convergeixen en una única plantilla.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Session deletion unavailable": { "summary": "Un servei d'emmagatzematge o un proveïdor de monitoratge no estava 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 magatzem biomètric no estava disponible en 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 sessió forma part d'un informe regulador finalitzat. No se suprimeix res.", "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. Omet el cos completament per seguir la política de conservació de l'aplicació amb una supressió operativa.", "content": { "application/json": { "schema": { "type": "object", "properties": { "retain_face_embeddings": { "type": "boolean", "nullable": true, "description": "Sobreescriu la `face_retention_policy` de l'aplicació per a aquesta supressió. `true` manté una plantilla biomètrica facial sense imatge vinculada a l'usuari de la sessió després que se suprimeixi la sessió; `false` suprimeix l'embedding facial amb la sessió; omet o posa `null` per seguir la política de l'aplicació. S'ignora en sessions de KYB i en sessions sense embedding facial.", "example": true }, "face_retention_days": { "type": "integer", "minimum": 1, "maximum": 3650, "description": "Durada de conservació finita, en dies, per a una plantilla conservada. Obligatori quan es conserva una plantilla tret que l'aplicació ja defineixi `face_retention_days`. El camp `expires_at` de la plantilla és la data més primerenca entre aquesta durada, la finestra general de conservació de dades de l'aplicació i `face_retention_deadline`.", "example": 365 }, "face_retention_deadline": { "type": "string", "format": "date-time", "description": "Caducitat estricta opcional per a una plantilla conservada. Ha de ser posterior a la data actual.", "example": "2027-08-28T00:00:00Z" }, "deletion_instruction": { "type": "string", "enum": [ "operational_session_delete", "privacy_erasure" ], "default": "operational_session_delete", "description": "La classe d'instrucció que estàs donant. `operational_session_delete` suprimeix la sessió i conserva una plantilla només quan la política o `retain_face_embeddings` així ho indiquen. `privacy_erasure` purga totes les plantilles biomètriques conservades vinculades a l'Usuari de la sessió abans de suprimir la sessió, no pot ser anul·lada per la política de l'aplicació i no es pot combinar amb `retain_face_embeddings: true` (`400`).", "example": "operational_session_delete" }, "instruction_id": { "type": "string", "maxLength": 255, "description": "La teva referència persistent per a aquesta instrucció de supressió (per exemple, l'id d'un tiquet de supressió). Es registra al registre d'auditoria i a qualsevol plantilla conservada. Didit la genera si s'omet.", "example": "dsar-2026-0142" } } }, "examples": { "Retain a biometric template": { "summary": "Elimina la sessió i mantén una plantilla sense imatges durant 365 dies", "value": { "retain_face_embeddings": true, "face_retention_days": 365, "instruction_id": "post-approval-cleanup-2026-08" } }, "Force deletion on an opted-in application": { "summary": "Elimina l'embedding facial independentment de la política de l'aplicació", "value": { "retain_face_embeddings": false } }, "Privacy erasure": { "summary": "Sol·licitud de l'interessat: suprimeix la sessió i purga totes les plantilles conservades per a aquesta persona", "value": { "deletion_instruction": "privacy_erasure", "instruction_id": "dsar-2026-0142" } } } } } } } }, "/v3/session/{sessionId}/generate-pdf/": { "get": { "summary": "Descarrega un informe en PDF d'una sessió de verificació", "description": "Genera i descarrega un informe en PDF preparat per al compliment normatiu per a una sessió de verificació finalitzada. La mateixa ruta serveix tant per a sessions de Verificació d'usuaris (KYC) com de Verificació d'empreses (KYB): el servidor resol el `sessionId` per a tots dos tipus de sessió i tria la plantilla d'informe corresponent.\n\n**Estats aptes.** La sessió ja ha de tenir un estat final o revisable:\n\n- Sessions de KYC: `Approved`, `Declined`, `In Review` o `Kyc Expired`.\n- Sessions de KYB: `Approved`, `Declined` o `In Review`.\n\nQualsevol altre estat (`Not Started`, `In Progress`, `Expired`, `Abandoned`, …) retorna `403` amb una cadena de text explicativa a `detail` — consulta la resposta `403` més avall.\n\n**Què conté l'informe.** El PDF reflecteix la vista de la sessió a la consola en el moment de la sol·licitud:\n\n- **KYC** — estat agregat de la sessió, la llista d'advertències i una secció per cada funcionalitat executada: Verificació d'identitat (imatges del document més camps extrets), NFC, Prova de vida, Coincidència facial, Verificació de correu electrònic, Verificació de telèfon, Comprovant de domicili, respostes dels Qüestionaris, Validació en bases de dades, Cribratge AML i Anàlisi d'IP — seguit de les etiquetes de la sessió, l'activitat de revisió a la consola (comentaris i canvis d'estat) i el cronograma d'esdeveniments de la sessió.\n- **KYB** — comprovacions de registres (dades de l'empresa), cribratges AML, verificacions de documents d'empresa, comprovacions de persones clau, respostes de qüestionaris, verificacions de telèfon/correu electrònic, anàlisis d'IP i el cronograma d'esdeveniments de la sessió, seguit de les etiquetes i l'activitat de revisió.\n\n**Personalització de marca.** Si la teva aplicació disposa de personalització de marca blanca, l'informe es genera amb el teu logotip i enllaços a la teva URL de política de privadesa; altrament, porta la marca de Didit. Els informes es generen en anglès — no hi ha paràmetre d'idioma.\n\n**Sense memòria cau.** Cada crida torna a generar el PDF a partir de les dades actuals de la sessió, de manera que un informe generat després d'una revisió manual reflecteix la decisió del revisor. Dues crides per a la mateixa sessió poden produir fitxers diferents byte a byte — arxiva el fitxer descarregat si necessites una còpia immutable.\n\n**Latència.** La generació descarrega cada imatge emmagatzemada (cares del document, selfies, fitxers addicionals) abans de compondre el PDF, per la qual cosa les sessions amb molt contingut multimèdia poden trigar diversos segons. Utilitza un temps d'espera de lectura generós al client (es recomanen 60 s) i desa el cos en flux al disc.\n\n**Barra inclinada final.** La ruta canònica acaba amb una barra inclinada al final (`…/generate-pdf/`). Una sol·licitud sense aquesta barra es respon directament amb la mateixa resposta — no hi ha redirecció `301`, de manera que cap client ha de seguir redireccions i `curl` no necessita `-L`. Utilitza la URL amb la barra inclinada tal com es mostra als exemples.\n\nSi necessites les dades subjacents en format JSON en lloc d'un informe generat, utilitza `GET /v3/session/{sessionId}/decision/`. Per a totes les sessions reportables d'un sol usuari en un únic document, utilitza `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 sessió de Verificació d'usuaris (KYC) o de Verificació d'empreses (KYB) que cal renderitzar: el `session_id` retornat per `POST /v3/session/`. La mateixa ruta funciona per a tots dos tipus de sessió; fes servir el nom de fitxer de `Content-Disposition` a la resposta per saber quin tipus d'informe has rebut.\n\n**Ha de ser un UUID en minúscules i ben format.** La ruta només coincideix amb UUID vàlids, de manera que el router d'URL rebutja qualsevol valor mal format abans que s'executi el codi de l'aplicació i la resposta és una pàgina **HTML** `404` en comptes de l'embolcall JSON `{\"detail\": ...}` que es mostra a continuació. El convertidor d'UUID de la ruta només coincideix amb la forma canònica en minúscules; els UUID en hexadecimals en majúscules es rebutgen amb l'HTML 404.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "responses": { "200": { "description": "El document PDF renderitzat, retornat directament com a binari `application/pdf`: no hi ha cap contenidor JSON ni cap redirecció d'URL de descàrrega. El cos comença amb els bytes màgics `%PDF` (PDF 1.7). Guarda'l en un fitxer `.pdf` o transmet-lo directament a qui fa la crida.", "headers": { "Content-Disposition": { "description": "`attachment; filename=session_{sessionId}.pdf` per a sessions de KYC, `attachment; filename=business_{sessionId}.pdf` per a sessions de KYB; el prefix t'indica quina plantilla d'informe s'ha renderitzat.", "schema": { "type": "string", "example": "attachment; filename=session_11111111-2222-3333-4444-555555555555.pdf" } }, "Content-Length": { "description": "Mida total del PDF en bytes; el cos no està fragmentat.", "schema": { "type": "integer", "example": 25191 } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Fallada d'autenticació, d'autorització o d'estat de la sessió. Si falta la clau es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`. Distingeix els modes de fallada mitjançant la cadena `detail`:\n\n- `\"Authentication credentials were not provided or are invalid.\"` — no hi ha capçalera `x-api-key` (i cap token `Authorization: Bearer`), o la credencial proporcionada no ha superat la introspecció (revocada, caducada o mal formada).\n- `\"You do not have permission to perform this action.\"` — la credencial és vàlida però no pot llegir aquesta sessió: un token Bearer d'usuari de la Console no té el permís `read:sessions` o no pot accedir a l'aplicació propietària, o una clau d'API pertany a una organització diferent de la de la sessió.\n- `\"You can only generate a PDF for sessions in review, declined, approved or kyc expired\"` — la sessió de KYC existeix però encara no està en un estat apte (per exemple `Not Started` o `In Progress`). Espera el webhook `status.updated` abans de sol·licitar l'informe.\n- `\"You can only generate a PDF for sessions in review, declined or approved\"` — mateixa condició per a sessions de KYB.\n\nTingues en compte que per a un `sessionId` completament desconegut l'endpoint resol l'aplicació propietària abans de validar les credencials, de manera que una sessió que no existeix retorna `404` fins i tot quan la credencial falta o no és 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 la capçalera x-api-key, o la clau ha fallat la introspecció", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Insufficient permissions": { "summary": "Credencial vàlida sense read:sessions o sense accés a l'aplicació propietària", "value": { "detail": "You do not have permission to perform this action." } }, "KYC session not finished": { "summary": "Sessió de KYC encara No iniciada / En curs", "value": { "detail": "You can only generate a PDF for sessions in review, declined, approved or kyc expired" } }, "KYB session not finished": { "summary": "Sessió de KYB encara No iniciada / En curs", "value": { "detail": "You can only generate a PDF for sessions in review, declined or approved" } } } } } }, "404": { "description": "No existeix cap sessió activa amb aquest `sessionId` — no es va crear mai o s'ha suprimit. La resolució del propietari es fa abans de la validació de les credencials, de manera que aquest `404` es retorna fins i tot per a sol·licituds no autenticades. Depenent de quina cerca falli, la cadena `detail` és `\"Not found.\"` (el cas habitual) o `\"Session not found.\"`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Not found." } } }, "examples": { "Unknown session": { "summary": "sessionId no coincideix amb cap sessió de KYC o KYB", "value": { "detail": "Not found." } }, "Recently deleted session": { "summary": "La sessió s'ha suprimit entre les cerques", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. La generació de PDF té un límit dedicat de **50 sol·licituds per minut per credencial** (clau d'API, token Bearer o IP d'origen si no s'ha autenticat), a més del límit global de GET de 600/min. Espera els segons indicats a `Retry-After` (també reflectits a les capçaleres `X-RateLimit-*`) i després reintenta-ho. Els informes no s'emmagatzemen a la memòria cau del servidor, de manera que és millor descarregar cada informe un sol cop i desar el fitxer en comptes de tornar-lo a sol·licitar.", "headers": { "Retry-After": { "description": "Segons d'espera abans de reintentar la sol·licitud.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Nombre màxim de generacions de PDF permeses a la finestra actual (50).", "schema": { "type": "integer", "example": 50 } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Marca de temps Unix (segons) en què es reinicia la finestra actual.", "schema": { "type": "integer", "example": 1750000000 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Explicació fàcil de llegir de la superació del límit de freqüència.", "example": "Session PDF generation rate limit exceeded. You can make up to 50 requests per minute." } } }, "examples": { "Throttled": { "summary": "Més de 50 generacions de PDF en un minut des de la mateixa 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": "Prepara un escenari de sandbox en una sessió", "description": "Persisteix un escenari de sandbox en una sessió `Not Started` i desplega els seus valors màgics inclosos (correu electrònic, telèfon o camps de `expected_details`) a la sessió, de manera que els proveïdors simulats reprodueixin el resultat de l'escenari un cop s'executi el flux. Aquest és l'endpoint que crida el selector d'escenaris previ al flux a la IU de verificació allotjada de Didit quan un tester tria un resultat abans d'iniciar la captura. Desenvolupa el teu propi selector contra ell o crida'l directament des d'un entorn de proves de sandbox.\n\nAutentica't amb el propi `Session-Token` de la sessió (retornat a `session_token` per [Create Session](/ca/sessions-api/create-session)), no pas amb la teva `x-api-key` d'aplicació: aquest endpoint està pensat per ser cridat des del client, no pas des del teu backend. Un escenari només s'accepta mentre `status` és `Not Started`. Cridar-lo de nou mentre encara està en `Not Started` rearma la sessió: canvia pels valors màgics del nou escenari i esborra només els valors que va escriure l'escenari *anterior*, de manera que qualsevol valor que l'usuari ja hagi introduït a mà (correu electrònic, nom, etc.) es manté després del rearmat. Armar una sessió que ja ha superat l'estat `Not Started`, o que pertany a una aplicació de producció (que no és de sandbox), es rebutja.\n\nConsulta [Sandbox & Test Data](/ca/integration/sandbox-testing) per veure el catàleg complet d'escenaris i les altres dues maneres d'obtenir un resultat: `sandbox_scenario` en crear la sessió i introduint valors màgics directament.", "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 sessió de verificació de sandbox que s'ha d'activar. Ha de coincidir amb la sessió codificada al Session-Token utilitzat per autenticar-se.", "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 de l'escenari que es vol preparar. Consulta el catàleg a GET /v1/sandbox/scenarios/ o la taula d'escenaris a [Sandbox i dades de prova](/ca/integration/sandbox-testing).", "example": "decline_document_expired" } } }, "examples": { "Arm": { "summary": "Prepara l'escenari de coincidència PEP d'AML", "value": { "scenario": "decline_aml_hit" } } } } } }, "responses": { "200": { "description": "Escenari activat. Els seus valors màgics ja són a la sessió. `status` reflecteix l'estat actual de la sessió, que aquesta crida no canvia mai: sempre és `Not Started` si té èxit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid" }, "scenario": { "type": "string", "description": "L'slug de l'escenari armat (reprodueix la sol·licitud)." }, "status": { "type": "string", "example": "Not Started" } } }, "examples": { "Armed": { "summary": "Escenari activat en una sessió Not Started", "value": { "session_id": "11111111-2222-3333-4444-555555555555", "scenario": "decline_aml_hit", "status": "Not Started" } } } } } }, "400": { "description": "Error de validació: un slug d'escenari desconegut, o la sessió ja ha avançat més enllà de `Not Started`.", "content": { "application/json": { "examples": { "Unknown Scenario": { "summary": "l'escenari no és al catàleg", "value": { "scenario": [ "Unknown sandbox scenario: 'not-a-real-scenario'." ] } }, "Already Started": { "summary": "La sessió ha passat de Not Started", "value": [ "Scenario can only be armed before the verification starts." ] } } } } }, "404": { "description": "El Session-Token no correspon a aquest `session_id`, o la sessió pertany a una aplicació de producció (fora de sandbox).", "content": { "application/json": { "examples": { "Not Found": { "summary": "Sessió en viu, o desajust de session_id / token", "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": "Aprova, declina o sol·licita reenviament per a una sessió de verificació", "description": "Sobreescriu manualment la decisió final d'una sessió de verificació KYC o KYB. Estableix `new_status` a `Approved` o `Declined` per registrar una decisió manual, o a `Resubmitted` per reiniciar passos concrets de la verificació i permetre que l'usuari els torni a fer a través del mateix URL de verificació. L'endpoint accepta tant ID de sessió d'usuari (KYC) com d'empresa (KYB).\n\nCrida'l quan una sessió hagi assolit un estat revisable: l'estat actual ha de ser `Approved`, `Declined`, `In Review`, `Kyc Expired`, `Abandoned` o `Resubmitted`. Les sessions que encara estan a `Not Started`, `In Progress` o `Awaiting User`, o que han finalitzat com a `Expired`, retornen `400`. La teva clau d'API necessita el permís `write:sessions` (una clau d'API amb abast restringit necessita accés d'escriptura a decisions). La comprovació d'estat apte s'executa abans de la validació del cos, de manera que una sessió no apta retorna l'error `Wrong Current Status` fins i tot si el payload també és invàlid.\n\nPer a `Resubmitted`, passa `nodes_to_resubmit` per triar quins passos del flux de treball ha de tornar a fer l'usuari, o omet-lo per seleccionar automàticament els intents de funcionalitats existents que estiguin en un estat en què es poden tornar a presentar (`Declined`, `In Review`, `Not Finished`, `Expired`). Les funcionalitats que mai no s'han intentat no se seleccionen automàticament: enumera-les explícitament a `nodes_to_resubmit`, o la sol·licitud retornarà `400` si cap intent registrat necessita resubmissió. Els resultats anteriors dels passos seleccionats es mouen a l'historial de la resubmissió (retornat per Get Decision amb `include=resubmissions`), els passos es reordenen per coincidir amb el graf del flux de treball, la finestra de caducitat de la sessió es reinicia i l'URL de verificació original es pot tornar a utilitzar. Els passos exclusius de backend (`AML`, `DATABASE_VALIDATION`, `IP_ANALYSIS`) a l'inici de la llista s'executen immediatament sense interacció de l'usuari; si tots els passos reenviats són exclusius de backend, la sessió es finalitza de nou dins de la mateixa sol·licitud. `KYB_REGISTRY` i `KYB_KEY_PEOPLE` no es poden reenviar directament: reenvia en el seu lloc les sessions KYC filles rellevants i la sessió d'empresa principal es recalcularà automàticament.\n\nCada crida que canvia l'estat activa el [webhook](/ca/integration/webhooks) `status.updated` un cop aplicat el canvi i afegeix una entrada d'activitat (amb l'atribució de l'actor i el teu `comment`) a les `reviews` de la sessió, visible a [Get Decision](#get-/v3/session/-sessionId-/decision/) i a la cronologia d'activitat de la consola. Les dades agregades del perfil d'usuari vinculades al `vendor_data` de la sessió també s'actualitzen. Rebutjar desactiva el monitoratge AML continu per a la sessió; tornar a aprovar el reactiva (des de `Resubmitted`, `Declined` o `Kyc Expired`) quan el flux de treball té el monitoratge activat. Aprovar o rebutjar un KYC fill que pertanyi a una comprovació de persones clau de KYB recalcula l'estat de la sessió d'empresa principal. Estableix `send_email: true` (amb `email_address`) per notificar l'usuari: un avís d'estat per a `Approved`/`Declined`, o un correu electrònic de resubmissió que conté l'enllaç de verificació i els motius pas per pas per a `Resubmitted`. Per comprovar el correu electrònic prèviament, fes-ne una vista prèvia amb [Preview Decision Email](/ca/sessions-api/preview-decision-email) (`Approved`, `Declined`) o [Preview Resubmission Email](/ca/sessions-api/preview-resubmission) (`Resubmitted`) i passa el seu `preview_token` com a `email_preview_token`: l'actualització enviarà llavors exactament el correu previsualitzat, o retornarà `409` abans de canviar res si el correu o la sessió han canviat des de la vista prèvia o si el justificant té més de 15 minuts.\n\nRepetir `Approved` o `Declined` en una sessió que ja té aquest estat no canvia res i retorna `200`: cap webhook, cap entrada d'activitat i cap correu electrònic. Repetir `Resubmitted` retorna `400` (`The new status is the same as the current status.`). Les credencials absents o no vàlides i la manca de permisos retornen `403`; una clau d'API amb abast restringit caducada retorna `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 sessió de verificació que s'ha d'actualitzar. Accepta tant IDs de sessió d'usuari (KYC) com d'empresa (KYB); el servei resol l'ID entre tots dos tipus de sessió.", "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": "Estat de destinació. `Approved` i `Declined` registren una decisió manual definitiva (cadascuna també pot revocar l'altra). `Resubmitted` neteja els passos seleccionats i torna a enviar la sessió a l'usuari. Qualsevol altre valor retorna `400`.", "enum": [ "Approved", "Declined", "Resubmitted" ], "example": "Approved" }, "comment": { "type": "string", "description": "Motiu de text lliure del canvi, desat al registre de revisió de la sessió i retornat a la matriu `reviews` d'[Obtenir la decisió](#get-/v3/session/-sessionId-/decision/). Per exemple, `Duplicated user`.", "example": "All checks passed manual review" }, "nodes_to_resubmit": { "type": "array", "description": "Passos del flux de treball que l'usuari ha de refer. Només s'hi actua quan `new_status` és `Resubmitted`. Per a `Approved`/`Declined`, es continua validant l'esquema de les entrades (un valor de `feature` no vàlid retorna `400`), però les entrades vàlides segons l'esquema s'ignoren semànticament. Si s'omet, el servidor selecciona automàticament els intents existents d'OCR, prova de vida, coincidència facial, comprovant de domicili, telèfon, correu electrònic, AML, validació en bases de dades i qüestionari l'estat dels quals sigui `Declined`, `In Review`, `Not Finished` o `Expired` (els intents d'NFC, anàlisi d'IP, estimació d'edat, cerca facial i documents de KYB mai no se seleccionen automàticament; els intents facials que no són de coincidència facial se seleccionen com a `LIVENESS`); les funcionalitats que l'usuari mai no ha intentat (cap intent registrat) NO se seleccionen, de manera que una sessió amb zero intents retorna `400` (\"No features found that need resubmission\") encara que no s'hagi aprovat res; passa `nodes_to_resubmit` explícitament en aquest cas. Els passos s'executen en l'ordre del graf del flux de treball, independentment de l'ordre en què els enviïs. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` i l'àlies `KYB` es rebutgen amb `400`; aquestes comprovacions pare es tornen a calcular a partir de les seves sessions de KYC filles.", "items": { "type": "object", "required": [ "node_id", "feature" ], "properties": { "node_id": { "type": "string", "description": "Identificador del node tal com apareix a la definició del flux de treball de la sessió (per exemple `feature_ocr`, `feature_liveness`).", "example": "feature_ocr" }, "feature": { "type": "string", "description": "Tipus de funcionalitat del node. Els àlies `ID_VERIFICATION`, `POA`, `PHONE` i `EMAIL` es normalitzen al servidor a `OCR`, `PROOF_OF_ADDRESS`, `PHONE_VERIFICATION` i `EMAIL_VERIFICATION`. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` i `KYB` superen la validació de l'esquema, però sempre es rebutgen amb l'error de regla de negoci `400` mostrat als exemples.", "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 s'ha d'enviar un correu electrònic a l'usuari sobre el canvi. Requereix `email_address`. Per a `Approved`/`Declined`, l'usuari rep un avís d'estat; per a `Resubmitted`, el correu electrònic inclou l'enllaç de verificació i els motius de reenviament per a cada pas.", "default": false, "example": false }, "email_address": { "type": "string", "format": "email", "description": "Destinatari del correu electrònic de notificació. **Obligatori quan `send_email` és `true`**; si s'omet, es retorna `400`.", "example": "user@example.com" }, "email_language": { "type": "string", "description": "Idioma per al correu electrònic de notificació. Accepta qualsevol cadena a nivell d'esquema; els codis no admesos tornen silenciosament a l'anglès (`en`).", "default": "en", "example": "en" }, "email_preview_token": { "type": "string", "writeOnly": true, "minLength": 1, "maxLength": 512, "description": "Rebut opcional de [Preview Decision Email](/ca/sessions-api/preview-decision-email) (per a `Approved` i `Declined`) o de [Preview Resubmission Email](/ca/sessions-api/preview-resubmission) (per a `Resubmitted`): el seu `preview_token`. Només és vàlid amb `send_email: true`; sense aquest, la sol·licitud retorna `400`. El destinatari, l'idioma, l'estat de la sessió, el remitent i el correu electrònic (i, per a un reenviament, els passos seleccionats) encara han de coincidir amb la previsualització, i el rebut caduca al cap de 15 minuts. En cas contrari, la sol·licitud retorna `409` abans que la sessió canviï o s'enviï un correu electrònic. Les integracions existents poden ometre aquest camp." } } }, "examples": { "Approve Session": { "summary": "Aprova una sessió després de la revisió manual", "value": { "new_status": "Approved", "comment": "All checks passed manual review" } }, "Decline Session": { "summary": "Rebutjar una sessió", "value": { "new_status": "Declined", "comment": "Suspected fraud" } }, "Resubmit Specific Steps": { "summary": "Sol·licitar el reenviament dels passos escollits, amb correu electrònic", "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": "Sol·licitar reenviament (autoselecciona els passos no aprovats)", "value": { "new_status": "Resubmitted" } }, "Approve With Previewed Email": { "summary": "Aprova i envia el correu electrònic retornat per 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": "Estat actualitzat. La resposta només conté el `session_id`; obtén la sessió actualitzada mitjançant [Get Decision](#get-/v3/session/-sessionId-/decision/). El webhook `status.updated` s'activa un cop aplicat el canvi. Repetir `Approved` o `Declined` retorna el mateix cos i no canvia res.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "UUID de la sessió actualitzada." } } }, "examples": { "Updated": { "summary": "Retornat per a Aprovada, Rebutjada i Reenviada per igual", "value": { "session_id": "3472fb7c-8f7c-4d1a-9cf4-cf3d74ce1a60" } } } } } }, "400": { "description": "Error de validació. Els errors de camp arriben com a `{\"\": [\"\"]}` (alguns rebuigs de regles de negoci utilitzen un valor de cadena en el seu lloc: `{\"nodes_to_resubmit\": \"\"}`), els errors entre estats com a `{\"detail\": \"\"}` i l'error del mateix estat com a array JSON simple.", "content": { "application/json": { "examples": { "Wrong Current Status": { "summary": "La sessió no es troba en un estat actualitzable", "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 és un estat de sessió real, però no és cap dels estats Approved/Declined/Resubmitted", "value": { "new_status": [ "You can only update the status to 'Approved', 'Declined', or 'Resubmitted'." ] } }, "Missing new_status": { "summary": "S'ha omès un camp obligatori", "value": { "new_status": [ "This field is required." ] } }, "Same Status": { "summary": "Reenviament sol·licitat en una sessió que ja s'ha reenviat", "value": [ "The new status is the same as the current status." ] }, "Email Address Required": { "summary": "send_email true sense email_address", "value": { "email_address": [ "Email address is required when send_email is true." ] } }, "Non-resubmittable Feature": { "summary": "El reenviament té com a objectiu una verificació pare 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ó automàtica no ha trobat funcionalitats no aprovades", "value": { "nodes_to_resubmit": "No features found that need resubmission. All features are already approved." } }, "Invalid Feature Choice": { "summary": "Funcionalitat desconeguda a 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 és un valor de StatusChoices vàlid", "value": { "new_status": [ "\"Bogus\" is not a valid choice." ] } }, "Preview Receipt Without Email": { "summary": "S'ha enviat email_preview_token sense send_email: true", "value": { "email_preview_token": [ "A preview receipt is only valid when the email is sent." ] } } } } } }, "401": { "description": "La clau d'API amb abast ha caducat.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Clau d'API amb abast que ha superat la data de caducitat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falten les credencials o els permisos són insuficients, o el `session_id` pertany a una altra aplicació.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Falta l'x-api-key o no és vàlid", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La clau d'API no té write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap sessió de KYC o KYB amb aquest `session_id` (les sessions eliminades també retornen `404`).", "content": { "application/json": { "examples": { "Not Found": { "summary": "session_id desconegut", "value": { "detail": "Not found." } } } } } }, "429": { "description": "S'ha repetit un reenviament destinat únicament a funcionalitats de backend (AML, DATABASE_VALIDATION, IP_ANALYSIS) dins de la finestra d'espera de 30 segons; una repetició immediata no pot canviar el resultat. Espera i torna-ho a provar després de l'interval indicat a `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 previsualització del correu electrònic ha canviat o ha caducat. Genera una nova previsualització abans de confirmar; no s'aplica cap canvi a la sessió ni es fa cap lliurament de correu electrònic.", "content": { "application/json": { "examples": { "Preview Changed": { "summary": "El rebut ja no coincideix o té més de 15 minuts", "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ó d'identitat (OCR del document + comprovacions de frau)", "description": "Aplica l'OCR a un document d'identitat i executa controls de frau documental en una sola crida: retorna els camps extrets del titular, la MRZ analitzada, un `status` `Approved`/`Declined`/`In Review` i una llista de `warnings` que explica cada problema detectat. Admet 14,000+ tipus de documents de 220+ països i territoris.\n\n**Com funciona.** Envia la `front_image` del document (obligatòria) i, en el cas de documents de dues cares, la `back_image`. Puja fotografies sense retallar on siguin visibles les quatre cantonades del document; el servei mateix detecta, alinea i retalla el document, així que no el retallis prèviament. El document es classifica automàticament (mai has de declarar el país ni el tipus de document), la zona visual es llegeix mitjançant OCR i es descodifiquen la MRZ i els codis de barres que hi hagi. A continuació, les comprovacions creuades validen les dates, els formats dels números i els dígits de control de la MRZ, i comparen la zona visual amb la MRZ. Amb `perform_document_liveness=true`, les imatges s'analitzen a més per detectar reproduccions en pantalla, còpies impreses i manipulacions del retrat.\n\n**Lògica de decisió.** `status` és `Approved` llevat que com a mínim un advertiment es resolgui en un rebuig. Els riscos de frau i fallades crítiques sempre rebutgen: `DOCUMENT_EXPIRED`, `SCREEN_CAPTURE_DETECTED`, `PRINTED_COPY_DETECTED`, `PORTRAIT_MANIPULATION_DETECTED`, `PUBLIC_DOCUMENT_IMAGE_DETECTED`, a més de les fallades d'extracció (`NAME_NOT_DETECTED`, `DATE_OF_BIRTH_NOT_DETECTED`, `DOCUMENT_NUMBER_NOT_DETECTED`). (`PORTRAIT_IMAGE_NOT_DETECTED`, `INVALID_DATE` i `MRZ_NOT_DETECTED` existeixen a les sessions de flux de treball, però aquest endpoint independent mai no els produeix. `COULD_NOT_DETECT_DOCUMENT_TYPE` es retorna aquí quan la imatge frontal no coincideix amb un disseny oficial de document conegut amb prou confiança, i rebutja la sol·licitud.) Tres grups de risc es poden configurar per sol·licitud mitjançant `invalid_mrz_action`, `inconsistent_data_action` i `expiration_date_not_detected_action` (`DECLINE` o `NO_ACTION`). Tots els altres advertiments (p. ex., `POSSIBLE_DUPLICATED_USER`) són informatius i mai no provoquen un rebuig per si sols. Quan `perform_document_liveness=true` (per defecte) i el control de falsificació no retorna cap puntuació utilitzable —el proveïdor ha fallat, ha respost amb un codi diferent de 200 o ha respost HTTP 200 amb `status=\"ERR\"`—, la crida retorna `200` amb `status: \"In Review\"` i un advertiment `DOCUMENT_LIVENESS_NOT_COMPUTED` (`log_type: \"warning\"`) en comptes d'`Approved`: una comprovació que no s'ha executat no és prova que el document sigui autèntic. Aquesta escalada no és configurable i mai no preval sobre un `Declined`; amb `perform_document_liveness=false` s'omet la comprovació i l'estat segueix els advertiments restants com abans. Un document que no es pot processar de cap manera retorna `400` amb `{\"error\": \"COULD_NOT_RECOGNIZE_DOCUMENT\"}`; un document llegible però amb problemes retorna `200` amb `status: \"Declined\"` —inspecciona sempre `id_verification.status` i `id_verification.warnings`, no només el codi HTTP.\n\n**Facturació.** Cada resposta `200` consumeix un crèdit de l'API de Verificació d'identitat (descomptat del crèdit del teu pla o del saldo de recàrrega). Quan el saldo de l'organització no pot cobrir la crida, l'endpoint retorna `403` amb l'error de crèdits insuficients abans de processar cap imatge.\n\n**Persistència de la sessió (`save_api_request`, per defecte `true`).** Quan és `true`, la crida es desa com una sessió de tipus API: apareix a la Business Console, el `request_id` retornat és un identificador de sessió real que pots passar a `GET /v3/session/{sessionId}/decision/`, les imatges retallades del document/retrat s'emmagatzemen i es retornen com a URL de mitjans de curta durada (`https:///ocr/...`), i s'emet un webhook `status.updated` cap a les destinacions de webhook configurades. Quan és `false`, no s'emmagatzema res, el `request_id` és un UUID de correlació d'un sol ús i `portrait_image`/`front_image`/`back_image` es retornen incrustats com a cadenes JPEG codificades en base64.\n\n**Sandbox.** Les claus d'API de sandbox ometen tot el processament i la facturació: després de validar la sol·licitud (una entrada mal formada continua retornant `400`), l'endpoint retorna un payload simulat estàtic `Approved` (un document d'identitat fictici dels EUA a nom de «Sandbox User»), no es desa cap sessió i no es consumeix cap crèdit.\n\n**Autenticació.** Envia la clau d'API de la teva aplicació a la capçalera `x-api-key`. Si les credencials falten o són invàlides, es retorna un `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`) —aquesta API mai no retorna `401`.\n\n**Límit de freqüència.** Límit compartit d'escriptures de 300 sol·licituds/min per clau d'API entre tots els endpoints POST/PATCH/DELETE; superar-lo retorna `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": "Anvers del document d'identitat. Extensions permeses: `tiff`, `jpg`, `jpeg`, `png`, `webp`, `pdf`. Mida màxima de càrrega: **10 MB** (els fitxers més grans es rebutgen amb `400`). Els PDF es renderitzen a una imatge abans de l'OCR; els PDF xifrats requereixen `front_image_password`. Les imatges es comprimeixen automàticament a ~0.5 MB i s'aplica l'orientació EXIF. Carrega la captura completa, sense retallar, amb les quatre cantonades del document visibles." }, "front_image_password": { "type": "string", "description": "Contrasenya per desxifrar `front_image` quan és un PDF xifrat. Enviar un PDF xifrat sense contrasenya (o amb una d'incorrecta) retorna `400`.", "writeOnly": true }, "back_image": { "type": "string", "format": "binary", "description": "Revers del document — envia'l sempre que el document en tingui (molts documents d'identitat porten la MRZ o un codi de barres al darrere; ometre'l simplement deixa buits la MRZ i els camps del revers a la resposta — aquest endpoint no genera cap advertència de MRZ absent). Mateix format i límits de mida que `front_image`. Si s'omet, `back_image` i els camps del revers són `null` a la resposta." }, "back_image_password": { "type": "string", "description": "Contrasenya per desxifrar `back_image` quan és un PDF xifrat.", "writeOnly": true }, "perform_document_liveness": { "type": "boolean", "default": true, "description": "Analitza ambdues imatges a la cerca d'atac de presentació: reproduccions en pantalla (`SCREEN_CAPTURE_DETECTED`), còpies impreses (`PRINTED_COPY_DETECTED`) i manipulació de retrats (`PORTRAIT_MANIPULATION_DETECTED`). Qualsevol d'aquests es rebutja automàticament. Activat per defecte; defineix-ho com a `false` per ometre l'anàlisi de frau i reduir la latència. Quan està activat i el proveïdor no retorna cap puntuació utilitzable, la resposta és `In Review` amb una advertència `DOCUMENT_LIVENESS_NOT_COMPUTED` en lloc d'`Approved`.", "example": true }, "minimum_age": { "type": "integer", "nullable": true, "default": null, "minimum": 1, "maximum": 120, "description": "S'accepta i es valida (1–120), però **actualment aquest endpoint no ho aplica**; mai no genera una advertència `MINIMUM_AGE_NOT_MET` a partir d'aquest camp. Aplica les regles d'edat a partir del `date_of_birth`/`age` retornat, o utilitza un flux de treball de sessió de verificació amb restriccions d'edat." }, "expiration_date_not_detected_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Què fer quan no es pot llegir cap data de caducitat (`EXPIRATION_DATE_NOT_DETECTED`). Per defecte és `NO_ACTION` perquè molts documents d'identitat no imprimeixen data de caducitat. Nota: una data de caducitat *detectada i vençuda* sempre es rebutja (`DOCUMENT_EXPIRED`), independentment d'aquesta opció." }, "invalid_mrz_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "DECLINE", "description": "Què fer quan el MRZ extret no supera la validació del dígit de control (`MRZ_VALIDATION_FAILED`). Un MRZ absent no genera cap advertència en aquest endpoint. Només és rellevant per a documents que incloguin un MRZ. `REVIEW` no s'admet en aquest endpoint i retorna `400`." }, "inconsistent_data_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "DECLINE", "description": "Què fer quan les dades extretes són internament incoherents: `DATA_INCONSISTENT`, `MRZ_AND_DATA_EXTRACTED_FROM_OCR_NOT_SAME` (la zona visual no coincideix amb la MRZ) o `DOCUMENT_NAME_DIFFERENT_FROM_OTHER_APPROVED_DOCUMENTS`." }, "critical_field_occlusion_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "DECLINE", "description": "Què fer quan un camp imprès crític s'ha tapat físicament a la captura (`CRITICAL_FIELD_OCCLUSION_DETECTED`) - un número d'identitat, un nom, la data de naixement o la data de caducitat. Es rebutja per defecte, igual que els altres riscos d'integritat del document d'aquest endpoint: tapar els números amb què es concilia un informe és el que sembla un document redactat o ocultat. El valor llegit d'un camp tapat es descarta de l'extracció en qualsevol cas, de manera que l'advertència `*_NOT_DETECTED` corresponent sol acompanyar-lo. `REVIEW` no s'admet en aquest endpoint i retorna `400`." }, "document_or_personal_number_format_mismatch_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Què fer quan un número no coincideix amb el format que la seva autoritat emissora utilitza per a aquest tipus de document (`DOCUMENT_NUMBER_FORMAT_MISMATCH`, `PERSONAL_NUMBER_FORMAT_MISMATCH`). Per defecte és `NO_ACTION`, que informa de l'advertència sense canviar l'estat. `REVIEW` no s'admet en aquest endpoint i retorna `400`." }, "preferred_characters": { "type": "string", "enum": [ "latin", "non_latin" ], "default": "latin", "description": "Sistema d'escriptura preferit per als camps de nom/adreça en documents que imprimeixen text tant llatí com no llatí (àrab, ciríl·lic, CJK, …). `latin` retorna valors transliterats/llatins; `non_latin` prefereix el sistema d'escriptura natiu." }, "save_api_request": { "type": "boolean", "default": true, "description": "Quan és `true` (per defecte), manté la crida com una sessió de tipus API — visible a la Business Console, recuperable mitjançant `GET /v3/session/{sessionId}/decision/` utilitzant el `request_id` retornat, anunciada a través d'un webhook `status.updated` i amb les imatges del document retornades com a URL de mitjans. Quan és `false`, no s'emmagatzema res, `request_id` és un UUID transitori i les imatges es retornen integrades com a cadenes JPEG en base64.", "example": true }, "vendor_data": { "type": "string", "description": "Cadena opaca opcional (el teu ID d'usuari intern, correu electrònic, UUID…) desada a la sessió persistent i retornada a la resposta. Utilitza-la per correlacionar crides a l'API amb els teus propis registres i per filtrar sessions més endavant.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objecte JSON opcional emmagatzemat amb la sessió (quan `save_api_request=true`) i retornat a la resposta. En sol·licituds multipart, envia'l com a camp de cadena codificat en JSON (p. ex., `metadata={\"flow\":\"onboarding\"}`); s'analitza com un objecte.", "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": "Document processat. `id_verification.status` és `Approved`, `Declined` o `In Review`; cada problema detectat es detalla a `id_verification.warnings`. Es retorna `In Review` quan una comprovació sol·licitada de prova de vida del document no ha produït cap resultat utilitzable (`DOCUMENT_LIVENESS_NOT_COMPUTED`). Un document problemàtic continua retornant `200` amb `status: \"Declined\"`; inspecciona el cos, no només el codi HTTP. Quan `save_api_request=true`, `request_id` és l'id de sessió persistit i els camps d'imatge són URL multimèdia de curta durada; amb `save_api_request=false` són cadenes JPEG en base64 en línia.", "content": { "application/json": { "examples": { "Approved": { "summary": "Document d'identitat de dues cares llegit correctament (desat — imatges com a URL multimèdia)", "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 sessió persistida quan `save_api_request=true` (utilitzable amb `GET /v3/session/{sessionId}/decision/`); en cas contrari, un UUID de correlació transitori." }, "id_verification": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "`Approved` quan cap advertència no es resol en un rebuig i la comprovació de prova de vida del document sol·licitada ha generat un resultat utilitzable; `In Review` quan la comprovació sol·licitada no ha generat cap resultat utilitzable (`DOCUMENT_LIVENESS_NOT_COMPUTED`); `Declined` quan una advertència es resol en un rebuig — la llista `warnings` n'explica el motiu." }, "document_type": { "type": "string", "nullable": true, "description": "Nom visible del tipus de document detectat: `Identity Card`, `Passport`, `Driver's License`, `Residence Permit`, `Health Insurance Card` o `Tax Card`. `null` quan el document no s'ha pogut classificar.", "example": "Identity Card" }, "document_subtype": { "type": "string", "nullable": true, "description": "Subtipus més detallat quan estigui disponible (p. ex. `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 secundari imprès en alguns documents.", "example": "20446581H" }, "portrait_image": { "type": "string", "nullable": true, "description": "Foto de retrat retallada del document. Un URL de fitxer multimèdia de curta durada (`https:///ocr/...`) quan `save_api_request=true` (per defecte); una cadena JPEG codificada en base64 integrada quan `save_api_request=false`. `null` quan no s'ha detectat cap retrat." }, "front_image": { "type": "string", "nullable": true, "description": "Retall alineat de l'anvers del document. URL del contingut multimèdia quan s'ha desat, JPEG en base64 en línia en cas contrari." }, "back_image": { "type": "string", "nullable": true, "description": "Retall alineat del revers del document. `null` quan no s'ha pujat cap `back_image`." }, "front_image_camera_front": { "type": "string", "nullable": true, "description": "Sempre `null` en aquest endpoint (només s'omple en sessions de verificació amb captura de càmera)." }, "back_image_camera_front": { "type": "string", "nullable": true, "description": "Sempre `null` en aquest endpoint." }, "front_image_camera_front_face_match_score": { "type": "number", "nullable": true, "description": "Sempre `null` en aquest endpoint." }, "back_image_camera_front_face_match_score": { "type": "number", "nullable": true, "description": "Sempre `null` en aquest endpoint." }, "front_image_quality_score": { "type": "object", "nullable": true, "description": "Diagnòstics de qualitat de captura per a la imatge pujada (`null` quan no s'ha proporcionat el costat o la puntuació ha fallat). Totes les puntuacions són de 0 a 100.", "properties": { "focus_score": { "type": "number", "format": "float", "description": "Nitidesa del retall del document (com més alt, més nítid)." }, "brightness_score": { "type": "number", "format": "float", "description": "Qualitat de l'exposició (com més alta, millor)." }, "brightness_issue": { "type": "string", "nullable": true, "description": "`ok` quan l'exposició és correcta; en cas contrari, el problema detectat (p. ex., massa fosc / massa brillant)." }, "is_document_fully_visible": { "type": "boolean", "nullable": true, "description": "Indica si les quatre cantonades del document estan dins de l'enquadrament." }, "resolution_score": { "type": "number", "format": "float", "description": "Resolució efectiva de l'àrea del document." }, "overall_score": { "type": "number", "format": "float", "description": "Puntuació de qualitat agregada." } } }, "back_image_quality_score": { "type": "object", "nullable": true, "description": "Diagnòstics de qualitat de captura per a la imatge pujada (`null` quan no s'ha proporcionat el costat o la puntuació ha fallat). Totes les puntuacions són de 0 a 100.", "properties": { "focus_score": { "type": "number", "format": "float", "description": "Nitidesa del retall del document (com més alt, més nítid)." }, "brightness_score": { "type": "number", "format": "float", "description": "Qualitat de l'exposició (com més alta, millor)." }, "brightness_issue": { "type": "string", "nullable": true, "description": "`ok` quan l'exposició és correcta; en cas contrari, el problema detectat (p. ex., massa fosc / massa brillant)." }, "is_document_fully_visible": { "type": "boolean", "nullable": true, "description": "Indica si les quatre cantonades del document estan dins de l'enquadrament." }, "resolution_score": { "type": "number", "format": "float", "description": "Resolució efectiva de l'àrea del document." }, "overall_score": { "type": "number", "format": "float", "description": "Puntuació de qualitat agregada." } } }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "example": "1980-01-13" }, "age": { "type": "integer", "nullable": true, "description": "Edat del titular en anys, 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 emissor (ISO 3166-1 alfa-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` quan no està imprès o detectat.", "example": "M" }, "address": { "type": "string", "nullable": true, "description": "Adreça exactament com està impresa al document." }, "formatted_address": { "type": "string", "nullable": true, "description": "Versió geocodificada i normalitzada de `address`." }, "place_of_birth": { "type": "string", "nullable": true, "example": "Valencia, Valencia" }, "marital_status": { "type": "string", "nullable": true, "description": "`UNKNOWN` tret que el document imprimeixi l'estat civil.", "example": "UNKNOWN" }, "nationality": { "type": "string", "nullable": true, "description": "Nacionalitat del titular (ISO 3166-1 alfa-3).", "example": "ESP" }, "extra_fields": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Camps addicionals específics del document que no tenen una columna dedicada (p. ex., `first_surname`/`second_surname` en DNIs espanyols, categories de permís en permisos de conduir)." }, "mrz": { "type": "object", "description": "Zona de lectura mecànica analitzada. Un **objecte buit** (`{}`) quan el document no té MRZ o no s'ha pogut llegir; en aquest cas, consulta també la llista `warnings`. Les dates de la MRZ utilitzen el format brut `YYMMDD`.", "properties": { "surname": { "type": "string", "example": "FORES SENA" }, "name": { "type": "string", "example": "JULIO FRANCISCO" }, "country": { "type": "string", "description": "País emissor (ISO 3166-1 alfa-3).", "example": "ESP" }, "nationality": { "type": "string", "description": "Nacionalitat del titular (ISO 3166-1 alfa-3).", "example": "ESP" }, "birth_date": { "type": "string", "description": "Data de naixement en brut de la MRZ (`YYMMDD`).", "example": "800113" }, "expiry_date": { "type": "string", "description": "Data de caducitat en brut de la MRZ (`YYMMDD`).", "example": "320331" }, "sex": { "type": "string", "example": "M" }, "document_type": { "type": "string", "description": "Codi de tipus de document de la MRZ (p. ex., `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ígit de control de la MRZ per a la data de naixement.", "example": "9" }, "expiry_date_hash": { "type": "string", "description": "Dígit de control de la MRZ per a la data de caducitat.", "example": "8" }, "document_number_hash": { "type": "string", "description": "Dígit de control de la MRZ per al número de document.", "example": "3" }, "final_hash": { "type": "string", "description": "Dígit de control compost de la MRZ.", "example": "3" }, "personal_number": { "type": "string", "nullable": true, "example": "20446581H" }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Advertències no crítiques d'anàlisi de la MRZ." }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Errors de dígits de control o d'anàlisi de la MRZ. Els errors que no siguin buits es mostren com una advertència `MRZ_VALIDATION_FAILED`." }, "mrz_type": { "type": "string", "description": "Format de la MRZ: `TD1` (targetes d'identitat, 3 línies), `TD2` o `TD3` (passaports, 2 línies).", "example": "TD1" }, "mrz_string": { "type": "string", "description": "Text en brut de la MRZ tal com s'ha llegit, amb les línies separades per `\\n`." }, "mrz_key": { "type": "string", "description": "Clau composta (número de document + dígits de control) utilitzada per a comprovacions creuades." } } }, "parsed_address": { "type": "object", "nullable": true, "description": "Desglossament estructurat i geocodificat de `address`. `null` quan el document no conté cap adreça o no s'ha pogut analitzar.", "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": "Codi 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 d'adreça 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ó en brut (`address_components`, `geometry.location`, `place_id`, …) per a consumidors avançats." }, "document_location": { "type": "object", "nullable": true, "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "description": "Coordenades geocodificades de l'adreça del document." }, "label": { "type": "string", "nullable": true, "description": "De quin camp del document s'ha llegit l'adreça.", "example": "Spain Identity Card Address" }, "is_verified": { "type": "boolean", "description": "Indica si la geocodificació ha confirmat que l'adreça existeix." }, "category": { "type": "string", "nullable": true, "description": "Categoria de l'adreça (p. ex., `Residential`, `Commercial`).", "example": "Residential" } } }, "warnings": { "type": "array", "description": "Buit en cas d'aprovació neta. Cada entrada explica un risc detectat; les entrades amb `log_type: \"error\"` estableixen `status` a `Declined`, i `DOCUMENT_LIVENESS_NOT_COMPUTED` (`log_type: \"warning\"`) l'estableix a `In Review`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "description": "Codi de risc llegible per màquina. Riscos de rebuig automàtic: `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` (només 400, mai una advertència), `DOCUMENT_NUMBER_NOT_DETECTED`, `COULD_NOT_DETECT_DOCUMENT_TYPE`, `NAME_NOT_DETECTED`, `DATE_OF_BIRTH_NOT_DETECTED`. Regulats per opcions de la sol·licitud: `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`). Altres riscos (p. ex. `POSSIBLE_DUPLICATED_USER`) són informatius. `DOCUMENT_LIVENESS_NOT_COMPUTED` es genera quan `perform_document_liveness=true` però la comprovació de falsificació no ha retornat cap puntuació utilitzable; estableix `status` a `In Review`. `COULD_NOT_DETECT_DOCUMENT_TYPE` també es retorna quan l'anvers del document no coincideix amb un disseny de document oficial conegut amb prou confiança, com ara un document editat o generat per ordinador, o un disseny que encara no és compatible.", "example": "DOCUMENT_EXPIRED" }, "feature": { "type": "string", "enum": [ "ID_VERIFICATION" ], "description": "Funcionalitat que ha generat l'advertència. Sempre `ID_VERIFICATION` en aquest endpoint." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Context addicional per a alguns riscos (p. ex. `POSSIBLE_DUPLICATED_USER` inclou `duplicated_session_id`); `null` per a la majoria." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravetat. Les advertències `error` canvien `status` a `Declined`; `warning` (només `DOCUMENT_LIVENESS_NOT_COMPUTED`, quan la comprovació de falsificació sol·licitada no ha produït cap puntuació utilitzable) canvia `status` a `In Review`; les entrades `information` són consultives i mai no canvien l'estat." }, "short_description": { "type": "string", "description": "Resum d'una sola línia del risc, llegible per a humans." }, "long_description": { "type": "string", "description": "Explicació fàcil de llegir del risc." } } } }, "barcodes": { "type": "array", "description": "Codis de barres descodificats del document (PDF417, QR, …). Buit quan el document no en té cap o no se n'ha pogut llegir cap.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Tipus de codi de barres (p. ex., `PDF417`, `QR_CODE`, `UNKNOWN`)." }, "position": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ubicació del codi de barres a la imatge, quan estigui disponible." }, "data": { "type": "string", "description": "Payload descodificat." }, "data_raw": { "type": "string", "description": "Payload en brut (sense descodificar), si és diferent." }, "side": { "type": "string", "nullable": true, "description": "`front` o `back`." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò de les `vendor_data` que has enviat, o `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ressò de l'objecte `metadata` que has enviat, o `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de temps ISO 8601 (UTC) de quan s'ha generat la resposta." } } } } } }, "400": { "description": "Error de validació o de processament. Els problemes a nivell de camp retornen l'embolcall estàndard de DRF (un array de missatges per camp afectat). Els problemes de PDF xifrats retornen `{\"detail\": ...}`. Una imatge de document en què no es pot reconèixer cap document retorna `{\"error\": \"COULD_NOT_RECOGNIZE_DOCUMENT\"}`. Les càrregues de PDF també poden fallar amb \"The submitted PDF file is corrupted or invalid.\" o un error de document sense pàgines.", "content": { "application/json": { "examples": { "Missing front image": { "summary": "`front_image` no s'ha inclòs a les dades del formulari", "value": { "front_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Extensió de fitxer no permesa (només 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": "La pujada supera el límit de 10 MB", "value": { "front_image": [ "File size should not exceed 10 MB" ] } }, "Invalid option value": { "summary": "Les opcions només accepten DECLINE o NO_ACTION", "value": { "invalid_mrz_action": [ "\"REVIEW\" is not a valid choice." ] } }, "Encrypted PDF": { "summary": "PDF pujat sense la contrasenya 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 desxifra el PDF", "value": { "detail": "The PDF password is incorrect. Please provide the correct password." } }, "Document not recognized": { "summary": "No s'ha pogut detectar cap document d'identitat a la imatge", "value": { "error": "COULD_NOT_RECOGNIZE_DOCUMENT" } }, "PDF conversion failure": { "summary": "El PDF pujat no s'ha pogut convertir en una imatge", "value": { "error": "Failed to convert front image PDF." } } } } } }, "403": { "description": "Permís denegat. Es retorna quan falta la capçalera `x-api-key`, i també quan el saldo de l'organització que fa la crida no pot cobrir la crida; una clau incorrecta, revocada o caducada retorna `401`. Si falta la clau es retorna `403` amb `{\"detail\": ...}`; una clau incorrecta, revocada o caducada retorna `401`. La manca de crèdit retorna `403` amb `{\"error\": ...}` abans que es produeixi cap processament d'imatges.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de l'organització no pot cobrir la crida", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Més de 300 sol·licituds d'escriptura en el minut 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": { "$ref": "#/components/responses/DocumentProcessingBusy" } }, "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": "Coincidència facial", "description": "Compara dues imatges facials (1:1) i obtén una puntuació de similitud `score` (0–100) més un estat `status` `Approved`/`Declined`.\n\n**Com funciona.** Ambdues imatges es descodifiquen i s'analitzen mitjançant un model biomètric (defineix `rotate_image=true` si les captures poden estar de costat o cap per avall), i després es calcula una puntuació de similitud entre les dues cares. Una puntuació **estrictament superior** a `face_match_score_decline_threshold` (per defecte `30`) retorna `status: \"Approved\"`; una puntuació igual o inferior retorna `Declined` amb una advertència `LOW_FACE_MATCH_SIMILARITY`. Si no es pot puntuar cap parell de cares, la crida continua retornant `200` amb `status: \"Declined\"` i una advertència `NO_REFERENCE_IMAGE` — `score` és `null` en la ruta de desat per defecte, o `0` amb `save_api_request=false`. Envia una sola cara frontal i nítida per imatge per obtenir els millors resultats.\n\n**Facturació.** Cada resposta `200` consumeix un crèdit de l'API de Coincidència facial (pagat des del crèdit del teu pla o saldo de recàrrega). Quan el saldo de l'organització no pot cobrir la crida, l'endpoint retorna `403` amb l'error de crèdits insuficients abans de processar cap imatge.\n\n**Persistència de la sessió (`save_api_request`, per defecte `true`).** Quan és `true`, la crida es desa com una sessió de tipus API: apareix a la Business Console, el `request_id` retornat és un identificador de sessió real que pots passar a `GET /v3/session/{sessionId}/decision/`, ambdues imatges s'emmagatzemen com a imatges d'origen i objectiu de coincidència facial de la sessió, i s'emet un webhook `status.updated` cap a les teves destinacions de webhook configurades. Quan és `false`, no s'emmagatzema res i `request_id` és un UUID de correlació puntual que no es podrà consultar més endavant.\n\n**Índex de cerca facial.** Aquest endpoint mai no inscriu cares al teu índex de cerca facial ni executa cribratge de llistes de bloqueig o duplicats — utilitza `POST /v3/passive-liveness/` o `POST /v3/face-search/` per a aquests casos.\n\n**Sandbox.** Les claus d'API de sandbox ometen tot el processament i la facturació: després de la validació de la sol·licitud (les entrades mal formades continuen retornant `400`), l'endpoint retorna un payload simulat estàtic `Approved`, no es desa cap sessió i no es consumeixen crèdits.\n\n**Autenticació.** Envia la clau d'API de la teva aplicació a la capçalera `x-api-key`. Unes credencials absents o no vàlides retornen `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`) — aquesta API mai no retorna `401`.\n\n**Límit de freqüència.** Quota compartida d'escriptura de 300 sol·licituds/min per clau d'API en tots els endpoints POST/PATCH/DELETE; superar-lo retorna `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": "Imatge facial en viu o candidata a verificar (p. ex., una selfie). Envia una única fotografia frontal amb la cara del subjecte ben visible i ben il·luminada. Extensions permeses: `tiff`, `jpg`, `jpeg`, `png`, `webp`. Mida màxima de pujada: **5 MB** (els fitxers més grans es rebutgen amb `400`). Les imatges es comprimeixen automàticament a ~0.5 MB abans de processar-les, per la qual cosa les resolucions molt altes no milloren la precisió." }, "ref_image": { "type": "string", "format": "binary", "description": "Imatge facial de referència amb la qual comparar (p. ex., la foto d'un document d'identitat o una foto registrada prèviament). Els mateixos límits de format i mida que `user_image`." }, "face_match_score_decline_threshold": { "type": "number", "format": "float", "default": 30, "minimum": 0, "maximum": 100, "description": "Llindar de similitud (0–100) que determina el valor de `status` a la resposta. Una puntuació calculada **igual o inferior** a aquest valor estableix `status` com a `Declined` i afegeix una advertència `LOW_FACE_MATCH_SIMILARITY`; una puntuació estrictament superior retorna `Approved`. El valor per defecte `30` és permissiu —augmenta'l (p. ex., `50`–`60`) per a una verificació més estricta. Els valors fora de 0–100 retornen `400`.", "example": 50 }, "rotate_image": { "type": "boolean", "default": false, "description": "Quan és `true`, el servei prova les imatges d'entrada en increments de 90 graus (0, 90, 180, 270) i utilitza l'orientació que ofereix la millor detecció facial — útil per a captures mòbils a les quals falta l'orientació EXIF. Afegeix latència, de manera que activa'l només si no pots garantir imatges orientades correctament.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Quan és `true` (per defecte), manté la crida com una sessió de tipus API — visible a la Business Console, recuperable mitjançant `GET /v3/session/{sessionId}/decision/` utilitzant el `request_id` retornat i anunciada a través d'un webhook `status.updated`. Quan és `false`, no s'emmagatzema res i `request_id` és un UUID transitori només per a la correlació de la resposta.", "example": true }, "vendor_data": { "type": "string", "description": "Cadena opaca opcional (el teu ID d'usuari intern, correu electrònic, UUID…) desada a la sessió persistent i retornada a la resposta. Utilitza-la per correlacionar crides a l'API amb els teus propis registres i per filtrar sessions més endavant.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objecte JSON opcional emmagatzemat amb la sessió (quan `save_api_request=true`) i retornat a la resposta. En sol·licituds multipart, envia'l com a camp de cadena codificat en JSON (p. ex., `metadata={\"flow\":\"login\"}`); s'analitza com un objecte.", "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": "Coincidència facial calculada. `face_match.score` és un nombre flotant de 0 a 100 (dos decimals); `status` és `Approved` quan la puntuació està estrictament per sobre de `face_match_score_decline_threshold`, altrament `Declined` amb una advertència explicativa. Una similitud baixa o una parella no avaluable encara retorna `200` — inspecciona `face_match.status` i `face_match.warnings`, no només el codi HTTP. Quan `save_api_request=true`, `request_id` és l'identificador de sessió persistit.", "content": { "application/json": { "examples": { "Approved": { "summary": "Mateixa persona: puntuació per sobre del llindar", "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ó igual o inferior al llindar de rebuig", "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 sessió persistida quan `save_api_request=true` (utilitzable amb `GET /v3/session/{sessionId}/decision/`); en cas contrari, un UUID de correlació transitori." }, "face_match": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Approved` quan la puntuació de similitud és estrictament superior a `face_match_score_decline_threshold` i s'ha pogut calcular una puntuació; `Declined` en cas contrari (una advertència n'explica el motiu)." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Puntuació de similitud de 0 a 100 —la confiança del model que ambdues imatges representen la mateixa persona. Arrodonida a dos decimals només quan `save_api_request` és cert; amb `save_api_request=false` es retorna el nombre decimal en cru. `null` quan no s'ha pogut puntuar cap parell de cares (amb el valor per defecte `save_api_request=true`); amb `save_api_request=false` la mateixa condició es pot mostrar com a `score: 0`. En qualsevol cas, hi ha una advertència `NO_REFERENCE_IMAGE` present i `status` és `Declined`.", "example": 99.41 }, "user_image": { "type": "object", "description": "Resultats de la detecció facial per a les imatges analitzades.", "properties": { "entities": { "type": "array", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Quadre delimitador de la cara detectada com a coordenades de píxels `[x_min, y_min, x_max, y_max]` a la imatge processada.", "example": [ 661, 728, 1688, 2188 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Confiança de la detecció facial (0–1).", "example": 0.732973 }, "age": { "type": "number", "format": "float", "description": "Edat estimada pel model de la cara detectada, en anys. Només informativa: no afecta la decisió de coincidència facial.", "example": 26.91 }, "gender": { "type": "string", "description": "Gènere predit pel model de la cara detectada (`male` o `female`). Només informatiu.", "example": "male" }, "race": { "type": "string", "nullable": true, "description": "Camp reservat: sempre `null` a les respostes d'aquest endpoint.", "example": null } } }, "description": "Una entrada per cara detectada." }, "best_angle": { "type": "integer", "description": "Rotació (graus: 0, 90, 180 o 270) que ha produït la millor detecció facial. Només és diferent de zero quan `rotate_image=true` ha corregit l'orientació.", "example": 0 } } }, "ref_image": { "type": "object", "description": "Resultats de la detecció facial per a la imatge de referència, amb la mateixa estructura que `user_image`.", "properties": { "entities": { "type": "array", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Quadre delimitador de la cara detectada com a coordenades de píxels `[x_min, y_min, x_max, y_max]` a la imatge processada.", "example": [ 661, 728, 1688, 2188 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Confiança de la detecció facial (0–1).", "example": 0.732973 }, "age": { "type": "number", "format": "float", "description": "Edat estimada pel model de la cara detectada, en anys. Només informativa: no afecta la decisió de coincidència facial.", "example": 26.91 }, "gender": { "type": "string", "description": "Gènere predit pel model de la cara detectada (`male` o `female`). Només informatiu.", "example": "male" }, "race": { "type": "string", "nullable": true, "description": "Camp reservat: sempre `null` a les respostes d'aquest endpoint.", "example": null } } }, "description": "Una entrada per cara detectada." }, "best_angle": { "type": "integer", "example": 0 } } }, "warnings": { "type": "array", "description": "Buit en cas d'aprovació neta. `NO_REFERENCE_IMAGE` (`error`): no s'ha pogut puntuar cap parell de cares; `LOW_FACE_MATCH_SIMILARITY` (`error`): puntuació igual o inferior al llindar de rebuig. Qualsevol d'aquestes estableix `status` a `Declined`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "NO_REFERENCE_IMAGE", "LOW_FACE_MATCH_SIMILARITY" ], "description": "Codi de risc llegible per màquina." }, "feature": { "type": "string", "enum": [ "FACEMATCH" ], "description": "Funcionalitat que ha generat l'advertència. Sempre `FACEMATCH` en aquest endpoint." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Sempre `null` per a les advertències de coincidència facial." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravetat. Les advertències `error` canvien `status` a `Declined`; les entrades `warning` i `information` són consultives i mai no rebutgen per si soles." }, "short_description": { "type": "string", "description": "Resum d'una sola línia del risc, llegible per a humans." }, "long_description": { "type": "string", "description": "Explicació fàcil de llegir del risc." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò de les `vendor_data` que has enviat, o `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ressò de l'objecte `metadata` que has enviat, o `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de temps ISO 8601 (UTC) de quan s'ha generat la resposta, p. ex. `2026-06-12T01:04:42.763237+00:00`." } } } } } }, "400": { "description": "Error de validació. Es retorna quan falta una imatge obligatòria, supera els 5 MB, té una extensió no admesa o quan una opció està fora de rang. El cos és l'embolcall estàndard d'errors de camp de DRF: una matriu de missatges per cada camp que conté l'error.", "content": { "application/json": { "examples": { "Missing required image": { "summary": "`ref_image` (o `user_image`) no s'ha inclòs a les dades del formulari", "value": { "ref_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Extensió de fitxer no permesa (només 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": "La pujada supera el límit de 5 MB", "value": { "user_image": [ "File size should not exceed 5 MB" ] } }, "Threshold out of range": { "summary": "`face_match_score_decline_threshold` fora de 0–100", "value": { "face_match_score_decline_threshold": [ "Ensure this value is less than or equal to 100." ] } } } } } }, "403": { "description": "Permís denegat. Es retorna quan falta la capçalera `x-api-key`, i també quan el saldo de l'organització que fa la crida no pot cobrir la crida; una clau incorrecta, revocada o caducada retorna `401`. Si falta la clau es retorna `403` amb `{\"detail\": ...}`; una clau incorrecta, revocada o caducada retorna `401`. La manca de crèdit retorna `403` amb `{\"error\": ...}` abans que es produeixi cap processament d'imatges.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de l'organització no pot cobrir la crida", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Més de 300 sol·licituds d'escriptura en el minut 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ó d'edat (edat facial + prova de vida passiva)", "description": "Estima l'edat d'una persona a partir d'una sola foto de la cara i fa una prova de vida passiva en la mateixa crida — retorna el valor `age_estimation` predit pel model (en anys), una `score` de prova de vida (0–100) i un `status` `Approved`/`Declined`. L'edat està **predita pel model a partir de la cara, no verificada contra un document** — utilitza-la per a controls d'edat i comprovacions de baixa fricció, no com a prova legal d'edat.\n\n**Com funciona.** S'analitza la imatge per detectar cares (defineix `rotate_image=true` si les captures poden estar de costat o cap per avall); cada cara detectada rep una edat estimada, i la cara més gran de l'enquadrament determina `age_estimation`. En paral·lel, un model de prova de vida passiva puntua si la foto mostra una persona real (sense requerir cap repte a l'usuari) i detecta atacs de presentació (fotos de fotos, pantalles, màscares). Envia una sola cara clara, frontal i ben il·luminada per imatge per obtenir els millors resultats.\n\n**Lògica de decisió.** Qualsevol advertència comporta el rebuig: l'`status` és `Approved` només quan l'array `warnings` és buit. Una `score` de prova de vida igual o inferior a `face_liveness_score_decline_threshold` (per defecte `30`) afegeix `LOW_LIVENESS_SCORE`; un atac detectat afegeix `LIVENESS_FACE_ATTACK`; si el model de prova de vida no troba cap cara s'afegeix `NO_FACE_DETECTED`; si no es pot estimar l'edat de la cara s'afegeix `AGE_NOT_DETECTED` (`age_estimation` és `null`); una edat estimada per sota de `age_estimation_decline_threshold` (per defecte `18`) afegeix `AGE_BELOW_MINIMUM`. Les edats dubtoses properes al teu llindar mereixen una alternativa basada en la verificació de documents — l'error del model augmenta per a cares properes al límit.\n\n**Facturació.** Cada resposta `200` consumeix un crèdit de l'API d'Estimació d'edat (pagat amb el crèdit del teu pla o amb el saldo de recàrrega). Quan el saldo de l'organització no pot cobrir la crida, l'endpoint retorna `403` amb l'error de crèdits insuficients abans de qualsevol processament d'imatge.\n\n**Persistència de la sessió (`save_api_request`, per defecte `true`).** Quan és `true`, la crida es persisteix com una sessió de tipus API: apareix a la Business Console, el `request_id` retornat és un identificador de sessió real que pots passar a `GET /v3/session/{sessionId}/decision/` (el resultat s'exposa allà a `liveness_checks[]`, amb `features: [\"AGE_ESTIMATION\"]`), la retallada de la cara i la imatge de referència s'emmagatzemen, l'embedding facial s'afegeix a l'índex de cares de la teva aplicació (utilitzat per la cerca facial i la detecció de duplicats) i s'emet un webhook `status.updated`. Quan és `false`, no s'emmagatzema res i `request_id` és un UUID de correlació d'un sol ús que no es pot consultar posteriorment.\n\n**Sandbox.** Les claus d'API de sandbox ometen tot el processament i la facturació: després de la validació de la sol·licitud (l'entrada mal formada continua retornant `400`), l'endpoint retorna un payload simulat estàtic `Approved` (`age_estimation: 30`, sense advertències), no es persisteix cap sessió i no es consumeixen crèdits.\n\n**Autenticació.** Envia la clau d'API de la teva aplicació a la capçalera `x-api-key`. Les credencials absents o no vàlides retornen `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`) — aquesta API mai retorna `401`.\n\n**Límit de freqüència.** Pressupost compartit d'escriptura de 300 sol·licituds/min per clau d'API a tots els endpoints POST/PATCH/DELETE; superar-lo retorna `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 de la cara per analitzar (p. ex., una selfie). Envia una única foto frontal amb la cara de l'individu clarament visible i ben il·luminada. Extensions permeses: `tiff`, `jpg`, `jpeg`, `png`, `webp` (no s'admet PDF). Mida màxima de càrrega: **5 MB** (els fitxers més grans es rebutgen amb un error `400`). Les imatges es comprimeixen automàticament a ~0,3 MB abans del processament, de manera que resolucions molt altes no milloren la precisió." }, "face_liveness_score_decline_threshold": { "type": "number", "format": "float", "default": 30, "minimum": 0, "maximum": 100, "description": "Llindar de prova de vida (0–100). Una `score` de prova de vida **igual o inferior** a aquest valor afegeix una advertència `LOW_LIVENESS_SCORE` i rebutja. Augmenta'l per a una postura antisuplantació més estricta; els valors fora de 0–100 retornen `400`.", "example": 30 }, "age_estimation_decline_threshold": { "type": "integer", "default": 18, "minimum": 0, "maximum": 100, "description": "Edat estimada mínima acceptable en anys. Una edat estimada **per sota** d'aquest valor afegeix una advertència `AGE_BELOW_MINIMUM` i rebutja. Estableix `0` per desactivar la comprovació d'edat (aleshores la crida només executa la prova de vida + estimació d'edat sense una decisió basada en l'edat).", "example": 18 }, "rotate_image": { "type": "boolean", "default": false, "description": "Quan és `true`, el servei prova la imatge d'entrada en increments de 90 graus (0, 90, 180, 270) i utilitza l'orientació que ofereix la millor detecció facial — útil per a captures mòbils a les quals falta l'orientació EXIF. Afegeix latència, de manera que activa'l només si no pots garantir imatges orientades correctament.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Quan és `true` (per defecte), manté la crida com una sessió de tipus API — visible a la Business Console, recuperable mitjançant `GET /v3/session/{sessionId}/decision/` utilitzant el `request_id` retornat, anunciada a través d'un webhook `status.updated` i amb la cara detectada afegida a l'índex facial de la teva aplicació. Quan és `false`, no s'emmagatzema res i `request_id` és un UUID transitori només per a la correlació de la resposta.", "example": true }, "vendor_data": { "type": "string", "description": "Cadena opaca opcional (el teu ID d'usuari intern, correu electrònic, UUID…) desada a la sessió persistent i retornada a la resposta. Utilitza-la per correlacionar crides a l'API amb els teus propis registres i per filtrar sessions més endavant.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objecte JSON opcional emmagatzemat amb la sessió (quan `save_api_request=true`) i retornat a la resposta. En sol·licituds multipart, envia'l com a camp de cadena codificat en JSON (p. ex., `metadata={\"flow\":\"age-gate\"}`); s'analitza com un objecte.", "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ó d'edat i prova de vida passiva completades. `age_estimation.age_estimation` és l'edat en anys predita pel model de la cara detectada més gran (`null` si no n'hi ha cap); `age_estimation.score` és la puntuació de prova de vida passiva (0–100); `status` és `Approved` només quan `warnings` està buit. Una captura d'un menor d'edat o amb suplantació continua retornant `200` amb `status: \"Declined\"` — inspecciona el cos, no només el codi HTTP. Quan `save_api_request=true`, `request_id` és l'id de la sessió persistida.", "content": { "application/json": { "examples": { "Approved": { "summary": "Cara d'adult real — ambdues comprovacions superades", "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": "Edat estimada per sota de `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ó de la prova de vida igual o inferior al llindar de rebuig (possible suplantació)", "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 sessió persistida quan `save_api_request=true` (utilitzable amb `GET /v3/session/{sessionId}/decision/`); en cas contrari, un UUID de correlació transitori." }, "age_estimation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Approved` quan no s'ha generat cap advertència; `Declined` en cas contrari (cada advertència que produeix aquest endpoint comporta un rebuig)." }, "method": { "type": "string", "enum": [ "PASSIVE" ], "description": "Mètode de prova de vida. Sempre `PASSIVE` en aquest endpoint (imatge única, sense desafiament per a l'usuari)." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Puntuació de la prova de vida passiva de 0 a 100: la confiança del model que la foto mostra una persona viva. Es compara amb `face_liveness_score_decline_threshold`; si és igual o inferior, la crida es rebutja amb `LOW_LIVENESS_SCORE`. `null` quan el model de prova de vida no retorna cap confiança; la crida igualment es rebutja amb `LOW_LIVENESS_SCORE` perquè el valor null es tracta com a 0 per a la comparació amb el llindar.", "example": 97.5 }, "user_image": { "type": "object", "description": "Resultats de la detecció facial per a la imatge analitzada.", "properties": { "entities": { "type": "array", "description": "Una entrada per cara detectada. Buit quan no s'ha trobat cap cara (en aquest cas `age_estimation` és `null` i s'afegeix una advertència `AGE_NOT_DETECTED`).", "items": { "type": "object", "properties": { "age": { "type": "number", "format": "float", "description": "Edat estimada pel model d'aquesta cara, en anys.", "example": 27.33 }, "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Quadre delimitador de la cara detectada com a coordenades de píxels `[x_min, y_min, x_max, y_max]` a la imatge processada.", "example": [ 40, 40, 100, 100 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Confiança de la detecció facial (0–1).", "example": 0.7177750468254089 }, "gender": { "type": "string", "description": "Gènere predit pel model de la cara detectada (`male` o `female`). Només informatiu.", "example": "male" } } } }, "best_angle": { "type": "integer", "nullable": true, "description": "Rotació (graus: 0, 90, 180 o 270) que ha produït la millor detecció facial. Només és diferent de zero quan `rotate_image=true` ha corregit l'orientació.", "example": 0 } } }, "age_estimation": { "type": "number", "format": "float", "nullable": true, "description": "Edat prevista pel model en anys de la cara detectada **més gran**. `null` quan no s'ha pogut estimar cap edat facial (s'afegeix una advertència `AGE_NOT_DETECTED` i la crida es rebutja).", "example": 27.33 }, "warnings": { "type": "array", "description": "Buit en cas d'aprovació neta. Qualsevol entrada estableix `status` a `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": "Codi de risc llegible per màquina. `NO_FACE_DETECTED` — el model de prova de vida no ha trobat cap rostre; `LOW_LIVENESS_SCORE` — `score` de prova de vida igual o inferior a `face_liveness_score_decline_threshold`; `LIVENESS_FACE_ATTACK` — s'ha detectat un atac de presentació (foto/pantalla/màscara); `AGE_NOT_DETECTED` — no s'ha pogut estimar l'edat del rostre; `AGE_BELOW_MINIMUM` — edat estimada per sota de `age_estimation_decline_threshold`. `NO_FACE_DETECTED` i `LOW_LIVENESS_SCORE` són mútuament excloents — quan no es troba cap rostre, només s'emet `NO_FACE_DETECTED`." }, "feature": { "type": "string", "enum": [ "LIVENESS" ], "description": "Funcionalitat que ha generat l'advertència. Sempre `LIVENESS` en aquest endpoint." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Sempre `null` per a les advertències d'estimació d'edat." }, "log_type": { "type": "string", "enum": [ "error" ], "description": "Gravetat. Cada advertència que produeix aquest endpoint és un `error` i estableix `status` com a `Declined`." }, "short_description": { "type": "string", "description": "Resum d'una sola línia del risc, llegible per a humans." }, "long_description": { "type": "string", "description": "Explicació fàcil de llegir del risc." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò de les `vendor_data` que has enviat, o `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ressò de l'objecte `metadata` que has enviat, o `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de temps ISO 8601 (UTC) de quan s'ha generat la resposta." } } } } } }, "400": { "description": "Error de validació. Es retorna quan falta `user_image`, supera els 5 MB, té una extensió no admesa o quan un llindar està fora de rang. El cos és l'embolcall estàndard d'errors de camp de DRF: una matriu de missatges per cada camp que conté l'error.", "content": { "application/json": { "examples": { "Missing user image": { "summary": "`user_image` no s'ha inclòs a les dades del formulari", "value": { "user_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Extensió de fitxer no permesa (només 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": "La pujada supera el límit de 5 MB", "value": { "user_image": [ "File size should not exceed 5 MB" ] } }, "Threshold out of range": { "summary": "`face_liveness_score_decline_threshold` fora de 0–100", "value": { "face_liveness_score_decline_threshold": [ "Ensure this value is less than or equal to 100." ] } } } } } }, "403": { "description": "Permís denegat. Es retorna quan falta la capçalera `x-api-key`, i també quan el saldo de l'organització que fa la crida no pot cobrir la crida; una clau incorrecta, revocada o caducada retorna `401`. Si falta la clau es retorna `403` amb `{\"detail\": ...}`; una clau incorrecta, revocada o caducada retorna `401`. La manca de crèdit retorna `403` amb `{\"error\": ...}` abans que es produeixi cap processament d'imatges.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de l'organització no pot cobrir la crida", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Més de 300 sol·licituds d'escriptura en el minut 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": "Comprovant de domicili (OCR de documents + comprovacions d'adreça)", "description": "Extreu i valida un document de comprovant de domicili —factures de serveis bàsics, extractes bancaris i documents emesos pel govern— en una sola crida. Retorna l'emissor, les dates d'emissió/caducitat, el nom del titular, l'adreça sense processar i analitzada/geocodificada, un `status` d'`Approved`/`Declined` i una llista de `warnings` que explica cada incidència trobada.\n\n**Latència.** L'extracció es basa en LLM: les crides habituals triguen entre **5 i 15 segons**, i els PDF de diverses pàgines fins a **~30 segons**. Configura un temps d'espera del client d'**almenys 45 segons** i no reintentis abans que la crida hagi finalitzat.\n\n**Com funciona.** El document (imatge o PDF, de fins a 15 MB; els PDF xifrats requereixen `document_password`) es classifica en un tipus i subtipus de document (p. ex., `UTILITY_BILL` / `WATER_BILL`), i l'emissor, les dates, el nom del titular i l'adreça s'extreuen mitjançant una extracció basada en LLM. L'adreça s'analitza i es geocodifica a `poa_parsed_address`. L'anàlisi forense de PDF/EXIF examina possibles manipulacions —modificació després de la signatura digital, editors de PDF coneguts, manipulació de text superposat, reexportacions sospitoses— i mostra `SUSPECTED_DOCUMENT_MANIPULATION` o `DOCUMENT_METADATA_MISMATCH`. Un camp de text que s'ha esborrat i s'ha tornat a escriure amb una altra font, on el propi fitxer no conté proves de si el seu contingut ha canviat, mostra `POA_DOCUMENT_UNPROVEN_TEXT_REPLACEMENT`. L'antiguitat del document es valida respecte a `poa_document_age_months`, i l'idioma respecte a `poa_languages_allowed`. Si proporciones `expected_address`, `expected_country` o `expected_first_name`/`expected_last_name`, els valors extrets es contrasten i s'assenyalen les discrepàncies.\n\n**Lògica de decisió.** `status` és `Approved` tret que com a mínim una advertència provoqui un rebuig. Els errors greus sempre el rebutgen: `MISSING_ADDRESS_INFORMATION`, `POA_DOCUMENT_EXPIRED`, `INVALID_DOCUMENT_TYPE`, `UNABLE_TO_VALIDATE_DOCUMENT_AGE`, a més d'`UNABLE_TO_EXTRACT_ISSUE_DATE` i `POA_NAME_NOT_DETECTED` (no configurables en aquest endpoint). Cinc grups de risc són configurables per sol·licitud mitjançant les opcions `poa_*_action` (`DECLINE` o `NO_ACTION`, totes amb `DECLINE` com a valor predeterminat). `POA_DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION` i `UNPARSABLE_OR_INVALID_ADDRESS` són informatius en aquest endpoint i mai no rebutgen. Un document que no es pugui processar en absolut retorna `400`; un document llegible però problemàtic retorna `200` amb `status: \"Declined\"` —inspecciona sempre `poa.status` i `poa.warnings`, no només el codi HTTP.\n\n**Facturació.** Cada resposta `200` consumeix un crèdit d'API de Comprovant de domicili (pagat des del crèdit del teu pla o saldo de recàrrega). Quan el saldo de l'organització no pugui cobrir la crida, l'endpoint retorna `403` amb l'error de crèdits insuficients abans de processar cap document.\n\n**Persistència de la sessió (`save_api_request`, per defecte `true`).** Quan és `true`, la crida es desa com una sessió de tipus API: apareix a la Business Console, el document pujat s'emmagatzema, el `request_id` retornat és un ID de sessió real que pots passar a `GET /v3/session/{sessionId}/decision/` (la decisió exposa addicionalment `document_file` i l'anàlisi forense de `document_metadata`, que aquesta resposta omet) i s'emet un webhook `status.updated`. Quan és `false`, no s'emmagatzema res i `request_id` és un UUID de correlació d'un sol ús que no es pot consultar posteriorment.\n\n**Sandbox.** Les claus d'API de sandbox ometen tot el processament i la facturació: després de validar la sol·licitud (l'entrada amb format incorrecte continua retornant `400`), l'endpoint retorna un payload simulat estàtic `Approved` (una factura d'electricitat fictícia de «Sandbox Power Co.»), no es desa cap sessió i no es consumeixen crèdits.\n\n**Autenticació.** Envia la clau d'API de la teva aplicació a la capçalera `x-api-key`. Les credencials absents o no vàlides retornen `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`) —aquesta API mai no retorna `401`.\n\n**Límit de freqüència.** Pressupost compartit d'escriptura de 300 sol·licituds/min per clau d'API entre tots els endpoints POST/PATCH/DELETE; si se supera, es retorna `429`.\n\nNota: `FUTURE_ISSUE_DATE` i `POOR_DOCUMENT_QUALITY` existeixen a les sessions de flux de treball, però mai no es generen en aquest endpoint independent —aquí un document amb data futura no es rebutja automàticament.", "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 document de comprovant de domicili. Extensions permeses: `tiff`, `jpg`, `jpeg`, `png`, `pdf`, `webp`. Mida màxima de càrrega: **15 MB** (els fitxers més grans es rebutgen amb `400`). S'admeten PDF multipàgina (espera una latència més alta); els PDF xifrats requereixen `document_password`. Les imatges es comprimeixen automàticament abans de processar-les." }, "document_password": { "type": "string", "description": "Contrasenya per desxifrar `document` quan és un PDF xifrat. Enviar un PDF xifrat sense contrasenya (o amb una d'incorrecta) retorna `400`.", "writeOnly": true }, "expected_address": { "type": "string", "description": "Adreça a verificar en comparació amb el document. Es geocodifica i es compara amb l'adreça extreta; una discrepància (o una adreça esperada que no es pot geocodificar/verificar) afegeix `ADDRESS_MISMATCH_WITH_PROVIDED`, regit per `poa_address_mismatch_action`. La forma geocodificada es retorna a `expected_details_formatted_address` / `expected_details_parsed_address`.", "example": "Av. Monseñor Tavella 1291, Salta, Argentina" }, "expected_country": { "type": "string", "description": "País per verificar respecte al document (codi ISO 3166-1, p. ex. `ARG` o `AR`). Una discrepància amb el país del document afegeix `POA_COUNTRY_MISMATCH_WITH_PROVIDED`, regit per `poa_address_mismatch_action`.", "example": "ARG" }, "expected_first_name": { "type": "string", "description": "Nom de pila a verificar respecte a `name_on_document` (coincidència difusa, compatible amb transliteració). Una puntuació inferior al llindar de coincidència afegeix `NAME_MISMATCH_WITH_PROVIDED`, regit per `poa_address_mismatch_action`.", "example": "Sophia" }, "expected_last_name": { "type": "string", "description": "Cognom a verificar contra `name_on_document`, combinat amb `expected_first_name` per a la puntuació de coincidència.", "example": "Martinez" }, "poa_languages_allowed": { "type": "string", "description": "Llista separada per comes dels idiomes de documents acceptats com a codis ISO 639-1 (p. ex. `en,es,fr`). Quan s'omet o es deixa en blanc, s'accepten **tots 51 idiomes admesos**. Un document en un idioma que no sigui a la llista afegeix `UNSUPPORTED_DOCUMENT_LANGUAGE` (regit per `poa_unsupported_language_action`); un codi desconegut a la llista retorna `400` amb el conjunt complet de codis admesos.", "example": "en,es" }, "poa_document_age_months": { "type": "string", "description": "Parells `key:value` separats per comes que estableixen l'antiguitat màxima del document en mesos per tipus de document — claus: `utility_bill`, `bank_statement`, `government_issued_document`, `other_poa_document`; valors: `1`–`120`, o `-1` per a il·limitat (sense comprovació d'antiguitat). Valors per defecte si s'omet: `utility_bill:3,bank_statement:3,government_issued_document:12,other_poa_document:12`. Un document més antic que el seu límit es rebutja amb `POA_DOCUMENT_EXPIRED`. **Atenció:** quan proporcionis aquest camp, llista *tots* els tipus que acceptes — els tipus omesos es tracten com a no acceptats (informatiu `POA_DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION`) i s'omet la seva comprovació d'antiguitat.", "example": "utility_bill:3,bank_statement:6" }, "poa_name_mismatch_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "S'accepta però **actualment no s'aplica**: les advertències de discordança de nom (`NAME_MISMATCH_WITH_PROVIDED`) segueixen `poa_address_mismatch_action`. Defineix `poa_address_mismatch_action` per controlar el comportament de discordança tant de nom com d'adreça." }, "poa_document_issues_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Què fer davant de problemes d'integritat del fitxer — a la pràctica, aquest endpoint només produeix `DOCUMENT_METADATA_MISMATCH`." }, "poa_document_authenticity_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Què fer quan se sospita de manipulació del document (`SUSPECTED_DOCUMENT_MANIPULATION`) — p. ex., el PDF s'ha modificat després de la signatura digital, s'ha processat amb un editor de PDF conegut, mostra manipulació de text superposat o té dates EXIF incoherents. També regeix `POA_DOCUMENT_UNPROVEN_TEXT_REPLACEMENT` (un camp de text reescrit que el fitxer no pot demostrar si ha canviat o no): `DECLINE` també el rebutja, `NO_ACTION` el manté com a advertència." }, "poa_unsupported_language_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Què fer quan l'idioma del document està fora de `poa_languages_allowed` (`UNSUPPORTED_DOCUMENT_LANGUAGE`)." }, "poa_address_mismatch_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Què fer quan les dades extretes no coincideixen amb els camps `expected_*`: `ADDRESS_MISMATCH_WITH_PROVIDED`, `NAME_MISMATCH_WITH_PROVIDED` i `POA_COUNTRY_MISMATCH_WITH_PROVIDED` segueixen tots aquesta acció." }, "poa_issuer_not_identified_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Què fer quan no es pot identificar cap empresa/organització emissora al document (`ISSUER_NOT_IDENTIFIED`)." }, "save_api_request": { "type": "boolean", "default": true, "description": "Quan és `true` (per defecte), manté la crida com una sessió de tipus API — visible a la Business Console, recuperable mitjançant `GET /v3/session/{sessionId}/decision/` utilitzant el `request_id` retornat, anunciada a través d'un webhook `status.updated` i amb el document carregat emmagatzemat. Quan és `false`, no s'emmagatzema res i `request_id` és un UUID transitori només per a la correlació de la resposta.", "example": true }, "vendor_data": { "type": "string", "description": "Cadena opaca opcional (el teu ID d'usuari intern, correu electrònic, UUID…) desada a la sessió persistent i retornada a la resposta. Utilitza-la per correlacionar crides a l'API amb els teus propis registres i per filtrar sessions més endavant.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objecte JSON opcional emmagatzemat amb la sessió (quan `save_api_request=true`) i retornat a la resposta. En sol·licituds multipart, envia'l com a camp de cadena codificat en JSON (p. ex., `metadata={\"flow\":\"onboarding\"}`); s'analitza com un objecte.", "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": "Document processat. `poa.status` és `Approved` o `Declined`; cada problema detectat es detalla a `poa.warnings`. Un document caducat, no coincident o sospitós continua retornant `200` amb `status: \"Declined\"`; inspecciona el cos, no només el codi HTTP. Quan `save_api_request=true`, `request_id` és l'id de sessió persistit.", "content": { "application/json": { "examples": { "Approved": { "summary": "Factura de serveis llegida correctament, sense comprovacions dels detalls esperats", "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": "Data d'emissió anterior a la permesa per `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 coincideixen amb `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 sessió persistida quan `save_api_request=true` (utilitzable amb `GET /v3/session/{sessionId}/decision/`); en cas contrari, un UUID de correlació transitori." }, "poa": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Approved` quan cap advertència no es resol en un rebuig; `Declined` en cas contrari — la llista `warnings` n'explica el motiu." }, "issuing_state": { "type": "string", "nullable": true, "description": "País on s'ha emès el document, segons s'ha extret del document — normalment ISO 3166-1 alpha-3 (p. ex. `ARG`).", "example": "ARG" }, "document_type": { "type": "string", "enum": [ "UTILITY_BILL", "BANK_STATEMENT", "GOVERNMENT_ISSUED_DOCUMENT", "OTHER_POA_DOCUMENT", "UNKNOWN" ], "description": "Categoria del document detectada. `UNKNOWN` significa que el document no s'ha pogut classificar com un Comprovant de domicili acceptable i es rebutja automàticament amb `INVALID_DOCUMENT_TYPE`. Mai és null: els errors de classificació es resolen com a `UNKNOWN`." }, "document_subtype": { "type": "string", "description": "Classificació més detallada dins de `document_type` — p. ex. `ELECTRICITY_BILL`, `WATER_BILL`, `GAS_BILL`, `INTERNET_BILL`, `PHONE_BILL` (factures de serveis bàsics); `ACCOUNT_STATEMENT`, `CREDIT_CARD_STATEMENT` (extractes bancaris); `TAX_ASSESSMENT`, `RESIDENCY_CERTIFICATE` (documents oficials). `UNKNOWN` quan no s'ha pogut determinar cap subtipus. Mai és nul — les fallades de classificació passen per defecte a `UNKNOWN`.", "example": "WATER_BILL" }, "document_language": { "type": "string", "nullable": true, "description": "Idioma del document detectat (ISO 639-1).", "example": "es" }, "issuer": { "type": "string", "nullable": true, "description": "Empresa o organització que ha emès el document. `null` afegeix `ISSUER_NOT_IDENTIFIED`.", "example": "Aguas del Norte" }, "issue_date": { "type": "string", "format": "date", "nullable": true, "description": "Data d'emissió del document (`YYYY-MM-DD`). `null` quan no s'ha pogut extreure; això fa que es rebutgi amb `UNABLE_TO_EXTRACT_ISSUE_DATE` en aquest endpoint.", "example": "2021-02-10" }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "description": "Data explícita de caducitat/validesa impresa al document, si n'hi ha. Independent de la comprovació d'antiguitat `poa_document_age_months`." }, "poa_address": { "type": "string", "nullable": true, "description": "Adreça exactament com està impresa al document. `null` fa que es rebutgi automàticament amb `MISSING_ADDRESS_INFORMATION`." }, "poa_formatted_address": { "type": "string", "nullable": true, "description": "Versió geocodificada i normalitzada de `poa_address`.", "example": "Av. Monseñor Tavella 1291 b, A4400 Salta, Argentina" }, "poa_parsed_address": { "type": "object", "nullable": true, "description": "Desglossament estructurat i geocodificat de l'adreça del document. `null` quan no s'ha pogut analitzar l'adreça.", "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": "Codi 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": "Coordenades geocodificades de l'adreça del document." } } }, "expected_details_address": { "type": "string", "nullable": true, "description": "Ressò de l'`expected_address` que has enviat, o `null`." }, "expected_details_formatted_address": { "type": "string", "nullable": true, "description": "Versió geocodificada i normalitzada de `expected_address`; `null` quan no s'ha proporcionat o no es pot geocodificar." }, "expected_details_parsed_address": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Resultat complet de geocodificació per a `expected_address` (carrer/ciutat/regió/país/codi postal més la sortida en brut del geocodificador i un indicador `is_verified`). `null` quan no s'ha proporcionat `expected_address`." }, "name_on_document": { "type": "string", "nullable": true, "description": "Nom del titular principal extret del document; es compara amb `expected_first_name`/`expected_last_name` quan es proporcionen. Si és `null`, es rebutja amb `POA_NAME_NOT_DETECTED` en aquest endpoint.", "example": "OESTE EMBOTELLADORA S.A." }, "extra_fields": { "type": "object", "description": "Camps addicionals específics del document. Els camps bancaris s'emplenen per a extractes bancaris quan estan impresos al document; `null` en cas contrari.", "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èfon de contacte imprès al document." }, "additional_names": { "type": "array", "items": { "type": "string" }, "description": "Altres noms de titulars trobats al document (p. ex., cotitulars del compte, noms anteriors del compte)." } } }, "warnings": { "type": "array", "description": "Buit en cas d'aprovació neta. Cada entrada explica un risc detectat; les entrades amb `log_type: \"error\"` estableixen `status` a `Declined`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "description": "Codi de risc llegible per màquina. Rebuig automàtic: `MISSING_ADDRESS_INFORMATION`, `POA_DOCUMENT_EXPIRED`, `INVALID_DOCUMENT_TYPE`, `UNABLE_TO_VALIDATE_DOCUMENT_AGE`, a més de `UNABLE_TO_EXTRACT_ISSUE_DATE` i `POA_NAME_NOT_DETECTED` (fixats per rebutjar en aquest endpoint). Regulats per opcions de la sol·licitud: `NAME_MISMATCH_WITH_PROVIDED` / `ADDRESS_MISMATCH_WITH_PROVIDED` / `POA_COUNTRY_MISMATCH_WITH_PROVIDED` (`poa_address_mismatch_action`), `POOR_DOCUMENT_QUALITY` (mai generat per aquest endpoint) / `DOCUMENT_METADATA_MISMATCH` (`poa_document_issues_action`), `SUSPECTED_DOCUMENT_MANIPULATION` i `POA_DOCUMENT_UNPROVEN_TEXT_REPLACEMENT` (`poa_document_authenticity_action`), `UNSUPPORTED_DOCUMENT_LANGUAGE` (`poa_unsupported_language_action`), `ISSUER_NOT_IDENTIFIED` (`poa_issuer_not_identified_action`). Informatius en aquest endpoint: `POA_DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION`, `UNPARSABLE_OR_INVALID_ADDRESS`.", "example": "POA_DOCUMENT_EXPIRED" }, "feature": { "type": "string", "enum": [ "PROOF_OF_ADDRESS" ], "description": "Funcionalitat que ha generat l'advertència. Sempre `PROOF_OF_ADDRESS` en aquest endpoint." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Context addicional per a alguns riscos —p. ex. `POA_DOCUMENT_EXPIRED` inclou `expiration_reason` (`printed_expiration` o `age_window`), `document_type`, `document_subtype` i `issue_date`, a més d'`expiration_date` a la ruta `printed_expiration` o `max_age_months` a la ruta `age_window`; `SUSPECTED_DOCUMENT_MANIPULATION` inclou `reason` i `detection_method`; `POA_DOCUMENT_UNPROVEN_TEXT_REPLACEMENT` inclou `reason`, `detection_method` (`unproven_text_replacement`), `replaced_text`, `manipulated_regions` i `manipulated_blocks`. `null` per a la majoria dels riscos." }, "log_type": { "type": "string", "enum": [ "error", "information" ], "description": "Gravetat. Les advertències `error` canvien `status` a `Declined`; les entrades `information` són consultives i mai no rebutgen per si soles. (`warning` no es produeix en aquest endpoint; les seves opcions només accepten `DECLINE` o `NO_ACTION`.)" }, "short_description": { "type": "string", "description": "Resum d'una sola línia del risc, llegible per a humans." }, "long_description": { "type": "string", "description": "Explicació fàcil de llegir del risc." } } } }, "detected_codes": { "type": "array", "description": "Codis QR i codis de barres detectats a totes les pàgines processades del document. Buit quan no se'n troba cap. Un codi QR localitzat però no descodificable té `parsed_payload: null`.", "items": { "$ref": "#/components/schemas/DocumentAIDetectedCode" } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò de les `vendor_data` que has enviat, o `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ressò de l'objecte `metadata` que has enviat, o `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de temps ISO 8601 (UTC) de quan s'ha generat la resposta." } } } } } }, "400": { "description": "Error de validació o de processament. Els problemes a nivell de camp retornen l'embolcall estàndard de DRF (un array de missatges per camp afectat). Els problemes de PDF xifrats retornen `{\"detail\": ...}`. Un document que el procés d'extracció no pot processar retorna `{\"error\": [\"Error extracting POA information\"]}`.", "content": { "application/json": { "examples": { "Missing document": { "summary": "`document` no s'ha inclòs a les dades del formulari", "value": { "document": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Extensió de fitxer no permesa (només 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": "La pujada supera el límit de 15 MB", "value": { "document": [ "File size should not exceed 15 MB" ] } }, "Encrypted PDF": { "summary": "PDF pujat sense la contrasenya requerida", "value": { "detail": "The PDF is encrypted. Please upload a decrypted PDF or a photo instead." } }, "Wrong PDF password": { "summary": "`document_password` no desxifra el PDF", "value": { "detail": "The PDF password is incorrect. Please provide the correct password." } }, "Invalid language code": { "summary": "`poa_languages_allowed` conté un codi no admès", "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` fora de 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 document no s'ha pogut processar mitjançant el pipeline d'extracció", "value": { "error": [ "Error extracting POA information" ] } } } } } }, "403": { "description": "Permís denegat. Es retorna quan falta la capçalera `x-api-key`, i també quan el saldo de l'organització que fa la crida no pot cobrir la crida; una clau incorrecta, revocada o caducada retorna `401`. Si falta la clau es retorna `403` amb `{\"detail\": ...}`; una clau incorrecta, revocada o caducada retorna `401`. La manca de crèdit retorna `403` amb `{\"error\": ...}` abans que es produeixi cap processament de documents.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de l'organització no pot cobrir la crida", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Més de 300 sol·licituds d'escriptura en el minut 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": { "$ref": "#/components/responses/DocumentProcessingBusy" } }, "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ó de camps personalitzats + comprovacions de manipulació)", "description": "Extreu els camps que **tu** defineixis de qualsevol document acreditatiu — nòmines, comprovants de fons, cartes d'origen del patrimoni, declaracions d'impostos, contractes, factures — en una sola crida. Envia el fitxer juntament amb una definició de `fields` (clau, nom, instrucció d'extracció, tipus) i rep valors tipats (`text`, `number`, `date` com a `YYYY-MM-DD`), una puntuació de coincidència de nom opcional respecte a la persona o empresa esperada, senyals de manipulació de PDF/EXIF, un `status` `Approved`/`Declined`/`In Review`, i una llista de `warnings` que explica cada problema detectat. Aquest és l'equivalent de servidor a servidor del pas del flux de treball allotjat de Document AI (consulta `/core-technology/document-ai/overview`); utilitza el model d'extracció per defecte de Didit i no permet la selecció de proveïdor.\n\n**Latència.** L'extracció es basa en LLM: les crides típiques triguen **5–15 segons**, i els PDF multipàgina fins a **~30 segons**. Configura un temps d'espera del client d'**almenys 45 segons** i no reintentis abans que la crida hagi finalitzat.\n\n**Format de la sol·licitud.** Només `multipart/form-data`. `fields` és **una única cadena d'array codificada en JSON** (1–30 elements, com a màxim 16 KB); els arrays de formulari amb claudàtors es rebutgen amb un `400`. Cada element és `{key, name, instruction, type, required, is_full_name}` — `key` és la clau JSON que reps (`^[a-z0-9_]{1,64}$`, única), `instruction` indica al model què ha de llegir, `type` és `text` (per defecte) | `number` | `date`, `required` genera `DOCUMENT_AI_MISSING_REQUIRED_FIELDS` quan el valor no es pot llegir, i com a màxim un camp pot tenir `is_full_name: true` per marcar el valor comparat amb el nom esperat.\n\n**Coincidència de noms.** Proporciona `expected_first_name` + `expected_last_name` (persona) **o** `expected_company_name` (+ `expected_company_country` opcional) — no tots dos. El valor del camp `is_full_name` (o, si no n'hi ha cap de marcat, el primer camp de text la clau del qual sembli un nom) es compara de manera difusa; `name_match_score` (0–100) i `name_on_document` es retornen sempre quan existeixen ambdues parts, i una puntuació inferior a `document_ai_name_match_score_threshold` (per defecte 80) afegeix `DOCUMENT_AI_NAME_MISMATCH`, regit per `document_ai_name_mismatch_action`.\n\n**Lògica de decisió.** Cada risc s'associa a una acció configurable: `DECLINE` → `status: \"Declined\"`, `REVIEW` → `status: \"In Review\"`, `NO_ACTION` → només informatiu. Els valors per defecte reflecteixen el pas del flux de treball: document il·legible `REVIEW`, camps obligatoris absents `REVIEW`, sospita de manipulació `DECLINE`, discrepància de nom `NO_ACTION`, fitxer no admès `REVIEW`. Un document que no es pot processar de cap manera retorna un `400`; un document llegible però amb problemes retorna un `200` amb `Declined`/`In Review` — inspecciona sempre `document_ai.status` i `document_ai.warnings`, no només el codi HTTP.\n\n**Facturació.** Cada resposta `200` consumeix un crèdit de l'API de Document AI — **$0.20 per document** a preu de llista, que es paga amb el crèdit del teu pla o el saldo de recàrrega. Quan el saldo de l'organització no cobreix la crida, l'endpoint retorna un `403` abans de qualsevol processament. Les claus d'API de sandbox retornen una resposta simulada determinista i no es cobren.\n\n**Persistència.** Amb `save_api_request=true` (per defecte), la crida s'emmagatzema com una sessió de tipus API: el document, els valors extrets, les definicions de camps i la captura de coincidència de noms es conserven, la sessió apareix a la Business Console, i `request_id` funciona amb `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 document per llegir. Extensions permeses: `tiff`, `jpg`, `jpeg`, `png`, `pdf`, `webp`, `zip`. Mida màxima de pujada: **30 MB** (els fitxers més grans es rebutgen amb un `400`). Els PDF multipàgina són compatibles (espera una latència més alta); els PDF xifrats es rebutgen amb un `400`. Les imatges es comprimeixen automàticament abans de processar-se." }, "fields": { "type": "string", "description": "Una cadena que codifica en JSON una matriu amb **1–30** definicions de camp (màxim 16 KB). Cada element: `key` (obligatori, `^[a-z0-9_]{1,64}$`, únic — la clau retornada a `extracted_data`), `name` (≤100 caràcters, mostrat als missatges), `instruction` (≤500 caràcters, el que ha de llegir el model), `type` (`text` per defecte | `number` | `date`), `required` (booleà, per defecte `false`), `is_full_name` (booleà, per defecte `false`, com a màxim un per sol·licitud). Les matrius de formulari amb claudàtors, el JSON no vàlid, les claus duplicades o més d'un `is_full_name` retornen `400` abans de qualsevol processament o facturació.", "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": "Nom de pila a verificar respecte al camp del nom del document (coincidència difusa, compatible amb transliteració). Utilitza'l juntament amb `expected_last_name`; no es pot combinar amb `expected_company_name`.", "example": "Sophia" }, "expected_last_name": { "type": "string", "description": "Cognom a verificar contra el camp de nom del document, combinat amb `expected_first_name` per a `name_match_score`.", "example": "Martinez" }, "expected_company_name": { "type": "string", "description": "Nom de l'empresa a verificar respecte al camp de nom del document (per a documents d'empresa). No es pot combinar amb `expected_first_name` / `expected_last_name` (no hi ha cap valor d'exemple expressament —la mostra de sol·licitud generada utilitza els camps de persona física; canvia'ls per aquest quan verifiquis un document d'empresa)." }, "expected_company_country": { "type": "string", "description": "Codi de país ISO 3166-1 alfa-2 opcional (dues lletres ASCII, p. ex., `FR`) que ajusta la normalització del nom de l'empresa per a `expected_company_name`. Només s'utilitza amb `expected_company_name`." }, "document_ai_name_match_score_threshold": { "type": "integer", "minimum": 0, "maximum": 100, "default": 80, "description": "Puntuació mínima de `name_match_score` (0–100) per considerar que el nom coincideix. Una puntuació inferior afegeix `DOCUMENT_AI_NAME_MISMATCH`, regit per `document_ai_name_mismatch_action`.", "example": 80 }, "document_ai_unreadable_document_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "REVIEW", "description": "Què fer quan no s'ha pogut llegir cap camp del document (`DOCUMENT_AI_UNREADABLE_DOCUMENT`)." }, "document_ai_missing_required_fields_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "REVIEW", "description": "Què fer quan no s'ha pogut llegir almenys un camp `required` (`DOCUMENT_AI_MISSING_REQUIRED_FIELDS`; `additional_data.missing_fields` els enumera)." }, "document_ai_document_tampering_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "DECLINE", "description": "Què fer quan l'anàlisi forense de PDF/EXIF sospita de manipulació — modificat després de la signatura digital, editor de PDF conegut, manipulació de text superposat, reexportació sospitosa, anomalies en la imatge (`DOCUMENT_AI_SUSPECTED_MANIPULATION`)." }, "document_ai_name_mismatch_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "NO_ACTION", "description": "Què fer quan `name_match_score` està per sota del llindar (`DOCUMENT_AI_NAME_MISMATCH`)." }, "document_ai_unsupported_file_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "REVIEW", "description": "Què fer quan la càrrega està buida o no és un fitxer processable (`DOCUMENT_AI_UNSUPPORTED_FILE`)." }, "save_api_request": { "type": "boolean", "default": true, "description": "Quan és `true` (per defecte), persisteix la crida com una sessió de tipus API — visible a la Business Console, recuperable mitjançant `GET /v3/session/{sessionId}/decision/` utilitzant el `request_id` retornat, amb el document carregat, els valors extrets, les definicions de camps i la instantània de coincidència de noms emmagatzemats. Quan és `false`, no s'emmagatzema res i `request_id` és un UUID transitori només per a la correlació de la resposta; la crida es continua facturant.", "example": true }, "vendor_data": { "type": "string", "description": "Cadena opaca opcional (el teu ID d'usuari intern, correu electrònic, UUID…) desada a la sessió persistent i retornada a la resposta. Utilitza-la per correlacionar crides a l'API amb els teus propis registres i per filtrar sessions més endavant.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objecte JSON opcional emmagatzemat amb la sessió (quan `save_api_request=true`) i retornat a la resposta. En sol·licituds multipart, envia'l com a camp de cadena codificat en JSON (p. ex., `metadata={\"flow\":\"onboarding\"}`); s'analitza com un objecte.", "example": { "flow": "onboarding" } } } } } } }, "responses": { "200": { "description": "Document processat. `document_ai.status` és `Approved`, `Declined` o `In Review`; cada problema detectat es detalla a `document_ai.warnings`. Un document problemàtic continua retornant `200`; inspecciona el cos, no només el codi HTTP. Quan `save_api_request=true`, `request_id` és l'id de sessió persistit.", "content": { "application/json": { "examples": { "Approved": { "summary": "Nòmina llegida correctament, el nom coincideix", "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 s'ha pogut llegir `net_pay`; acció per defecte 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": "L'anàlisi forense del PDF ha detectat un editor conegut; acció per defecte 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 sessió persistida quan `save_api_request=true` (utilitzable amb `GET /v3/session/{sessionId}/decision/`); en cas contrari, un UUID de correlació transitori." }, "document_ai": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "`Approved` quan cap advertència no es resol en un rebuig o revisió; `Declined` quan almenys un risc s'assigna a `DECLINE`; en cas contrari, `In Review` quan almenys un s'assigna a `REVIEW`. La llista `warnings` n'explica el motiu." }, "extracted_data": { "type": "object", "additionalProperties": true, "description": "Una entrada per clau de camp sol·licitada. Els valors estan tipats segons el `type` del camp: cadenes per a `text`, nombres per a `number`, cadenes `YYYY-MM-DD` per a `date`, o `null` quan el valor no s'ha pogut llegir.", "example": { "employer_name": "Acme Payments Ltd", "employee_name": "Sophia Martinez", "net_pay": 3120.5, "pay_date": "2026-07-31" } }, "detected_codes": { "type": "array", "description": "Codis QR i codis de barres detectats a totes les pàgines processades. Buit quan no se'n troba cap. Un codi QR localitzat però no descodificable té `parsed_payload: null`.", "items": { "$ref": "#/components/schemas/DocumentAIDetectedCode" } }, "fields": { "type": "array", "description": "Les definicions de camps normalitzades que s'han utilitzat per a aquesta extracció, retornades com a resposta (també s'emmagatzemen amb la sessió quan `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` i el nom esperat de la persona/empresa. Es retorna sempre que existeixin tant un valor de nom com un nom esperat — en coincidències **i** discrepàncies; `null` en cas contrari.", "example": 96.0 }, "name_on_document": { "type": "string", "nullable": true, "description": "El valor del nom extret del document (el camp `is_full_name`, o el primer camp de text similar a un nom) que s'ha comparat amb el nom esperat. `null` quan no hi havia cap valor de nom disponible.", "example": "Sophia Martinez" }, "warnings": { "type": "array", "description": "Buit en cas d'aprovació neta. Cada entrada explica un risc detectat; les entrades amb `log_type: \"error\"` estableixen `status` a `Declined`, les entrades amb `log_type: \"warning\"` l'estableixen a `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": "Codi de risc llegible per màquina. Cadascun està regulat per l'opció de sol·licitud `document_ai_*_action` corresponent.", "example": "DOCUMENT_AI_MISSING_REQUIRED_FIELDS" }, "feature": { "type": "string", "enum": [ "DOCUMENT_AI" ], "description": "Funcionalitat que ha generat l'advertència. Sempre `DOCUMENT_AI` en aquest endpoint." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Context addicional per al risc: `{\"missing_fields\": [\"Net pay\"]}` per a camps requerits que falten, `{\"name_on_document\", \"score\", \"threshold\"}` per a una discrepància de nom, i la troballa forense (`detection_method`, detalls del productor/editor) en cas de sospita de manipulació. `null` quan no hi ha res a afegir.", "example": { "missing_fields": [ "Net pay" ] } }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravetat derivada de l'acció configurada: `error` (DECLINE), `warning` (REVIEW), `information` (NO_ACTION)." }, "short_description": { "type": "string", "description": "Descripció breu d'una sola línia del risc, llegible per a humans.", "example": "Required fields could not be extracted" }, "long_description": { "type": "string", "description": "Explicació fàcil de llegir, interpolada amb `additional_data` quan correspongui." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò de les `vendor_data` que has enviat, o `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ressò de l'objecte `metadata` que has enviat, o `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Quan es va processar la sol·licitud (UTC, ISO 8601)." } } } } } }, "400": { "description": "Error de validació o de processament. Els problemes a nivell de camp retornen l'embolcall estàndard de DRF (un array de missatges per camp afectat). Els documents xifrats o il·legibles i les fallades d'extracció retornen `{\"error\": ...}`.", "content": { "application/json": { "examples": { "Missing document": { "summary": "`document` no s'ha inclòs a les dades del formulari", "value": { "document": [ "No file was submitted." ] } }, "Invalid fields payload": { "summary": "`fields` no és una cadena d'array codificada en JSON", "value": { "fields": [ "fields must be a valid JSON array string." ] } }, "Duplicate field keys": { "summary": "Dos elements comparteixen la mateixa `key`", "value": { "fields": [ "Every fields item must have a unique key." ] } }, "Conflicting expectations": { "summary": "Expectatives de persona i empresa enviades juntes", "value": { "non_field_errors": [ "Provide either person expected-name fields or expected_company_name, not both." ] } }, "Invalid metadata": { "summary": "`metadata` no és un objecte JSON (o conté un caràcter NUL)", "value": { "metadata": [ "Metadata must be a JSON object." ] } }, "Oversized vendor_data": { "summary": "`vendor_data` supera el límit màxim de 2.000 bytes", "value": { "vendor_data": [ "vendor_data is too long (maximum 2000 bytes)." ] } }, "Encrypted PDF": { "summary": "PDF protegit amb contrasenya", "value": { "error": "The PDF is encrypted. Please upload a decrypted PDF or a photo instead." } }, "Extraction failed": { "summary": "El pipeline d'extracció no ha pogut processar el document", "value": { "error": [ "Error extracting Document AI information" ] } } }, "schema": { "type": "object", "additionalProperties": true } } } }, "403": { "description": "Permís denegat. Es retorna quan falta la capçalera `x-api-key`, i també quan el saldo de l'organització que fa la crida no pot cobrir la crida; una clau incorrecta, revocada o caducada retorna `401`. Si falta la clau es retorna `403` amb `{\"detail\": ...}`; una clau incorrecta, revocada o caducada retorna `401`. La manca de crèdit —i les organitzacions facturades per contracte la taula de tarifes de les quals no té cap entrada per a l'API de Document AI— retornen `403` amb `{\"error\": ...}` abans que es produeixi cap processament de documents.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de l'organització no pot cobrir la crida", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } }, "Contract rate missing": { "summary": "Organització facturada per contracte la taula de tarifes de la qual no té cap entrada per a l'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": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Més de 300 sol·licituds d'escriptura en el minut 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": { "$ref": "#/components/responses/DocumentProcessingBusy" } }, "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": "Cribratge AML (independent)", "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": "Clau opcional de seguretat per a reintents, de fins a 255 caràcters. Reutilitzar la mateixa clau amb el mateix cos de sol·licitud retorna la resposta original sense executar ni facturar un segon cribratge. Reutilitzar la clau amb un cos diferent retorna `409`.", "schema": { "type": "string", "maxLength": 255 } } ], "description": "Fes el cribratge d'una persona o empresa contra conjunts de dades de PEP, sancions, llistes d'advertències/llistes de vigilància i mitjans adversos en una sola crida.\n\n**Model de dues puntuacions.** Cada coincidència inclou un `match_score` (0–100, confiança de la identitat) i un `risk_score` (0–100, risc de l'entitat). Les coincidències amb un `match_score` inferior a `aml_match_score_threshold` (per defecte **93**) s'etiqueten com a `review_status: \"False Positive\"` i s'ignoren a efectes de risc; el `risk_score` més alt d'entre les coincidències restants es converteix en `aml.score`. L'`aml.status` final segueix els teus llindars: `score` > `aml_score_review_threshold` (per defecte **100**) → `Declined`; `score` > `aml_score_approve_threshold` (per defecte **80**) → `In Review`; altrament `Approved`. Sempre que l'`score` sigui diferent de zero i ≥ el llindar d'aprovació, s'afegeix una advertència `POSSIBLE_MATCH_FOUND` (una puntuació exactament de 0 mai no genera cap advertència).\n\n**Ponderacions de la puntuació de coincidència.** `aml_name_weight` + `aml_dob_weight` + `aml_country_weight` han de sumar exactament 100 (per defecte 60/25/15). Els components que faltin a la sol·licitud s'eliminen de la suma i les ponderacions es renormalitzen; un `document_number` coincident actua com una clau mestra que substitueix el `match_score` per 100.\n\n**Latència.** Els cribratges ordinaris solen completar-se en pocs segons. Amb `include_adverse_media=true`, l'API espera l'enriquiment de mitjans adversos (una pausa inicial d'uns ~5 s més fins a ~25 s de sondeig); configura un temps d'espera del client de **com a mínim 60 segons**.\n\n**Persistència.** `save_api_request` està establert per defecte a **true**: el cribratge s'emmagatzema com una sessió (`request_id` funciona amb `GET /v3/session/{sessionId}/decision/`), apareix a la consola, es dispara un webhook `status.updated`, i els estats de revisió de les coincidències es poden actualitzar més endavant. Amb `save_api_request=false` no s'emmagatzema res i `request_id` és un identificador de correlació transitori. `include_ongoing_monitoring=true` continua recribrant el perfil i requereix `save_api_request=true` (es fa complir amb un `400`).\n\n**Idempotència.** Envia una capçalera `Idempotency-Key` en reintentar després d'un temps d'espera o d'un error transitori. La clau està limitada a la teva aplicació i al cos exacte de la sol·licitud. La primera sol·licitud completada emmagatzema la seva resposta; els reintents idèntics posteriors retornen aquesta mateixa resposta i no executen ni facturen cap altre cribratge AML. Si la sol·licitud original encara s'està executant, torna-ho a intentar més tard amb la mateixa clau. Si es reutilitza la mateixa clau amb un cos diferent, l'API retorna `409`.\n\n**Facturació.** Es cobra un crèdit d'API d'AML després del primer cribratge satisfactori. Les respostes idempotents retornades de nou no es tornen a cobrar; un saldo insuficient retorna `403` abans que es produeixi cap cribratge nou.\n\n**Sandbox.** Les claus d'aplicacions de sandbox ometen completament el cribratge i la facturació i retornen un resultat simulat: `Approved` amb zero coincidències tret que passis `sandbox_scenario`. `save_api_request` funciona igual que a les claus de producció, de manera que un cribratge desat de sandbox es pot recuperar mitjançant `GET /v3/session/{sessionId}/decision/` i `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": "Nom complet de la persona o empresa a sotmetre a cribratge. Mínim **2 caràcters**: el límit mínim del propi proveïdor de cribratge. Un nom més curt o en blanc retorna `400` en aquest camp abans que s'executi cap cribratge, de manera que no es factura res.", "example": "Antonio Ejemplo Modelo" }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "default": "person", "description": "Tipus d'entitat que s'ha de cribrar. El valor per defecte és `person`." }, "date_of_birth": { "type": "string", "format": "date", "description": "Data de naixement (persones) o data de constitució (empreses), `YYYY-MM-DD`. Millora la precisió de la coincidència mitjançant la ponderació de la data de naixement.", "example": "1972-02-29" }, "nationality": { "type": "string", "description": "Codi de país ISO 3166-1 **alfa-2** (p. ex. `ES`). Els codis no vàlids retornen `400`. Millora la precisió de coincidència mitjançant la ponderació per país.", "example": "ES" }, "document_number": { "type": "string", "description": "Número del document d'identitat. No ponderat: actua com a clau mestra: una coincidència exacta substitueix el `match_score` de la coincidència a 100, i una discrepància clara el penalitza. S'envia al proveïdor de cribratge com a filtre de cerca només quan té entre **2 i 50 caràcters**; si té un valor fora d'aquest interval, s'accepta i s'emmagatzema, i el cribratge s'executa i es factura igualment, però sense filtrar pel número de document." }, "aml_score_approve_threshold": { "type": "number", "minimum": 0, "maximum": 100, "default": 80, "description": "Llindar de la puntuació de risc igual o per sota del qual el resultat és `Approved`. Ha de ser ≤ `aml_score_review_threshold` (en cas contrari, `400`)." }, "aml_score_review_threshold": { "type": "number", "minimum": 0, "maximum": 100, "default": 100, "description": "Llindar de la puntuació de risc per sobre del qual el resultat és `Declined`. Les puntuacions entre els dos llindars produeixen `In Review`." }, "aml_name_weight": { "type": "integer", "minimum": 0, "maximum": 100, "default": 60, "description": "Pes de la similitud del nom en la puntuació de coincidència per hit. Els tres pesos han de sumar exactament 100 (en cas contrari, `400`)." }, "aml_dob_weight": { "type": "integer", "minimum": 0, "maximum": 100, "default": 25, "description": "Pes de la data de naixement en la puntuació de coincidència per coincidència." }, "aml_country_weight": { "type": "integer", "minimum": 0, "maximum": 100, "default": 15, "description": "Pes del país/nacionalitat en la puntuació de coincidència per coincidència." }, "aml_match_score_threshold": { "type": "integer", "minimum": 0, "maximum": 100, "default": 93, "description": "Punt de tall per coincidència: les coincidències amb un `match_score` inferior a aquest es consideren `False Positive` (excloses de l'avaluació de risc); les que siguin iguals o superiors són possibles coincidències `Unreviewed`." }, "include_adverse_media": { "type": "boolean", "default": false, "description": "Cerca també mitjans de comunicació per detectar cobertura negativa. Afegeix fins a ~30 s de latència mentre es recopilen els resultats; utilitza un temps d'espera del client de ≥60 s." }, "include_ongoing_monitoring": { "type": "boolean", "default": false, "description": "Continua tornant a cribrar aquest perfil i envia els canvis mitjançant webhook. Requereix `save_api_request=true` (si no, `400`)." }, "save_api_request": { "type": "boolean", "default": true, "description": "Persisteix el cribratge com una sessió (visibilitat a la consola, endpoint de decisió, webhooks, revisió de coincidències). Estableix-ho a `false` per a una comprovació sense estat." }, "vendor_data": { "type": "string", "description": "El teu identificador per a l'usuari sotmès a cribratge; es retorna tal com s'ha enviat i s'emmagatzema amb la sessió." }, "metadata": { "type": "object", "nullable": true, "description": "JSON de format lliure emmagatzemat amb la sol·licitud i retornat com a resposta." }, "sandbox_scenario": { "type": "string", "description": "Identificador d'escenari només per a sandbox. Només s'accepta quan la clau d'API pertany a una aplicació en mode sandbox; es rebutja en aplicacions en producció. Un cribratge independent no té cap sessió per activar, de manera que l'identificador s'inclou a la mateixa sol·licitud de cribratge: `decline_aml_hit` retorna una coincidència amb estructura de producció i resol el cribratge com a `Declined`, `review_aml_possible_match` el resol com a `In Review`, i un escenari que no activi cap resultat d'AML deixa el cribratge net. Consulta el catàleg d'escenaris a GET /v1/sandbox/scenarios/ o a [Sandbox i dades de prova](/ca/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": "Cribratge completat. `aml.status` reflecteix els teus llindars; cada coincidència que iguali o superi el mínim intern d'inclusió s'indica a `aml.hits` amb el seu `match_score` d'identitat, el `risk_score` de l'entitat i un `score_breakdown` que explica la coincidència.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de sessió persistida quan `save_api_request=true` (utilitzable amb `GET /v3/session/{sessionId}/decision/`); en cas contrari, un UUID de correlació transitori." }, "aml": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "`Declined` quan `score` > `aml_score_review_threshold`; `In Review` quan `score` > `aml_score_approve_threshold`; `Approved` en cas contrari (fins i tot quan no hi ha cap puntuació disponible)." }, "total_hits": { "type": "integer", "description": "Nombre d'entrades a `hits`." }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Ressò del tipus d'entitat sotmesa a cribratge." }, "hits": { "type": "array", "items": { "type": "object", "description": "Una coincidència de cribratge. `match_score` (0–100) mesura la confiança de la identitat: les coincidències per sota de `aml_match_score_threshold` s'etiqueten com a `review_status: \"False Positive\"` i s'exclouen de l'avaluació de risc; les coincidències iguals o superiors s'etiqueten com a possibles coincidències `\"Unreviewed\"`. `risk_score` (0–100) mesura com de riesgosa és l'entitat coincident i determina el valor de `aml.score` de nivell superior.", "properties": { "id": { "type": "string", "nullable": true, "description": "Identificador estable de Didit per a la coincidència: `hit_` seguit de 24 caràcters hexadecimals. La mateixa entitat coincident manté el mateix `id` quan se sotmet el subjecte a un nou cribratge. Transmet-lo com a `hit_id` als endpoints de revisió de coincidències d'AML." }, "url": { "type": "string", "nullable": true, "description": "URL d'origen de l'entitat coincident, si està disponible." }, "match": { "type": "boolean", "nullable": true, "description": "Indicador antic de coincidència exacta. És preferible utilitzar `match_score` + `review_status`." }, "score": { "type": "number", "nullable": true, "description": "OBSOLET. Puntuació de coincidència ponderada en el rang 0–1. Utilitza `match_score` en el seu lloc." }, "match_score": { "type": "number", "nullable": true, "description": "Confiança de la identitat (0–100). Es compara amb `aml_match_score_threshold` per separar els falsos positius de les possibles coincidències." }, "risk_score": { "type": "number", "nullable": true, "description": "Puntuació de risc de l'entitat (0–100). El `risk_score` més alt entre les coincidències que no siguin falsos positius es converteix en l'`aml.score` de nivell superior." }, "target": { "type": "boolean", "nullable": true }, "caption": { "type": "string", "nullable": true, "description": "Nom visible de l'entitat coincident." }, "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": "Categories de risc en què figura l'entitat: `PEP` (amb el seu nivell, de `PEP Level 1` a `PEP Level 4`), `Sanctions`, `Adverse Media`, `Warnings and Regulatory Enforcement`, `Fitness and Probity`, `SIP`, `SIE` o `Insolvency`. `Other Lists` quan la font de l'entitat no indica cap d'aquestes categories." }, "features": { "type": "object", "nullable": true }, "properties": { "type": "object", "nullable": true, "description": "Perfil de l'entitat: `name`, `alias`, `notes`, `gender`, `birthDate`, `birthPlace`, `nationality`, `position` i altres vectors biogràfics (cadascun admet valors nuls)." }, "rca_name": { "type": "string", "nullable": true, "description": "Nom de la persona associada propera amb la qual s'ha produït la coincidència de l'entitat, quan la coincidència és un RCA." }, "pep_matches": { "type": "array", "description": "Entrades de la llista PEP que motiven aquesta coincidència.", "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": "Entrades de la llista de sancions que justifiquen aquesta coincidència (la mateixa estructura de llista que `pep_matches`, més camps específics de sancions)." }, "warning_matches": { "type": "array", "items": { "type": "object" }, "description": "Entrades d'advertències/llistes de vigilància que donen suport a aquesta coincidència." }, "adverse_media_matches": { "type": "array", "description": "Articles de mitjans adversos. S'omple només quan `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": "Sentiment agregat de mitjans adversos per a l'entitat (`sentiment`, `sentiment_score`, mapa de freqüència d'`adverse_keywords`). S'omple només quan `include_adverse_media=true`." }, "first_seen": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan l'entitat va aparèixer per primera vegada als conjunts de dades." }, "last_seen": { "type": "string", "format": "date-time", "nullable": true, "description": "Actualització més recent del conjunt de dades que inclou l'entitat." }, "linked_entities": { "type": "array", "description": "Relacions conegudes de l'entitat coincident (família, associats, empreses).", "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": "Desglossament del risc per dimensió (`crimes`, `countries`, `categories`, `custom_list`), cadascun amb `score`, `weightage`, `risk_level` i un mapa `risk_scores`." }, "additional_information": { "type": "object", "nullable": true, "description": "Context addicional de format lliure, p. ex. una matriu `flag_summary` que explica per què l'entitat està marcada." }, "review_status": { "type": "string", "nullable": true, "enum": [ "False Positive", "Unreviewed", "Confirmed Match", "Inconclusive" ], "description": "`False Positive` — `match_score` per sota d'`aml_match_score_threshold`, exclòs de l'avaluació de risc. `Unreviewed` — possible coincidència pendent de revisió. `Confirmed Match` / `Inconclusive` — establert manualment per un revisor (mitjançant la Business Console) en sessions desades; aquesta funcionalitat de revisió no forma part d'aquesta especificació." }, "score_breakdown": { "type": "object", "nullable": true, "description": "Com s'ha calculat `match_score`. El nom, la data de naixement i el país aporten cadascun `_score` × `_weight_normalized` punts; els pesos es renormalitzen quan falta un component a les dades analitzades. El número de document no té pes: actua com a 'clau d'or': `MATCH` canvia la puntuació a 100, `NEUTRAL` la deixa sense canvis i `HARD_MISMATCH` aplica una penalització.", "properties": { "name_score": { "type": "integer", "nullable": true, "description": "Similitud del nom en brut (0–100)." }, "name_weight": { "type": "integer", "nullable": true, "description": "Pes configurat per al nom (`aml_name_weight`)." }, "name_weight_normalized": { "type": "number", "nullable": true, "description": "Pes del nom després de la renormalització (0–100)." }, "name_contribution": { "type": "number", "nullable": true, "description": "Punts que el nom ha aportat a `total_score`." }, "dob_score": { "type": "integer", "nullable": true, "description": "Puntuació de la data de naixement com a percentatge del seu pes (−100 a 100)." }, "dob_weight": { "type": "integer", "nullable": true, "description": "Pes configurat per a la data de naixement (`aml_dob_weight`)." }, "dob_weight_normalized": { "type": "number", "nullable": true, "description": "Pes de la data de naixement després de la renormalització (0–100)." }, "dob_contribution": { "type": "number", "nullable": true, "description": "Punts que la data de naixement ha aportat a `total_score`." }, "country_score": { "type": "integer", "nullable": true, "description": "Puntuació de país com a percentatge del seu pes (−100 a 100)." }, "country_weight": { "type": "integer", "nullable": true, "description": "Pes configurat per al país (`aml_country_weight`)." }, "country_weight_normalized": { "type": "number", "nullable": true, "description": "Pes del país després de la renormalització (0–100)." }, "country_contribution": { "type": "number", "nullable": true, "description": "Punts que el país ha aportat a `total_score`." }, "document_number_match_type": { "type": "string", "nullable": true, "enum": [ "MATCH", "NEUTRAL", "HARD_MISMATCH" ], "description": "Resultat de clau mestra (golden key) per a la comparació del número de document." }, "document_number_effect": { "type": "string", "nullable": true, "description": "Descripció fàcil de llegir de l'efecte del número de document." }, "total_score": { "type": "integer", "nullable": true, "description": "Puntuació de coincidència ponderada final (0–100) — reflecteix `match_score`." } } } } } }, "score": { "type": "number", "nullable": true, "description": "Puntuació de risc AML global (0–100): el `risk_score` més alt entre les coincidències que no són falsos positius. Determina l'`status` mitjançant els dos llindars." }, "screened_data": { "type": "object", "description": "Ressò del que s'ha sotmès a cribratge: `full_name`, `date_of_birth`, `nationality`, `document_number` (els camps absents són `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": "Funcionalitat que ha generat l'advertència." }, "risk": { "type": "string", "description": "Identificador de risc llegible per màquina." }, "additional_data": { "type": "object", "nullable": true, "description": "Context addicional per a l'advertència, quan estigui disponible." }, "log_type": { "type": "string", "description": "`warning`, `information` o `error` — com ha afectat el risc el resultat." }, "short_description": { "type": "string", "description": "Resum d'una línia llegible per humans." }, "long_description": { "type": "string", "description": "Explicació completa comprensible per a persones." } } }, "description": "Conté un advertiment `POSSIBLE_MATCH_FOUND` sempre que `score` sigui diferent de zero i ≥ `aml_score_approve_threshold` (una puntuació d'exactament 0 mai no adverteix); buit en cas contrari." } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò del `vendor_data` que has enviat." }, "metadata": { "type": "object", "nullable": true, "description": "Ressò de les `metadata` que has enviat." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "No hits (Approved)": { "summary": "Cribratge net: zero coincidències", "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 possible coincidència amb una PEP; la puntuació de risc 73 es manté per sota del llindar d'aprovació per defecte 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ó. Els problemes a nivell de camp retornen l'embolcall estàndard de DRF (un array de missatges per camp infractor); les regles entre camps (suma de pesos, ordenació de llindars, monitoratge sense desar) retornen `{\"error\": [...]}`.", "content": { "application/json": { "examples": { "Missing full_name": { "summary": "`full_name` és l'únic camp obligatori", "value": { "full_name": [ "This field is required." ] } }, "Short full_name": { "summary": "`full_name` ha de tenir com a mínim 2 caràcters", "value": { "full_name": [ "Ensure this field has at least 2 characters." ] } }, "Invalid nationality": { "summary": "`nationality` ha de 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": "Llindar d'aprovació per sobre del llindar de revisió", "value": { "error": [ "Approve threshold (90.0) cannot be greater than review threshold (80.0)" ] } }, "Monitoring without saving": { "summary": "`include_ongoing_monitoring=true` amb `save_api_request=false`", "value": { "error": [ "Ongoing monitoring can only be enabled when the API request is saved." ] } } } } } }, "403": { "description": "Permís denegat. Es retorna quan falta la capçalera `x-api-key`, i també quan el saldo de l'organització que fa la crida no pot cobrir la crida; una clau incorrecta, revocada o caducada retorna `401`. Si falta la clau es retorna `403` amb `{\"detail\": ...}`; una clau incorrecta, revocada o caducada retorna `401`. La manca de crèdit retorna `403` amb `{\"error\": ...}` abans que es produeixi cap cribratge o crida al proveïdor.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de l'organització no pot cobrir la crida", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Més de 300 sol·licituds d'escriptura en el minut 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": "Cerca facial", "description": "Cerca una imatge facial (1:N) a l'índex de cerca facial de la teva aplicació (cares registrades a partir de sessions de verificació, crides d'API independents desades, pujades directes de cares de perfils d'usuari i les teves llistes de bloqueig i de permesos) i rep coincidències de similitud ordenades juntament amb advertències de llista de bloqueig i duplicats.\n\n**Com funciona.** La cara més gran detectada a `user_image` es converteix en un embedding i es cerca a l'índex, limitat a la teva aplicació. Es retornen fins a **5 coincidències** per sobre del llindar mínim de similitud a `matches`, cadascuna amb `similarity_percentage`, la sessió d'origen (`session_id`, `session_number`, `status`, `vendor_data`), els `user_details` extrets durant la verificació de documents d'aquella sessió, els indicadors `is_blocklisted` / `is_allowlisted` i un discriminador de `source` (`session`, `imported` o `list_entry`).\n\n- `search_type=most_similar` (per defecte) classifica totes les cares registrades per similitud; utilitza'l per a la desduplicació i la investigació de xarxes de frau.\n- `search_type=blocklisted_or_approved` restringeix els candidats a cares a la llista de bloqueig, cares a la llista de permesos, cares de sessions aprovades i cares de perfils d'usuari importades, classificant primer les entrades a la llista de bloqueig; utilitza'l quan l'objectiu principal sigui el cribratge de llistes de bloqueig.\n\n`status` és `Declined` només quan s'activa una advertència `FACE_IN_BLOCKLIST` o `POSSIBLE_FACE_IN_BLOCKLIST`; `DUPLICATED_FACE` / `POSSIBLE_DUPLICATED_FACE` (`information`) i `MULTIPLE_FACES_DETECTED` (`warning`) mai rebutgen. A diferència de la prova de vida passiva, aquest endpoint **no** exclou de la coincidència les sessions anteriors amb el mateix `vendor_data`. També s'executa internament una anàlisi de prova de vida passiva que s'emmagatzema amb la sessió persistida, però el seu resultat no forma part d'aquesta resposta.\n\n**Facturació.** Cada resposta `200` consumeix un crèdit de l'API de cerca facial (descomptat del crèdit del teu pla o del saldo de recàrrega). Si el saldo és insuficient, es retorna un `403` abans de processar cap imatge.\n\n**Persistència de sessions i registre de cares (`save_api_request`, per defecte `true`).** Quan és `true`, la crida es persisteix com una sessió de tipus API (Business Console, `GET /v3/session/{sessionId}/decision/` mitjançant el `request_id` retornat, webhook `status.updated`) i la cara cercada es registra a l'índex de cerca facial. Les cares registrades mitjançant crides de cerca facial s'exclouen dels resultats futurs de cerca facial, de manera que les cerques repetides mai coincideixen entre si. Quan és `false`, la crida és d'un sol ús: no s'emmagatzema res, la cara no es registra i els valors de `match_image_url` són rutes d'emmagatzematge intern en comptes d'URL descarregables.\n\n**Sandbox.** Les claus d'API de sandbox ometen tot el processament i la facturació: després de validar la sol·licitud (les entrades amb format incorrecte continuen retornant `400`), l'endpoint retorna un payload simulat estàtic `Approved`, no es persisteix cap sessió i no es consumeixen crèdits.\n\n**Autenticació.** Envia la clau d'API de la teva aplicació a la capçalera `x-api-key`. Si les credencials falten o no són vàlides, es retorna un `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); aquesta API mai retorna un `401`.\n\n**Límit de freqüència.** Límit compartit de 300 sol·licituds d'escriptura/min per clau d'API a tots els endpoints POST/PATCH/DELETE; si se supera, es retorna un `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": "Imatge frontal del rostre per fer la cerca. Extensions permeses: `tiff`, `jpg`, `jpeg`, `png`, `webp`. Mida màxima de càrrega: **5 MB** (els fitxers més grans es rebutgen amb `400`). Les imatges es comprimeixen automàticament a ~0.5 MB abans de processar-les, de manera que una resolució gaire alta no millora la precisió. La imatge ha de contenir almenys una cara detectable; en cas contrari, l'endpoint retorna `400`. Si hi ha diverses cares presents, es busca la més gran i s'afegeix una advertència `MULTIPLE_FACES_DETECTED`." }, "search_type": { "type": "string", "default": "most_similar", "enum": [ "most_similar", "blocklisted_or_approved" ], "description": "Política de cerca. `most_similar` (per defecte) classifica cada cara registrada a la teva aplicació per similitud. `blocklisted_or_approved` restringeix els candidats a cares a la llista de bloqueig, cares a la llista blanca, cares de sessions aprovades i cares de perfils d'usuari importats — classificant les entrades a la llista de bloqueig en primer lloc.", "example": "most_similar" }, "rotate_image": { "type": "boolean", "default": false, "description": "Quan és `true`, el servei prova rotacions de 90 graus de l'entrada i utilitza l'orientació que ofereix la millor detecció facial. Útil quan falta l'orientació EXIF. Afegeix latència.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Quan és `true` (per defecte), manté la crida com una sessió de tipus API, emet un webhook `status.updated`, presigna els valors de `match_image_url` i inscriu la cara cercada al teu índex de cerca facial (les inscripcions de Cerca facial s'exclouen de cerques futures). Quan és `false`, la cerca és d'un sol ús: no s'emmagatzema cap sessió i la cara no s'inscriu.", "example": true }, "vendor_data": { "type": "string", "description": "Identificador opac opcional (el teu ID d'usuari, correu electrònic, UUID…) desat a la sessió persistent i retornat a la resposta. No exclou les cares del mateix usuari dels resultats de cerca.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objecte JSON opcional emmagatzemat amb la sessió (quan `save_api_request=true`) i retornat. En sol·licituds multipart, envia'l com a camp de cadena codificat en JSON; s'analitza com un objecte.", "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": "Cerca facial completada. `face_search.matches` conté fins a 5 cares similars ordenades per similitud; una matriu buida vol dir que cap cara registrada ha superat el llindar mínim de similitud. `status` és `Declined` només per coincidències amb la llista de bloqueig — les coincidències duplicades per si soles retornen `Approved`, per tant inspecciona `matches` i `warnings`, no només `status`. Quan `save_api_request=true`, `request_id` és l'identificador de sessió persistit. Cada coincidència conté `source` (`session`, `imported`, `list_entry` o `retained_template`), `vendor_user_id` i `biometric_template_id`; una coincidència `retained_template` prové d'una plantilla biomètrica sense imatge conservada després que la sessió d'origen s'hagués suprimit i té `null` als camps de sessió, `match_image_url` i `user_details`.", "content": { "application/json": { "examples": { "Blocklist hit (Declined)": { "summary": "La cara coincideix amb una cara de la llista de bloqueig", "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": "La cara ja ha aparegut en una altra sessió aprovada — informatiu, sense rebuig", "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": "Cap cara registrada ha superat el llindar mínim 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 sessió persistida quan `save_api_request=true` (utilitzable amb `GET /v3/session/{sessionId}/decision/`); en cas contrari, un UUID de correlació transitori." }, "face_search": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Declined` només quan s'ha activat una advertència `FACE_IN_BLOCKLIST` o `POSSIBLE_FACE_IN_BLOCKLIST`. Les coincidències duplicades i les advertències de múltiples cares mai no causen rebuig." }, "total_matches": { "type": "integer", "description": "Nombre d'entrades a `matches` (0–5).", "example": 1 }, "matches": { "type": "array", "maxItems": 5, "description": "Fins a 5 cares del teu índex de cerca facial que superen el llindar mínim de similitud, ordenades per similitud (amb les entrades a la llista de bloqueig classificades primer quan `search_type=blocklisted_or_approved`). Buit quan cap cara registrada és prou similar.", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID de la sessió de verificació a la qual pertany la cara coincident. `null` quan `source` és `imported`, `list_entry` o `retained_template`.", "example": "882c42d5-8a4d-4d20-8080-a22f57822c86" }, "session_number": { "type": "integer", "nullable": true, "description": "Número de sessió fàcil de llegir que es mostra a la Business Console. `null` per a coincidències que no són de sessió.", "example": 323442 }, "similarity_percentage": { "type": "number", "format": "float", "minimum": 0, "maximum": 100, "description": "Similitud entre la cara enviada i la cara coincident (0–100).", "example": 99.99 }, "source": { "type": "string", "enum": [ "session", "imported", "list_entry", "retained_template" ], "description": "D'on prové la cara coincident: `session` — una sessió de verificació o una crida d'API independent desada; `imported` — una cara pujada directament a un perfil d'usuari; `list_entry` — una cara associada a una de les teves llistes; `retained_template` — una plantilla biomètrica sense imatge emmagatzemada en un usuari, llistada a `/v3/biometric-templates/`." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` de la sessió coincident o de l'usuari vinculat per a cares importades i de plantilla retinguda.", "example": "user-1" }, "vendor_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Identificador d'User vinculat. `null` per a entrades de llista i coincidències de sessió sense un User.", "example": "2f7c1a9e-4b28-4a6d-97f1-83576f80e1b4" }, "biometric_template_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID de la plantilla biomètrica conservada. Només s'estableix quan `source` és `retained_template`; `null` en cas contrari.", "example": null }, "verification_date": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va capturar originalment la cara coincident, o quan es va crear una plantilla conservada (`YYYY-MM-DDThh:mm:ssZ`). `null` per a coincidències de `list_entry`.", "example": "2025-01-01T00:00:00Z" }, "user_details": { "type": "object", "nullable": true, "description": "Dades d'identitat extretes durant la verificació del document de la sessió coincident. `null` quan la sessió coincident no té dades de document (p. ex., sessions només amb prova de vida) i sempre `null` per a coincidències de `retained_template`. En el cas de coincidències amb `source: imported`, s'emplena a partir del perfil d'usuari: `full_name` establert, `document_type`/`document_number` nuls.", "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 durada limitada (`https:///...`) de la imatge de referència de la cara coincident quan `save_api_request=true`. Amb `save_api_request=false`, aquesta és una ruta d'emmagatzematge intern que no es pot descarregar directament. Sempre és `null` per a coincidències de `retained_template` perquè les plantilles retingudes no contenen cap imatge.", "example": "https:///face/3f6a1c2e/reference.jpg" }, "status": { "type": "string", "nullable": true, "description": "Estat de la sessió que coincideix (`Approved`, `Declined`, `In Review`, …). `null` per a coincidències `imported`/`list_entry`.", "example": "Approved" }, "is_blocklisted": { "type": "boolean", "description": "`true` quan la cara coincident és a la teva llista de bloqueig facial. Qualsevol coincidència prou similar a la llista de bloqueig rebutja la cerca." }, "is_allowlisted": { "type": "boolean", "description": "`true` quan la cara coincident és en una de les teves llistes d'autorització. Les coincidències a la llista d'autorització suprimeixen les advertències de duplicats." }, "api_service": { "type": "string", "nullable": true, "description": "S'estableix quan la cara coincident es va registrar mitjançant una crida d'API independent (p. ex., `PASSIVE_LIVENESS`); `null` per a sessions de verificació habituals i cares importades.", "example": null } } } }, "user_image": { "type": "object", "description": "Resultats de la detecció facial per a la imatge enviada. Les entrades aquí només contenen `bbox` i `confidence`.", "properties": { "entities": { "type": "array", "description": "Una entrada per cara detectada. La cara més gran és la que se cerca.", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Quadre delimitador `[x_min, y_min, x_max, y_max]` en píxels.", "example": [ 40, 40, 120, 120 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Confiança de la detecció facial (0–1).", "example": 0.732973 } } } }, "best_angle": { "type": "integer", "description": "Rotació (graus) que ha produït la millor detecció facial; diferent de zero només quan `rotate_image=true` ha corregit l'orientació. Mai no és null en aquest endpoint (per defecte és 0 quan el model l'omet).", "example": 0 } } }, "warnings": { "type": "array", "description": "Senyals de risc. `FACE_IN_BLOCKLIST` / `POSSIBLE_FACE_IN_BLOCKLIST` (`error`) rebutgen la cerca; `MULTIPLE_FACES_DETECTED` (`warning`) i `DUPLICATED_FACE` / `POSSIBLE_DUPLICATED_FACE` (`information`) són informatius.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "MULTIPLE_FACES_DETECTED", "FACE_IN_BLOCKLIST", "POSSIBLE_FACE_IN_BLOCKLIST", "DUPLICATED_FACE", "POSSIBLE_DUPLICATED_FACE" ], "description": "Codi de risc llegible per màquina." }, "feature": { "type": "string", "enum": [ "LIVENESS" ], "description": "Funcionalitat que ha generat l'advertència. Sempre `LIVENESS` en aquest endpoint." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "`null` per a `MULTIPLE_FACES_DETECTED`. Les coincidències amb la llista de bloqueig inclouen `{blocklisted_session_id, blocklisted_session_number, api_service}`; les coincidències per duplicat inclouen `{duplicated_session_id, duplicated_session_number, api_service}` que apunten a la primera sessió coincident." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravetat. Les advertències `error` canvien `status` a `Declined`; les entrades `warning` i `information` són consultives i mai no rebutgen per si soles." }, "short_description": { "type": "string", "description": "Resum d'una sola línia del risc, llegible per a humans." }, "long_description": { "type": "string", "description": "Explicació fàcil de llegir del risc." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò de les `vendor_data` que has enviat, o `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ressò de l'objecte `metadata` que has enviat, o `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de temps ISO 8601 (UTC) de quan s'ha generat la resposta, p. ex. `2026-06-12T01:04:42.763237+00:00`." } } } } } }, "400": { "description": "Error de validació. Es retorna quan falta `user_image`, supera els 5 MB, té una extensió no admesa o quan **no es detecta cap cara** a la imatge enviada. Els errors de camp utilitzen l'embolcall `{field: [messages]}` de DRF; els errors de detecció facial utilitzen `{\"error\": ...}`.", "content": { "application/json": { "examples": { "No face detected": { "summary": "La imatge es descodifica correctament però no conté cap cara detectable", "value": { "error": "No face detected in the image" } }, "Missing image": { "summary": "`user_image` no s'ha inclòs a les dades del formulari", "value": { "user_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Extensió de fitxer no permesa (només 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": "La pujada supera el límit de 5 MB", "value": { "user_image": [ "File size should not exceed 5 MB" ] } } } } } }, "403": { "description": "Permís denegat. Es retorna quan falta la capçalera `x-api-key`, i també quan el saldo de l'organització que fa la crida no pot cobrir la crida; una clau incorrecta, revocada o caducada retorna `401`. Si falta la clau es retorna `403` amb `{\"detail\": ...}`; una clau incorrecta, revocada o caducada retorna `401`. La manca de crèdit retorna `403` amb `{\"error\": ...}` abans que es produeixi cap processament d'imatges.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de l'organització no pot cobrir la crida", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Més de 300 sol·licituds d'escriptura en el minut 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": "Llista sessions de verificació (KYC i/o KYB) amb filtres i paginació", "description": "Retorna una llista paginada de sessions de verificació per a l'aplicació identificada per la teva clau d'API, de més recents a més antigues (`session_number` descendent).\n\n**URL canònica:** la ruta és `/v3/sessions/` (amb barra final). Les sol·licituds a `/v3/sessions` sense la barra reben una redirecció `301` cap a la URL amb barra conservant la cadena de consulta; la majoria de clients HTTP la segueixen de manera transparent en GET.\n\n**Quan utilitzar aquest endpoint vs webhooks.** Fes servir aquest endpoint per a taulers, cerques de gestió interna, conciliació i exportacions per lots. No facis sondejos periòdics per seguir el progrés de verificacions individuals: en lloc d'això, configura [webhooks](/ca/integration/webhooks), que envien esdeveniments `status.updated` en el moment en què canvia una sessió. Per obtenir el resultat complet d'una sessió, crida `GET /v3/session/{sessionId}/decision/`.\n\n**Sessions de KYC i KYB.** `session_kind` selecciona quins tipus es llisten:\n- `user` (per defecte): només sessions de Verificació d'usuaris (KYC). Comportament compatible amb versions anteriors.\n- `business`: només sessions de Verificació d'empreses (KYB). Les files tenen una estructura diferent i més reduïda (consulta l'esquema de resposta).\n- `all`: ambdós tipus en una sola resposta: la pàgina de KYC i la pàgina de KYB per als mateixos `limit`/`offset` es concatenen a `results` (primer les files de KYC), de manera que una pàgina pot contenir fins a `2 x limit` files. `count` és la suma d'ambdós tipus i `next`/`previous` reflecteixen la paginació del costat de KYC. Per a una paginació estricta de dades mixtes, crida `user` i `business` per separat.\n\nCada fila inclou un discriminador `session_kind` (`\"user\"` o `\"business\"`).\n\n**Paginació.** Limit/offset estàndard: `limit` (per defecte 50) i `offset` (per defecte 0), amb URL de pàgina preparades a `next`/`previous`. Per a les files de KYC, `count` és exacte. Per a les files de KYB, `count` es calcula amb un escaneig acotat i està limitat a 100; quan hi ha més de 100 coincidències es queda a 100, de manera que cal iterar fent servir `next` (o comprovant si s'ha retornat una pàgina sencera) en lloc de calcular el total de pàgines a partir de `count`.\n\n**Semàntica dels filtres.** Tots els filtres es combinen amb AND i s'apliquen a les files de KYC. Quan `session_kind` és `business` o `all`, la part de KYB respecta els paràmetres compartits `vendor_data`, `status`, `workflow_id`, `country` (codi de país del registre de l'empresa), `date_from`, `date_to`, `search` (nom de l'empresa, número de registre —introdueix els números de registre sense separadors, p. ex. `DPC001` i no `DPC-001`—, vendor_data, número de sessió o UUID de sessió), `warning` i `organization_name`; la resta de filtres exclusius de KYC s'ignoren per a les files de KYB. Els paràmetres separats per comes (`status`, `country`, `document_type`, `region`, `workflow_id`, `document_name`, `warning`, `organization_name`, `session_type`) coincideixen amb qualsevol dels valors indicats (OR dins del paràmetre). `vendor_data` és una coincidència exacta; fes servir `search` per a coincidències parcials. Els valors desconeguts als filtres de llista simplement no retornen cap fila (sense error); els valors amb tipus mal formats (`date_from`, `date_to`, `didit_internal_id`, `api_service`, `session_kind`) retornen `400` amb un objecte d'error per camp.\n\n**Cerca.** `search` s'adapta a l'entrada: un UUID complet cerca per `session_id`; els dígits (amb `+ - . space` opcionals) coincideixen amb el prefix del número de sessió, números de document/personals, prefix de número de telèfon o `vendor_data`; els valors que contenen `@` coincideixen amb prefixos de correu electrònic; qualsevol altre text coincideix amb noms (sense distinció d'accents) i `vendor_data`.\n\nNo s'aplica cap límit de freqüència fix per endpoint, però mantén els sondejos de llistes poc freqüents i fes servir webhooks per a les actualitzacions en temps 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": "Quin tipus de sessions s'han de llistar: `user` (només KYC, per defecte), `business` (només KYB) o `all` (ambdues, concatenades; consulta la descripció per a la semàntica de paginació combinada). No distingeix entre majúscules i minúscules (`BUSINESS` funciona); qualsevol valor que no sigui una variant de majúscules/minúscules de `user`/`business`/`all` retorna `400`.", "schema": { "type": "string", "enum": [ "user", "business", "all" ], "default": "user" }, "example": "all" }, { "name": "limit", "in": "query", "required": false, "description": "Nombre màxim de files per pàgina (per tipus quan `session_kind=all`). Per defecte és 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 20 }, { "name": "offset", "in": "query", "required": false, "description": "Nombre de files que cal ometre abans de la primera fila retornada. Per defecte és 0. És preferible seguir els URL `next`/`previous` de la resposta.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 20 }, { "name": "status", "in": "query", "required": false, "description": "Llista separada per comes dels estats de sessió que cal incloure, p. ex. `Approved,In Review`. Els valors distingeixen entre majúscules i minúscules; consulta [Estats de verificació](/ca/integration/verification-statuses). Els valors desconeguts no coincideixen amb res.", "schema": { "type": "string" }, "example": "Approved,In Review" }, { "name": "vendor_data", "in": "query", "required": false, "description": "Filtre de coincidència exacta sobre el `vendor_data` que vas enviar en crear la sessió (el teu propi identificador d'usuari/empresa). Per a coincidències parcials, utilitza `search` en el seu lloc.", "schema": { "type": "string" }, "example": "your-user-id-123" }, { "name": "search", "in": "query", "required": false, "description": "Una referència mostrada completa com ara `S-0001` (usuari) o `B-0001` (empresa) només coincideix amb aquest número i tipus de sessió; els zeros inicials i les majúscules o minúscules no afecten la coincidència. Cerca intel·ligent de text lliure. Un UUID complet coincideix amb `session_id`; una entrada numèrica coincideix amb el prefix del número de sessió, números de document/personals, prefix de telèfon o `vendor_data`; una entrada que conté `@` coincideix amb prefixos de correu electrònic; la resta de text coincideix amb noms (sense distingir accents) i `vendor_data`. El text lliure que conté dígits coincideix addicionalment amb camps de cerca de número de document/personal i prefixos de número de sessió.", "schema": { "type": "string" }, "example": "jane doe" }, { "name": "workflow_id", "in": "query", "required": false, "description": "UUID de flux de treball separats per comes (troba'ls a la pàgina de Fluxos de treball a la Console). Els UUID amb format incorrecte a la llista s'ignoren; si cap no és vàlid, el resultat és buit.", "schema": { "type": "string" }, "example": "9f9b1234-aaaa-bbbb-cccc-1234567890ab" }, { "name": "date_from", "in": "query", "required": false, "description": "Només sessions creades en o després d'aquesta data (UTC), format `YYYY-MM-DD`. Les dates amb format incorrecte retornen `400`.", "schema": { "type": "string", "format": "date" }, "example": "2026-06-01" }, { "name": "date_to", "in": "query", "required": false, "description": "Només sessions creades fins a aquesta data (UTC), format `YYYY-MM-DD`. Per a files de KYC s'inclou el dia sencer; per a files de KYB la comparació és `created_at <= date_to` (mitjanit), així que utilitza la data de l'endemà per incloure un dia complet de sessions de KYB.", "schema": { "type": "string", "format": "date" }, "example": "2026-06-30" }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Identificadors d'etiquetes separats per comes (`tags` de la teva aplicació). Retorna les sessions que en continguin qualsevol. Els identificadors que no siguin UUID vàlids s'ignoren, i quan cap no és vàlid la llista és buida." }, { "name": "decided_from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Data i hora ISO 8601. Retorna les sessions l'estat de les quals ha canviat per darrera vegada en aquest moment o després. Filtra per l'hora de l'últim canvi d'estat, no per l'hora de creació." }, { "name": "decided_to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Data i hora ISO 8601. Retorna les sessions l'estat de les quals ha canviat per darrera vegada abans d'aquest moment. Combina-ho amb `decided_from` per a una finestra semioberta." }, { "name": "country", "in": "query", "required": false, "description": "Filtre de països separat per comes. Per a files de KYC: codis ISO 3166-1 alfa-3 de l'estat emissor del document d'identitat (p. ex. `ESP,USA`), que poden diferir de la nacionalitat. Per a files de KYB: el codi de país de l'empresa al registre.", "schema": { "type": "string" }, "example": "ESP,USA" }, { "name": "document_type", "in": "query", "required": false, "description": "Codis de tipus de document d'identitat verificats a la sessió separats per comes (només files de KYC): `P` (passaport), `ID` (document d'identitat), `DL` (permís de conduir), `RP` (permís de residència), `SSC` (targeta de la Seguretat Social), `HIC` (targeta d'assegurança mèdica), `WP` (permís de treball), `TC` (targeta fiscal), `VISA`, `PSC` (targeta de serveis públics), `BC` (certificat de naixement), `OTHER`. Tingues en compte que el camp de resposta `document_type` conté el nom visible, no el codi.", "schema": { "type": "string" }, "example": "P,ID" }, { "name": "document_name", "in": "query", "required": false, "description": "Noms exactes de documents; es poden passar diversos noms separats per comes, però el valor només es divideix per comes quan conté més d'un separador ` - ` (un nom sol amb una coma integrada es fa coincidir sencer). Els noms són tal com els reconeix la verificació de documents (anvers o revers), p. ex. `Spain - Id Card (2021)`. Només files de KYC.", "schema": { "type": "string" }, "example": "Spain - Id Card (2021)" }, { "name": "region", "in": "query", "required": false, "description": "Valors de regió/estat del document separats per comes (per a documents emesos per regió, com ara els permisos de conduir dels EUA). Només files de KYC.", "schema": { "type": "string" }, "example": "CA,TX" }, { "name": "didit_internal_id", "in": "query", "required": false, "description": "Filtra per l'identificador intern d'usuari de Didit (el camp de resposta `didit_internal_id`) per llistar totes les sessions d'un usuari verificat. Ha de ser un UUID vàlid; els valors mal formats retornen `400`. Només files de KYC.", "schema": { "type": "string", "format": "uuid" }, "example": "d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147" }, { "name": "session_type", "in": "query", "required": false, "description": "Canals de creació de sessions separats per comes: `API`, `HOSTED`, `MIGRATED`. El valor especial `ALL` (o ometre el paràmetre) desactiva el filtre. Només per a files de KYC.", "schema": { "type": "string" }, "example": "HOSTED" }, { "name": "api_service", "in": "query", "required": false, "description": "Filtra les sessions d'API independents per servei. Els valors no vàlids retornen `400`. Només files de 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": "Cerca de noms insensible als accents dins de les dades cribrades d'AML i de validació en bases de dades. Quan es combina amb `api_service=AML` o `api_service=DATABASE_VALIDATION`, la cerca es restringeix a les dades cribrades d'aquesta funcionalitat. Només files de KYC.", "schema": { "type": "string" }, "example": "Jane Doe" }, { "name": "warning", "in": "query", "required": false, "description": "Codis de risc d'advertència separats per comes; retorna les sessions que n'hagin generat algun (p. ex. `POSSIBLE_FRAUD`). Els codis de risc s'enumeren per funcionalitat a la [documentació d'advertències](/ca/integration/webhooks). S'aplica a files de KYC i, amb codis d'advertència d'empresa, a files de KYB.", "schema": { "type": "string" }, "example": "POSSIBLE_FRAUD" }, { "name": "status_initialized_as_in_review", "in": "query", "required": false, "description": "Quan és `true`, només les sessions la decisió de les quals hagi quedat inicialment a `In Review` (útil per auditar el volum de revisió manual). Només files de KYC.", "schema": { "type": "boolean" }, "example": true }, { "name": "is_kyc_to_be_reviewed", "in": "query", "required": false, "description": "`true` retorna sessions la verificació de documents de les quals s'ha marcat per a revisió manual; `false` retorna sessions amb la verificació de documents no marcada explícitament. Omet-ho per desactivar-ho. Només files de KYC.", "schema": { "type": "boolean" }, "example": true }, { "name": "euuid", "in": "query", "required": false, "description": "Filtra per l'euuid de l'usuari final (UUID assignat a l'usuari que es verifica, utilitzat pels enllaços profunds de la Console). Ha de ser un UUID vàlid; els valors malformats retornen un error de camp 400. Només files de KYC.", "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "organization_name", "in": "query", "required": false, "description": "Noms d'organització separats per comes. Orientat a la consola; amb una clau d'API (ja restringida a una aplicació), només coincideix amb el nom de la teva pròpia organització.", "schema": { "type": "string" }, "example": "Acme Inc" } ], "responses": { "200": { "description": "Llista de sessions paginada. Els elements de `results` són files de KYC, files de KYB o ambdues segons `session_kind`; distingeix-los mitjançant el camp `session_kind` de cada fila.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Nombre de sessions que coincideixen amb els filtres: exacte fins a 100 i limitat a 100 a partir d'aquí, de manera que no l'has d'utilitzar com a total. Fes servir `next` per saber si hi ha més pàgines. Per a `session_kind=all` és la suma de tots dos tipus, cadascun limitat a 100.", "example": 2 }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la pàgina següent, o `null` a l'ú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` a la primera pàgina.", "example": null }, "results": { "type": "array", "description": "Files de sessió, les més recents primer. Amb `session_kind=all`, les files de KYC van primer, seguides de les files de 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 sessió completada i una altra de no iniciada", "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: fila de KYC seguida d'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": "Redirigeix a l'URL canònic amb barra final. Es retorna quan el camí de la sol·licitud és `/v3/sessions` (sense barra final); la capçalera `Location` apunta a `/v3/sessions/` conservant la cadena de consulta. Els clients GET normalment la segueixen automàticament." }, "400": { "description": "Paràmetre de consulta no vàlid. El cos és un objecte indexat pel paràmetre causant.", "content": { "application/json": { "examples": { "Invalid session_kind": { "summary": "session_kind no és cap dels valors user/business/all", "value": { "session_kind": "Must be \"user\", \"business\", or \"all\"." } }, "Invalid date": { "summary": "date_from/date_to amb format incorrecte", "value": { "date_from": [ "Enter a valid date." ] } }, "Invalid didit_internal_id": { "summary": "didit_internal_id no és un UUID", "value": { "didit_internal_id": [ "Enter a valid UUID." ] } }, "Invalid api_service": { "summary": "api_service no es troba entre les opcions permeses", "value": { "api_service": [ "Select a valid choice. FOO is not one of the available choices." ] } } } } } }, "403": { "description": "Clau d'API absent, mal formada o revocada. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.\n\n**Aplicació suprimida:** durant uns minuts després de suprimir una aplicació, una sol·licitud feta amb una de les seves claus d'API pot respondre `{\"detail\": \"This application was deleted.\", \"code\": \"application_deleted\"}`. No reintentis: l'aplicació i les seves claus d'API ja no existeixen. Després d'aquests minuts, la clau es rebutja com qualsevol altra clau 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": "Motiu llegible per màquina, present només en algunes fallades. `application_deleted`: la clau d'API pertany a una aplicació que s'ha suprimit.", "example": "application_deleted" } }, "required": [ "detail" ] }, "examples": { "Forbidden": { "summary": "Falta l'x-api-key o no és vàlid", "value": { "detail": "You do not have permission to perform this action." } }, "ApplicationDeleted": { "summary": "Clau d'API d'una aplicació suprimida", "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 per compartir per a una sessió de verificació finalitzada", "description": "Genera un JWT de curta durada que permet a una aplicació de Didit específica importar aquesta sessió finalitzada. Combina-ho amb `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 de compartició generat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "share_token": { "type": "string", "description": "JWT signat amb HS256. Passa això literalment com a `share_token` a [`POST /v3/session/import-shared/`](/sessions-api/import-shared-session) a l'aplicació de destinació.", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." }, "for_application_id": { "type": "string", "format": "uuid", "description": "Retorna el UUID de l'aplicació de destinació a la qual està vinculat el token.", "example": "a5f3bca2-46e2-411e-90ef-a580900a57ee" }, "session_kind": { "type": "string", "enum": [ "user", "business" ], "description": "Si la sessió d'origen és una sessió de Verificació d'usuaris (KYC) o de Verificació d'empreses (KYB)." } } }, "examples": { "User session": { "summary": "Compartir una sessió de KYC", "value": { "share_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXNzaW9uX2lkIjoiMjBiYjNjM2ItNjE0Ni00MzlmLTg0YTQtYmQzMGQwMGFjNmEyIiwiZnJvbV9hcHBsaWNhdGlvbl9pZCI6ImRiZDIwZTM0LTQyZTktNGYyYy1iYTkxLWNmMDc2MjAxNmY2NCIsImZvcl9hcHBsaWNhdGlvbl9pZCI6ImE1ZjNiY2EyLTQ2ZTItNDExZS05MGVmLWE1ODA5MDBhNTdlZSIsImlhdCI6MTc1MzYzMDY2NiwiZXhwIjoxNzUzNjM0MjY2fQ.JJ9pNE_hqZsOtbR0XYZIWw4JzidjdEl279iUrsIkhGE", "for_application_id": "a5f3bca2-46e2-411e-90ef-a580900a57ee", "session_kind": "user" } }, "Business session": { "summary": "Compartir una sessió de KYB", "value": { "share_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "for_application_id": "a5f3bca2-46e2-411e-90ef-a580900a57ee", "session_kind": "business" } } } } } }, "401": { "description": "Falten les credencials o no són vàlides. A diferència de la majoria d'endpoints v3, aquest endpoint s'autentica mitjançant el decorador de permisos i retorna `401` quan no es presenta cap token o clau vàlids.", "content": { "application/json": { "examples": { "Unauthorized": { "summary": "No autoritzat", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "404": { "description": "No existeix cap sessió amb el `session_id` indicat a la teva aplicació.", "content": { "application/json": { "examples": { "Not Found": { "summary": "Sessió no trobada", "value": { "detail": "Not found." } } } } } }, "400": { "description": "Error de validació. Els errors de camp s'indexen pel nom del camp; l'error de no finalització arriba sota la clau `detail` (com un array).", "content": { "application/json": { "examples": { "Wrong status": { "summary": "La sessió d'origen no ha finalitzat", "value": { "detail": [ "Only finished sessions (\"Approved\", \"Declined\", \"In Review\") can be shared." ] } }, "Target missing": { "summary": "L'aplicació de destinació no existeix", "value": { "for_application_id": [ "Target application does not exist." ] } }, "Self-share": { "summary": "La destinació és l'aplicació que fa la crida", "value": { "for_application_id": [ "Cannot share a session with the same application." ] } }, "TTL bounds": { "summary": "ttl_in_seconds fora dels límits", "value": { "ttl_in_seconds": [ "Ensure this value is greater than or equal to 60." ] } } } } } }, "403": { "description": "Les credencials són vàlides però no tenen el permís `write:sessions` per a aquesta aplicació.", "content": { "application/json": { "examples": { "No Permission": { "value": { "detail": "You do not have permission to perform this action." }, "summary": "Sense permís" } } } } } }, "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sessió de verificació d'origen per a la qual s'ha d'emetre 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 l'aplicació de Didit que bescanviarà el token. Ha d'existir, no pot estar suprimida i ha de ser diferent de l'aplicació que fa la crida. Troba'l a la Business Console a **Settings → Application**.", "example": "a5f3bca2-46e2-411e-90ef-a580900a57ee" }, "ttl_in_seconds": { "type": "integer", "description": "Temps de vida del token, en segons. Mínim `60`, màxim `86400` (24 h). Per defecte és `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": "Bescanvia un token per compartir per clonar una sessió de verificació a la teva aplicació", "description": "Bescanvia un token per compartir per clonar una sessió de KYC o KYB a l'aplicació que fa la crida amb un nou `session_id`. No idempotent — un token es bescanvia una vegada per 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": "Sessió clonada. El cos és el payload de decisió V3 per a tots dos tipus, discriminat per `session_kind`: `\"user\"` (KYC) amb blocs de funcionalitats basats en llistes com ara `id_verifications`, `liveness_checks`, `aml_screenings`; `\"business\"` (KYB) amb blocs com ara `registry_checks` i `key_people_checks`. Tots dos inclouen `shared_from_session`, el `session_id` de la sessió original a l'aplicació d'origen. Amb `trust_review: false`, l'`status` de la sessió clonada es força a `In Review`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionDecision" }, "examples": { "User session imported": { "summary": "Sessió KYC clonada (truncada; en realitat és el payload complet de decisió 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": "Sessió KYB clonada (truncada; en realitat és el payload complet de decisió V3 KYB)", "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ó (token no vàlid, caducat, destinació incorrecta o fa referència a una sessió que ja no existeix).", "content": { "application/json": { "examples": { "Invalid Share Token": { "summary": "JWT no vàlid", "value": { "share_token": [ "Invalid share token." ] } }, "Expired Share Token": { "summary": "Token posterior a `exp`", "value": { "share_token": [ "Share token has expired." ] } }, "Wrong audience": { "summary": "Token no vinculat a aquesta aplicació", "value": { "share_token": [ "This token is not valid for this application." ] } }, "Original missing": { "summary": "La sessió d'origen s'ha eliminat", "value": { "share_token": [ "Original session does not exist." ] } } } } } }, "403": { "description": "Falta la clau d'API (una clau incorrecta, revocada o caducada rep `401`), o aquesta sessió d'origen ja s'ha importat a l'aplicació sol·licitant (un sol bescanvi per receptor).", "content": { "application/json": { "examples": { "Forbidden": { "summary": "Prohibit", "value": { "detail": "You do not have permission to perform this action." } }, "Already imported": { "summary": "L'origen ja s'ha importat un cop", "value": { "detail": "This session has already been shared with your application." } } } } } }, "404": { "description": "`workflow_id` no pertany a l'aplicació que fa la crida.", "content": { "application/json": { "examples": { "Workflow not found": { "summary": "Flux de treball desconegut", "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 per compartir JWT emès per [`POST /v3/session/{sessionId}/share/`](/sessions-api/share-session).", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." }, "trust_review": { "type": "boolean", "description": "Si és `true`, la sessió clonada conserva el `status` final de l'origen. Si és `false`, es força a l'estat `In Review`.", "example": false }, "workflow_id": { "type": "string", "format": "uuid", "description": "UUID d'un flux de treball de l'aplicació que fa la crida. Els ID d'altres aplicacions es rebutgen amb un `404`.", "example": "9f9b1234-aaaa-bbbb-cccc-1234567890ab" }, "vendor_data": { "type": "string", "nullable": true, "description": "Substitució opcional per al `vendor_data` de la sessió 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": "Cerca d'empresa al registre mercantil per a KYB (independent)", "operationId": "post_v3_kyb_search", "x-didit-sdk": { "resource": "kyb", "method": "search", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [], "description": "Cerca empreses candidates als registres mercantils oficials per nom i/o número de registre. Aquest és el pas 1 del flux de registre en dos passos: **search** retorna candidats simplificats i, després, `POST /v3/kyb/select/` obté el perfil complet d'un candidat.\n\n**Facturació de la cerca.** Les cerques satisfactòries que utilitzen una font de dades d'empresa de pagament costen USD 0.50 per sol·licitud, independentment del nombre de candidats. Els resultats buits, les fallades i els resultats servits només per altres fonts no es cobren. El preu aplicable es reserva abans de la cerca; un saldo insuficient retorna 403 amb el codi `insufficient_credits`. S'apliquen les tarifes per contracte quan s'hagi acordat, i una tarifa de cerca per contracte no configurada retorna 403. Les cerques al sandbox són gratuïtes. Repetir una cerca satisfactòria pot comportar un altre càrrec; el lliurament del callback no afegeix cap càrrec. L'obtenció del perfil es factura per separat. Aquesta tarifa de cerca també s'aplica a la v2. Els candidats sempre es retornen amb `fetch_status: \"pending\"`: les dades completes de l'empresa només s'obtenen (i es facturen) en seleccionar.\n\n**`kyb_response_id` és efímer.** És un identificador per a cada cerca, no un id d'empresa estable. Fes la selecció ràpidament després de cercar i torna a cercar per obtenir un identificador nou en lloc d'emmagatzemar-lo.\n\n**`tier` tria la cadena de proveïdors.** `tier` indica el nivell de registre en què s'executa la cerca: `basic` (per defecte, la cadena Lite), `shareholders` o `ubo`. La cerca utilitza la cadena de proveïdors que dona servei a aquest nivell, i no sempre és la mateixa cadena que llegeix la cerca Lite, de manera que una cerca Lite buida no és una prova que el registre no contingui l'empresa — torna a cercar al nivell que necessitis. Un país que no ofereixi el nivell que indiques es cerca al nivell més alt que ofereixi fins a aquest. Obtén el candidat des de l'endpoint que ven aquest nivell: `POST /v3/kyb/select/` (Lite), `POST /v3/kyb/shareholders/` o `POST /v3/kyb/ubo/`.\n\n**Autenticació.** `POST /v3/kyb/search/` (i `/v2/`) rep la clau d'API de la teva aplicació a la capçalera `x-api-key`. L'endpoint allotjat `POST /v1/kyb/search/` és la ruta autenticada per sessió que crida un flux de verificació allotjat: respon `403` a una clau d'API i no rep cap `tier` — la configuració del registre KYB del flux de treball tria la cadena.\n\n**Dos modes.**\n- *Síncron (per defecte):* l'API consulta repetidament el registre fins que la cerca es resol i retorna la llista final de candidats (`search_resolved: true`).\n- *Asíncron:* passa `webhook_url` i l'API respon immediatament — normalment amb `search_status: \"pending\"` i una llista buida de candidats — i després fa un POST amb un callback `kyb.registry_search.resolved` a la teva URL quan el registre acaba. El cos del callback és `{\"event_id\", \"event_type\": \"kyb.registry_search.resolved\", \"request_id\", \"vendor_data\", \"metadata\", \"search_status\", \"search_resolved\", \"kyb_registry\", \"timestamp\", \"created_at\"}` — tingues en compte que `timestamp` i `created_at` al callback són enters epoch, a diferència del `created_at` en format ISO d'aquest endpoint — i s'envia **sense signar** (capçalera `X-Didit-Unsigned-Callback: true`, sense `X-Signature`).\n\n**Codis de país.** ISO 3166-1 alpha-2 (`GB`, `DE`), més codis de subdivisió `XX-YY` on els registres són regionals — p. ex., `US-CA` per a Califòrnia.\n\n**Sandbox.** Les claus d'aplicacions del sandbox retornen un candidat estàtic sense contactar amb cap registre.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "country_code" ], "properties": { "country_code": { "type": "string", "maxLength": 10, "description": "Codi ISO 3166-1 alfa-2 del país el registre mercantil del qual es vol cercar. Per exemple, `GB`. On els registres mercantils operen a escala estatal o provincial, afegeix el codi de subdivisió ISO 3166-2 en format `XX-YY`: `US-CA` cerca al registre de Califòrnia. Les cerques als Estats Units sempre requereixen la subdivisió; un valor simple `US` es rebutja. No distingeix entre majúscules i minúscules; es normalitza a majúscules.", "example": "GB" }, "name": { "type": "string", "maxLength": 255, "description": "Nom de l'empresa a cercar. Cal indicar `name` o `registration_number`.", "example": "Tesco" }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registre del registre que cal cercar. Es requereix `name` o bé `registration_number`." }, "tier": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "default": "basic", "description": "Nivell del registre en la cadena de proveïdors en què s'executa aquesta cerca. `basic` (per defecte) cerca a la cadena Lite del país; `shareholders` i `ubo` cerquen a la cadena de titularitat d'aquest nivell, que pot ser una font diferent, de manera que una cerca Lite buida no demostra que l'empresa no figuri al registre. En un país que no ofereixi el nivell indicat, es cerca al nivell més alt que ofereixi fins a aquest. Recupera el candidat des de l'endpoint que ven el nivell que has cercat: `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": "Estratègia de coincidència de noms aplicada per la cerca al registre. `contains` és l'únic valor acceptat: cap font de registre darrere de la cerca ofereix un mode de prefix o difús (fuzzy), de manera que `start_with` i `fuzzy` es rebutgen amb `400` (`not a valid choice`)." }, "vendor_data": { "type": "string", "description": "El teu identificador per a aquesta consulta; es retorna tal com s'ha enviat i s'inclou al callback del webhook." }, "metadata": { "type": "object", "nullable": true, "description": "JSON de format lliure; retornat com a resposta i inclòs a la crida de retorn del webhook." }, "webhook_url": { "type": "string", "format": "uri", "maxLength": 500, "description": "Canvia la cerca al mode asíncron: l'API respon immediatament i envia mitjançant POST un callback no signat `kyb.registry_search.resolved` a aquesta URL quan la llista de candidats està a punt." } } }, "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": "Cerca acceptada. El mode síncron retorna la llista de candidats resolta; el mode webhook retorna immediatament (sovint `search_status: \"pending\"`) i lliura la llista final mitjançant el callback `kyb.registry_search.resolved`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Amb `webhook_url`: l'identificador persistent de la sol·licitud de cerca, retornat com a `request_id` al callback de `kyb.registry_search.resolved`. Sense `webhook_url`: un UUID de correlació transitori (la cerca no s'emmagatzema)." }, "kyb_registry": { "$ref": "#/components/schemas/KYBRegistrySearchResults" }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò del `vendor_data` que has enviat." }, "metadata": { "type": "object", "nullable": true, "description": "Ressò de les `metadata` que has enviat." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved search": { "summary": "Mode síncron — llista final de candidats", "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": "S'ha proporcionat `webhook_url` — els candidats arriben a través del 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ó. Els problemes a nivell de camp utilitzen l'embolcall estàndard de DRF; la regla de nom/número de registre es notifica sota `non_field_errors`. Un país que els registres no cobreixen respon `400` amb `code: kyb_registry_country_unsupported`.", "content": { "application/json": { "examples": { "Missing search criteria": { "summary": "No s'ha proporcionat ni `name` ni `registration_number`", "value": { "non_field_errors": [ "Either 'name' or 'registration_number' is required." ] } }, "Invalid country_code": { "summary": "Ha de ser `XX` (alfa-2) o subdivisió `XX-YY`", "value": { "country_code": [ "country_code must be a 2-letter ISO code." ] } }, "Invalid search_type": { "summary": "Només s'accepta `contains`", "value": { "search_type": [ "\"start_with\" is not a valid choice." ] } }, "Invalid webhook_url": { "summary": "`webhook_url` ha de ser un URL vàlid", "value": { "webhook_url": [ "Enter a valid URL." ] } }, "Country not covered": { "summary": "No hi ha cap registre mercantil per a aquest 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": "Permís denegat. Es retorna quan falta la capçalera `x-api-key`; una clau incorrecta, revocada o caducada retorna `401`. Si falta la clau es retorna `403` amb `{\"detail\": ...}`; una clau incorrecta, revocada o caducada retorna `401`. També es retorna abans de fer la cerca quan no es pot cobrir la tarifa de cerca aplicable (`code: \"insufficient_credits\"`), o quan falta una tarifa de cerca per contracte.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència o s'ha esgotat el límit de cerques disponibles. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600), amb les capçaleres `X-RateLimit-*` i `Retry-After`. A part, les cerques de pagament al registre mercantil estan limitades a 600 per aplicació i per hora: passat aquest límit, la resposta és `429` amb `code: kyb_registry_search_limit_reached`, i les cerques ateses exclusivament per fonts gratuïtes continuen funcionant. Espera i torna a cercar més tard.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Més de 300 sol·licituds d'escriptura en el minut 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 cerques de pagament en l'ú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 proveïdor del registre de KYB no està disponible temporalment: una resposta 5xx, temps d'espera esgotat o fallada de connexió del registre d'origen. La cerca no es factura. Torna-ho a provar més tard, o bé, en el flux de verificació allotjat de Didit, a l'usuari se li ofereix automàticament la introducció manual de l'empresa en lloc d'un error que només permeti reintentar.", "content": { "application/json": { "examples": { "Registry provider outage": { "summary": "El proveïdor del registre no ha respost a la cerca", "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ó d'empresa al registre mercantil per a KYB — nivell Lite (independent)", "operationId": "post_v3_kyb_select", "x-didit-sdk": { "resource": "kyb", "method": "select", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [], "description": "Recupera el perfil de registre **Lite** d'un candidat retornat per `POST /v3/kyb/search/`: detalls de l'empresa, adreça registrada, identificadors, estat, activitat i els càrrecs directius, a més del payload brut del registre. Els accionistes i els titulars reals es venen mitjançant `POST /v3/kyb/shareholders/` i `POST /v3/kyb/ubo/`.\n\n**Associació amb la cerca.** Passa el `kyb_response_id` del candidat exactament tal com el retorna una cerca de la mateixa aplicació. L'identificador és efímer i està limitat a aquesta cerca: selecciona'l ràpidament i torna a cercar per obtenir un identificador nou en lloc d'emmagatzemar-lo.\n\n**Facturació.** Cada selecció es factura al preu Lite del país (qualsevol tarifa de cerca és a part); consulta els [preus del registre de KYB](/ca/getting-started/kyb-registry-pricing). El saldo es comprova abans de qualsevol crida al registre (`403` si és insuficient) i el càrrec es registra a la sessió d'empresa creada.\n\n**La persistència és obligatòria.** Cada selecció crea una sessió d'empresa (el seu id és el `request_id`) perquè se'n pugui fer el seguiment de la facturació i la recuperació; apareix a la consola. S'accepta `save_api_request` per simetria, però ha de ser `true` (el valor per defecte); enviar `false` retorna `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 recuperada i facturada. `kyb_registry` conté el perfil complet; comprova `data_resolved` — quan és `false`, el registre encara s'estava processant i el registre emmagatzemat es completa automàticament un cop es resol.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sessió de l'empresa creada per a aquesta recuperació. El registre emmagatzemat (visible a la consola) es continua actualitzant si la consulta al registre mercantil es resol després de la resposta." }, "registry_tier_requested": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "El nivell que ven aquest endpoint: `basic` (Lite) per a select, `shareholders`, `ubo`." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "El nivell realment lliurat i facturat. És inferior al sol·licitat quan els registres del país no contenen dades de titularitat, o el registre no té cap registre de titularitat per a aquesta empresa." }, "kyb_registry": { "type": "object", "description": "Perfil complet de l'empresa al registre.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID de Didit per a aquest registre d'empresa." }, "node_id": { "type": "string", "example": "feature_kyb_registry" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review" ], "description": "Avaluació de Didit de la comprovació del registre (p. ex., `In Review` quan l'empresa no està activa al registre o no s'han pogut derivar les dades de titularitat)." }, "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": "Estat normalitzat de l'empresa tal com l'informa el registre." }, "data_resolved": { "type": "boolean", "description": "`true` un cop el registre ha retornat el perfil complet. `false` quan el registre encara estava processant després del sondeig; el registre emmagatzemat es completa automàticament un cop el registre es resol." }, "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": "Codi de subdivisió quan el registre és regional (p. ex. `CA` per a `US-CA`); buit en cas contrari." }, "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": "Nivell de risc notificat pel registre, quan estigui disponible." }, "verification_status": { "type": "string", "enum": [ "verified", "failed", "unknown" ], "nullable": true, "description": "Estat de verificació entre jurisdiccions: `verified` quan l'estat del registre mercantil estableix vigència (`active`), `failed` quan indica que l'empresa ja no està vigent (per exemple `dissolved`), i altrament `unknown`. `null` per a una empresa que no prové d'un registre mercantil i mentre una selecció encara estigui en `pending`." }, "is_from_registry": { "type": "boolean", "description": "Sempre `true` per a aquest endpoint: el perfil s'ha obtingut d'un registre oficial." }, "fetch_status": { "type": "string", "enum": [ "pending", "resolved" ], "description": "Cicle de vida de l'obtenció del registre. Reflectit per `data_resolved`." }, "alternative_names": { "type": "string", "nullable": true, "description": "Noms alternatius, comercials, anteriors o en l'idioma original de l'empresa com a text, quan s'hagin informat." }, "nature_of_business": { "type": "string", "nullable": true, "description": "Descripció de l'activitat o codi de classificació, quan s'informa." }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Quantitat decimal com a cadena de text, quan s'informa." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Codi ISO 4217, quan es comunica." }, "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, quan s'hagi informat." }, "location_of_registration": { "type": "string", "nullable": true, "description": "Registre/jurisdicció en què està registrada l'empresa, quan s'hagi notificat." }, "vat_number": { "type": "string", "nullable": true, "description": "Número d'IVA de la UE, quan es recull durant el pas de registre allotjat o s'edita posteriorment. En el moment de la selecció, normalment encara no està establert: la validació de l'IVA i de l'identificador fiscal s'executa quan l'usuari final envia el pas de registre al flux allotjat." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Resultat de la validació del número d'IVA o, si no n'hi ha, del `tax_number`, en enviar al registre. `valid` / `invalid`: determinat pel registre oficial del país (VIES de la UE, Noruega, Suïssa, Brasil, Colòmbia, Costa Rica, Equador, Paraguai; Polònia també pel seu registre intern d'IVA). `format_valid` / `invalid_format`: determinat per les regles de format i dígit de control del país on no es pot consultar cap registre. `could_not_validate`: el registre no estava disponible. `not_applicable`: sense número, un país sense registre o regles, o una sessió de sandbox." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "El número que s'ha comprovat, tal com el coneix la font (per exemple, el número d'IVA derivat d'un SIREN francès o d'un RSIN holandès). `null` quan no s'ha executat cap comprovació." }, "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 font que ha determinat `vat_validation_status`: un registre oficial o `format_rules`. `null` quan no s'ha executat cap comprovació." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Nom registrat amb la font que ha validat el número, quan en revela un. Només s'estableix quan l'estat és `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Adreça registrada amb la font que ha validat el número, quan en divulga una. Només s'estableix quan l'estat és `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de temps de la comprovació. `null` quan no s'ha executat cap comprovació." }, "financial_summary": { "type": "object", "nullable": true, "description": "Detalls sobre accions/capital notificats pel registre (moneda, accions totals, classes d'accions), quan estiguin 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": "Denominació en el registre en brut (p. ex., `Director`, `Secretary`)." }, "role": { "type": "string", "description": "Rol normalitzat derivat de la designació. Conjunt complet de 17 valors del model; l'anàlisi del registre mercantil en aquest endpoint sol emetre 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` quan el registre indica que l'administrador ha dimitit." }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending" ], "description": "Estat d'una sessió de KYC associada, quan se'n va iniciar una per a aquest administrador. `null` en cas contrari." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "URL de verificació de la sessió de KYC associada, quan n'existeix una." }, "first_name": { "type": "string", "nullable": true, "description": "Nom de pila quan el registre el reporta explícitament; no deduït del nom complet." }, "last_name": { "type": "string", "nullable": true, "description": "Cognom quan el registre mercantil l'informa explícitament." }, "address": { "type": "string", "nullable": true, "description": "Adreça de l'administrador notificada pel registre mercantil." }, "appointment_date": { "type": "string", "nullable": true, "description": "Data en què es va nomenar el directiu.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Data en què va finalitzar el càrrec, quan s'ha notificat.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Data de naixement completa informada pel registre. Null quan només es coneix l'any o el mes de naixement.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Any de naixement notificat pel registre, inclòs quan la data completa no està disponible." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Mes de naixement notificat pel registre. Nul quan només es coneix l'any." } } }, "description": "Administradors, secretaris i altres càrrecs extrets del registre." }, "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 titular és una persona física o una persona jurídica." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Rols normalitzats (p. ex. `ubo`, `shareholder`)." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Límit inferior del tram de titularitat comunicat pel registre (p. ex., `25%`)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Límit superior de la franja de titularitat informada pel registre mercantil." }, "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": "Percentatge de titularitat analitzat (límit màxim, amb alternativa al límit mínim)." }, "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": "Data de naixement completa quan s'ha informat.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Data de nomenament quan s'ha informat.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } }, "description": "Titulars reals / persones amb control significatiu extrets del registre. Pot estar buit quan el registre no exposa la titularitat." }, "addresses": { "type": "array", "nullable": true, "description": "Totes les adreces que indica el registre, en un format canònic. Null si no n'indica cap.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "Les activitats sota les quals el registre classifica l'empresa, en un format canònic. Null si no n'indica cap.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Dates de presentació al registre, quan estiguin disponibles. Els informes anuals i les juntes generals utilitzen last_annual_return_date i last_agm_date; són diferents dels comptes financers." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "description": "Sempre `null` en aquest endpoint (utilitzat pel flux de KYB allotjat quan els usuaris finals editen dades del registre)." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Sempre `null` en aquest endpoint." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "S'estableix quan un revisor de la consola edita el registre més endavant." }, "is_editable": { "type": "boolean", "description": "Si les dades provinents del registre encara es poden editar al flux allotjat o a la consola." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "Igual que el `registry_tier_delivered` de nivell superior." }, "registry_ownership_status": { "type": "string", "nullable": true, "enum": [ "not_requested", "delivered", "not_held", "unavailable" ], "description": "`delivered` quan s'han obtingut les dades de titularitat, `not_held` quan el registre de titularitat ha respost i no llista aquesta empresa (consulta `registry_data.ownership_error`), `unavailable` quan s'ha sol·licitat un nivell de titularitat però el registre no en tenia per a aquesta empresa o no s'ha pogut consultar (consulta `registry_data.ownership_error`), `not_requested` al nivell Lite." }, "ownership": { "$ref": "#/components/schemas/KYBRegistryOwnership" }, "registry_tier": { "type": "string", "nullable": true, "description": "El nivell de registre que ha sol·licitat el flux de treball: `basic`, `shareholders` o `ubo`. També a `ownership.tier_requested`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "El monitor de registre més recent per a l'empresa, o `null` quan no n'existeix cap.", "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": "Els camps de l'empresa que el monitor supervisa." } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò del `vendor_data` que has enviat." }, "metadata": { "type": "object", "nullable": true, "description": "Ressò de les `metadata` que has enviat." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved company": { "summary": "Perfil complet del registre (llista d'administradors truncada per brevetat)", "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ó s'ha mantingut pendent després del sondeig — camps dispersos, que s'emplenen automàticament al 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ó. Els problemes a nivell de camp utilitzen l'embolcall estàndard de DRF. Un país que els registres no cobreixen respon `400` amb `code: kyb_registry_country_unsupported`.", "content": { "application/json": { "examples": { "Missing kyb_response_id": { "summary": "`kyb_response_id` és obligatori", "value": { "kyb_response_id": [ "This field is required." ] } }, "save_api_request=false rejected": { "summary": "Les seleccions sempre es conserven", "value": { "save_api_request": [ "KYB registry select must be saved so billing and retrieval can be tracked." ] } }, "Country not covered": { "summary": "No hi ha cap registre mercantil per a aquest 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": "Permís denegat. Es retorna quan falta la capçalera `x-api-key`, i també quan el saldo de l'organització que fa la crida no pot cobrir la crida; una clau incorrecta, revocada o caducada retorna `401`. Si falta la clau es retorna `403` amb `{\"detail\": ...}`; una clau incorrecta, revocada o caducada retorna `401`. La manca de crèdit retorna `403` amb `{\"error\": ...}` abans que es produeixi cap cribratge o crida al proveïdor.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de l'organització no pot cobrir la crida", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Més de 300 sol·licituds d'escriptura en el minut 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": "Prova de vida passiva", "description": "Detecta atacs de presentació (fotos impreses, reproduccions en pantalla, màscares, deepfakes) a partir d'una única imatge facial. No requereix vídeo, moviment ni interacció de l'usuari.\n\n**Com funciona.** La imatge és analitzada per un model biomètric; s'avalua la cara detectada més gran i es calcula una `score` de prova de vida (0–100). L'estat `status` és `Declined` quan s'activa qualsevol advertència de gravetat `error`:\n- `NO_FACE_DETECTED`: el model de prova de vida no ha trobat cap cara,\n- `LOW_LIVENESS_SCORE`: puntuació igual o inferior a `face_liveness_score_decline_threshold` (per defecte `30`),\n- `LIVENESS_FACE_ATTACK`: el model ha detectat un atac de presentació,\n- `FACE_IN_BLOCKLIST` / `POSSIBLE_FACE_IN_BLOCKLIST`: la cara coincideix amb una entrada de la teva llista de bloqueig facial.\n\n`MULTIPLE_FACES_DETECTED` és un senyal de gravetat `warning` (no rebutja), i `DUPLICATED_FACE` / `POSSIBLE_DUPLICATED_FACE` són senyals de gravetat `information` que indiquen que la mateixa cara ja ha aparegut en una altra sessió aprovada (mai no rebutgen). `face_quality` i `face_luminance` (0–100, que pot ser nul) descriuen la qualitat de la captura.\n\n**Cribratge de llista de bloqueig i duplicats.** S'executa a **cada** crida (amb o sense `save_api_request`) comparant la cara detectada amb l'índex de cerca facial de la teva aplicació. Les cares prèvies amb el mateix `vendor_data` s'exclouen de tota la cerca a l'índex; per tant, tornar a executar la prova de vida per al mateix usuari no activa `DUPLICATED_FACE`, i una cara a la llista de bloqueig originada en una sessió amb el mateix `vendor_data` de qui fa la crida tampoc NO es marca (el cribratge `FACE_IN_BLOCKLIST` s'omet per a cares amb el mateix `vendor_data`).\n\n**Facturació.** Cada resposta `200` consumeix un crèdit de l'API de Passive Liveness (pagat des del crèdit del teu pla o del saldo de recàrrega). Un saldo insuficient retorna `403` abans de qualsevol processament de la imatge.\n\n**Persistència de sessions i registre facial (`save_api_request`, per defecte `true`).** Quan és `true`, la crida es persisteix com una sessió de tipus API (Business Console, `GET /v3/session/{sessionId}/decision/` mitjançant el `request_id` retornat, webhook `status.updated`), la imatge de referència i el retall de la cara s'emmagatzemen, i la cara detectada **es registra al teu índex de cerca facial** perquè les crides posteriors de Cerca facial i les comprovacions de duplicats hi puguin coincidir. Quan és `false`, la crida és d'un sol ús: no s'emmagatzema res i la cara no es registra (el cribratge de llista de bloqueig i duplicats se segueix executant).\n\n**Sandbox.** Les claus d'API de sandbox ometen tot el processament i la facturació: després de la validació de la sol·licitud (l'entrada mal formada continua retornant `400`), l'endpoint retorna un payload simulat estàtic `Approved`, no es persisteix cap sessió i no es consumeixen crèdits.\n\n**Autenticació.** Envia la clau d'API de la teva aplicació a la capçalera `x-api-key`. Unes credencials absents o no vàlides retornen `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); aquesta API mai no retorna `401`.\n\n**Límit de freqüència.** Pressupost d'escriptura compartit de 300 sol·licituds/min per clau d'API entre tots els endpoints POST/PATCH/DELETE; superar-lo retorna `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": "Imatge frontal del rostre (p. ex., una selfie). Extensions permeses: `tiff`, `jpg`, `jpeg`, `png`, `webp`. Mida màxima de càrrega: **5 MB** (els fitxers més grans es rebutgen amb `400`). Les imatges es comprimeixen automàticament a ~0.5 MB abans de processar-les, de manera que una resolució gaire alta no millora la precisió. La imatge ha de contenir un sol subjecte; si hi ha diverses cares presents, s'avalua la més gran i s'afegeix una advertència `MULTIPLE_FACES_DETECTED`." }, "face_liveness_score_decline_threshold": { "type": "number", "format": "float", "default": 30, "minimum": 0, "maximum": 100, "description": "Llindar de puntuació de prova de vida (0–100). Una puntuació calculada **igual o inferior** a aquest valor emet una advertència `LOW_LIVENESS_SCORE` i estableix `status` com a `Declined`. Per defecte és `30`; augmenta'l per a una postura antisuplantació més estricta. Els valors fora de 0–100 retornen `400`.", "example": 30 }, "rotate_image": { "type": "boolean", "default": false, "description": "Quan és `true`, el servei prova rotacions de 90 graus de l'entrada i utilitza l'orientació que ofereix la millor detecció facial. Útil quan falta l'orientació EXIF. Afegeix latència.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Quan és `true` (per defecte), manté la crida com una sessió de tipus API, emmagatzema les imatges de la cara, emet un webhook `status.updated` i inscriu la cara detectada al teu índex de cerca facial. Quan és `false`, la crida és d'un sol ús: no s'emmagatzema res i la cara no s'inscriu. El cribratge de llistes de bloqueig i duplicats s'executa en ambdós casos.", "example": true }, "vendor_data": { "type": "string", "description": "Identificador opac opcional (el teu ID d'usuari, correu electrònic, UUID…) desat a la sessió persistent i retornat a la resposta. També s'utilitza per excloure sessions anteriors amb el mateix `vendor_data` de la comprovació de cares duplicades, de manera que reverificar el mateix usuari no genera `DUPLICATED_FACE`.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objecte JSON opcional emmagatzemat amb la sessió (quan `save_api_request=true`) i retornat. En sol·licituds multipart, envia'l com a camp de cadena codificat en JSON; s'analitza com un objecte.", "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": "Prova de vida passiva completada. `liveness.score` és la confiança del model de 0 a 100 que la imatge mostra una persona viva; `status` és `Approved` tret que s'hagi activat una advertència de gravetat `error`. Una cara suplantada o a la llista de bloqueig continua retornant `200` — inspecciona `liveness.status` i `liveness.warnings`, no només el codi HTTP. Quan `save_api_request=true`, `request_id` és l'id de la sessió persistida.", "content": { "application/json": { "examples": { "Approved": { "summary": "Cara viva — sense advertències", "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 model ha detectat una suplantació (impressió, reproducció, 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": "Cara viva, però coincideix amb una entrada de la llista de bloqueig", "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 sessió persistida quan `save_api_request=true` (utilitzable amb `GET /v3/session/{sessionId}/decision/`); en cas contrari, un UUID de correlació transitori." }, "liveness": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Declined` quan s'ha activat almenys una advertència de gravetat `error` (cap cara, puntuació baixa, atac de presentació o coincidència amb la llista de bloqueig); `Approved` en cas contrari. Les entrades `warning`/`information` (múltiples cares, duplicats) mai no rebutgen per si soles." }, "method": { "type": "string", "enum": [ "PASSIVE" ], "description": "Sempre `PASSIVE` per a aquest endpoint." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Confiança de la prova de vida (0–100, dos decimals) que la imatge mostra una persona real i no pas una suplantació. `null` quan el model no ha retornat cap confiança.", "example": 95.0 }, "user_image": { "type": "object", "description": "Resultats de la detecció facial per a la imatge enviada.", "properties": { "entities": { "type": "array", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Quadre delimitador de la cara detectada com a coordenades de píxels `[x_min, y_min, x_max, y_max]` a la imatge processada.", "example": [ 661, 728, 1688, 2188 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Confiança de la detecció facial (0–1).", "example": 0.732973 }, "age": { "type": "number", "format": "float", "description": "Edat estimada pel model de la cara detectada, en anys. Només informativa: no afecta la decisió de prova de vida.", "example": 26.91 }, "gender": { "type": "string", "description": "Gènere predit pel model de la cara detectada (`male` o `female`). Només informatiu.", "example": "male" }, "race": { "type": "string", "nullable": true, "description": "Camp reservat: sempre `null` a les respostes d'aquest endpoint.", "example": null } } }, "description": "Una entrada per cara detectada. La cara més gran és la que s'avalua." }, "best_angle": { "type": "integer", "nullable": true, "description": "Rotació (graus) que ha produït la millor detecció facial; diferent de zero només quan `rotate_image=true` ha corregit l'orientació.", "example": 0 } } }, "warnings": { "type": "array", "description": "Senyals de risc. Gravetat `error` (rebutja): `NO_FACE_DETECTED`, `LOW_LIVENESS_SCORE` (puntuació igual o inferior al llindar), `LIVENESS_FACE_ATTACK`, `FACE_IN_BLOCKLIST`, `POSSIBLE_FACE_IN_BLOCKLIST`. Gravetat `warning` (revisió, no comporta un rebuig): `MULTIPLE_FACES_DETECTED`. Gravetat `information` (no comporta un rebuig): `DUPLICATED_FACE`, `POSSIBLE_DUPLICATED_FACE` — la mateixa cara ja ha aparegut en una altra sessió aprovada.", "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": "Codi de risc llegible per màquina." }, "feature": { "type": "string", "enum": [ "LIVENESS" ], "description": "Funcionalitat que ha generat l'advertència. Sempre `LIVENESS` en aquest endpoint." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "`null` per a la majoria d'advertències. Les coincidències amb la llista de bloqueig inclouen `{blocklisted_session_id, blocklisted_session_number, api_service}`; les coincidències per duplicat inclouen `{duplicated_session_id, duplicated_session_number, api_service}`, que apunten a la sessió coincident." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravetat. Les advertències `error` canvien `status` a `Declined`; les entrades `warning` i `information` són consultives i mai no rebutgen per si soles." }, "short_description": { "type": "string", "description": "Resum d'una sola línia del risc, llegible per a humans." }, "long_description": { "type": "string", "description": "Explicació fàcil de llegir del risc." } } } }, "face_quality": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Puntuació de qualitat de captura de la cara detectada, normalitzada de 0 a 100. `null` quan el model no ha pogut produir un valor fiable.", "example": 84.21 }, "face_luminance": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Brillantor de la cara detectada, normalitzada de 0 a 100. `null` quan no estigui disponible.", "example": 50.33 } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò de les `vendor_data` que has enviat, o `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ressò de l'objecte `metadata` que has enviat, o `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de temps ISO 8601 (UTC) de quan s'ha generat la resposta, p. ex. `2026-06-12T01:04:42.763237+00:00`." } } } } } }, "400": { "description": "Error de validació. Es retorna quan falta `user_image`, supera els 5 MB, té una extensió no admesa, falla la descodificació de la imatge al servidor o quan una opció està fora de rang. Els errors de camp utilitzen l'embolcall `{field: [messages]}` de DRF; els errors de descodificació d'imatge utilitzen `{\"error\": ...}`.", "content": { "application/json": { "examples": { "Missing image": { "summary": "`user_image` no s'ha inclòs a les dades del formulari", "value": { "user_image": [ "No file was submitted." ] } }, "Invalid image format": { "summary": "Extensió permesa però contingut de la imatge indescodificable", "value": { "error": "Invalid user image format.", "code": "invalid_image" } }, "Unsupported file extension": { "summary": "Extensió de fitxer no permesa (només 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": "La pujada supera el límit de 5 MB", "value": { "user_image": [ "File size should not exceed 5 MB" ] } } } } } }, "403": { "description": "Permís denegat. Es retorna quan falta la capçalera `x-api-key`, i també quan el saldo de l'organització que fa la crida no pot cobrir la crida; una clau incorrecta, revocada o caducada retorna `401`. Si falta la clau es retorna `403` amb `{\"detail\": ...}`; una clau incorrecta, revocada o caducada retorna `401`. La manca de crèdit retorna `403` amb `{\"error\": ...}` abans que es produeixi cap processament d'imatges.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de l'organització no pot cobrir la crida", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Més de 300 sol·licituds d'escriptura en el minut 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ó en bases de dades (independent)", "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 les dades d'identitat d'una persona amb fonts oficials del govern i dels registres: CPF al Brasil, RENAPER a l'Argentina, registres de DNI a Espanya i el Perú, INE a Mèxic i 100+ serveis addicionals en 60+ països.\n\n**Selecció de serveis.** Cada país exposa un o més serveis del catàleg identificats per un `service_id` (p. ex. `bra_cpf`, `arg_renaper`, `pan_cedula_sib`). Fixa els serveis que vulguis amb l'array `services`: si l'omets, s'executa exactament **un** servei per defecte (el servei en producció més consolidat per al país). Enviar `services` també canvia la resposta a l'estructura ampliada amb `services_used` i `match_score`. Descobreix serveis, els seus camps obligatoris i preus mitjançant `GET /v1/organization/database-validation-countries/` (un endpoint de catàleg no documentat en aquesta especificació) o l'editor de fluxos de treball de la Business Console. Alguns serveis tenen la marca `requires_consent=true` al catàleg i exigeixen `consent=true`; d'altres requereixen alta per a la teva organització abans de poder-los cridar.\n\n**Camps d'entrada.** `identification_number` és un camp universal que s'assigna automàticament al camp específic del país correcte (consulta'n la descripció). Les regles de format del país s'apliquen abans de cridar cap proveïdor (p. ex., el CPF de BRA ha de tenir exactament 11 xifres) i els errors de format no es facturen mai. Els serveis biomètrics necessiten la càrrega d'una `selfie` (només multipart); el RENAPER de l'Argentina requereix addicionalment `gender`.\n\n**Resultats.** Cada servei retorna un mapa de `validation` camp per camp més un `outcome_code` neutre respecte al proveïdor (`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`). Tingues en compte les distincions: `NO_MATCH` és una no coincidència definitiva, `INCONCLUSIVE` significa que el registre no ha pogut confirmar cap de les dues opcions (revisar, no rebutjar) i `BIOMETRIC_IMAGE_UNUSABLE` és un problema tècnic amb la selfie (cal repetir-la), a diferència del definitiu `BIOMETRIC_NO_MATCH`. El `match_type` global s'agrega entre serveis (qualsevol coincidència total → `full_match`, altrament qualsevol coincidència parcial → `partial_match`, altrament `no_match`) i `no_match_action`/`partial_match_action` el tradueixen a l'estat final (`status`). El `validation_type` és derivat: `two_by_two` quan dos o més serveis diferents han produït una coincidència total (sobre el número d'identificació, sobre el nom complet + data de naixement plegats, o sobre l'adreça sense contradiccions), altrament `one_by_one`.\n\n**Persistència.** `save_api_request` per defecte és **true**: el resultat s'emmagatzema com a sessió (`request_id` funciona amb `GET /v3/session/{sessionId}/decision/`), apareix a la consola i dispara un webhook `status.updated`. També controla l'estructura de `validations`: objectes per servei quan es desa, un mapa fusionat `{field: match}` quan no.\n\n**Facturació.** Per servei: a cada servei que retorna un resultat facturable se li cobra el seu propi preu de catàleg. Els serveis fallits o omesos no es facturen, i les sol·licituds rebutjades amb `400` no costen res. La comprovació prèvia de saldo cobreix la suma dels preus dels serveis seleccionats (`403` si és insuficient).\n\n**Errors.** Quan cap dels serveis seleccionats retorna un resultat utilitzable, l'API retorna `400` amb `validation_errors` si tots els intents sense resposta han rebutjat explícitament les dades d'entrada (`provider_rejected_input`, `retryable: false`). Corregeix les dades d'entrada abans de tornar-ho a provar. En cas contrari, retorna `502` amb `validation_errors` (`empty_provider_response`, `retryable: true`), inclosos els casos de rebuig d'entrades mixtes i intents de reserva no disponibles; no es factura res (es continua registrant una sessió amb estat `Not Finished` quan `save_api_request=true`). Quan només fallen alguns serveis, la resposta `200` inclou les seves fallades a `database_validation.errors`.\n\n**Sandbox.** Les claus d'aplicacions de sandbox ometen les crides als registres i la facturació, i retornen una resposta estàtica `full_match`; el payload de sandbox sempre inclou `services_used` i `match_score: 100` independentment de com s'hagi enviat `services`, de manera que no validis el condicionament de l'estructura ampliada en producció ni la fracció de 0.0–1.0 de `match_score` amb respostes del sandbox.\n\nEnvia la sol·licitud com a `application/json`, o com a `multipart/form-data` quan pugis una `selfie`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "issuing_state" ], "properties": { "issuing_state": { "type": "string", "description": "Codi de país ISO 3166-1 **alfa-3** del registre contra el qual s'ha de validar (p. ex. `BRA`, `ESP`, `COL`). Determina quins serveis estan disponibles. Els codis no admesos retornen `400` amb la llista completa d'opcions vàlides.", "example": "BRA" }, "services": { "type": "array", "items": { "type": "string" }, "description": "`service_id`s de catàleg que s'han d'executar per a aquest país (p. ex., `[\"bra_cpf\"]`). També accepta una sola cadena o una cadena separada per comes / codificada en JSON. **Si s'omet o és buit, s'executa exactament un servei per defecte** —el servei en producció més consolidat per al país; els serveis més nous, biomètrics i de pagament per ús s'han d'especificar explícitament. Enviar `services` canvia la resposta a l'estructura ampliada (afegeix `services_used` i `match_score`). Cada id ha d'existir i estar actiu per a l'`issuing_state`; els serveis que requereixen alta retornen `400` fins que s'activin per a la teva organització. Descobreix els serveis disponibles per país mitjançant `GET /v1/organization/database-validation-countries/` (un endpoint de catàleg no documentat en aquesta especificació) o l'editor de fluxos de treball de la Business Console.", "example": [ "bra_cpf" ] }, "validation_type": { "type": "string", "deprecated": true, "description": "OBSOLET. S'accepta per compatibilitat amb versions anteriors però s'ignora: el `validation_type` de la resposta ara es deriva de quants serveis han coincidit completament. Utilitza `services` per fixar serveis específics." }, "consent": { "type": "boolean", "default": false, "description": "Estableix-ho a `true` quan l'usuari final hagi donat el consentiment explícit als serveis de validació seleccionats. Requerit per als serveis marcats amb `requires_consent=true` al catàleg — sense ell, aquests serveis retornen `400` amb `services_requiring_consent`." }, "identification_number": { "type": "string", "description": "Número d'identificació universal — s'assigna automàticament al camp correcte específic de cada país, de manera que pots utilitzar-lo en lloc de `personal_number`/`tax_number`/`document_number`: ARG→document_number (DNI), BOL→document_number (CI), BRA→tax_number (CPF, 11 dígits), CHL→personal_number (RUT), COL→personal_number (Cédula), CRI→personal_number (Cédula), DOM→personal_number (Cédula, 11 dígits), ECU→personal_number (Cédula, 10 dígits), ESP→personal_number (DNI/NIE), GTM→document_number (DPI), HND→document_number (DNI), MEX→personal_number (CURP, 18 caràcters), PAN→personal_number (Cédula), PER→personal_number (DNI, 8 dígits), PRY→document_number (CI), SLV→document_number (DUI), URY→personal_number (CI), VEN→document_number (Cédula). Mai no sobreescriu un camp específic del país proporcionat de manera explícita." }, "first_name": { "type": "string", "description": "El nom de la persona física. Requerit per alguns serveis/països.", "example": "John" }, "last_name": { "type": "string", "description": "Els cognoms de la persona física. Requerits per alguns serveis/països.", "example": "Doe" }, "middle_name": { "type": "string", "description": "Segon nom, utilitzat per serveis d'alguns països (AUS, NZL, …)." }, "full_name": { "type": "string", "description": "Nom complet — alguns serveis l'accepten en lloc del nom/cognoms (p. ex., serveis de CHN, que fan coincidir el nom en el sistema d'escriptura natiu)." }, "date_of_birth": { "type": "string", "format": "date", "description": "Data de naixement, `YYYY-MM-DD`. Requerida per molts serveis.", "example": "1980-01-01" }, "personal_number": { "type": "string", "description": "Identificador personal únic emès pel govern. Fes servir: CHL (RUT), COL (Cédula), CRI, DOM, ECU, ESP (DNI/NIE), MEX (CURP), PAN (Cédula), PER (DNI), URY. Considera fer servir `identification_number` en el seu lloc." }, "tax_number": { "type": "string", "description": "Identificador fiscal. Utilitzat per: BRA (CPF, 11 dígits). Considera utilitzar `identification_number` en el seu lloc." }, "document_number": { "type": "string", "description": "Número de document. Utilitzat per: ARG (DNI), BOL (CI), GTM (DPI), HND (DNI), PRY (CI), SLV (DUI), VEN (Cédula). Considera utilitzar `identification_number` en el seu lloc." }, "document_type": { "type": "string", "enum": [ "P", "DL", "ID", "RP", "SSC", "HIC", "WP", "TC", "VISA", "PSC", "BC", "OTHER" ], "description": "Tipus de document que s'està validant: `P` passaport, `DL` permís de conduir, `ID` document nacional d'identitat, `RP` permís de residència (a més de `SSC`, `HIC`, `WP`, `TC`, `VISA`, `PSC`, `BC`, `OTHER`). Requerit per alguns serveis (p. ex., ESP)." }, "expiration_date": { "type": "string", "format": "date", "description": "Data de caducitat del document, `YYYY-MM-DD`. Obligatòria per a la validació d'ESP (Espanya).", "example": "2030-01-15" }, "date_of_issue": { "type": "string", "format": "date", "description": "Data d'emissió del document, `YYYY-MM-DD` (fecha de expedición). Obligatòria per a la validació de la cèdula de COL (Colòmbia).", "example": "2015-06-20" }, "nationality": { "type": "string", "description": "Nacionalitat en format ISO 3166-1 alpha-3. Requerida per alguns serveis." }, "gender": { "type": "string", "enum": [ "M", "F", "X" ], "description": "Gènere: `M`, `F` o `X` (altre/desconegut). Obligatori per a la validació de RENAPER de l'Argentina (`arg_renaper`)." }, "address": { "description": "Adreça de residència. Es recomana l'objecte estructurat `{\"street_1\":\"123 Main St\",\"street_2\":\"Apt 4B\",\"city\":\"Springfield\",\"region\":\"IL\",\"postal_code\":\"62701\",\"country\":\"US\"}`; encara s'accepta una cadena completa d'una sola línia. Obligatori per als serveis de verificació d'adreça; quan un servei defineix requisits d'adreça, les parts que faltin retornen `400` amb `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": "Adreça completa en una sola línia (llegat)." } ] }, "address_element_1": { "type": "string", "description": "Adreça que inclou el carrer, el número i el tipus de via. Si s'omet, es dedueix de `address`." }, "address_element_2": { "type": "string", "description": "Apartament, unitat, edifici, planta o línia d'adreça addicional. Envia-ho només quan ho tinguis explícitament." }, "address_element_3": { "type": "string", "description": "Ciutat, suburbi, districte, localitat o barri. Si s'omet, es deriva d'`address`." }, "address_element_4": { "type": "string", "description": "Estat, província, regió o població. Si s'omet, es deriva d'`address`." }, "address_element_5": { "type": "string", "description": "Codi postal. S'accepta `postal_code` com a àlies." }, "postal_code": { "type": "string", "description": "Codi postal per a serveis basats en adreça (àlies de `address_element_5`)." }, "driver_license_number": { "type": "string", "description": "Número del permís de conduir per a serveis governamentals de verificació de documents (AUS, NZL, IND)." }, "driver_license_card_number": { "type": "string", "description": "Número de la targeta física del permís de conduir, quan es requereix per separat del número de permís (AUS)." }, "driver_license_state": { "type": "string", "description": "Estat o territori d'emissió del permís de conduir (AUS)." }, "driver_license_version": { "type": "string", "description": "Codi de versió del permís de conduir (NZL)." }, "passport_number": { "type": "string", "description": "Número de passaport per als serveis governamentals de verificació de passaports (AUS, NZL, IND, CHN)." }, "passport_expiration_date": { "type": "string", "format": "date", "description": "Data de caducitat del passaport, `YYYY-MM-DD`, per als serveis de verificació de passaports." }, "passport_file_number": { "type": "string", "description": "Número de fitxer del passaport (IND)." }, "passport_issue_country": { "type": "string", "description": "País emissor del passaport (ISO 3166-1 alfa-3) per a serveis de verificació de passaport." }, "medicare_card_number": { "type": "string", "description": "Número de targeta Medicare (AUS)." }, "immi_card_number": { "type": "string", "description": "Número de la ImmiCard australiana." }, "immi_card_expiry_date": { "type": "string", "format": "date", "description": "Data de caducitat de la ImmiCard australiana." }, "citizenship_certificate_number": { "type": "string", "description": "Número de certificat de ciutadania (AUS)." }, "birth_registration_number": { "type": "string", "description": "Número de registre del certificat de naixement (AUS)." }, "birth_registration_date": { "type": "string", "format": "date", "description": "Data de registre del certificat de naixement (AUS)." }, "birth_registration_state": { "type": "string", "description": "Estat de registre del certificat de naixement (AUS)." }, "marriage_certificate_number": { "type": "string", "description": "Número del certificat de matrimoni (AUS)." }, "change_of_name_certificate_number": { "type": "string", "description": "Número del certificat de canvi de nom (AUS)." }, "first_partner_name": { "type": "string", "description": "Nom de pila del cònjuge en un certificat de matrimoni (AUS)." }, "last_partner_name": { "type": "string", "description": "Cognom del cònjuge en un certificat de matrimoni (AUS)." }, "voter_id": { "type": "string", "description": "Número d'inscripció electoral (IND EPIC, IRL)." }, "epic_card": { "type": "string", "description": "Número de la targeta d'elector EPIC de l'Índia." }, "pan": { "type": "string", "description": "PAN (Permanent Account Number) de l'Índia." }, "national_id": { "type": "string", "description": "Número d'identificació nacional (CHN, MYS, KEN, KHM, NGA, ZAF, …)." }, "cic": { "type": "string", "description": "Codi d'identificació de credencial (CIC) de l'INE/IFE mexicà, 9 dígits. S'utilitza pel servei de validesa de credencials MEX INE (`mex_ine_vigencia`)." }, "identificador_ciudadano": { "type": "string", "description": "Identificador de ciutadà de l'INE mexicà (9 dígits). S'utilitza amb `cic` per a models moderns de l'INE (E/F/G/H) a `mex_ine_vigencia`." }, "ocr": { "type": "string", "description": "Número OCR de l'INE mexicà (13 dígits, dors de la targeta). S'utilitza amb `cic` per al Model D a `mex_ine_vigencia`." }, "voter_number": { "type": "string", "description": "Clau d'elector de l'INE mexicà (18 caràcters). S'utilitza amb `emission_number` per a models antics de l'IFE (A/B/C) a `mex_ine_vigencia`." }, "emission_number": { "type": "string", "description": "Número d'emissió de l'INE mexicà. S'utilitza amb `voter_number` per a models antics de l'IFE (A/B/C) a `mex_ine_vigencia`." }, "bvn": { "type": "string", "description": "Número de verificació bancària de Nigèria." }, "bank_card_number": { "type": "string", "description": "Número de targeta bancària (verificació de targeta bancària CHN)." }, "company_registration_number": { "type": "string", "description": "Número de registre de l'empresa tal com l'emet el registre mercantil: el CNPJ al Brasil (p. ex., `11222333000181`), el número de registre a Sud-àfrica (p. ex., `1936/007721/06`). Requerit pels serveis de registre mercantil i administradors d'empreses (`bra_company_registry`, `bra_company_directors`, `zaf_company_registry`, `zaf_company_directors`)." }, "company_name": { "type": "string", "description": "Nom de l'empresa registrada, confrontat amb l'entrada del registre. Opcional per a `zaf_company_registry`." }, "initials": { "type": "string", "description": "Les inicials de la persona tal com apareixen impreses al document. Requerides per `zaf_drivers_license`; acceptades per `zaf_bank_account_holder`." }, "licence_number": { "type": "string", "description": "Número del permís de conduir tal com apareix imprès a la targeta, per a `zaf_drivers_license`. Quan s'omet, s'utilitza `document_number`." }, "refugee_file_number": { "type": "string", "description": "Número d'expedient de refugiat emès pel Department of Home Affairs de Sud-àfrica. Requerit per a `zaf_refugee`." }, "bank_name": { "type": "string", "description": "Nom del banc titular del compte. Requerit per `zaf_bank_account_holder`." }, "bank_account_number": { "type": "string", "description": "Número de compte bancari. Obligatori per a `zaf_bank_account_holder`; admès per `zaf_fraud_prevention`." }, "account_type": { "type": "string", "description": "Tipus de compte bancari per a `zaf_bank_account_holder`: `current`, `savings`, `transmission`, `subscriptionShare` o `notKnown`, sense distingir majúscules i minúscules. Qualsevol altre valor retorna `400`. Omet-lo si no en saps el tipus: la comprovació creuada del tipus de compte s'informa llavors com a no confirmada." }, "phone_number": { "type": "string", "description": "Número de telèfon mòbil de contacte, per als serveis que verifiquen de forma creuada la contactabilitat (`zaf_bank_account_holder`, `zaf_fraud_prevention`, `zaf_refugee`)." }, "right_thumb": { "type": "string", "description": "Empremta dactilar del polze dret codificada en base64 per a `zaf_dha_fingerprint_match`, juntament amb `left_thumb` o sola." }, "left_thumb": { "type": "string", "description": "Empremta dactilar del polze esquerre codificada en base64 per a `zaf_dha_fingerprint_match`, juntament amb `right_thumb` o sola." }, "score_level": { "type": "integer", "description": "Nivell mínim de puntuació biomètrica per a `zaf_criminal_face_screening`. Per defecte és `3`." }, "max_matches": { "type": "integer", "description": "Nombre màxim de coincidències candidates que retorna `zaf_criminal_face_screening`. Per defecte és `1`." }, "vehicle_register_number": { "type": "string", "description": "Número de registre del vehicle. Obligatori, juntament amb `vehicle_licence_plate` i `vin`, per a `zaf_vehicle_ownership`." }, "vehicle_licence_plate": { "type": "string", "description": "Número de matrícula del vehicle. Obligatori, juntament amb `vehicle_register_number` i `vin`, per a `zaf_vehicle_ownership`." }, "vin": { "type": "string", "description": "Número d'identificació del vehicle (VIN o número de bastidor). Obligatori, juntament amb `vehicle_register_number` i `vehicle_licence_plate`, per a `zaf_vehicle_ownership`." }, "ssn": { "type": "string", "description": "Número de la Seguretat Social (EUA)." }, "phone": { "type": "string", "description": "Número de telèfon per als serveis de verificació de telèfon." }, "landline": { "type": "string", "description": "Número de telèfon fix per als serveis de verificació de telèfon." }, "email": { "type": "string", "format": "email", "description": "Adreça de correu electrònic per als serveis de verificació d'identitat." }, "country_of_residence": { "type": "string", "description": "País de residència ISO 3166-1 alpha-2. Utilitzat pels serveis globals d'enriquiment d'identitat (p. ex., `glb_identity_enrichment`) per centrar la cerca.", "example": "US" }, "partial_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "NO_ACTION", "description": "Quin efecte té un `partial_match` en `database_validation.status`. Per defecte és `NO_ACTION` (l'estat es manté en `Approved`, amb una advertència)." }, "no_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Quin efecte té un `no_match` en `database_validation.status`. Per defecte és `DECLINE`." }, "save_api_request": { "type": "boolean", "default": true, "description": "Persisteix la validació com una sessió (visibilitat a la consola, endpoint de decisió, webhook `status.updated`). També canvia l'estructura de resposta de `validations`: objectes per servei quan és `true` (per defecte), un mapa de camps fusionat quan és `false`." }, "vendor_data": { "type": "string", "description": "El teu identificador per a l'usuari validat; es retorna tal com s'ha enviat i s'emmagatzema amb la sessió." }, "metadata": { "type": "object", "nullable": true, "description": "JSON de format lliure emmagatzemat amb la sol·licitud i retornat com a resposta." } } }, "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": "Codi de país ISO 3166-1 **alfa-3** del registre contra el qual s'ha de validar (p. ex. `BRA`, `ESP`, `COL`). Determina quins serveis estan disponibles. Els codis no admesos retornen `400` amb la llista completa d'opcions vàlides.", "example": "BRA" }, "services": { "type": "array", "items": { "type": "string" }, "description": "`service_id`s de catàleg que s'han d'executar per a aquest país (p. ex., `[\"bra_cpf\"]`). També accepta una sola cadena o una cadena separada per comes / codificada en JSON. **Si s'omet o és buit, s'executa exactament un servei per defecte** —el servei en producció més consolidat per al país; els serveis més nous, biomètrics i de pagament per ús s'han d'especificar explícitament. Enviar `services` canvia la resposta a l'estructura ampliada (afegeix `services_used` i `match_score`). Cada id ha d'existir i estar actiu per a l'`issuing_state`; els serveis que requereixen alta retornen `400` fins que s'activin per a la teva organització. Descobreix els serveis disponibles per país mitjançant `GET /v1/organization/database-validation-countries/` (un endpoint de catàleg no documentat en aquesta especificació) o l'editor de fluxos de treball de la Business Console.", "example": [ "bra_cpf" ] }, "validation_type": { "type": "string", "deprecated": true, "description": "OBSOLET. S'accepta per compatibilitat amb versions anteriors però s'ignora: el `validation_type` de la resposta ara es deriva de quants serveis han coincidit completament. Utilitza `services` per fixar serveis específics." }, "consent": { "type": "boolean", "default": false, "description": "Estableix-ho a `true` quan l'usuari final hagi donat el consentiment explícit als serveis de validació seleccionats. Requerit per als serveis marcats amb `requires_consent=true` al catàleg — sense ell, aquests serveis retornen `400` amb `services_requiring_consent`." }, "identification_number": { "type": "string", "description": "Número d'identificació universal — s'assigna automàticament al camp correcte específic de cada país, de manera que pots utilitzar-lo en lloc de `personal_number`/`tax_number`/`document_number`: ARG→document_number (DNI), BOL→document_number (CI), BRA→tax_number (CPF, 11 dígits), CHL→personal_number (RUT), COL→personal_number (Cédula), CRI→personal_number (Cédula), DOM→personal_number (Cédula, 11 dígits), ECU→personal_number (Cédula, 10 dígits), ESP→personal_number (DNI/NIE), GTM→document_number (DPI), HND→document_number (DNI), MEX→personal_number (CURP, 18 caràcters), PAN→personal_number (Cédula), PER→personal_number (DNI, 8 dígits), PRY→document_number (CI), SLV→document_number (DUI), URY→personal_number (CI), VEN→document_number (Cédula). Mai no sobreescriu un camp específic del país proporcionat de manera explícita." }, "first_name": { "type": "string", "description": "El nom de la persona física. Requerit per alguns serveis/països.", "example": "John" }, "last_name": { "type": "string", "description": "Els cognoms de la persona física. Requerits per alguns serveis/països.", "example": "Doe" }, "middle_name": { "type": "string", "description": "Segon nom, utilitzat per serveis d'alguns països (AUS, NZL, …)." }, "full_name": { "type": "string", "description": "Nom complet — alguns serveis l'accepten en lloc del nom/cognoms (p. ex., serveis de CHN, que fan coincidir el nom en el sistema d'escriptura natiu)." }, "date_of_birth": { "type": "string", "format": "date", "description": "Data de naixement, `YYYY-MM-DD`. Requerida per molts serveis.", "example": "1980-01-01" }, "personal_number": { "type": "string", "description": "Identificador personal únic emès pel govern. Fes servir: CHL (RUT), COL (Cédula), CRI, DOM, ECU, ESP (DNI/NIE), MEX (CURP), PAN (Cédula), PER (DNI), URY. Considera fer servir `identification_number` en el seu lloc." }, "tax_number": { "type": "string", "description": "Identificador fiscal. Utilitzat per: BRA (CPF, 11 dígits). Considera utilitzar `identification_number` en el seu lloc." }, "document_number": { "type": "string", "description": "Número de document. Utilitzat per: ARG (DNI), BOL (CI), GTM (DPI), HND (DNI), PRY (CI), SLV (DUI), VEN (Cédula). Considera utilitzar `identification_number` en el seu lloc." }, "document_type": { "type": "string", "enum": [ "P", "DL", "ID", "RP", "SSC", "HIC", "WP", "TC", "VISA", "PSC", "BC", "OTHER" ], "description": "Tipus de document que s'està validant: `P` passaport, `DL` permís de conduir, `ID` document nacional d'identitat, `RP` permís de residència (a més de `SSC`, `HIC`, `WP`, `TC`, `VISA`, `PSC`, `BC`, `OTHER`). Requerit per alguns serveis (p. ex., ESP)." }, "expiration_date": { "type": "string", "format": "date", "description": "Data de caducitat del document, `YYYY-MM-DD`. Obligatòria per a la validació d'ESP (Espanya).", "example": "2030-01-15" }, "date_of_issue": { "type": "string", "format": "date", "description": "Data d'emissió del document, `YYYY-MM-DD` (fecha de expedición). Obligatòria per a la validació de la cèdula de COL (Colòmbia).", "example": "2015-06-20" }, "nationality": { "type": "string", "description": "Nacionalitat en format ISO 3166-1 alpha-3. Requerida per alguns serveis." }, "gender": { "type": "string", "enum": [ "M", "F", "X" ], "description": "Gènere: `M`, `F` o `X` (altre/desconegut). Obligatori per a la validació de RENAPER de l'Argentina (`arg_renaper`)." }, "address": { "description": "Adreça de residència. Es recomana l'objecte estructurat `{\"street_1\":\"123 Main St\",\"street_2\":\"Apt 4B\",\"city\":\"Springfield\",\"region\":\"IL\",\"postal_code\":\"62701\",\"country\":\"US\"}`; encara s'accepta una cadena completa d'una sola línia. Obligatori per als serveis de verificació d'adreça; quan un servei defineix requisits d'adreça, les parts que faltin retornen `400` amb `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": "Adreça completa en una sola línia (llegat)." } ] }, "address_element_1": { "type": "string", "description": "Adreça que inclou el carrer, el número i el tipus de via. Si s'omet, es dedueix de `address`." }, "address_element_2": { "type": "string", "description": "Apartament, unitat, edifici, planta o línia d'adreça addicional. Envia-ho només quan ho tinguis explícitament." }, "address_element_3": { "type": "string", "description": "Ciutat, suburbi, districte, localitat o barri. Si s'omet, es deriva d'`address`." }, "address_element_4": { "type": "string", "description": "Estat, província, regió o població. Si s'omet, es deriva d'`address`." }, "address_element_5": { "type": "string", "description": "Codi postal. S'accepta `postal_code` com a àlies." }, "postal_code": { "type": "string", "description": "Codi postal per a serveis basats en adreça (àlies de `address_element_5`)." }, "driver_license_number": { "type": "string", "description": "Número del permís de conduir per a serveis governamentals de verificació de documents (AUS, NZL, IND)." }, "driver_license_card_number": { "type": "string", "description": "Número de la targeta física del permís de conduir, quan es requereix per separat del número de permís (AUS)." }, "driver_license_state": { "type": "string", "description": "Estat o territori d'emissió del permís de conduir (AUS)." }, "driver_license_version": { "type": "string", "description": "Codi de versió del permís de conduir (NZL)." }, "passport_number": { "type": "string", "description": "Número de passaport per als serveis governamentals de verificació de passaports (AUS, NZL, IND, CHN)." }, "passport_expiration_date": { "type": "string", "format": "date", "description": "Data de caducitat del passaport, `YYYY-MM-DD`, per als serveis de verificació de passaports." }, "passport_file_number": { "type": "string", "description": "Número de fitxer del passaport (IND)." }, "passport_issue_country": { "type": "string", "description": "País emissor del passaport (ISO 3166-1 alfa-3) per a serveis de verificació de passaport." }, "medicare_card_number": { "type": "string", "description": "Número de targeta Medicare (AUS)." }, "immi_card_number": { "type": "string", "description": "Número de la ImmiCard australiana." }, "immi_card_expiry_date": { "type": "string", "format": "date", "description": "Data de caducitat de la ImmiCard australiana." }, "citizenship_certificate_number": { "type": "string", "description": "Número de certificat de ciutadania (AUS)." }, "birth_registration_number": { "type": "string", "description": "Número de registre del certificat de naixement (AUS)." }, "birth_registration_date": { "type": "string", "format": "date", "description": "Data de registre del certificat de naixement (AUS)." }, "birth_registration_state": { "type": "string", "description": "Estat de registre del certificat de naixement (AUS)." }, "marriage_certificate_number": { "type": "string", "description": "Número del certificat de matrimoni (AUS)." }, "change_of_name_certificate_number": { "type": "string", "description": "Número del certificat de canvi de nom (AUS)." }, "first_partner_name": { "type": "string", "description": "Nom de pila del cònjuge en un certificat de matrimoni (AUS)." }, "last_partner_name": { "type": "string", "description": "Cognom del cònjuge en un certificat de matrimoni (AUS)." }, "voter_id": { "type": "string", "description": "Número d'inscripció electoral (IND EPIC, IRL)." }, "epic_card": { "type": "string", "description": "Número de la targeta d'elector EPIC de l'Índia." }, "pan": { "type": "string", "description": "PAN (Permanent Account Number) de l'Índia." }, "national_id": { "type": "string", "description": "Número d'identificació nacional (CHN, MYS, KEN, KHM, NGA, ZAF, …)." }, "cic": { "type": "string", "description": "Codi d'identificació de credencial (CIC) de l'INE/IFE mexicà, 9 dígits. S'utilitza pel servei de validesa de credencials MEX INE (`mex_ine_vigencia`)." }, "identificador_ciudadano": { "type": "string", "description": "Identificador de ciutadà de l'INE mexicà (9 dígits). S'utilitza amb `cic` per a models moderns de l'INE (E/F/G/H) a `mex_ine_vigencia`." }, "ocr": { "type": "string", "description": "Número OCR de l'INE mexicà (13 dígits, dors de la targeta). S'utilitza amb `cic` per al Model D a `mex_ine_vigencia`." }, "voter_number": { "type": "string", "description": "Clau d'elector de l'INE mexicà (18 caràcters). S'utilitza amb `emission_number` per a models antics de l'IFE (A/B/C) a `mex_ine_vigencia`." }, "emission_number": { "type": "string", "description": "Número d'emissió de l'INE mexicà. S'utilitza amb `voter_number` per a models antics de l'IFE (A/B/C) a `mex_ine_vigencia`." }, "bvn": { "type": "string", "description": "Número de verificació bancària de Nigèria." }, "bank_card_number": { "type": "string", "description": "Número de targeta bancària (verificació de targeta bancària CHN)." }, "company_registration_number": { "type": "string", "description": "Número de registre de l'empresa tal com l'emet el registre mercantil: el CNPJ al Brasil (p. ex., `11222333000181`), el número de registre a Sud-àfrica (p. ex., `1936/007721/06`). Requerit pels serveis de registre mercantil i administradors d'empreses (`bra_company_registry`, `bra_company_directors`, `zaf_company_registry`, `zaf_company_directors`)." }, "company_name": { "type": "string", "description": "Nom de l'empresa registrada, confrontat amb l'entrada del registre. Opcional per a `zaf_company_registry`." }, "initials": { "type": "string", "description": "Les inicials de la persona tal com apareixen impreses al document. Requerides per `zaf_drivers_license`; acceptades per `zaf_bank_account_holder`." }, "licence_number": { "type": "string", "description": "Número del permís de conduir tal com apareix imprès a la targeta, per a `zaf_drivers_license`. Quan s'omet, s'utilitza `document_number`." }, "refugee_file_number": { "type": "string", "description": "Número d'expedient de refugiat emès pel Department of Home Affairs de Sud-àfrica. Requerit per a `zaf_refugee`." }, "bank_name": { "type": "string", "description": "Nom del banc titular del compte. Requerit per `zaf_bank_account_holder`." }, "bank_account_number": { "type": "string", "description": "Número de compte bancari. Obligatori per a `zaf_bank_account_holder`; admès per `zaf_fraud_prevention`." }, "account_type": { "type": "string", "description": "Tipus de compte bancari per a `zaf_bank_account_holder`: `current`, `savings`, `transmission`, `subscriptionShare` o `notKnown`, sense distingir majúscules i minúscules. Qualsevol altre valor retorna `400`. Omet-lo si no en saps el tipus: la comprovació creuada del tipus de compte s'informa llavors com a no confirmada." }, "phone_number": { "type": "string", "description": "Número de telèfon mòbil de contacte, per als serveis que verifiquen de forma creuada la contactabilitat (`zaf_bank_account_holder`, `zaf_fraud_prevention`, `zaf_refugee`)." }, "right_thumb": { "type": "string", "description": "Empremta dactilar del polze dret codificada en base64 per a `zaf_dha_fingerprint_match`, juntament amb `left_thumb` o sola." }, "left_thumb": { "type": "string", "description": "Empremta dactilar del polze esquerre codificada en base64 per a `zaf_dha_fingerprint_match`, juntament amb `right_thumb` o sola." }, "score_level": { "type": "integer", "description": "Nivell mínim de puntuació biomètrica per a `zaf_criminal_face_screening`. Per defecte és `3`." }, "max_matches": { "type": "integer", "description": "Nombre màxim de coincidències candidates que retorna `zaf_criminal_face_screening`. Per defecte és `1`." }, "vehicle_register_number": { "type": "string", "description": "Número de registre del vehicle. Obligatori, juntament amb `vehicle_licence_plate` i `vin`, per a `zaf_vehicle_ownership`." }, "vehicle_licence_plate": { "type": "string", "description": "Número de matrícula del vehicle. Obligatori, juntament amb `vehicle_register_number` i `vin`, per a `zaf_vehicle_ownership`." }, "vin": { "type": "string", "description": "Número d'identificació del vehicle (VIN o número de bastidor). Obligatori, juntament amb `vehicle_register_number` i `vehicle_licence_plate`, per a `zaf_vehicle_ownership`." }, "ssn": { "type": "string", "description": "Número de la Seguretat Social (EUA)." }, "phone": { "type": "string", "description": "Número de telèfon per als serveis de verificació de telèfon." }, "landline": { "type": "string", "description": "Número de telèfon fix per als serveis de verificació de telèfon." }, "email": { "type": "string", "format": "email", "description": "Adreça de correu electrònic per als serveis de verificació d'identitat." }, "country_of_residence": { "type": "string", "description": "País de residència ISO 3166-1 alpha-2. Utilitzat pels serveis globals d'enriquiment d'identitat (p. ex., `glb_identity_enrichment`) per centrar la cerca.", "example": "US" }, "partial_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "NO_ACTION", "description": "Quin efecte té un `partial_match` en `database_validation.status`. Per defecte és `NO_ACTION` (l'estat es manté en `Approved`, amb una advertència)." }, "no_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Quin efecte té un `no_match` en `database_validation.status`. Per defecte és `DECLINE`." }, "save_api_request": { "type": "boolean", "default": true, "description": "Persisteix la validació com una sessió (visibilitat a la consola, endpoint de decisió, webhook `status.updated`). També canvia l'estructura de resposta de `validations`: objectes per servei quan és `true` (per defecte), un mapa de camps fusionat quan és `false`." }, "vendor_data": { "type": "string", "description": "El teu identificador per a l'usuari validat; es retorna tal com s'ha enviat i s'emmagatzema amb la sessió." }, "metadata": { "type": "object", "nullable": true, "description": "JSON de format lliure emmagatzemat amb la sol·licitud i retornat com a resposta." }, "selfie": { "type": "string", "format": "binary", "description": "Imatge de la selfie (`jpg`, `jpeg`, `png`, `webp`; màx. 2 MB — les imatges es comprimeixen a ~1.5 MB abans de pujar-se al registre) per a serveis de validació biomètrica, p. ex. RENAPER de l'Argentina (`arg_renaper`) i SIB de Panamà (`pan_cedula_sib`, `pan_cedula_sib_plus`). Obligatòria sempre que un servei seleccionat la llisti com a camp obligatori. Només disponible mitjançant `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ó completada — almenys un dels serveis seleccionats ha retornat un resultat utilitzable. Inspecciona `database_validation.match_type` per al resultat agregat, `validations` per a les comparacions de camps per servei i els `outcome_code`s, i `errors` (quan n'hi hagi) per als serveis que hagin fallat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de sessió persistida quan `save_api_request=true` (utilitzable amb `GET /v3/session/{sessionId}/decision/`); en cas contrari, un UUID de correlació transitori." }, "database_validation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "`Declined` quan el `match_type` global activa una acció `DECLINE` (`no_match_action` té per defecte `DECLINE`, i `partial_match_action` té per defecte `NO_ACTION`); `In Review` quan cap servei ha produït una comparació utilitzable, per exemple quan l'únic servei seleccionat ha retornat `REGISTRY_UNAVAILABLE` o `INCONCLUSIVE`; `Approved` en cas contrari. Una sol·licitud que ha seleccionat diversos serveis pot resultar `Approved` per la coincidència d'un servei mentre un altre no estava disponible, de manera que cal comprovar també `errors` i els `outcome_code` de cada servei." }, "issuing_state": { "type": "string", "description": "Ressò del país ISO 3166-1 alpha-3 contra el qual s'ha validat.", "example": "BRA" }, "validation_type": { "type": "string", "enum": [ "one_by_one", "two_by_two" ], "description": "Deduït a partir dels resultats: `two_by_two` quan ≥2 serveis diferents han produït una coincidència completa (en el número d'identificació, en el nom complet + data de naixement plegats, o en l'adreça sense contradiccions); `one_by_one` en cas contrari. (El camp de la sol·licitud amb el mateix nom està obsolet i s'ignora.)" }, "screened_data": { "type": "object", "description": "Ressò dels camps d'entrada enviats als serveis seleccionats (dates normalitzades a `YYYY-MM-DD`; si s'envia una `selfie`, es retorna com a URL presignada; s'afegeix `consent_obtained: true` quan s'ha obtingut el consentiment)." }, "match_type": { "type": "string", "nullable": true, "enum": [ "full_match", "partial_match", "no_match" ], "description": "Resultat global agregat entre serveis amb comparacions a nivell de camp: qualsevol `full_match` → `full_match`; altrament, qualsevol `partial_match` → `partial_match`; altrament, `no_match`. Els serveis només de resultat, com ara el cribratge penal biomètric, poden retornar `null`; inspecciona cada element a `validations` per veure el seu `outcome_code`." }, "validations": { "description": "L'estructura depèn de `save_api_request`. **`true` (per defecte):** una matriu d'objectes per servei (`service_id`, `service_name`, `validation`, `outcome_code`, `outcome_detail`, `source_data`). **`false`:** un únic objecte pla que fusiona els resultats a nivell de camp de tots els serveis (`{\"full_name\": \"full_match\", ...}`).", "oneOf": [ { "type": "array", "items": { "type": "object", "description": "Resultat de validació per servei (es retorna quan `save_api_request=true`, el valor per defecte).", "properties": { "service_id": { "type": "string", "description": "Identificador de catàleg del servei que ha generat aquest resultat (p. ex., `bra_cpf`).", "example": "bra_cpf" }, "service_name": { "type": "string", "description": "Nom de catàleg del servei fàcil de llegir.", "example": "Brazil - CPF status check" }, "validation": { "type": "object", "description": "Comparació camp per camp entre les teves dades d'entrada i el registre oficial. Les claus són noms canònics de camp (`full_name`, `date_of_birth`, `identification_number`, `address`, …); els valors són `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": "Resultat independent del proveïdor de la consulta al registre. `MATCH`/`PARTIAL_MATCH`/`NO_MATCH` descriuen la comparació; `DOCUMENT_NOT_FOUND` significa que l'identificador no és al registre; `INCONCLUSIVE` significa que el registre no ha pogut confirmar cap de les dues opcions (s'envia a revisió manual, NO és una no coincidència); `BIOMETRIC_NO_MATCH` és una no coincidència facial definitiva, mentre que `BIOMETRIC_IMAGE_UNUSABLE` és un problema tècnic de la imatge (torna a fer la selfie); `DECEASED`/`MINOR_BLOCKED` són resultats per polítiques del registre; `DOCUMENT_SUPERSEDED` significa que la identitat coincideix però l'edició del document presentat no és la que figura en els arxius (s'ha emès una edició més nova); `INVALID_DOCUMENT_FORMAT`/`INVALID_INPUT` signifiquen que el registre mateix ha rebutjat les dades enviades; `REGISTRY_UNAVAILABLE`/`REGISTRY_ERROR` indiquen fallades dels sistemes anteriors." }, "outcome_detail": { "type": "string", "nullable": true, "description": "Detall de l'estat d'origen en brut que fonamenta el codi de resultat (p. ex., un codi d'estat HTTP o del registre)." }, "source_data": { "type": "object", "nullable": true, "description": "Vista neta i normalitzada del registre mitjançant noms de camp canònics (`identification_number`, `first_name`, `last_name`, `date_of_birth`, a més d'indicadors específics del registre). Els camps d'imatge, quan estan presents, es retornen com a URL signades prèviament." } } } }, { "type": "object", "additionalProperties": { "type": "string", "enum": [ "full_match", "partial_match", "no_match" ] }, "description": "Resultats fusionats a nivell de camp (format sense estat `save_api_request=false`)." } ] }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Funcionalitat que ha generat l'advertència." }, "risk": { "type": "string", "description": "Identificador de risc llegible per màquina." }, "additional_data": { "type": "object", "nullable": true, "description": "Context addicional per a l'advertència, quan estigui disponible." }, "log_type": { "type": "string", "description": "`warning`, `information` o `error` — com ha afectat el risc el resultat." }, "short_description": { "type": "string", "description": "Resum d'una línia llegible per humans." }, "long_description": { "type": "string", "description": "Explicació completa comprensible per a persones." } } }, "description": "`DATABASE_VALIDATION_NO_MATCH` o `DATABASE_VALIDATION_PARTIAL_MATCH` quan correspongui; buit en cas de coincidència total." }, "errors": { "type": "array", "description": "Present només quan alguns serveis seleccionats (però no tots) han fallat. Cada entrada conté `service_id`, `code`, `message` i `retryable`. Un servei informat aquí no apareix a `validations` ni a `services_used`, i no es factura. Aquesta matriu és l'únic lloc on apareix, de manera que revisa-la fins i tot quan `status` sigui `Approved`.", "items": { "type": "object", "properties": { "service_id": { "type": "string" }, "code": { "type": "string", "example": "empty_provider_response" }, "message": { "type": "string" }, "retryable": { "type": "boolean", "description": "`true` quan el servei no ha donat cap resposta i reintentar-ho més tard pot ser satisfactori; `false` quan la font ha rebutjat les dades que se li han enviat i cal corregir l'entrada primer.", "example": true } } } }, "services_used": { "type": "array", "items": { "type": "string" }, "description": "Identificadors de catàleg dels serveis que han retornat un resultat facturable. **Només present quan la sol·licitud ha enviat explícitament `services`.**" }, "match_score": { "type": "number", "description": "Fracció (0.0–1.0) de serveis intentats que han produït una coincidència total (en el número d'identificació, en el nom complet + data de naixement plegats, o en l'adreça sense contradiccions). **Només present quan la sol·licitud ha enviat explícitament `services`.**" } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò del `vendor_data` que has enviat." }, "metadata": { "type": "object", "nullable": true, "description": "Ressò de les `metadata` que has enviat." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Full match (Approved)": { "summary": "Per defecte save_api_request=true: objectes `validations` per servei", "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": "S'ha enviat la sol·licitud amb `services` — la resposta afegeix `services_used` i `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 registre no coincideix — `no_match_action=DECLINE` per defecte", "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` es redueix a un mapa de camps fusionat; no s'emmagatzema res", "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ó - no es factura res. Els errors de camp de prevalidació es produeixen abans de qualsevol crida externa. Si cada intent sense resposta rebutja explícitament l'entrada, la resposta inclou en el seu lloc `validation_errors` amb `code: provider_rejected_input` i `retryable: false`; corregeix l'entrada abans de reintentar. Els problemes a nivell de camp utilitzen l'embolcall estàndard de DRF; els problemes de catàleg retornen una matriu `services` (més `requires_onboarding` o `services_requiring_consent` quan sigui rellevant); els errors de camps que falten inclouen `fields_required_by`, que assigna cada camp que falta als serveis que el requereixen; els serveis que necessiten almenys un identificador addicional (p. ex., `usa_states_credit_bureau`, que no pot verificar un nom tot sol) retornen `any_field_required_by`, que assigna cada servei als camps dels quals almenys un ha d'estar present; els problemes de format comprovats per servei retornen `invalid_fields_by_service`.", "content": { "application/json": { "examples": { "Invalid issuing_state": { "summary": "País no admès — el missatge llista tots els codis alpha-3 vàlids", "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ó de camps obligatoris entre els serveis seleccionats, amb la indicació del camp universal", "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` conté un id que no és al catàleg", "value": { "services": [ "Unknown service_id(s): ['bogus_service']" ] } }, "Service not live for country": { "summary": "`services` indica un servei d'un altre país (o una entrada fictícia)", "value": { "services": [ "Services not currently live for PER: ['bra_cpf']. Available services: ['per_dni', 'per_residential', 'per_tax_registration']" ] } }, "Service requires onboarding": { "summary": "El servei existeix però encara no està activat per a la teva organització", "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 servei seleccionat té la marca requires_consent=true i `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": "L'identificador no compleix la regla de format del país (longitud/dígits/expressió regular)", "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 camp no compleix els requisits de format propis del servei seleccionat", "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": "Corregeix les dades d'entrada abans 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ó a nivell de sol·licitud o errors de camp de comprovació prèvia.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "validation_errors": { "type": "array", "description": "Present quan tots els intents sense resposta han rebutjat les dades després de la comprovació prèvia.", "items": { "type": "object", "properties": { "service_id": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean", "description": "Indica si reintentar més tard pot resoldre aquest error del servei. False significa que primer cal corregir les dades d'entrada proporcionades." } } } } } } } } }, "403": { "description": "Permís denegat. Es retorna quan falta la capçalera `x-api-key`, i també quan el saldo de l'organització que fa la crida no pot cobrir la crida; una clau incorrecta, revocada o caducada retorna `401`. Si falta la clau es retorna `403` amb `{\"detail\": ...}`; una clau incorrecta, revocada o caducada retorna `401`. La manca de crèdit retorna `403` amb `{\"error\": ...}` abans que es produeixi cap cribratge o crida al proveïdor.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de l'organització no pot cobrir la crida", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Més de 300 sol·licituds d'escriptura en el minut 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": "Cap servei seleccionat ha retornat un resultat utilitzable. Inspecciona cada entrada de validation_errors abans de reintentar; HTTP 502 per si sol no determina una fallada transitòria. Un empty_provider_response amb retryable: true indica resultats no disponibles o inexplicats, incloent-hi un proveïdor principal rebutjat seguit d'una alternativa no disponible. En canvi, les entrades heretades provider_invalid_input i provider_validation_error requereixen dades d'entrada corregides i poden ometre retryable. No es factura res. Quan save_api_request=true, l'intent fallit es registra com una sessió amb estat Not Finished. Les fallades parcials retornen 200 amb 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 tard pot resoldre aquest error del servei. False significa que primer cal corregir les dades d'entrada proporcionades." } } } } } }, "examples": { "Provider returned no result": { "summary": "Tots els serveis seleccionats han fallat", "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 el codi per telèfon", "description": "Envia un codi d'un sol ús (OTP) a un número de telèfon a través de WhatsApp, SMS o un altre canal admès, i després verifica'l amb [`POST /v3/phone/check/`](/ca/standalone-apis/phone-check).\n\n**Com es vinculen l'enviament i la comprovació.** L'estat de la verificació s'identifica mitjançant la teva aplicació i el `phone_number` en format E.164; la crida de comprovació no accepta `request_id`. Cada nou enviament crea una verificació pendent que dura **5 minuts**: crida la comprovació amb el mateix número i el codi que ha rebut l'usuari abans que es tanqui la finestra. Si tornes a cridar l'enviament per al mateix número mentre hi ha una verificació pendent, es reenvia un codi per a aquesta mateixa verificació (`status: \"Retry\"`, mateix `request_id`). Com a màxim es vincula un reintent d'aquesta manera (dos enviaments en total); un enviament posterior inicia una nova verificació amb un nou `request_id`. La finestra de 5 minuts es compta a partir del primer enviament i no s'amplia amb els reintents.\n\n**Canals de lliurament.** `options.preferred_channel` selecciona el canal (`whatsapp` per defecte; també s'admeten `sms`, `telegram`, `voice`, `rcs`, `viber` i `zalo`). Quan el canal preferit no està disponible per al país o número de destinació, el lliurament canvia automàticament a SMS: l'enviament continua informant de `Success`, i el canal utilitzat realment s'indica a la resposta de comprovació (`phone.verification_method` i els esdeveniments `lifecycle`).\n\n**Personalització de marca.** Els codis per SMS inclouen el nom de remitent de SMS de la teva aplicació, configurat a la Business Console, sense cap cost addicional. Passa `options.sms_sender_name` perquè un codi s'enviï amb un altre nom, o `options.use_white_label_customization: true` per recórrer al teu nom públic de marca blanca quan no s'hagi establert cap nom de remitent. Els codis de WhatsApp utilitzen un missatge fix; connecta el teu propi número de WhatsApp Business a la Business Console per enviar-los des del nom i número de la teva empresa, facturats només amb la tarifa de Didit.\n\n**Estats d'enviament.** `Success`: OTP enviat per a una nova verificació; `Retry`: OTP reenviat per a la verificació pendent; `Blocked`: la capa antifrau ha refusat l'enviament (consulta `reason`, p. ex., `repeated_attempts`, `suspicious`, `spam`). Un enviament `Blocked` finalitza immediatament la verificació com a `Declined` amb una advertència d'alt risc, de manera que una comprovació posterior retorna `Expired or Not Found`.\n\n**Facturació.** El preu depèn del país de destinació i del canal que lliura realment el missatge; consulta [Preus de Verificació de telèfon](/ca/getting-started/phone-verification-pricing). Només els enviaments `Blocked` són garantits com a gratuïts: qualsevol altre intent d'enviament no facturat es cobra en finalitzar o caducar la verificació, fins i tot si el lliurament mai no es va confirmar o el proveïdor de lliurament va informar que el missatge no es podia lliurar. Les comprovacions són sempre gratuïtes. Com a mesura antiabús, la verificació de telèfon està desactivada fins a la primera recàrrega de la teva organització (`403`).\n\n**Persistència de sessions.** Cada nova verificació es desa com una sessió de tipus API: `request_id` és un id de sessió real que pots passar a `GET /v3/session/{sessionId}/decision/`, la verificació apareix a la Business Console i els webhooks `status.updated` s'activen a mesura que avança.\n\n**Sandbox.** Les claus d'API de sandbox ometen el lliurament i la facturació: després de la validació de la sol·licitud (l'entrada amb format incorrecte continua retornant `400`), l'endpoint retorna un payload estàtic `Success` amb un `request_id` aleatori; no s'envia cap missatge ni es desa res. Utilitza el codi `123456` a la comprovació de sandbox.\n\n**Autenticació.** Envia la clau d'API de la teva aplicació a la capçalera `x-api-key`. Les credencials absents o no vàlides retornen `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); aquesta API mai no retorna `401`.\n\n**Límits de freqüència.** Pressupost d'escriptura compartit de 300 sol·licituds/min per clau d'API a tots els endpoints POST/PATCH/DELETE, més un límit antiabús de 4 intents d'enviament per número de telèfon per hora; superar qualsevol dels dos retorna `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èfon del destinatari en format E.164 — amb `+` inicial i codi de país (p. ex., `+14155552671`). Els números es validen i es normalitzen a E.164; els números invàlids o que no es poden analitzar retornen `400` amb un error al camp `phone_number`.", "example": "+14155552671" }, "options": { "type": "object", "description": "Opcions de lliurament de l'OTP. Tots els camps són opcionals.", "properties": { "code_size": { "type": "integer", "minimum": 4, "maximum": 8, "default": 6, "description": "Nombre de dígits de l'OTP." }, "locale": { "type": "string", "maxLength": 5, "pattern": "^[a-z]{2,3}(-[A-Z]{2,3})?$", "description": "Configuració regional BCP-47 utilitzada per localitzar el missatge de verificació (p. ex., `en-US`, `fr`, `es`). Els formats no vàlids retornen `400`.", "example": "en-US" }, "preferred_channel": { "type": "string", "enum": [ "whatsapp", "sms", "telegram", "voice", "rcs", "viber", "zalo" ], "default": "whatsapp", "description": "Canal de lliurament preferit. Si el canal no està disponible per al país o número de destinació, el missatge passa automàticament a SMS — l'enviament continua indicant `Success`." }, "use_white_label_customization": { "type": "boolean", "default": false, "description": "Quan és `true`, l'enviament és de marca blanca: si la teva aplicació no té cap nom de remitent d'SMS, l'SMS inclou el teu nom públic de marca blanca (\"123456 és el teu codi de verificació per a Acme Bank\"). El teu nom de remitent d'SMS, si està configurat, s'utilitza amb aquest indicador o sense. S'aplica als missatges SMS, inclòs el recurs a SMS des d'un altre canal; els codis de WhatsApp s'envien amb un missatge fix i no porten marca. Per defecte és `false`." }, "sms_sender_name": { "type": "string", "nullable": true, "maxLength": 30, "example": "Acme Bank", "description": "El nom que porta l'SMS d'aquest codi (\"123456 és el teu codi de verificació per a Acme Bank\"), en comptes del nom de remitent d'SMS de la teva aplicació. Gratuït. D'1 a 30 caràcters: només lletres, dígits, espais i ' & - !, no només dígits, amb espais simples entre paraules; qualsevol altre valor retorna `400` i no s'envia cap codi. Si s'omet, és `null` o està en blanc, s'utilitza el nom de remitent d'SMS de la teva aplicació. Cada aplicació pot començar a utilitzar fins a dos noms nous per dia (UTC); després d'això, el codi s'envia amb el nom de la teva aplicació. S'aplica als missatges SMS, inclòs un SMS de reserva des d'un altre canal; els codis de WhatsApp no porten marca.", "pattern": "^$|^(?![\\d ]+$)[\\p{L}\\p{N}'&!-]+( [\\p{L}\\p{N}'&!-]+)*$" } } }, "signals": { "type": "object", "description": "Senyals opcionals de dispositiu i xarxa sobre l'usuari final, reenviats a la capa antifrau per millorar la detecció de trànsit abusiu o automatitzat. Tots els camps són opcionals.", "properties": { "ip": { "type": "string", "description": "Adreça IP del dispositiu de l'usuari final. IPv4 o IPv6.", "example": "192.0.2.1" }, "device_id": { "type": "string", "maxLength": 255, "description": "Identificador únic del dispositiu de l'usuari 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 dispositiu de l'usuari final." }, "device_model": { "type": "string", "maxLength": 255, "description": "Model del dispositiu de l'usuari final.", "example": "iPhone17,2" }, "os_version": { "type": "string", "maxLength": 64, "description": "Versió del sistema operatiu del dispositiu de l'usuari final.", "example": "18.0.1" }, "app_version": { "type": "string", "maxLength": 64, "description": "Versió de la teva aplicació.", "example": "1.2.34" }, "user_agent": { "type": "string", "maxLength": 512, "description": "Agent d'usuari del navegador o de l'aplicació de l'usuari 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 controlat per qui fa la crida (el teu id d'usuari intern, un correu electrònic, un UUID, etc.) que es manté a la sessió i es retorna a la resposta d'enviament, a la resposta de comprovació de coincidències, als webhooks i a la Business Console. Utilitza'l per correlacionar el `request_id` de Didit amb el teu registre d'usuari." }, "metadata": { "type": "object", "nullable": true, "description": "Objecte JSON opcional de format lliure que es desa a la sessió i es retorna a la resposta d'enviament, a la resposta de la comprovació de coincidència, als webhooks i a la Business Console." } }, "required": [ "phone_number" ] }, "examples": { "WhatsApp (default)": { "summary": "OTP de 6 xifres per WhatsApp, amb commutació automàtica a SMS com a alternativa", "value": { "phone_number": "+14155552671", "options": { "preferred_channel": "whatsapp", "locale": "en-US" }, "vendor_data": "user-1234" } }, "SMS with custom code length": { "summary": "Força el lliurament per SMS amb un codi de 4 xifres", "value": { "phone_number": "+34699999999", "options": { "preferred_channel": "sms", "code_size": 4, "locale": "es" } } }, "With fraud signals": { "summary": "Reenvia senyals del dispositiu per reforçar el cribratge antifrau", "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": "Enviament confirmat. Revisa `status`: `Success` i `Retry` indiquen que s'està enviant un codi; `Blocked` significa que la capa antifrau ho ha refusat i la verificació ja s'ha finalitzat com a `Declined`. `request_id` és l'identificador de sessió persistit (el mateix identificador en un `Retry`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneVerificationSendResponse" }, "examples": { "Success": { "summary": "OTP enviat per a una nova verificació", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Success", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Retry": { "summary": "Segon enviament per al mateix número dins de la finestra de 5 minuts — mateix request_id", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Retry", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Blocked": { "summary": "Denegació antifrau — verificació finalitzada com a Rebutjada, no s'ha facturat res", "value": { "request_id": "0d8af1f4-0c43-46d7-b75c-6e4e22c0a7b3", "status": "Blocked", "reason": "repeated_attempts", "vendor_data": "user-1234", "metadata": null } } } } } }, "400": { "description": "Error de validació. Les dades d'entrada amb format incorrecte retornen l'embolcall d'errors de camp de DRF (una matriu de missatges per cada camp que conté l'error, anidada sota `options` per a errors d'opcions). Un número que s'analitza correctament però es rebutja en el moment de l'enviament (inaccessible o un tipus de línia no apte com ara un codi curt) retorna en canvi un embolcall `{\"detail\": ...}`.", "content": { "application/json": { "examples": { "Invalid phone number (field error)": { "summary": "El número no és un número E.164 vàlid", "value": { "phone_number": [ "Invalid phone number provided." ] } }, "Missing phone number": { "summary": "`phone_number` no s'ha inclòs al cos", "value": { "phone_number": [ "This field is required." ] } }, "Invalid options": { "summary": "`code_size` fora de rang, `locale` mal format, `preferred_channel` desconegut", "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": "Format E.164 vàlid però el número no pot rebre cap OTP", "value": { "detail": "Invalid phone number provided." } }, "Ineligible line type": { "summary": "El tipus de línia no pot rebre un OTP (p. ex., codi curt)", "value": { "detail": "Invalid phone line type provided." } } } } } }, "403": { "description": "Permís denegat. Es retorna quan falta la capçalera `x-api-key` (`{\"detail\": ...}`); una clau incorrecta, revocada o caducada retorna `401`. També es retorna abans de qualsevol enviament quan l'organització mai no ha recarregat (control contra l'abús) o quan el seu saldo no pot cobrir el preu d'enviament de la destinació (`{\"error\": ...}`).", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } }, "Top-up required": { "summary": "La verificació de telèfon roman desactivada fins a la primera recàrrega de l'organització", "value": { "detail": "To protect against abuse, phone verification is disabled until your first top-up." } }, "Not enough credits": { "summary": "El saldo de l'organització no pot cobrir el preu de l'enviament", "value": { "error": "You don't have enough credits to perform this request." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). A més, a nivell superior s'aplica un límit contra abusos de 4 intents de verificació per número de telèfon i per hora. La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`. Nota: les capçaleres `X-RateLimit-*`/`Retry-After` només acompanyen l'error 429 del límit d'escriptura de 300/min; el 429 del límit per número de telèfon no conté capçaleres de límit de freqüència.", "content": { "application/json": { "examples": { "Per-number cap": { "summary": "Més de 4 intents de verificació per al mateix número en l'ú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 sol·licituds d'escriptura en el minut 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 proveïdor de verificació de telèfon no està disponible temporalment: una resposta 5xx, un temps d'espera esgotat o un error de connexió que ha persistit després dels reintents integrats. És segur reintentar-ho; no es factura res ni es consumeix cap intent.", "content": { "application/json": { "examples": { "Provider outage": { "summary": "El proveïdor no ha respost a la sol·licitud d'enviament", "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 inesperat en crear la verificació que no correspon a una caiguda coneguda del proveïdor. Es pot reintentar amb seguretat.", "content": { "application/json": { "examples": { "Provider error": { "summary": "No s'ha pogut iniciar el lliurament de l'OTP", "value": { "detail": "Error creating phone verification" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/phone/check/": { "post": { "summary": "Comprovar el codi de telèfon", "description": "Verifica l'OTP lliurat per [`POST /v3/phone/send/`](/ca/standalone-apis/phone-send) i obtén el resultat final de la verificació a més d'informació d'intel·ligència del telèfon: nom de l'operador i tipus de línia, indicadors de número virtual (VoIP) i d'un sol ús, i l'ús duplicat del número entre les teves sessions.\n\n**Com es localitza la verificació.** La coincidència es fa mitjançant la teva aplicació i el `phone_number` en format E.164; `request_id` no és un paràmetre d'entrada. Es comprova la verificació pendent més recent creada en els darrers **5 minuts**. Si no n'hi ha cap (no s'ha enviat mai, ja està finalitzada o té més de 5 minuts), l'endpoint retorna `200` amb `status: \"Expired or Not Found\"`.\n\n**Límit d'intents.** Cada verificació permet **3 intents de codi**. Els dos primers codis incorrectes retornen `status: \"Failed\"` amb els intents restants i `phone: null`; el tercer codi incorrecte finalitza la verificació com a `Declined` amb una advertència `VERIFICATION_CODE_ATTEMPTS_EXCEEDED` i retorna l'informe complet del telèfon.\n\n**Resultats.** `Approved` — codi correcte i cap risc que motivi un rebuig. `Declined` — terminal: el codi era correcte però ha coincidit un risc de rebuig (una acció `DECLINE` més avall, un número inclòs a la llista de bloqueig o un número d'alt risc), o bé s'ha esgotat el límit d'intents. `Failed` — codi incorrecte, queden intents. `Expired or Not Found` — res a comprovar. Amb `Approved`/`Declined`, el `request_id` és igual al `request_id` de l'enviament (l'identificador de sessió) i `phone` conté l'informe complet (`carrier`, `is_virtual`, `is_disposable`, `warnings`, `lifecycle`, `matches`); amb `Failed` i `Expired or Not Found`, el `request_id` és un UUID aleatori d'un sol ús.\n\n**Accions de risc.** `duplicated_phone_number_action`, `disposable_number_action` i `voip_number_action` decideixen què passa quan es detecta el risc corresponent amb un codi correcte: `DECLINE` canvia l'estat final a `Declined`; `NO_ACTION` (per defecte) registra el risc a `phone.warnings` sense afectar l'estat.\n\n**Facturació.** Les comprovacions són gratuïtes; el lliurament es factura en la part de l'enviament (consulta [Preus de la verificació de telèfon](/ca/getting-started/phone-verification-pricing)).\n\n**Persistència de la sessió.** Una comprovació finalitzada actualitza la sessió creada per l'enviament (visible a la Business Console, consultable mitjançant `GET /v3/session/{sessionId}/decision/`) i dispara un webhook `status.updated`.\n\n**Sandbox.** Les claus d'API de sandbox ometen tot el processament: qualsevol codi ben format (de 4 a 8 xifres, `123456` inclòs) retorna un payload `Approved` estàtic amb un objecte pla `phone` simplificat (`status`, `phone_number`, `country_code`, `carrier_name`, `line_type`, `flags`); una entrada mal formada continua retornant `400`. No es persisteix res.\n\n**Autenticació.** Envia la clau d'API de la teva aplicació a la capçalera `x-api-key`. Unes credencials absents o no vàlides retornen `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`) — aquesta API mai no retorna `401`.\n\n**Límits de freqüència.** Pressupost d'escriptura compartit de 300 sol·licituds/min per clau d'API, a més del límit antiabús del sistema ascendent de 4 intents per número i hora; si se supera qualsevol dels dos es retorna `429`.\n\n**Petjada social.** Estableix `enable_social` a `true` per afegir un bloc `phone_social`: les plataformes en línia on està registrat aquest número, amb recomptes per categoria i qualsevol detall del perfil disponible. `profiles_registered: 0` significa que s'han comprovat les plataformes i el número no s'ha trobat en cap d'elles: una resposta vàlida i facturable. El bloc no apareix si no s'ha sol·licitat el complement o si la comprovació no s'ha pogut completar, i en aquest cas no es factura. La facturació afegeix una unitat de `phone_social` per sol·licitud a sobre del preu propi d'aquest 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 mateix número de telèfon utilitzat a la crida [`POST /v3/phone/send/`](/ca/standalone-apis/phone-send) coincident, en format E.164. Això és el que enllaça la comprovació amb l'enviament.", "example": "+14155552671" }, "code": { "type": "string", "minLength": 4, "maxLength": 8, "pattern": "^[0-9]{4,8}$", "description": "L'OTP que ha rebut l'usuari final. Ha de tenir entre 4 i 8 dígits numèrics; qualsevol altra cosa retorna `400` sense consumir cap intent. Un codi ben format però incorrecte retorna `200` amb `status: \"Failed\"` i consumeix un dels 3 intents.", "example": "123456" }, "duplicated_phone_number_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Què fer quan el mateix número ja ha estat utilitzat per un usuari diferent (diferent `vendor_data`) de la teva aplicació. `DECLINE` canvia el `status` final a `Declined`; `NO_ACTION` registra el risc a `phone.warnings` i emplena `phone.matches`." }, "disposable_number_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Què fer quan la cerca de l'operador marca el número com a línia temporal/d'un sol ús (`phone.is_disposable`). `DECLINE` canvia el `status` final a `Declined`; `NO_ACTION` registra el risc a `phone.warnings`." }, "voip_number_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Què fer quan la cerca de l'operador indica un tipus de línia virtual — `voip`, `isp` o `vpn` (`phone.is_virtual`). `DECLINE` canvia el `status` final a `Declined`; `NO_ACTION` registra el risc a `phone.warnings`." }, "enable_enrichment": { "type": "boolean", "default": false, "description": "Quan és `true`, també executa intel·ligència telefònica al número: una puntuació de risc, el tipus de línia, si s'ha portat recentment i un índex de confiança. Es factura com una unitat de `phone_intelligence_api` per sol·licitud ($0.05 a preu de tarifa) a més del preu propi d'aquest endpoint. La sol·licitud retorna `403` quan el teu saldo no pot cobrir-ho.", "example": false }, "phone_intelligence_score_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acció quan la puntuació de risc de la intel·ligència telefònica supera el llindar. `DECLINE` canvia l'`status` final a `Declined`; `NO_ACTION` registra el senyal sense rebutjar. Només té efecte quan `enable_enrichment` és `true`." }, "phone_type_risk_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acció quan el número és d'un tipus de línia d'alt risc. `DECLINE` canvia l'`status` final a `Declined`; `NO_ACTION` registra el senyal sense rebutjar. Només té efecte quan `enable_enrichment` és `true`." }, "recent_port_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acció quan el número s'ha portat recentment a una altra operadora. `DECLINE` canvia l'`status` final a `Declined`; `NO_ACTION` registra el senyal sense rebutjar. Només té efecte quan `enable_enrichment` és `true`." }, "low_phone_trust_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acció quan l'índex de confiança de la intel·ligència telefònica és igual o inferior al llindar. `DECLINE` canvia l'`status` final a `Declined`; `NO_ACTION` registra el senyal sense rebutjar. Només té efecte quan `enable_enrichment` és `true`." }, "enable_social": { "type": "boolean", "default": false, "description": "Quan és cert, també consulta la petjada social del número: les plataformes de missatgeria, socials, de comerç electrònic i professionals on està registrat. Es factura com una unitat de `phone_social` per sol·licitud a més del preu propi d'aquest endpoint.", "example": true }, "phone_no_social_presence_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acció quan la comprovació de petjada social no troba el número registrat a cap de les plataformes que cobreix. En aquest endpoint només s'accepten NO_ACTION i DECLINE; REVIEW està disponible a la clau de configuració del flux de treball amb el mateix nom." } }, "required": [ "phone_number", "code" ] }, "examples": { "Default": { "summary": "Registra qualsevol risc però no rebutgis mai automàticament", "value": { "phone_number": "+14155552671", "code": "123456" } }, "Strict risk policy": { "summary": "Rebutja automàticament línies VoIP i d'un sol ús", "value": { "phone_number": "+14155552671", "code": "123456", "voip_number_action": "DECLINE", "disposable_number_action": "DECLINE" } } } } } }, "responses": { "200": { "description": "Comprovació completada: els codis incorrectes i les verificacions que falten també retornen `200`; inspecciona `status`, no el codi HTTP. `phone` només s'emplena en resultats finalitzats (`Approved`/`Declined`), és `null` a `Failed`, i no apareix a `Expired or Not Found`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneVerificationCheckResponse" }, "examples": { "Approved": { "summary": "Codi correcte — informe complet de telèfon amb operador, cicle de vida i coincidències", "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": "Codi incorrecte: l'usuari pot reintentar; request_id aquí és un UUID d'un sol ús", "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 codi incorrecte: verificació finalitzada com a Rebutjada", "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": "Codi correcte, però la línia és VoIP i 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 hi ha cap verificació pendent per a aquest número en els darrers 5 minuts", "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ó — embolcall d'errors de camp de DRF: una matriu de missatges per camp infractor.", "content": { "application/json": { "examples": { "Invalid code format": { "summary": "`code` no té entre 4 i 8 dígits numèrics", "value": { "code": [ "Invalid code format. Enter 4 to 8 numeric digits." ] } }, "Invalid phone number": { "summary": "`phone_number` no és un E.164 vàlid", "value": { "phone_number": [ "Invalid phone number provided." ] } }, "Invalid action": { "summary": "Les accions de risc només accepten NO_ACTION o DECLINE", "value": { "voip_number_action": [ "\"REVIEW\" is not a valid choice." ] } } } } } }, "403": { "description": "Permís denegat. Es retorna quan falta la capçalera `x-api-key`; una clau incorrecta, revocada o caducada retorna `401`. Les comprovacions són gratuïtes, de manera que aquí no hi ha cap comprovació de crèdit.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). A més, a nivell superior s'aplica un límit contra abusos de 4 intents de verificació per número de telèfon i per hora. La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`. Nota: les capçaleres `X-RateLimit-*`/`Retry-After` només acompanyen l'error 429 del límit d'escriptura de 300/min; el 429 del límit per número de telèfon no conté capçaleres de límit de freqüència.", "content": { "application/json": { "examples": { "Per-number cap": { "summary": "Més de 4 intents de verificació per al mateix número en l'ú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 sol·licituds d'escriptura en el minut 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 proveïdor de verificació de telèfon no està disponible temporalment: una resposta 5xx, un temps d'espera esgotat o un error de connexió que ha persistit després dels reintents integrats. És segur reintentar-ho; no es consumeix el límit d'intents.", "content": { "application/json": { "examples": { "Provider outage": { "summary": "El proveïdor no ha respost a la sol·licitud de comprovació", "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 inesperat en verificar el codi en el proveïdor que no correspon a una caiguda coneguda del proveïdor. Es pot reintentar amb seguretat; el pressupost d'intents només es consumeix amb les comprovacions completades.", "content": { "application/json": { "examples": { "Provider error": { "summary": "No s'ha pogut completar la verificació del codi", "value": { "detail": "Error checking phone verification" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/bank/account-check/": { "post": { "summary": "Comprovar un compte bancari", "description": "Comprova que un compte bancari pertany a la persona o empresa que indiques, abans d'enviar-hi diners. Sense sessió i sense inici de sessió: envia el nom i el compte, i llegeix el resultat. És la [comprovació de compte](/ca/core-technology/bank-verification/account-check) del pas de verificació bancària, executada des del teu backend.\n\n**El que envies.** El `country` del compte (ISO 3166-1 alfa-3), el compte (`account`) tal com s'escriu en aquest país, i el nom del titular (`holder`): `full_name` per a una persona física o `business_name` per a una empresa. Un nom d'empresa comprova un compte d'empresa.\n\n**El que reps.** `result` és `match`, `close_match`, `no_match` o `cannot_verify`. Si és `close_match`, `holder_name` és el nom sota el qual el banc té registrat el compte, quan el banc l'ha retornat. `account` es retorna emmascarat mostrant només els darrers 4 caràcters.\n\n**Facturació.** Cada comprovació que el banc respon es factura un cop al preu de comprovació de compte del país corresponent, sigui quin sigui el resultat: un `no_match`, un compte inexistent i un `cannot_verify` també es facturen. Una sol·licitud que rep un error com a resposta no es factura mai.\n\n**Cada sol·licitud és una comprovació nova.** No hi ha clau d'idempotència ni cap endpoint per consultar una comprovació anterior, de manera que una sol·licitud reintentada s'executa, i es factura, un altre cop. Emmagatzema la resposta.\n\n**Sandbox.** Utilitza una clau d'API de sandbox amb les dades de compte d'exemple. Una clau de sandbox no crida cap banc i no té cap cost. Els darrers 4 caràcters de l'IBAN o, si no n'hi ha, del número de compte, determinen la resposta: `0001` un `close_match` amb `holder_name`, `0002` un `close_match` sense ell, `0003` i `0006` un `no_match`, `0004` `cannot_verify`, `0005` un `503` i `0009` un `400`. Qualsevol altra terminació és un `match`.\n\n**Claus d'API.** Una clau d'API amb abast restringit necessita accés d'escriptura a sessions.", "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, Nigeria": { "summary": "Un codi bancari i un número de compte, contrastats amb el nom d'una persona", "value": { "country": "NGA", "account": { "bank_code": "000014", "account_number": "0123450001" }, "holder": { "full_name": "Maria Oliveira" }, "vendor_data": "payout_20481" } }, "Company, Nigeria": { "summary": "Un codi bancari i un número de compte, contrastats amb el nom d'una empresa", "value": { "country": "NGA", "account": { "bank_code": "000014", "account_number": "0123456789" }, "holder": { "business_name": "Northwind Trading Ltd" } } } } } } }, "responses": { "200": { "description": "El banc ha respost. La comprovació es factura, sigui quin sigui el resultat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckResponse" }, "examples": { "Close match": { "summary": "El banc manté el compte sota un nom similar", "value": { "request_id": "c2f4a9e0-7b1d-4c3a-9e55-1d0a6b8f2a47", "result": "close_match", "holder_name": "MARIA R OLIVEIRA", "account": "****0001", "vendor_data": "payout_20481", "created_at": "2026-10-21T14:32:08Z" } }, "Match": { "summary": "El banc manté el compte sota el nom enviat", "value": { "request_id": "5b0e2d7c-41a8-4f6e-9c3b-8e7d1a2f6c90", "result": "match", "holder_name": null, "account": "****6789", "vendor_data": null, "created_at": "2026-10-21T14:35:41Z" } } } } } }, "400": { "description": "Rebutjada tal com s'ha enviat, i no facturada. `field` indica el camp del cos que cal corregir i `reason` n'explica el motiu, amb els mateixos motius que mostra el formulari de compte allotjat. Només s'informa del primer camp rebutjat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Missing field": { "summary": "La comprovació del país requereix un codi bancari", "value": { "detail": "The bank code is not valid (required).", "code": "invalid_account_input", "field": "account.bank_code", "reason": "required" } }, "Invalid IBAN": { "summary": "L'IBAN té una longitud incorrecta per al seu 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 banc ha rebutjat el compte tal com s'ha enviat", "value": { "detail": "The account was refused as typed (rejected).", "code": "invalid_account_input", "field": "account.account_number", "reason": "rejected" } }, "No name": { "summary": "`holder` no té 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" } }, "Consent required": { "summary": "La comprovació del compte del país requereix el consentiment del titular del compte", "value": { "detail": "Account checks in this country need the account holder's explicit consent. Ask for it, then send `consent=true`.", "code": "invalid_account_input", "field": "consent", "reason": "required" } } } } } }, "401": { "description": "La clau d'API amb abast ha caducat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Expired key": { "summary": "La data de caducitat de la clau ha passat", "value": { "detail": "This API key has expired." } } } } } }, "402": { "description": "La comprovació no es pot pagar, de manera que no s'ha executat. Recarrega el teu saldo i torna-la a enviar.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Out of credit": { "summary": "El teu saldo no pot cobrir una comprovació", "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": "El teu contracte no té cap preu per a l'API Account check", "value": { "detail": "Your contract does not price the Account check API. Contact your account manager.", "code": "contract_rate_missing" } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` o el token de portador, o no són vàlids; la sol·licitud prové d'una adreça fora de la llista d'IP de la clau, o una clau amb àmbit no té accés d'escriptura a les sessions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Missing or invalid credentials": { "summary": "Cap clau d'API o token vàlids", "value": { "detail": "You do not have permission to perform this action." } }, "No sessions write": { "summary": "Una clau amb abast restringit sense accés d'escriptura a les sessions", "value": { "detail": "This API key has no write access to sessions." } } } } } }, "404": { "description": "Cap verificació de compte dona servei a aquest compte encara, de manera que no s'ha comprovat ni facturat res. `country_not_covered`: cap dona servei al seu país, o al seu tipus de compte (persona o empresa) allà. `bank_not_covered`: cap dona servei al seu banc.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Country not covered": { "summary": "Cap verificació de compte dona servei al país", "value": { "detail": "No account check serves this country yet.", "code": "country_not_covered" } }, "Bank not covered": { "summary": "Cap verificació de compte dona servei al banc del compte", "value": { "detail": "No account check serves this account's bank yet.", "code": "bank_not_covered" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" }, "503": { "description": "El banc no ha pogut respondre. No s'ha comprovat ni facturat res; torna a enviar la comprovació més tard.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Unavailable": { "summary": "El banc no ha respost", "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\": \"NGA\",\n \"account\": {\"bank_code\": \"000014\", \"account_number\": \"0123450001\"},\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=\"NGA\",\n account={\n \"account_number\": \"0123450001\",\n \"bank_code\": \"000014\",\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: \"NGA\",\n account: {\n account_number: \"0123450001\",\n bank_code: \"000014\",\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: \"NGA\",\n\tAccount: didit.BankAccountCheckRequestAccount{\n\t\tAccountNumber: didit.String(\"0123450001\"),\n\t\tBankCode: didit.String(\"000014\"),\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(\"NGA\")\n .account(BankAccountCheckRequest.Account.builder()\n .accountNumber(\"0123450001\")\n .bankCode(\"000014\")\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' => 'NGA',\n 'account' => [\n 'account_number' => '0123450001',\n 'bank_code' => '000014',\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: \"NGA\",\n account: {\n account_number: \"0123450001\",\n bank_code: \"000014\",\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 = \"NGA\",\n Account = new()\n {\n AccountNumber = \"0123450001\",\n BankCode = \"000014\",\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 el codi per correu electrònic", "description": "Envia un codi d'un sol ús (OTP) a una adreça de correu electrònic i, després, verifica'l amb [`POST /v3/email/check/`](/ca/standalone-apis/email-check).\n\n**Com s'associen l'enviament i la comprovació.** L'estat de verificació s'identifica mitjançant la teva aplicació juntament amb l'adreça `email`; la crida de comprovació no admet `request_id`. Cada nou enviament crea una verificació pendent que dura **5 minuts**: crida la comprovació amb la mateixa adreça i el codi que ha rebut l'usuari abans que es tanqui la finestra. Si tornes a cridar l'enviament per a la mateixa adreça mentre hi ha una verificació pendent, es genera un nou codi per a aquesta mateixa verificació (`status: \"Retry\"`, mateix `request_id`); el codi anterior deixa de funcionar. Com a màxim s'associa un reintent d'aquesta manera (dos enviaments en total); un enviament posterior inicia una nova verificació amb un nou `request_id`. La finestra de 5 minuts es compta a partir del primer enviament i els reintents no l'amplien.\n\n**Comprovació prèvia de lliurabilitat.** Abans d'enviar res, l'adreça passa per una validació de sintaxi i de DNS/MX. Les adreces que no poden rebre correu retornen `200` amb `status: \"Undeliverable\"` i `reason: \"email_can_not_be_delivered\"`: no s'envia cap correu electrònic, no es factura res i la verificació es finalitza immediatament com a `Declined` (una comprovació posterior retorna `Expired or Not Found`). Un enviament que falla per un motiu que no és l'adreça (el correu electrònic no s'ha pogut lliurar per enviar-lo) retorna `503`: no s'envia cap codi, no es factura res, la verificació roman oberta i es pot repetir la mateixa sol·licitud.\n\n**Format del codi i personalització de marca.** Els codis tenen entre 4 i 8 caràcters (`options.code_size`, per defecte 6), numèrics per defecte; defineix `options.alphanumeric_code: true` per a lletres majúscules i dígits (la comparació que es fa en la comprovació no distingeix entre majúscules i minúscules). La plantilla de correu electrònic es localitza mitjançant `options.locale` (54 idiomes admesos) i pot utilitzar la personalització de marca blanca de la teva aplicació mitjançant `options.use_white_label_customization`.\n\n**Facturació.** Un crèdit de l'API de Verificació de correu electrònic per enviament satisfactori (`status: \"Success\"`), cobrat en el moment de l'enviament. Els enviaments `Retry` i `Undeliverable` són gratuïts, i les comprovacions són gratuïtes.\n\n**Persistència de la sessió.** Cada nova verificació es manté com una sessió de tipus API: `request_id` és un id de sessió real que pots passar a `GET /v3/session/{sessionId}/decision/`, la verificació apareix a la Business Console i els webhooks `status.updated` s'activen a mesura que avança.\n\n**Sandbox.** Les claus d'API de sandbox ometen el lliurament i la facturació: després de la validació de la sol·licitud (l'entrada amb format incorrecte continua retornant `400`), l'endpoint retorna un payload estàtic `Success` amb un `request_id` aleatori; no s'envia cap correu electrònic i no es desa res de manera persistent. Utilitza el codi `123456` a la comprovació de sandbox.\n\n**Autenticació.** Envia la clau d'API de la teva aplicació a la capçalera `x-api-key`. Les credencials absents o no vàlides retornen `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); aquesta API mai retorna `401`.\n\n**Límit de freqüència.** Límit d'escriptura compartit de 300 sol·licituds/min per clau d'API en tots els endpoints POST/PATCH/DELETE; superar-lo retorna `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": "Adreça de correu electrònic del destinatari. Les adreces amb un format incorrecte retornen `400`; les adreces sintàcticament vàlides que no poden rebre correu (error de validació de DNS/MX) retornen `200` amb `status: \"Undeliverable\"`.", "example": "alice@example.com" }, "options": { "type": "object", "description": "Opcions de format, localització i personalització de marca de l'OTP. Tots els camps són opcionals.", "properties": { "code_size": { "type": "integer", "minimum": 4, "maximum": 8, "default": 6, "description": "Nombre de caràcters de l'OTP (dígits per defecte; lletres majúscules i dígits quan `alphanumeric_code` és `true`)." }, "alphanumeric_code": { "type": "boolean", "default": false, "description": "Quan és `true`, l'OTP està compost per lletres majúscules `A–Z` i dígits `0–9` en lloc de només dígits. La comparació a `/v3/email/check/` no distingeix entre majúscules i minúscules." }, "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 correu electrònic d'OTP. Per defecte és `en`. Els valors no admesos retornen `400` amb una llista de tots els idiomes admesos.", "example": "en" }, "use_white_label_customization": { "type": "boolean", "default": false, "description": "Quan és `true`, el correu electrònic amb l'OTP utilitza la personalització de marca blanca de la teva aplicació (logotip, colors, marca del remitent) en lloc de la plantilla per defecte de Didit." } } }, "signals": { "type": "object", "description": "Senyals opcionals de dispositiu i xarxa sobre l'usuari final, reenviats a la capa antifrau per millorar la detecció de trànsit abusiu o automatitzat. Tots els camps són opcionals.", "properties": { "ip": { "type": "string", "description": "Adreça IP del dispositiu de l'usuari final. IPv4 o IPv6.", "example": "192.0.2.1" }, "device_id": { "type": "string", "maxLength": 255, "description": "Identificador únic del dispositiu de l'usuari 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 dispositiu de l'usuari final." }, "device_model": { "type": "string", "maxLength": 255, "description": "Model del dispositiu de l'usuari final.", "example": "iPhone17,2" }, "os_version": { "type": "string", "maxLength": 64, "description": "Versió del sistema operatiu del dispositiu de l'usuari final.", "example": "18.0.1" }, "app_version": { "type": "string", "maxLength": 64, "description": "Versió de la teva aplicació.", "example": "1.2.34" }, "user_agent": { "type": "string", "maxLength": 512, "description": "Agent d'usuari del navegador o de l'aplicació de l'usuari 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 controlat per qui fa la crida (el teu id d'usuari intern, un correu electrònic, un UUID, etc.) que es manté a la sessió i es retorna a la resposta d'enviament, a la resposta de comprovació de coincidències, als webhooks i a la Business Console. Utilitza'l per correlacionar el `request_id` de Didit amb el teu registre d'usuari." }, "metadata": { "type": "object", "nullable": true, "description": "Objecte JSON opcional de format lliure que es desa a la sessió i es retorna a la resposta d'enviament, a la resposta de la comprovació de coincidència, als webhooks i a la Business Console." } }, "required": [ "email" ] }, "examples": { "Numeric 6-digit code": { "summary": "Per defecte — codi numèric de 6 dígits en anglès", "value": { "email": "alice@example.com", "options": { "locale": "en" }, "vendor_data": "user-1234" } }, "Alphanumeric 8-character code": { "summary": "Lletres majúscules + dígits, plantilla espanyola", "value": { "email": "bob@example.com", "options": { "code_size": 8, "alphanumeric_code": true, "locale": "es" } } }, "White-label branding": { "summary": "Envia el correu electrònic amb l'OTP amb la personalització de marca blanca de la teva aplicació", "value": { "email": "carol@example.com", "options": { "locale": "en", "use_white_label_customization": true }, "vendor_data": "user-5678" } } } } } }, "responses": { "200": { "description": "Enviament confirmat. Revisa `status`: `Success` i `Retry` indiquen que s'està enviant un codi; `Undeliverable` significa que l'adreça no pot rebre correu i la verificació ja s'ha finalitzat com a `Declined`. `request_id` és l'identificador de sessió persistit (el mateix identificador en un `Retry`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailVerificationSendResponse" }, "examples": { "Success": { "summary": "OTP enviat per correu electrònic per a una nova verificació (facturat)", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Success", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Retry": { "summary": "Segon enviament dins de la finestra de 5 minuts — codi nou, mateix request_id, gratuït", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Retry", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Undeliverable": { "summary": "L'adreça no ha superat la validació de DNS/MX: verificació finalitzada com a Rebutjada, sense facturació", "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ó — embolcall d'errors de camp de DRF: una matriu de missatges per camp infractor, imbricada sota `options` per a errors d'opcions.", "content": { "application/json": { "examples": { "Invalid email": { "summary": "Adreça de correu electrònic amb format incorrecte", "value": { "email": [ "Enter a valid email address." ] } }, "Unsupported locale": { "summary": "`options.locale` no pertany al conjunt admès", "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` fora de l'interval 4–8", "value": { "options": { "code_size": [ "Ensure this value is less than or equal to 8." ] } } } } } } }, "403": { "description": "Permís denegat. Es retorna quan falta la capçalera `x-api-key` (`{\"detail\": ...}`); una clau incorrecta, revocada o caducada retorna `401`. També es retorna abans de qualsevol enviament quan el saldo de l'organització no pot cobrir un crèdit de l'API de Verificació de correu electrònic (`{\"error\": ...}`).", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de l'organització no pot cobrir el preu de l'enviament", "value": { "error": "You don't have enough credits to perform this request." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Més de 300 sol·licituds d'escriptura en el minut 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 s'ha pogut enviar el correu electrònic per un motiu no relacionat amb l'adreça (no s'ha pogut contactar amb el proveïdor de correu electrònic, s'ha esgotat el temps d'espera o aquest ha refusat l'enviament en si), de manera que no s'ha enviat cap codi ni s'ha facturat o comptabilitzat cap intent d'enviament. Repeteix la mateixa sol·licitud.", "content": { "application/json": { "examples": { "Email delivery unavailable": { "summary": "El proveïdor de correu electrònic ha fallat després d'un reintent automàtic", "value": { "detail": "Email delivery is temporarily unavailable. Please try again." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/email/check/": { "post": { "summary": "Comprovar el codi de correu electrònic", "description": "Verifica l'OTP lliurat per [`POST /v3/email/send/`](/ca/standalone-apis/email-send) i obtén el resultat final de la verificació més intel·ligència de correu electrònic: capacitat de lliurament, exposició a filtracions (`is_breached` i la llista `breaches` d'una base de dades d'intel·ligència de filtracions), detecció de proveïdors d'un sol ús i ús duplicat de l'adreça entre les teves sessions.\n\n**Com troba la comprovació la verificació.** La coincidència es fa mitjançant la teva aplicació i l'adreça `email`; `request_id` no és una entrada. Es comprova la verificació pendent més recent creada durant els darrers **5 minuts**. Si no n'hi ha cap (mai enviada, ja finalitzada, no lliurable en el moment de l'enviament o de fa més de 5 minuts), l'endpoint retorna `200` amb `status: \"Expired or Not Found\"`.\n\n**Pressupost d'intents.** Cada verificació permet **3 intents de codi**. Els dos primers codis incorrectes retornen `status: \"Failed\"` amb els intents restants i `email: null`; el tercer codi incorrecte finalitza la verificació com a `Declined` amb una advertència `EMAIL_CODE_ATTEMPTS_EXCEEDED` i retorna l'informe complet de correu electrònic. Els codis es comparen sense distingir entre majúscules i minúscules (rellevant per a enviaments amb `alphanumeric_code`); només és vàlid el codi enviat més recentment.\n\n**Resultats.** `Approved`: codi correcte i cap risc de rebuig. `Declined`: terminal: el codi era correcte però ha coincidit un risc de rebuig (una acció `DECLINE` a continuació, una adreça a la llista de bloqueig o l'adreça s'ha trobat no lliurable en finalitzar), o s'ha esgotat el pressupost d'intents. `Failed`: codi incorrecte, queden intents. `Expired or Not Found`: res a comprovar. En `Approved`/`Declined`, el `request_id` coincideix amb el `request_id` de l'enviament (l'id de la sessió) i `email` inclou l'informe complet (`is_breached`, `breaches`, `is_disposable`, `is_undeliverable`, `warnings`, `lifecycle`, `matches`); en `Failed` i `Expired or Not Found`, el `request_id` és un UUID aleatori d'un sol ús.\n\n**Accions de risc.** `duplicated_email_action`, `breached_email_action` i `disposable_email_action` decideixen què passa quan es detecta el risc corresponent amb un codi correcte: `DECLINE` canvia l'estat final a `Declined`; `NO_ACTION` (per defecte) registra el risc a `email.warnings` sense afectar l'estat.\n\n**Facturació.** Les comprovacions són gratuïtes: el crèdit es consumeix amb l'enviament satisfactori.\n\n**Persistència de la sessió.** Una comprovació finalitzada actualitza la sessió creada per l'enviament (visible a la Business Console, consultable mitjançant `GET /v3/session/{sessionId}/decision/`) i activa un webhook `status.updated`.\n\n**Sandbox.** Les claus d'API de sandbox ometen tot el processament: qualsevol codi ben format (inclòs `123456`) retorna un payload estàtic `Approved` amb un objecte `email` simplificat (`status`, `email`, `is_breached`, `is_disposable`, `is_undeliverable`); l'entrada mal formada continua retornant `400`. No es persisteix res.\n\n**Autenticació.** Envia la clau d'API de la teva aplicació a la capçalera `x-api-key`. Les credencials absents o no vàlides retornen `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); aquesta API mai retorna `401`.\n\n**Límit de freqüència.** Pressupost d'escriptura compartit de 300 sol·licituds/min per clau d'API entre tots els endpoints POST/PATCH/DELETE; superar-lo retorna `429`.\n\n**Petjada social.** Estableix `enable_social` a `true` per afegir un bloc `email_social`: les plataformes en línia on aquesta adreça està registrada, amb recomptes per categoria i qualsevol detall de perfil disponible. `profiles_registered: 0` significa que s'han comprovat les plataformes i que l'adreça no s'ha trobat en cap d'elles: una resposta vàlida i facturable. El bloc no apareix quan no s'ha sol·licitat el complement o quan la comprovació no s'ha pogut completar, i en aquest cas no es factura. La facturació afegeix una unitat de `email_social` per sol·licitud al preu propi d'aquest 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 mateixa adreça de correu electrònic utilitzada a la crida corresponent [`POST /v3/email/send/`](/ca/standalone-apis/email-send). Això és el que enllaça la comprovació amb l'enviament.", "example": "alice@example.com" }, "code": { "type": "string", "maxLength": 10, "description": "L'OTP que ha rebut l'usuari final: 4–8 dígits, o 4–8 lletres/dígits quan s'ha utilitzat `alphanumeric_code: true` en el moment de l'enviament. La comparació no distingeix entre majúscules i minúscules.", "example": "123456" }, "duplicated_email_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Què fer quan la mateixa adreça ja ha estat utilitzada i aprovada per un usuari diferent (només compten les verificacions prèviament aprovades) (diferent `vendor_data`) de la teva aplicació. `DECLINE` canvia el `status` final a `Declined`; `NO_ACTION` registra el risc a `email.warnings` i emplena `email.matches`." }, "breached_email_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Què fer quan l'adreça apareix en filtracions de dades conegudes (`email.is_breached`). `DECLINE` canvia el `status` final a `Declined`; `NO_ACTION` registra el risc a `email.warnings`." }, "disposable_email_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Què fer quan el domini pertany a un proveïdor de correu d'un sol ús o temporal (`email.is_disposable`). `DECLINE` canvia el `status` final a `Declined`; `NO_ACTION` registra el risc a `email.warnings`." }, "enable_enrichment": { "type": "boolean", "default": false, "description": "Quan és `true`, també executa intel·ligència de correu electrònic a l'adreça: una puntuació de risc i el seu historial de filtracions. Es factura com una unitat de `email_intelligence_api` per sol·licitud ($0.05 a preu de tarifa) a més del preu propi d'aquest endpoint. La sol·licitud retorna `403` quan el teu saldo no pot cobrir-ho.", "example": false }, "email_intelligence_score_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acció quan la puntuació de risc de la intel·ligència de correu electrònic supera el llindar. `DECLINE` canvia l'`status` final a `Declined`; `NO_ACTION` registra el senyal sense rebutjar. Només té efecte quan `enable_enrichment` és `true`." }, "recent_email_breach_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acció quan l'adreça apareix en una filtració de dades coneguda i recent. `DECLINE` canvia el `status` final a `Declined`; `NO_ACTION` registra el senyal sense rebutjar. Només té efecte quan `enable_enrichment` és `true`." }, "frequent_email_breach_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acció quan l'adreça apareix en moltes filtracions de dades conegudes. `DECLINE` canvia el `status` final a `Declined`; `NO_ACTION` registra el senyal sense rebutjar. Només té efecte quan `enable_enrichment` és `true`." }, "enable_social": { "type": "boolean", "default": false, "description": "Quan és cert, també consulta la petjada social de l'adreça: les plataformes de correu electrònic, socials, professionals, de comerç electrònic i d'entreteniment on està registrada. Es factura com una unitat de `email_social` per sol·licitud a més del preu propi d'aquest endpoint.", "example": true }, "email_no_social_presence_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Acció quan la comprovació de petjada social no troba l'adreça registrada a cap de les plataformes que cobreix. En aquest endpoint només s'accepten NO_ACTION i DECLINE; REVIEW està disponible a la clau de configuració del flux de treball amb el mateix nom." } }, "required": [ "email", "code" ] }, "examples": { "Default": { "summary": "Registra qualsevol risc però no rebutgis mai automàticament", "value": { "email": "alice@example.com", "code": "123456" } }, "Strict risk policy": { "summary": "Rebutja automàticament bústies d'un sol ús i compromeses", "value": { "email": "alice@example.com", "code": "123456", "disposable_email_action": "DECLINE", "breached_email_action": "DECLINE" } } } } } }, "responses": { "200": { "description": "Comprovació completada — els codis incorrectes i les verificacions que falten també retornen `200`; inspecciona `status`, no el codi HTTP. `email` només s'emplena en resultats finalitzats (`Approved`/`Declined`), és `null` a `Failed`, i no apareix a `Expired or Not Found`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailVerificationCheckResponse" }, "examples": { "Approved": { "summary": "Codi correcte — adreça neta, informe complet de correu electrònic", "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": "Codi correcte; exposició a filtracions registrada com a advertència (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": "Codi incorrecte: l'usuari pot reintentar; request_id aquí és un UUID d'un sol ús", "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": "Codi correcte, però l'adreça és d'un sol ús i 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 hi ha cap verificació pendent per a aquesta adreça en els darrers 5 minuts", "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ó — embolcall d'errors de camp de DRF: una matriu de missatges per camp infractor.", "content": { "application/json": { "examples": { "Invalid email": { "summary": "Adreça de correu electrònic amb format incorrecte", "value": { "email": [ "Enter a valid email address." ] } }, "Missing code": { "summary": "`code` no s'ha inclòs al cos", "value": { "code": [ "This field is required." ] } } } } } }, "403": { "description": "Permís denegat. Es retorna quan falta la capçalera `x-api-key`; una clau incorrecta, revocada o caducada retorna `401`. Les comprovacions són gratuïtes, de manera que aquí no hi ha cap comprovació de crèdit.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Més de 300 sol·licituds d'escriptura en el minut 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": "Llista els fluxos de treball", "description": "Llista els teus fluxos de treball, de més nous a més antics, en un embolcall de paginació amb límit/desplaçament (`{count, next, previous, results}`, mida de pàgina per defecte de 50). Cada fila és una versió; `workflow_id` és l'identificador de grup estable i les noves sessions utilitzen la darrera versió `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": "Mida de la pàgina (nombre de fluxos de treball per pàgina)." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Nombre de files que cal ometre abans del primer flux de treball retornat." } ], "responses": { "200": { "description": "Una pàgina de fluxos de treball ordenada per `created_at` descendent, inclosa a l'embolcall de paginació. Cada element de `results` és un `WorkflowListItem`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Nombre total de versions del flux de treball per a l'aplicació." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la pàgina següent, o `null` a l'última pàgina." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la pàgina anterior, o `null` a la primera pàgina." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowListItem" } } } }, "examples": { "Two workflows": { "summary": "Un flux de treball de KYC per defecte i un esborrany de flux de treball 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 clau d'API, està mal formada, ha caducat o pertany a una aplicació diferent. Cos: `{\"detail\": \"You do not have permission to perform this action.\"}`. Actualitza el token mitjançant l'[Auth API](/ca/auth-api/get-credentials) i torna-ho a provar.", "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": "S'ha superat el límit de freqüència. Reintenta amb un retrocés exponencial i respecta qualsevol capçalera `Retry-After`." }, "500": { "description": "Error inesperat del servidor en generar la llista. La sol·licitud es pot reintentar amb seguretat." } }, "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": "Crea un flux de treball", "description": "Crea un flux de treball simple. Envia `features` en ordre d'execució (s'apliquen regles d'ordenació); el valor per defecte és `published` v1. El cos NOMÉS accepta els camps llistats a `SimpleWorkflowRequest`; qualsevol altra clau (incloent-hi `workflow_type`) es rebutja amb un 400. No és idempotent: cada crida crea un nou flux de treball. Màxim de 50 fluxos de treball per aplicació.", "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": "Flux de treball lineal de verificació d'identitat, prova de vida i coincidència 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": "Executa el cribratge AML després de la verificació d'identitat", "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": "Executa un qüestionari creat amb 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": "Flux de treball creat. El cos de la resposta és la configuració COMPLETA del flux de treball (la mateixa serialització sense processar de `VerificationSettings` que retorna `GET /v3/workflows/{settings_uuid}/`, ~190 camps: cada commutador de funcionalitat, llindar, acció i el `workflow_graph` generat), no l'element de llista compacte. Guarda l'`uuid` (també exposat com a `workflow_id`) per poder fer-hi referència en futures crides de creació de sessions. Nota: `features` és una cadena unida per `\" + \"` i els preus són números JSON.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDetail" }, "examples": { "Created (abbreviated)": { "summary": "Camps clau de l'objecte de configuració complet", "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ó. Causes habituals: una clau de nivell superior fora de la llista blanca admesa (p. ex., `workflow_type`), un valor de `feature` desconegut, una funcionalitat col·locada abans de la seva dependència (p. ex., `FACE_MATCH` abans d'`OCR`), una funcionalitat passiva (`AML`, `IP_ANALYSIS`, `DATABASE_VALIDATION`, `KYB_KEY_PEOPLE`) utilitzada com a primer pas, una funcionalitat `QUESTIONNAIRE` el `config.questionnaire_uuid` de la qual no existeix per a aquesta aplicació, una funcionalitat `SIGNATURE` que es publicaria sense cap document per signar, una funcionalitat `SIGNATURE` amb `signature_level: \"aes\"` quan Advanced (AES) no està disponible (`aes_not_available`, consulta `signature_availability` al flux de treball) o un llindar fora de rang. El cos és un objecte d'error de validació de DRF; les claus són noms de camps i els valors són arrays de missatges llegibles per humans.", "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 clau d'API, està mal formada, ha caducat o està restringida a una aplicació diferent. Actualitza-la mitjançant l'[Auth API](/ca/auth-api/get-credentials) i torna-ho a provar.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "415": { "description": "Tipus de mitjà no admès. Defineix `Content-Type: application/json` i envia un cos JSON." }, "429": { "description": "S'ha superat el límit de freqüència. Reintenta amb un retrocés exponencial." }, "500": { "description": "Error inesperat del servidor en crear el flux de treball. Es pot reintentar amb seguretat." } }, "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": "Obtenir el flux de treball", "description": "Obtén la configuració completa d'una versió del flux de treball mitjançant `settings_uuid`: commutadors de funcionalitats, llindars, documents permesos, graf, política de reintents, crides de retorn i preus.", "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 per versió del flux de treball (el valor `uuid` retornat per l'endpoint de llistat). Cada versió d'un flux de treball té el seu propi `settings_uuid`." } ], "responses": { "200": { "description": "Configuració completa del flux de treball. L'estructura és la serialització en brut de `VerificationSettings` (~190 camps: cada commutador de funcionalitat, llindar, acció d'advertència, configuració de documents permesos, el `workflow_graph`, política de reintents, callbacks i preus). L'exemple següent està abreujat. Notes: `features` és una cadena unida per `\" + \"` (p. ex. `\"OCR + LIVENESS\"`), els preus són números JSON i `is_editable` és `true` només per a versions `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": "Falta la clau d'API, està mal formada, ha caducat o està assignada a una aplicació diferent.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap flux de treball amb aquest `settings_uuid` per a l'aplicació autenticada. O bé l'UUID és incorrecte o pertany a una altra aplicació; Didit no distingeix expressament entre ambdós casos per evitar revelar l'existència de registres d'altres aplicacions.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Reintenta amb un retrocés exponencial." }, "500": { "description": "Error inesperat del servidor. Es pot reintentar amb seguretat." } }, "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": "Actualitza el flux de treball", "description": "Actualitza un flux de treball. La gestió de versions depèn del camp `status` que enviïs i de l'estat actual de la versió: (1) sense `status` en una versió **publicada** → la versió publicada s'actualitza directament (mateix `uuid`, mateixa `version`); (2) sense `status` en un **esborrany** → l'esborrany s'actualitza i es publica immediatament; (3) `status: \"published\"` en una versió **publicada** → es crea una NOVA versió publicada sota el mateix `workflow_id` (nou `uuid`, `version` + 1) i es retorna, i qualsevol esborrany existent al grup se suprimeix; (4) `status: \"draft\"` manté un esborrany com a esborrany (desat automàtic), però es rebutja amb 400 en una versió publicada (`\"Cannot revert a published version to draft.\"`). El cos accepta la mateixa llista blanca estricta de camps que la creació: les claus desconegudes es rebutgen amb 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 per versió del flux de treball que s'actualitzarà." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleWorkflowUpdateRequest" }, "examples": { "Replace features": { "summary": "Envia l'ordre complet de funcionalitats que vulguis", "value": { "features": [ { "feature": "OCR" }, { "feature": "AML" } ] } }, "Rename": { "summary": "Reanomenar un flux de treball", "value": { "workflow_label": "Premium KYC" } }, "Set as default": { "summary": "Fes que aquest flux de treball sigui el predeterminat de l'aplicació", "value": { "is_default": true } }, "Update config": { "summary": "Canviar la configuració de la funcionalitat", "value": { "features": [ { "feature": "OCR" }, { "feature": "LIVENESS", "config": { "face_liveness_method": "passive" } } ] } }, "Publish a draft": { "summary": "Promoure un esborrany a l'estat de publicat", "value": { "status": "published" } } } } } }, "responses": { "200": { "description": "Flux de treball actualitzat. El cos és la configuració COMPLETA de la versió resultant (la mateixa estructura `VerificationSettings` en brut que `GET /v3/workflows/{settings_uuid}/`). Quan l'actualització crea una nova versió (s'ha enviat `status: \"published\"` en una fila publicada), l'`uuid` i la `version` retornats difereixen dels que has modificat; utilitza l'`uuid` retornat per a les crides posteriors.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDetail" } } } }, "400": { "description": "Error de validació — una clau de primer nivell fora de la llista blanca acceptada, una funcionalitat desconeguda, una ordenació no vàlida, un llindar fora de rang, referència a un qüestionari inexistent, una funcionalitat `SIGNATURE` que es posaria en producció sense cap document per signar, una nova funcionalitat `SIGNATURE` a `signature_level: \"aes\"` mentre l'Avançada (AES) no està disponible (`aes_not_available`, consulta `signature_availability` al flux de treball; un pas que ja emmagatzema `aes` el conserva), o `status: \"draft\"` enviat per a una versió publicada (`\"Cannot revert a published version to draft.\"`). El cos de la resposta és un error de validació de DRF indexat pel nom del camp." }, "403": { "description": "Falta la clau d'API o no és vàlida.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap flux de treball amb aquest `settings_uuid` per a l'aplicació autenticada." }, "415": { "description": "Tipus de mitjà no admès. Defineix `Content-Type: application/json`." }, "429": { "description": "S'ha superat el límit de freqüència. Reintenta amb un retrocés exponencial." }, "500": { "description": "Error inesperat del servidor. Es pot reintentar amb seguretat." } }, "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": "Elimina el flux de treball", "description": "Elimina permanentment una versió del flux de treball (sense opció de desfer). Les sessions existents mantenen els seus resultats de verificació, però la seva referència al flux de treball s'esborra; altres versions del mateix grup de `workflow_id` no s'eliminen.", "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 per versió del flux de treball que s'eliminarà." } ], "responses": { "204": { "description": "Flux de treball suprimit. El cos de la resposta és buit." }, "403": { "description": "Falta la clau d'API o no és vàlida.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap flux de treball amb aquest `settings_uuid` per a l'aplicació autenticada.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Reintenta amb un retrocés exponencial." }, "500": { "description": "Error inesperat del servidor. Es pot reintentar amb seguretat." } }, "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": "Llista els qüestionaris", "description": "Llista els teus qüestionaris, de més nous a més antics, en un embolcall de paginació amb límit/desplaçament (`{count, next, previous, results}`, mida de pàgina per defecte de 50). Cada fila és una versió; `questionnaire_group_id` és l'identificador de grup estable resolt a la darrera versió `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": "Mida de la pàgina (nombre de qüestionaris per pàgina)." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Nombre de files que cal ometre abans del primer qüestionari retornat." } ], "responses": { "200": { "description": "Una pàgina de qüestionaris ordenada per `created_at` descendent, inclosa a l'embolcall de paginació. Cada element de `results` és un `QuestionnaireListItem`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Nombre total de versions de qüestionari per a l'aplicació." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la pàgina següent, o `null` a l'última pàgina." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la pàgina anterior, o `null` a la primera pàgina." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/QuestionnaireListItem" } } } }, "examples": { "One questionnaire": { "summary": "Un qüestionari bilingüe senzill", "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": "Falta la clau d'API, està mal formada, ha caducat o està assignada a una aplicació diferent.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Reintenta amb un retrocés exponencial." }, "500": { "description": "Error inesperat del servidor en generar la llista. És segur reintentar." } }, "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": "Crea un qüestionari", "description": "Crea un qüestionari lineal simple. Envia `form_elements` en l'ordre de visualització; les ramificacions i els grups repetibles requereixen la Console. El valor per defecte és `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": "Qüestionari bàsic", "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": "Qüestionari creat. La resposta inclou el `questionnaire_id` — desa'l per fer referència a aquest qüestionari des de fluxos de treball o futures crides d'actualització/eliminació.", "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ó. Causes habituals: un `element_type` desconegut, un camp traduïble al qual li falta una traducció per a un dels `languages`, falta `en` a `languages`, `default_language` no és a `languages`, una opció sense `label`, una pregunta que té `branches`/`required_if`/`repeatable_config` (no admès per aquest endpoint) o l'enviament d'un `graph` en brut en lloc de `form_elements`. El cos és un error de validació de DRF indexat pel nom del camp.", "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": "Falta la clau d'API, està mal formada, ha caducat o està assignada a una aplicació diferent.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "415": { "description": "Tipus de mitjà no admès. Defineix `Content-Type: application/json` i envia un cos JSON." }, "429": { "description": "S'ha superat el límit de freqüència. Reintenta amb un retrocés exponencial." }, "500": { "description": "Error inesperat del servidor en crear el qüestionari. Es pot reintentar amb seguretat." } }, "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": "Obtenir el qüestionari", "description": "Obtén els detalls complets del qüestionari per a una versió mitjançant `questionnaire_uuid`: títol, `languages`, `graph` canònic, `sections` derivades i metadades de la versió.", "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 per versió del qüestionari (el valor `uuid` retornat per l'endpoint de llistat, també retornat com a `questionnaire_id` en els endpoints de detall)." } ], "responses": { "200": { "description": "Detall complet del qüestionari, incloent-hi el `graph` canònic, la visualització derivada de `sections`, les metadades de versió i `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": "Falta la clau d'API, està mal formada, ha caducat o està assignada a una aplicació diferent.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap qüestionari amb aquest `questionnaire_uuid` per a l'aplicació autenticada. O bé l'UUID és incorrecte o pertany a una altra aplicació; l'API no distingeix expressament entre ambdós casos.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Reintenta amb un retrocés exponencial." }, "500": { "description": "Error inesperat del servidor. Es pot reintentar amb seguretat." } }, "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": "Actualitza el qüestionari", "description": "Actualitza un qüestionari. La gestió de versions depèn del camp `status` que enviïs i de l'estat actual de la versió: (1) sense `status` en una versió **publicada** → la versió publicada s'actualitza directament (mateix `questionnaire_id`, mateixa `version`); (2) sense `status` en un **esborrany** → l'esborrany s'actualitza i es publica immediatament; (3) `status: \"published\"` en una versió **publicada** → es crea una NOVA versió publicada sota el mateix `questionnaire_group_id` (nou `questionnaire_id`, `version` + 1) i es retorna, i qualsevol esborrany existent al grup se suprimeix; (4) `status: \"draft\"` manté un esborrany com a esborrany (desat automàtic), però es rebutja amb 400 en una versió 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 per versió del qüestionari que s'actualitzarà." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleQuestionnaireUpdateRequest" }, "examples": { "Rename": { "summary": "Reanomenar un qüestionari", "value": { "title": "Updated Customer Onboarding" } }, "Replace questions": { "summary": "Substitueix la llista lineal completa de preguntes", "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": "Qüestionari actualitzat. El cos és l'últim estat de la versió resultant — la versió actualitzada in situ, o la versió publicada creada de nou quan has enviat `status: \"published\"` en una fila publicada (en aquest cas `questionnaire_id` i `version` difereixen dels que has modificat). El `questionnaire_id` de la resposta és l'UUID per versió; utilitza `questionnaire_group_id` si necessites l'identificador de grup estable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionnaireDetail" } } } }, "400": { "description": "Error de validació: `element_type` desconegut, falta una traducció, camps condicionals/de bifurcació no admesos, falta `en` a `languages`, `default_language` no és a `languages`, opció sense etiqueta, enviament d'un `graph` en brut o `status: \"draft\"` en una versió publicada (`\"Cannot revert a published version to draft.\"`). El cos de la resposta és un error de validació de DRF indexat pel nom del camp." }, "403": { "description": "Falta la clau d'API o no és vàlida.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap qüestionari amb aquest `questionnaire_uuid` per a l'aplicació autenticada." }, "415": { "description": "Tipus de mitjà no admès. Defineix `Content-Type: application/json`." }, "429": { "description": "S'ha superat el límit de freqüència. Reintenta amb un retrocés exponencial." }, "500": { "description": "Error inesperat del servidor. Es pot reintentar amb seguretat." } }, "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": "Elimina el qüestionari", "description": "Elimina permanentment una versió del qüestionari (sense opció de desfer). Les respostes emmagatzemades del qüestionari vinculades a aquesta versió s'eliminen amb ella, i les sessions que hi fan referència perden l'enllaç; altres versions del mateix grup no s'eliminen. Els fluxos de treball que hi feien referència continuen executant-se, però el pas del qüestionari ja no la pot carregar.", "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 per versió del qüestionari que s'eliminarà." } ], "responses": { "204": { "description": "Qüestionari eliminat. El cos de la resposta és buit." }, "403": { "description": "Falta la clau d'API o no és vàlida.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap qüestionari amb aquest `questionnaire_uuid` per a l'aplicació autenticada.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Reintenta amb un retrocés exponencial." }, "500": { "description": "Error inesperat del servidor. Es pot reintentar amb seguretat." } }, "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": "Llista els usuaris", "description": "Llista els [usuaris](/entities/users) que Didit reuneix a partir de sessions de KYC que comparteixen el mateix `vendor_data` (cadena de text lliure, NO pas un UUID), a més dels usuaris creats mitjançant l'API. Paginat, ordenat per `last_session_at` descendent. Aquest endpoint no admet paràmetres de filtre ni de cerca; obtén les pàgines i filtra al costat del client.", "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": "Mida de la pàgina. Per defecte és 50 si s'omet. No hi ha cap màxim imposat, però mantén les pàgines petites per reduir la latència." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Desplaçament basat en zero del primer registre a retornar. És preferible seguir l'URL `next` de la pàgina anterior abans que calcular-ho manualment." } ], "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": "Llista paginada d'usuaris amb estat de verificació, recomptes de sessions i desglossament de funcionalitats.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Nombre de files coincidents: exacte fins a 100, limitat a 100 a partir d'aquí per motius de rendiment. No el facis servir per detectar la darrera pàgina; confia en canvi que `next` sigui `null`." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta de la pàgina següent, o `null` a l'última pàgina." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta de la pàgina anterior, o `null` a 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 s'han proporcionat credencials. Les sol·licituds a rutes `/v3/users/*` sense una capçalera `x-api-key` (o token `Authorization: Bearer`) són rebutjades pel middleware d'autenticació abans d'arribar a l'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 clau no pot llistar usuaris per a aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `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": "Obtenir l'usuari", "description": "Obté un [usuari](/entities/users) per `vendor_data` (coincidència exacta). Afegeix `metadata`, `comments` i `updated_at` a la visualització de llista, i canvia `tags` al format detallat d'enllaç d'etiquetes.", "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": "El teu identificador únic per a l'usuari — una cadena de text lliure (NO un UUID). És el mateix valor que vas passar com a `vendor_data` quan vas crear la sessió que va introduir aquest usuari per primera vegada, que coincideix exactament amb el valor enviat.", "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": "Detall complet de l'usuari, incloent-hi metadades, registre de comentaris/activitat i dades agregades de la sessió.", "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 s'han proporcionat credencials. Les sol·licituds a rutes `/v3/users/*` sense una capçalera `x-api-key` (o token `Authorization: Bearer`) són rebutjades pel middleware d'autenticació abans d'arribar a l'API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Clau d'API no vàlida o revocada, o la clau no pot llegir els usuaris d'aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap usuari amb el `vendor_data` proporcionat per a aquesta aplicació.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualitza l'usuari", "description": "Actualització parcial d'un usuari: `display_name`, `full_name`, `date_of_birth`, `status`, `metadata`, `approved_emails`/`approved_phones`/`issuing_states`. `metadata` es reemplaça completament. Canviar `status` aquí funciona com a [Update User Status](#patch-/v3/users/-vendor_data-/update-status/): registra una activitat `STATUS_CHANGED` amb el camp opcional `reason`, i `BLOCKED` afegeix el `vendor_data` a la llista de bloqueig del sistema (canviar a un estat diferent de `BLOCKED` elimina aquesta entrada). Els canvis a `display_name`, `full_name`, `date_of_birth` o `metadata` es registren com a activitat `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": "El teu identificador únic per a l'usuari (cadena de text lliure, 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": "Usuari actualitzat. Es retorna el registre d'usuari complet actualitzat (amb la mateixa estructura que a 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": "Cos no vàlid — normalment un `status` desconegut o un `date_of_birth` que no està en `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 s'han proporcionat credencials. Les sol·licituds a rutes `/v3/users/*` sense una capçalera `x-api-key` (o token `Authorization: Bearer`) són rebutjades pel middleware d'autenticació abans d'arribar a l'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 clau no pot actualitzar usuaris per a aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap usuari amb el `vendor_data` proporcionat per a aquesta aplicació.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `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": "Nom complet de l'usuari" }, "display_name": { "type": "string", "nullable": true, "description": "Nom visible personalitzat per a aquest usuari" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Data de naixement en format YYYY-MM-DD" }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Estat del cicle de vida de l'usuari. Un canvi es registra com una activitat `STATUS_CHANGED`, i `BLOCKED` afegeix el `vendor_data` a la llista de bloqueig del sistema (sortir de `BLOCKED` elimina aquesta entrada)." }, "metadata": { "type": "object", "nullable": true, "description": "Objecte JSON arbitrari que adjuntes a l'usuari. **Substitueix completament** les metadades existents en actualitzar; fusiona-les al costat del client si només vols afegir claus." }, "approved_emails": { "type": "array", "items": { "type": "string" }, "description": "Adreces de correu electrònic verificades per a aquest usuari, p. ex. `[\"john@example.com\"]`. Substitueix completament la llista emmagatzemada." }, "approved_phones": { "type": "array", "items": { "type": "string" }, "description": "Números de telèfon verificats per a aquest usuari. Substitueix completament la llista emmagatzemada." }, "issuing_states": { "type": "array", "items": { "type": "string" }, "description": "Països emissors (ISO 3166-1 alfa-3), p. ex. `[\"USA\"]`. Substitueix completament la llista emmagatzemada." }, "reason": { "type": "string", "nullable": true, "maxLength": 1000, "description": "Per què ha canviat l'estat. Es registra a l'entrada de canvi d'estat de l'activitat de l'usuari (`comments[].comment`, i **Activitat** a la Business Console), només quan l'estat canvia realment. Els webhooks no l'inclouen." } } }, "examples": { "Rename": { "summary": "Establir el nom visible", "value": { "display_name": "Jane S." } }, "Override status": { "summary": "Marca l'usuari per a revisió", "value": { "status": "FLAGGED" } }, "Add metadata": { "summary": "Substitueix el JSON de metadades", "value": { "metadata": { "tier": "premium", "risk_level": "low" } } }, "Fix extracted DOB": { "summary": "Corregir els camps de perfil extrets", "value": { "full_name": "Jane Elizabeth Smith", "date_of_birth": "1985-11-22" } }, "Flag with reason": { "summary": "Marca l'usuari i registra'n el motiu", "value": { "status": "FLAGGED", "reason": "Address does not match the billing country" } } } } } } } }, "/v3/users/{vendor_data}/generate-pdf/": { "get": { "summary": "Descarrega l'informe complet en PDF de l'historial de l'usuari", "description": "Renderitza i descarrega un PDF apte per a compliment que conté l'historial complet de verificació de l'usuari identificat per `vendor_data`. És el mateix document que genera la Console des de **User detail → Actions → Download PDF**, de manera que les exportacions periòdiques de compliment ja no requereixen que una persona faci clic a la Console.\n\n**Què conté l'informe.** Una portada amb el resum del perfil (nom, data de naixement, estats emissors, correus electrònics i telèfons aprovats), l'últim estat de cada funcionalitat, els comptadors de sessions i un índex de les sessions incloses; seguit de l'informe estàndard de cada sessió inclosa, en ordre cronològic (de més antiga a més recent). L'informe de cada sessió és el mateix document que retorna `GET /v3/session/{sessionId}/generate-pdf/` per a aquesta sessió.\n\n**Sessions aptes.** Només s'inclouen les sessions de Verificació d'usuaris (KYC) en estat `Approved`, `Declined`, `In Review` o `Kyc Expired`; les sessions en qualsevol altre estat s'ometen. Si l'usuari no té cap sessió en un d'aquests estats, l'endpoint retorna `403` (vegeu més avall).\n\n**Límit.** L'informe està limitat a les **20 sessions notificables més recents**. Quan un usuari en té més, s'inclouen les 20 més noves i la portada indica quantes sessions més antigues han quedat excloses. Fes servir `GET /v3/sessions/?vendor_data=…` per obtenir la llista completa en format JSON.\n\n**Personalització de marca.** Si la teva aplicació té personalització de marca blanca, la portada i l'informe de cada sessió es renderitzen amb el teu logotip i l'URL de la teva política de privadesa; en cas contrari, porten la marca de Didit. Els informes es renderitzen en anglès; no hi ha cap paràmetre d'idioma.\n\n**Sense memòria cau.** Cada crida torna a renderitzar el PDF a partir de les dades actuals, de manera que un informe generat després d'una revisió manual reflecteix la decisió del revisor. Dues crides per al mateix usuari poden produir fitxers diferents byte a byte; arxiva el fitxer descarregat si necessites una còpia immutable.\n\n**Latència.** La renderització és síncrona i descarrega totes les imatges emmagatzemades de cada sessió inclosa, de manera que un usuari amb moltes sessions amb fitxers multimèdia pot trigar desenes de segons. Fes servir un temps d'espera de lectura de client generós (es recomanen 120 s) i transmet el cos directament al disc. La generació s'atura segons un pressupost de temps al servidor en comptes d'executar-se fins que el teu client es rendeixi: si s'assoleix aquest pressupost, la resposta continua sent un PDF vàlid que conté les sessions més recents, i la portada indica quantes se n'han omès.\n\n**Abast.** L'usuari es resol dins de l'aplicació propietària de la clau d'API. Una clau mai no pot exportar un usuari d'una altra aplicació: aquest usuari no existeix per a ella i l'endpoint retorna `404`.\n\n**Barra final.** La ruta canònica acaba amb una barra final (`…/generate-pdf/`). Una sol·licitud sense aquesta barra es processa directament amb la mateixa resposta; no hi ha cap redirecció `301`, de manera que cap client ha de seguir redireccions i `curl` no necessita `-L`. Fes servir l'URL amb barra com als exemples.", "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": "El teu identificador únic per a l'usuari — una cadena de text lliure (NO un UUID). És el mateix valor que vas passar com a `vendor_data` quan vas crear les sessions de l'usuari, que coincideix exactament com s'ha enviat. Codifica'l com a URL; un valor que contingui `/` no es pot adreçar mitjançant aquesta ruta.", "example": "user-abc-123" } ], "responses": { "200": { "description": "El document PDF renderitzat, retornat directament com a binari `application/pdf`: no hi ha cap contenidor JSON ni cap redirecció d'URL de descàrrega. El cos comença amb els bytes màgics `%PDF`. Guarda'l en un fitxer `.pdf` o transmet-lo directament a qui fa la crida.", "headers": { "Content-Disposition": { "description": "`attachment; filename=user_{didit_internal_id}.pdf` — el fitxer rep el nom de l'identificador estable de Didit de l'usuari (`didit_internal_id` a `GET /v3/users/{vendor_data}/`), no pas de `vendor_data`.", "schema": { "type": "string", "example": "attachment; filename=user_f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418.pdf" } }, "Content-Length": { "description": "Mida total del PDF en bytes; el cos no està fragmentat.", "schema": { "type": "integer", "example": 148213 } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "No s'han proporcionat credencials. Les sol·licituds a rutes `/v3/users/*` sense una capçalera `x-api-key` (o token `Authorization: Bearer`) són rebutjades pel middleware d'autenticació abans d'arribar a l'API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Fallada d'autorització o d'aptitud. Distingeix les dues mitjançant la cadena `detail`:\n\n- `\"You do not have permission to perform this action.\"` — la clau d'API no és vàlida o està revocada, o la sol·licitud porta un token d'usuari de la Console en lloc d'una clau d'API d'aplicació.\n- `\"This user has no sessions in review, declined, approved or kyc expired to report.\"` — l'usuari existeix a la teva aplicació però cap de les seves sessions es troba encara en un estat apte per a l'informe (per exemple, totes les sessions encara estan `In Progress`, o l'usuari s'ha creat mitjançant `POST /v3/users/create/` i no s'ha verificat mai). Espera un webhook `status.updated` abans de sol·licitar l'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": "Clau d'API revocada o no vàlida, o bé un token d'usuari de la Console", "value": { "detail": "You do not have permission to perform this action." } }, "No reportable sessions": { "summary": "L'usuari existeix però no té cap sessió en estat Aprovada / Rebutjada / En revisió / KYC caducat", "value": { "detail": "This user has no sessions in review, declined, approved or kyc expired to report." } } } } } }, "404": { "description": "No existeix cap usuari amb el `vendor_data` proporcionat a l'aplicació vinculada a la clau d'API. Els usuaris d'altres aplicacions són invisibles per a aquesta clau i retornen el mateix `404`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "User not found." } } }, "examples": { "Unknown user": { "summary": "vendor_data no coincideix amb cap usuari d'aquesta aplicació", "value": { "detail": "User not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. La generació de PDF té un límit dedicat de **50 sol·licituds per minut per credencial** (clau d'API, token Bearer o IP d'origen si no s'ha autenticat), compartit entre aquest endpoint i `GET /v3/session/{sessionId}/generate-pdf/`, a més del límit global de GET de 600/min. Espera els segons indicats a `Retry-After` (també reflectits a les capçaleres `X-RateLimit-*`) i després reintenta-ho. Els informes no s'emmagatzemen a la memòria cau del servidor, de manera que és millor descarregar cada informe un sol cop i desar el fitxer en comptes de tornar-lo a sol·licitar.", "headers": { "Retry-After": { "description": "Segons d'espera abans de reintentar la sol·licitud.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Nombre màxim de generacions de PDF permeses a la finestra actual (50).", "schema": { "type": "integer", "example": 50 } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Marca de temps Unix (segons) en què es reinicia la finestra actual.", "schema": { "type": "integer", "example": 1750000000 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Explicació fàcil de llegir de la superació del límit de freqüència.", "example": "Session PDF generation rate limit exceeded. You can make up to 50 requests per minute." } } }, "examples": { "Throttled": { "summary": "Més de 50 generacions de PDF en un minut des de la mateixa 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 usuaris en lot", "description": "**Elimina permanentment** usuaris: els registres d'usuari s'eliminen de manera permanent. Per al bloqueig habitual, utilitza preferentment [Actualitza l'estat de l'usuari](#patch-/v3/users/-vendor_data-/update-status/) amb `BLOCKED`. Selecciona usuaris amb `vendor_data_list`, amb `didit_internal_id_list`, o amb tots dos alhora; o passa `delete_all: true`. Aquest endpoint mai restringeix `delete_all` mitjançant filtres. Els filtres de Persones de la consola es rebutgen amb un `400` (consulta la resposta `400`), de manera que una intenció restringida no es converteixi en un esborrat complet. Dues excepcions: `filter_has_approved_sessions` i `filter_has_declined_sessions` no es rebutgen ni s'apliquen, de manera que amb `delete_all: true` continuen eliminant tots els usuaris; no els enviïs.\n\n**Plantilles biomètriques:** tret que defineixis `retain_face_embeddings` a `true`, qualsevol plantilla biomètrica sense imatges conservada per a aquests usuaris després de l'eliminació de la sessió (consulta `/v3/biometric-templates/`) es purga abans d'eliminar l'usuari, de manera que la persona deixi de coincidir en la detecció de duplicats i a Cerca facial. Amb `retain_face_embeddings: true` i `face_retention_days`, tries conservar una plantilla biomètrica sense imatges per persona durant aquest nombre de dies, i no es conserva res més sobre la persona. Si no es pot purgar una plantilla perquè un magatzem biomètric no està disponible, la crida retorna `503`, no s'elimina cap usuari de la sol·licitud i repetir la sol·licitud completa la tasca.\n\n**Informes regulatoris presentats:** si les dades seleccionades formen part d'un informe regulatori finalitzat, es rebutja tota la sol·licitud amb un `409` i no s'elimina res. El cos utilitza `code: in_filed_report` i identifica cada informe amb `uuid`, `report_number`, `report_type` i `case_uuid`. Elimina els informes i, tot seguit, repeteix la sol·licitud.", "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`. Les dues llistes es poden combinar i s'aplica una operació OR entre elles. Quan `delete_all` és `true`, té prioritat i s'ignoren totes dues llistes.", "properties": { "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Els teus propis identificadors a eliminar, coincidits exactament com es van enviar." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "ID interns d'usuari de Didit per eliminar: el `didit_internal_id` retornat pels endpoints de creació i obtenció." }, "delete_all": { "type": "boolean", "default": false, "description": "Si és `true`, elimina tots els usuaris de l'aplicació." }, "retain_face_embeddings": { "type": "boolean", "default": false, "description": "La teva elecció explícita de conservar una plantilla biomètrica sense imatge de cada persona suprimida per a la detecció de duplicats, durant `face_retention_days`. Tota la resta sobre la persona se suprimeix. Omet-ho, o envia `false`, per suprimir les plantilles amb els usuaris. Quan és `true`, `face_retention_days` és obligatori." }, "face_retention_days": { "type": "integer", "minimum": 1, "maximum": 3650, "description": "Nombre de dies que es conserva la plantilla biomètrica sense imatge quan `retain_face_embeddings` és `true`. Obligatori amb aquest paràmetre, i rebutjat sense ell amb un `400` a `face_retention_days`.", "example": 365 } } }, "examples": { "Specific users": { "summary": "Elimina usuaris per vendor_data", "value": { "vendor_data_list": [ "user-123", "user-456" ] } }, "By Didit internal ID": { "summary": "Elimina usuaris per didit_internal_id", "value": { "didit_internal_id_list": [ "3f1c0d3e-8f0a-4c2e-9a3d-9b1f5f4a2c11" ] } }, "All users": { "summary": "Esborra tots els usuaris d'aquesta aplicació", "value": { "delete_all": true } }, "Keep face templates": { "summary": "Elimina usuaris i mantén plantilles facials anònimes durant 365 dies", "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": "Usuaris eliminats. Retorna el nombre d'usuaris realment eliminats.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "integer", "description": "Nombre d'usuaris eliminats (exclou els valors de vendor_data que no han coincidit amb res)." } } }, "examples": { "Deleted some": { "value": { "deleted": 2 } }, "Nothing matched": { "value": { "deleted": 0 } } } } } }, "400": { "description": "Error de validació; no s'elimina res. Els errors estan indexats per nom de camp. Sense cap selector (cap de les dues llistes i `delete_all` no és `true`), el cos és `{\"vendor_data_list\": [\"This field is required unless delete_all is true.\"]}`; una llista buida es rebutja sota la seva pròpia clau amb `\"This list may not be empty.\"`. Un filtre exclusiu 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`) es rebutja sempre que contingui un valor, fins i tot `false`, amb un objecte indexat per cadascun d'aquests camps. Qualsevol altra clau `filter_*` desconeguda es rebutja amb `\"Unknown filter.\"`.", "content": { "application/json": { "examples": { "Missing selector": { "summary": "No s'ha proporcionat 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 s'han proporcionat credencials. Les sol·licituds a rutes `/v3/users/*` sense una capçalera `x-api-key` (o token `Authorization: Bearer`) són rebutjades pel middleware d'autenticació abans d'arribar a l'API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Clau d'API no vàlida o revocada, o la clau no pot suprimir usuaris per a aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } }, "503": { "description": "Un magatzem biomètric no estava disponible en conservar o purgar una plantilla biomètrica. No s'ha eliminat res; repeteix la mateixa sol·licitud. Els reintents són idempotents i convergeixen 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": "No s'elimina res. `code` n'indica el motiu: `in_filed_report` quan la selecció inclou una persona en un informe regulador finalitzat, `subject_deletion_in_progress` quan una altra sol·licitud encara està eliminant una de les persones seleccionades. Repeteix la sol·licitud quan hagi acabat aquesta eliminació.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/InFiledReportError" }, { "$ref": "#/components/schemas/SubjectDeletionInProgressError" } ] } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/sessions/delete/": { "post": { "summary": "Suprimir sessions de KYC en bloc per session_number", "description": "Elimina de forma massiva sessions de Verificació d'usuaris (KYC) mitjançant el seu `session_number` numèric, o totes les sessions de KYC de la teva aplicació amb `delete_all: true`.\n\n`session_number` és el comptador incremental fàcil de llegir que es mostra a la llista de sessions de la Console i que retornen com a `session_number` els endpoints de creació de sessió i de decisió; **no** és el UUID `session_id`. Per eliminar una sessió per UUID, o per eliminar una sessió de Verificació d'empreses (KYB), que aquest endpoint mai no modifica, utilitza `DELETE /v3/session/{sessionId}/delete/`.\n\n**S'eliminen fins a 20 sessions a la mateixa sol·licitud; si n'hi ha més, s'executen com una tasca.** El nombre de sessions coincidents determina el comportament, tant si se seleccionen mitjançant `session_numbers` com amb `delete_all`:\n- Fins a 20 sessions coincidents: s'eliminen abans de la resposta, que és `200` amb una entrada per sessió a `results[]`.\n- Més de 20: la resposta és `202` amb una tasca d'eliminació, i les sessions s'eliminen en segon pla. Fes sondeig a `GET /v3/sessions/delete/{job_id}/` fins que `status` sigui `COMPLETED` o `FAILED`. Una tasca informa dels recomptes per resultat, mai de quines sessions ha eliminat. Una tasca amb `delete_all` només elimina les sessions creades abans de la sol·licitud; les sessions iniciades mentre s'executa no s'eliminen.\n\nCada sessió eliminada rep exactament el mateix tractament que a l'endpoint d'eliminació d'una sola sessió: la sessió, cada intent de verificació que conté, la seva decisió i dades extretes, els seus registres de funcionalitats relacionats (verificació d'identitat, rostre, prova de vida, coincidència facial, etc.) i tots els seus fitxers emmagatzemats s'eliminen, desapareix de tots els endpoints de lectura i els URL de fitxers multimèdia emesos prèviament deixen de resoldre's. Els lliuraments de webhook que encara estiguin en cua per a una sessió eliminada, així com els seus reintents, es descarten; els webhooks ja lliurats no es veuen afectats. Les entrades de la llista de bloqueig **no** s'eliminen, els crèdits ja consumits **no** es reemborsen i les entitats User pare **no** s'eliminen (utilitza `POST /v3/users/delete/` per a aquestes); no s'emet cap webhook per l'eliminació. L'eliminació és permanent i irreversible.\n\n**Semàntica de selecció:**\n- Amb `delete_all: true` pots restringir la selecció amb els filtres de `GET /v3/sessions/`, cadascun amb el prefix `filter_` (per exemple `filter_status`, `filter_workflow_id`, `filter_date_from`). Els filtres que accepten diversos valors a List Sessions (`status`, `workflow_id`, `country`, `region`, `document_type`, `document_name`, `session_type`, `warning`, `organization_name`) admeten una cadena separada per comes o una matriu; els altres prenen un sol valor. Un valor buit s'ignora. Els filtres només s'apliquen juntament amb `delete_all`, i una tasca d'eliminació aplica els mateixos filtres.\n- Una clau `filter_*` desconeguda, o un valor de filtre que no es pugui llegir, rebutja tota la sol·licitud amb `400` abans que s'elimini res, de manera que un filtre mal escrit mai no amplia l'eliminació a totes les sessions.\n- Les entrades a `session_numbers` que no coincideixin amb una sessió de KYC activa a la teva aplicació (números desconeguts, sessions ja eliminades o sessions que pertanyen a una altra aplicació) s'**ometen silenciosament**: no apareixen a `results` i no es comptabilitzen al `total` d'una tasca.\n- Els errors de validació (una entrada no numèrica, una llista buida, no proporcionar ni `session_numbers` ni `delete_all`, o una conservació de plantilles que l'aplicació no pugui complir) rebutgen **tota la sol·licitud** amb `400` i no eliminen res.\n- Les sessions s'eliminen en grups. Si un grup no es pot eliminar (per exemple, perquè un servei d'emmagatzematge no està disponible), cada sessió d'aquest grup es notifica com a `face_retention_outcome: failed_retryable` i es manté; els altres grups no es veuen afectats. Repeteix la sol·licitud per a aquestes sessions. Una tasca reintenta aquest grup automàticament.\n- No hi ha cap límit documentat per a la longitud de la llista; el límit de freqüència d'escriptura compartit (a sota) és el límit pràctic.\n\n**Dades biomètriques facials:** els camps opcionals `retain_face_embeddings`, `face_retention_days`, `face_retention_deadline`, `deletion_instruction` i `instruction_id` tenen el mateix significat que a `DELETE /v3/session/{sessionId}/delete/` i s'apliquen a cada sessió coincident. Cada resultat informa del seu propi `face_retention_outcome`.\n\n**Resposta:** `200 OK` amb `results[]` per a un màxim de 20 sessions coincidents, o `202 Accepted` amb una tasca d'eliminació si n'hi ha més. Cada resultat confirma l'eliminació excepte `face_retention_outcome: failed_retryable`, que informa d'una sessió que NO s'ha eliminat i que s'hauria de reintentar. Les versions anteriors d'aquest endpoint retornaven `204 No Content`; actualitza els clients que validin `204`.\n\n**Idempotència:** repetir la mateixa sol·licitud no elimina res més: s'ometen els números que ja no coincideixen amb una sessió.\n\n**`delete_all: true` (destructiu):** elimina **totes** les sessions de KYC restants de l'aplicació; `session_numbers` s'ignora quan s'estableix. No hi ha cap pas de confirmació ni opció de desfer.\n\n**Autenticació:** clau d'API a la capçalera `x-api-key`. Les credencials absents o no vàlides retornen `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); aquesta API mai no retorna `401`.\n\n**Límit de freqüència:** pressupost d'escriptura compartit de 300 sol·licituds/min per clau d'API en tots els endpoints POST/PATCH/DELETE; si se supera, es retorna `429`.\n\nAquest endpoint només accepta claus d'API. Els tokens Bearer d'usuari de la Business Console es rebutgen amb `403` (a diferència de l'eliminació d'una sola sessió, que accepta tots dos).\n\n**Informes regulatoris presentats:** si les dades seleccionades formen part d'un informe regulatori finalitzat, es rebutja tota la sol·licitud amb `409` i no s'elimina res. El cos utilitza `code: in_filed_report` i indica el nom de cada informe amb `uuid`, `report_number`, `report_type` i `case_uuid`. Elimina els informes i després repeteix la sol·licitud.", "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": "Valors numèrics de `session_number` de les sessions de KYC que cal eliminar, com a cadenes que només contenen dígits (els números JSON també s'accepten i es converteixen). Obligatori tret que `delete_all` sigui `true`; una llista buida retorna `400`. Qualsevol entrada que no sigui un dígit rebutja tota la sol·licitud amb `400` (tret que `delete_all` sigui `true`, cas en què s'omet la validació i s'ignoren les entrades). Els números que no coincideixin amb una sessió activa a la teva aplicació s'ometen silenciosament.", "items": { "type": "string", "pattern": "^[0-9]+$", "example": "1001" }, "minItems": 1, "example": [ "1001", "1002", "1003" ] }, "delete_all": { "type": "boolean", "description": "Quan és `true`, s'eliminen totes les sessions de KYC restants a l'aplicació que fa la crida i s'ignora `session_numbers`, tret que restringeixis la selecció amb claus `filter_*`. Si hi ha més de 20 sessions coincidents, s'executa com una tasca d'eliminació (`202`) que només cobreix les sessions creades abans de la sol·licitud. Per defecte és `false`. Irreversible; no hi ha cap pas de confirmació.", "default": false, "example": false }, "retain_face_embeddings": { "type": "boolean", "nullable": true, "description": "Sobreescriu la `face_retention_policy` de l'aplicació per a aquesta supressió. `true` manté una plantilla biomètrica facial sense imatge vinculada a l'usuari de la sessió després que se suprimeixi la sessió; `false` suprimeix l'embedding facial amb la sessió; omet o posa `null` per seguir la política de l'aplicació. S'ignora en sessions de KYB i en sessions sense embedding facial.", "example": true }, "face_retention_days": { "type": "integer", "minimum": 1, "maximum": 3650, "description": "Durada de conservació finita, en dies, per a una plantilla conservada. Obligatori quan es conserva una plantilla tret que l'aplicació ja defineixi `face_retention_days`. El camp `expires_at` de la plantilla és la data més primerenca entre aquesta durada, la finestra general de conservació de dades de l'aplicació i `face_retention_deadline`.", "example": 365 }, "face_retention_deadline": { "type": "string", "format": "date-time", "description": "Caducitat estricta opcional per a una plantilla conservada. Ha de ser posterior a la data actual.", "example": "2027-08-28T00:00:00Z" }, "deletion_instruction": { "type": "string", "enum": [ "operational_session_delete", "privacy_erasure" ], "default": "operational_session_delete", "description": "La classe d'instrucció que estàs donant. `operational_session_delete` suprimeix la sessió i conserva una plantilla només quan la política o `retain_face_embeddings` així ho indiquen. `privacy_erasure` purga totes les plantilles biomètriques conservades vinculades a l'Usuari de la sessió abans de suprimir la sessió, no pot ser anul·lada per la política de l'aplicació i no es pot combinar amb `retain_face_embeddings: true` (`400`).", "example": "operational_session_delete" }, "instruction_id": { "type": "string", "maxLength": 255, "description": "La teva referència persistent per a aquesta instrucció de supressió (per exemple, l'id d'un tiquet de supressió). Es registra al registre d'auditoria i a qualsevol plantilla conservada. Didit la genera si s'omet.", "example": "dsar-2026-0142" }, "filter_status": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `status` de [List Sessions](/ca/sessions-api/list-sessions), amb els mateixos valors. Una cadena separada per comes o un array. S'ignora sense `delete_all`. Un valor buit s'ignora i no restringeix la selecció.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_vendor_data": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `vendor_data` de [List Sessions](/ca/sessions-api/list-sessions), amb el mateix valor. Un sol valor, no una llista: un array s'uneix en un únic text separat per comes, de manera que diversos valors no es comparen com a alternatives. S'ignora sense `delete_all`. Un valor buit s'ignora i no restringeix la selecció.", "type": "string" }, "filter_search": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `search` de [List Sessions](/ca/sessions-api/list-sessions), amb el mateix valor. Un sol valor, no una llista: un array s'uneix en un únic text separat per comes, de manera que diversos valors no es comparen com a alternatives. S'ignora sense `delete_all`. Un valor buit s'ignora i no restringeix la selecció.", "type": "string" }, "filter_workflow_id": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `workflow_id` de [List Sessions](/ca/sessions-api/list-sessions), amb els mateixos valors. Una cadena separada per comes o un array. S'ignora sense `delete_all`. Un valor buit s'ignora i no restringeix la selecció.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_date_from": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `date_from` de [Llistar sessions](/ca/sessions-api/list-sessions), amb el mateix valor. Un sol valor, no una llista: una matriu s'uneix en un únic valor separat per comes, de manera que diversos valors es rebutgen amb `400`. S'ignora sense `delete_all`. Un valor buit s'ignora i no redueix la selecció.", "type": "string", "format": "date" }, "filter_date_to": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `date_to` de [Llistar sessions](/ca/sessions-api/list-sessions), amb el mateix valor. Un sol valor, no una llista: una matriu s'uneix en un únic valor separat per comes, de manera que diversos valors es rebutgen amb `400`. S'ignora sense `delete_all`. Un valor buit s'ignora i no redueix la selecció.", "type": "string", "format": "date" }, "filter_country": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `country` de [Llistar sessions](/ca/sessions-api/list-sessions), amb els mateixos valors. Una cadena separada per comes o una matriu. S'ignora sense `delete_all`. Un valor buit s'ignora i no redueix la selecció.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_document_type": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `document_type` de [Llistar sessions](/ca/sessions-api/list-sessions), amb els mateixos valors. Una cadena separada per comes o una matriu. S'ignora sense `delete_all`. Un valor buit s'ignora i no redueix la selecció.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_document_name": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `document_name` de [Llistar sessions](/ca/sessions-api/list-sessions), amb els mateixos valors. Una cadena separada per comes o una matriu. S'ignora sense `delete_all`. Un valor buit s'ignora i no redueix la selecció.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_region": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `region` de [List Sessions](/ca/sessions-api/list-sessions), amb els mateixos valors. Una cadena separada per comes o un array. S'ignora sense `delete_all`. Un valor buit s'ignora i no restringeix la selecció.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_didit_internal_id": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `didit_internal_id` de [Llistar sessions](/ca/sessions-api/list-sessions), amb el mateix valor. Un sol valor, no una llista: una matriu s'uneix en un únic valor separat per comes, de manera que diversos valors es rebutgen amb `400`. S'ignora sense `delete_all`. Un valor buit s'ignora i no redueix la selecció.", "type": "string", "format": "uuid" }, "filter_session_type": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `session_type` de [List Sessions](/ca/sessions-api/list-sessions), amb els mateixos valors. Una cadena separada per comes o un array. S'ignora sense `delete_all`. Un valor buit s'ignora i no restringeix la selecció.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_api_service": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `api_service` de [Llistar sessions](/ca/sessions-api/list-sessions), amb el mateix valor. Un sol valor, no una llista: una matriu s'uneix en un únic valor separat per comes, de manera que diversos valors es rebutgen amb `400`. S'ignora sense `delete_all`. Un valor buit s'ignora i no redueix la selecció.", "type": "string" }, "filter_screened_full_name": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `screened_full_name` de [List Sessions](/ca/sessions-api/list-sessions), amb el mateix valor. Un sol valor, no una llista: un array s'uneix en un únic text separat per comes, de manera que diversos valors no es comparen com a alternatives. S'ignora sense `delete_all`. Un valor buit s'ignora i no restringeix la selecció.", "type": "string" }, "filter_warning": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `warning` de [List Sessions](/ca/sessions-api/list-sessions), amb els mateixos valors. Una cadena separada per comes o un array. S'ignora sense `delete_all`. Un valor buit s'ignora i no restringeix la selecció.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_status_initialized_as_in_review": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `status_initialized_as_in_review` de [List Sessions](/ca/sessions-api/list-sessions), amb els mateixos valors. S'ignora sense `delete_all`. Un valor buit s'ignora i no restringeix la selecció.", "type": "boolean" }, "filter_is_kyc_to_be_reviewed": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `is_kyc_to_be_reviewed` de [Llistar sessions](/ca/sessions-api/list-sessions), amb els mateixos valors. S'ignora sense `delete_all`. Un valor buit s'ignora i no redueix la selecció.", "type": "boolean" }, "filter_euuid": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `euuid` de [Llistar sessions](/ca/sessions-api/list-sessions), amb el mateix valor. Un sol valor, no una llista: una matriu s'uneix en un únic valor separat per comes, de manera que diversos valors es rebutgen amb `400`. S'ignora sense `delete_all`. Un valor buit s'ignora i no redueix la selecció.", "type": "string", "format": "uuid" }, "filter_organization_name": { "description": "Restringeix un `delete_all` a les sessions que coincideixen amb el filtre `organization_name` de [List Sessions](/ca/sessions-api/list-sessions), amb els mateixos valors. Una cadena separada per comes o un array. Amb una clau d'API només pot coincidir amb el nom de la teva pròpia organització, de manera que selecciona totes les teves sessions o cap. S'ignora sense `delete_all`. Un valor buit s'ignora i no restringeix la selecció.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "examples": { "Specific sessions": { "summary": "Elimina sessions específiques per número", "value": { "session_numbers": [ "1001", "1002", "1003" ] } }, "All sessions": { "summary": "Elimina totes les sessions de KYC de l'aplicació", "value": { "delete_all": true } }, "Delete and retain templates": { "summary": "Elimina sessions però mantén les plantilles biomètriques sense imatges durant 365 dies", "value": { "session_numbers": [ "1001", "1002" ], "retain_face_embeddings": true, "face_retention_days": 365, "instruction_id": "post-approval-cleanup-2026-08" } }, "Privacy erasure": { "summary": "Elimina sessions i purga totes les plantilles conservades dels seus usuaris", "value": { "session_numbers": [ "1001" ], "deletion_instruction": "privacy_erasure", "instruction_id": "dsar-2026-0142" } }, "Filtered delete_all": { "summary": "Elimina totes les sessions rebutjades d'un flux de treball creades el setembre 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": "Fins a 20 sessions han coincidit i s'han processat a la sol·licitud. Un resultat per sessió coincident; els números que no han coincidit amb res (desconeguts o ja suprimits) s'ometen i no apareixen. Un resultat confirma la supressió excepte quan `face_retention_outcome` és `failed_retryable`: aquesta sessió NO s'ha suprimit i s'hauria de reintentar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "La sessió eliminada." }, "session_number": { "type": "integer", "nullable": true, "description": "El número de la sessió eliminada." }, "face_retention_outcome": { "type": "string", "enum": [ "retained_with_user", "deleted", "none", "ineligible_no_vendor_user", "failed_retryable" ], "description": "Què ha passat amb les dades biomètriques facials de la sessió. `deleted`: l'embedding facial s'ha suprimit amb la sessió (per defecte). `retained_with_user`: la sessió se suprimeix i una plantilla biomètrica sense imatges es manté vinculada a l'usuari; consulta `biometric_template_uuid`. `none`: la sessió no tenia cap embedding facial (per exemple, una sessió de KYC només amb document sense selfie de prova de vida; aquest endpoint mai selecciona sessions de KYB). `ineligible_no_vendor_user`: s'ha sol·licitat la conservació però la sessió no té cap usuari enllaçat, de manera que l'embedding s'ha suprimit amb la sessió. `failed_retryable` (només a l'endpoint per lots): el grup amb el qual s'ha suprimit aquesta sessió no s'ha pogut suprimir (un servei d'emmagatzematge, un dipòsit biomètric o un proveïdor de monitoratge no estava disponible); aquesta sessió encara es manté, repeteix la sol·licitud per a ella." }, "biometric_template_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "ID de la plantilla biomètrica conservada quan `face_retention_outcome` és `retained_with_user`; `null` en cas contrari. Gestiona-la mitjançant `/v3/biometric-templates/{template_uuid}/`." }, "biometric_template_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan s'elimina la plantilla biomètrica conservada, quan `face_retention_outcome` és `retained_with_user`; `null` quan no es conserva cap plantilla." }, "deleted_child_verifications": { "type": "integer", "description": "Sempre `0` en aquest endpoint, que només suprimeix sessions de KYC. Si se suprimeix una sessió de Verificació d'empreses (KYB) amb `DELETE /v3/session/{sessionId}/delete/`, s'informa de les verificacions que va crear i que es van suprimir amb 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": "S'han trobat més de 20 sessions. S'eliminen en segon pla; consulta periòdicament `GET /v3/sessions/delete/{job_id}/` fins que `status` sigui `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ó — no s'ha eliminat res. Els valors d'error són matrius de cadenes de missatges indexades pel nom del camp.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_numbers": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": { "description": "Altres claus: una clau `filter_*` que no sigui un filtre de llista de sessions (`\"Unknown filter.\"`), o una clau `filter_*` el valor de la qual no es pugui llegir (amb aquesta clau `filter_*` com a clau, acompanyada d'una matriu de missatges)." } }, "examples": { "Missing selector": { "summary": "No s'ha proporcionat ni session_numbers ni delete_all", "value": { "session_numbers": [ "This field is required unless delete_all is true." ] } }, "Empty list": { "summary": "session_numbers és una matriu buida", "value": { "session_numbers": [ "This list may not be empty." ] } }, "Non-numeric entry": { "summary": "session_numbers conté una cadena que no és numèrica", "value": { "session_numbers": [ "All session_numbers must be numeric." ] } }, "Privacy erasure cannot retain": { "summary": "deletion_instruction privacy_erasure combinat amb retain_face_embeddings true", "value": { "retain_face_embeddings": [ "Privacy erasure cannot retain biometric templates." ] } }, "No finite retention duration": { "summary": "Conservació de dades sol·licitada sense face_retention_days a la sol·licitud o a l'aplicació", "value": { "detail": "A finite biometric-template retention duration is required." } }, "Unknown filter": { "summary": "Una clau filter_* que List Sessions no té", "value": { "filter_reviewer": "Unknown filter." } }, "Unreadable filter value": { "summary": "Un valor de filtre que no es pot llegir", "value": { "filter_date_from": [ "Enter a valid date." ] } } } } } }, "403": { "description": "Falta la clau d'API. Si falta la clau, es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid API key": { "summary": "Falta la capçalera x-api-key, o la clau no és vàlida", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència d'escriptura compartit (300 sol·licituds POST/PATCH/DELETE per minut per clau d'API). Revisa les capçaleres de resposta `Retry-After` i `X-RateLimit-*` abans de reintentar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Pressupost d'escriptura esgotat", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } }, "409": { "description": "Una sessió seleccionada forma part d'un informe regulador finalitzat. No s'elimina res.", "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": "Obtenir una tasca d'eliminació massiva de sessions", "description": "Progrés d'una eliminació massiva de sessions a la qual `POST /v3/sessions/delete/` ha respost amb `202` (més de 20 sessions coincidents, seleccionades mitjançant `session_numbers` o amb `delete_all`). Fes sondeig cada pocs segons mentre `status` sigui `PENDING` o `PROCESSING`; atura't quan sigui `COMPLETED` o `FAILED`.\n\nLa tasca informa de quantes sessions han acabat en cada resultat i quantes n'ha processat, mai de quines sessions ha eliminat. Una tasca `FAILED` inclou el motiu a `error`; les sessions a les quals no havia arribat continuen existint, de manera que cal repetir la sol·licitud d'eliminació per eliminar-les.\n\n**Autenticació:** clau d'API a la capçalera `x-api-key`. Una tasca només és visible per a l'aplicació que la va crear; qualsevol altre `job_id` retorna `404`. Unes credencials absents o no vàlides retornen `403`; aquesta API mai retorna `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` retornat amb 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": "La tasca.", "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 clau d'API. Si falta la clau, es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid API key": { "summary": "Falta la capçalera x-api-key, o la clau no és vàlida", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap tasca de supressió amb aquest `job_id` per a l'aplicació sol·licitant. Les tasques només són visibles per a l'aplicació que les ha creat." } } } }, "/v3/sessions/{session_id}/reviews/": { "get": { "summary": "Llista les revisions i el registre d'activitat de la sessió", "description": "Retorna el registre d'auditoria / canal d'activitat d'una sessió de Verificació d'usuaris (KYC), començant pel més recent, en un embolcall paginat (`count` / `next` / `previous` / `results`, 50 entrades per pàgina per defecte).\n\nLes entrades del canal les escriu cada actor que interactua amb la sessió: decisions manuals preses mitjançant `PATCH /v3/session/{session_id}/update-status/` (que registra `previous_status` → `new_status`), activitat dels revisors a la Console (comentaris amb mencions `@email`, edicions de dades KYC/POA, càrregues/eliminacions de fitxers, canvis d'etiquetes, visualitzacions de la pàgina de detalls), coincidències de Monitoratge AML continu i notes afegides mitjançant `POST` en aquesta mateixa ruta. Llegir aquest canal és l'equivalent a nivell d'API del panell **Activitat** a la vista de sessió de la Didit Console.\n\nNomés s'hi pot accedir a sessions de Verificació d'usuaris (KYC); els ID de sessió de Verificació d'empreses (KYB) retornen `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 sessió de Verificació d'usuaris (KYC). Ha de pertànyer a la mateixa aplicació que la clau d'API: els UUID d'altres aplicacions, les sessions suprimides i els ID de sessió de Verificació d'empreses (KYB) retornen tots un `404`.", "schema": { "type": "string", "format": "uuid", "example": "8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d" } }, { "name": "limit", "in": "query", "required": false, "description": "Mida de la pàgina. Per defecte és `50`.", "schema": { "type": "integer", "default": 50, "example": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Nombre d'entrades que cal ometre des de l'inici del canal (ordenat). Per defecte és `0`. Els URL `next` / `previous` de la resposta contenen els valors correctes per recórrer el canal.", "schema": { "type": "integer", "default": 0, "example": 0 } }, { "name": "ordering", "in": "query", "required": false, "description": "Criteri d'ordenació. Per defecte, el canal s'ordena del més recent al més antic (`-created_at`); passa `created_at` per llegir-lo del més antic al més recent. Els valors desconeguts s'ignoren de manera silenciosa (s'utilitza l'ordre per defecte); també s'admeten altres noms de camp del serialitzador.", "schema": { "type": "string", "default": "-created_at", "example": "created_at" } } ], "responses": { "200": { "description": "Flux d'activitat paginat, els més recents primer per defecte. `count` és el nombre total d'entrades; `next` / `previous` són URL de pàgina preparades (`null` als extrems). Un `count` de `0` amb `results` buit significa que encara no s'ha registrat cap activitat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Nombre total d'entrades del canal per a aquesta sessió (en totes les pàgines).", "example": 3 }, "next": { "type": "string", "nullable": true, "description": "URL de la pàgina següent, o `null` a l'última pàgina.", "example": null }, "previous": { "type": "string", "nullable": true, "description": "URL de la pàgina anterior, o `null` a la primera pàgina.", "example": null }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewItem" }, "description": "Entrades del canal per a aquesta pàgina." } } }, "examples": { "DecisionTrail": { "summary": "Aprovació manual més notes afegides per l'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 amb limit=2 — next conté la URL següent", "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": "Sessió sense cap activitat registrada encara", "value": { "count": 0, "next": null, "previous": null, "results": [] } } } } } }, "403": { "description": "Capçalera `x-api-key` absent, mal formada, caducada o revocada. L'autenticació es comprova abans de cercar la sessió, de manera que una clau absent retorna `403` fins i tot quan l'UUID de la sessió no existeix.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You do not have permission to perform this action." } } }, "examples": { "InvalidKey": { "summary": "Falta la capçalera x-api-key o no és vàlida", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No hi ha cap sessió de Verificació d'usuaris (KYC) amb aquest UUID visible per a la teva aplicació: l'UUID no existeix, la sessió s'ha eliminat o pertany a una aplicació diferent. Els ID de sessió de Verificació d'empreses (KYB) també retornen `404` aquí — el canal de revisions només és accessible per a sessions de KYC.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Session not found." } } }, "examples": { "NotFound": { "summary": "UUID de sessió desconegut, suprimit o d'una altra aplicació", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Revisa les capçaleres de resposta `Retry-After` i `X-RateLimit-*`. Consulta [Límit de freqüència](/ca/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": "Afegeix una nota de revisió al registre d'auditoria d'una sessió", "description": "Afegeix una nota al canal d'activitat / revisió d'una sessió de Verificació d'usuaris (KYC). **Aquest endpoint només registra una entrada; mai modifica la sessió.** El `status` de la sessió es manté intacte, no s'executa cap validació de transició d'estat i no es dispara cap webhook. Per aprovar, rebutjar o reobrir realment una sessió (cosa que també escriu una entrada `STATUS_UPDATED` totalment atribuïda a aquest canal), utilitza `PATCH /v3/session/{session_id}/update-status/` en el seu lloc.\n\nTots dos camps del cos són opcionals i s'accepta un objecte JSON buit. `new_status` s'emmagatzema exclusivament com una etiqueta a l'entrada i accepta qualsevol dels deu valors d'estat de la sessió (distingeix entre majúscules i minúscules). Les mencions `@email` dins de `comment` només s'emmagatzemen com a text pla; no activen cap notificació en aquest endpoint, i el camp `mentioned_emails` de l'entrada roman buit.\n\nNota sobre l'atribució: les entrades creades aquí no contenen informació sobre l'actor. Al canal mostren `actor_display: \"Unknown\"`, `actor_type: \"CONSOLE_USER\"` i `activity_type: \"STATUS_UPDATED\"` (valors per defecte d'emmagatzematge), i el camp `user` del cos de la resposta `201` és `\"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": "Estableix-ho a `application/json` quan enviïs un cos JSON.", "schema": { "type": "string", "example": "application/json" } }, { "name": "session_id", "in": "path", "required": true, "description": "UUID de la sessió de Verificació d'usuaris (KYC). Ha de pertànyer a la mateixa aplicació que la clau d'API: els UUID d'altres aplicacions, les sessions suprimides i els ID de sessió de Verificació d'empreses (KYB) retornen tots un `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 d'estat opcional per registrar a l'entrada. Accepta qualsevol valor d'estat de sessió, sensible a majúscules i minúscules (`\"approved\"` es rebutja amb `400`). Registrar un estat aquí **no** canvia l'estat real de la sessió; fes servir l'endpoint d'actualització d'estat per a això.", "example": "In Review" }, "comment": { "type": "string", "nullable": true, "description": "Nota opcional en text lliure (sense límit de longitud establert). Es desa literalment; les mencions `@email` no es processen en aquest endpoint.", "example": "Flagging for manual document re-check." } } }, "examples": { "NoteWithStatusLabel": { "summary": "Nota amb una etiqueta d'estat (l'estat de la sessió no canvia)", "value": { "new_status": "In Review", "comment": "Flagging for manual document re-check." } }, "CommentOnly": { "summary": "Nota de text pla sense etiqueta d'estat", "value": { "comment": "Customer emailed an updated utility bill; awaiting upload." } } } } } }, "responses": { "201": { "description": "Entrada registrada al registre d'auditoria de la sessió. La sessió en si no canvia: el seu `status` manté el valor anterior i no s'envia cap webhook. La nova entrada també apareix a la part superior de `GET …/reviews/` (amb `actor_display: \"Unknown\"`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "string", "description": "Nom visible de l'autor de l'entrada. Sempre `\"Unknown\"` per a entrades creades mitjançant aquest endpoint, ja que no registra cap atribució d'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": "L'etiqueta d'estat registrada a l'entrada, o `null` si no se n'ha enviat cap. L'estat real de la sessió no es veu afectat.", "example": "In Review" }, "comment": { "type": "string", "nullable": true, "description": "La nota registrada a l'entrada, o `null` si no se'n va enviar cap.", "example": "Flagging for manual document re-check." }, "created_at": { "type": "string", "format": "date-time", "description": "Quan es va escriure l'entrada, ISO 8601 UTC.", "example": "2026-06-12T00:18:44.466537Z" } } }, "examples": { "NoteWithStatusLabel": { "summary": "Nota amb una etiqueta d'estat", "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ó, retornat com un mapa de missatges per camp. La causa habitual és un valor de `new_status` que no és un dels deu estats permesos; la comprovació distingeix entre majúscules i minúscules.", "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 d'estat en minúscules / desconegut", "value": { "new_status": [ "\"approved\" is not a valid choice." ] } } } } } }, "403": { "description": "Capçalera `x-api-key` absent, mal formada, caducada o revocada. L'autenticació es comprova abans de cercar la sessió, de manera que una clau absent retorna `403` fins i tot quan l'UUID de la sessió no existeix.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You do not have permission to perform this action." } } }, "examples": { "InvalidKey": { "summary": "Falta la capçalera x-api-key o no és vàlida", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No hi ha cap sessió de Verificació d'usuaris (KYC) amb aquest UUID visible per a la teva aplicació: l'UUID no existeix, la sessió s'ha eliminat o pertany a una aplicació diferent. Els ID de sessió de Verificació d'empreses (KYB) també retornen `404` aquí — el canal de revisions només és accessible per a sessions de KYC.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Session not found." } } }, "examples": { "NotFound": { "summary": "UUID de sessió desconegut, suprimit o d'una altra aplicació", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Revisa les capçaleres de resposta `Retry-After` i `X-RateLimit-*`. Consulta [Límit de freqüència](/ca/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": "Obtenir el saldo de crèdit", "description": "Obtenir el saldo actual de crèdit prepagat en USD (per a tota l'organització) més la configuració de recàrrega automàtica. Els imports són cadenes decimals — analitza'ls amb una biblioteca de decimals.", "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èdit actual més la configuració d'autorecàrrega de l'organització.", "content": { "application/json": { "schema": { "type": "object", "required": [ "balance", "auto_refill_enabled" ], "properties": { "balance": { "type": "string", "description": "Saldo actual de crèdit prepagament en USD, com a cadena decimal de coma fixa. Disminueix a mesura que es facturen les verificacions i augmenta quan es liquida una recàrrega." }, "auto_refill_enabled": { "type": "boolean", "description": "Quan és `true`, Didit carregarà automàticament el mètode de pagament desat per afegir crèdits un cop el saldo superi `auto_refill_threshold`. Es configura des de Consola → Facturació." }, "auto_refill_amount": { "type": "string", "nullable": true, "description": "Import en USD que es carregarà i s'afegirà al saldo en cada recàrrega automàtica, pel valor nominal. Es configura de \\$50 a \\$20,000 a Consola → Facturació. `null` quan la recàrrega automàtica està desactivada o no s'ha definit." }, "auto_refill_threshold": { "type": "string", "nullable": true, "description": "Llindar d'activació en USD. La recàrrega automàtica s'executa quan el `balance` cau per sota d'aquest valor. `null` quan la recàrrega automàtica està desactivada o no s'ha establert." } } }, "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": "Clau d'API absent, no vàlida o revocada, o bé la clau no pot llegir dades de facturació per a aquesta organització. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `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": "Recarregar crèdits", "description": "Afegeix crèdits mitjançant una sessió allotjada de Stripe Checkout (**\\$50 a \\$20,000** per recàrrega). Les recàrregues estan disponibles als plans Free, Growth i Scale, s'afegeixen pel seu valor nominal sense cap descompte ni bonificació, i duren 12 mesos; els contractes anuals Enterprise no poden recarregar. Redirigeix el client a la `checkout_session_url` retornada.", "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": 20000, "description": "Import a carregar, en USD. **Ha de ser de 50 a 20.000.** El saldo rep el mateix import, sense descomptes ni bonificacions. Els impostos s'afegeixen automàticament en el pagament segons l'adreça de facturació del client." }, "success_url": { "type": "string", "format": "uri", "description": "URL a la qual la pantalla de pagament allotjada redirigeix el client després d'un pagament satisfactori. Actualment per defecte és `https://console.didit.me`. Passa una URL funcional explícitament; l'amfitrió per defecte no està disponible. Afegeix el marcador de posició literal `{CHECKOUT_SESSION_ID}` si vols que la pantalla de pagament allotjada substitueixi l'ID de sessió." }, "cancel_url": { "type": "string", "format": "uri", "description": "URL a la qual la pantalla de pagament allotjada redirigeix el client quan cancel·la o tanca la finestra de pagament. Actualment per defecte és `https://console.didit.me`. Passa una URL funcional explícitament; el host per defecte 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": "Sessió de pagament allotjada creada. Redirigeix l'usuari a `checkout_session_url` per completar el pagament.", "content": { "application/json": { "schema": { "type": "object", "required": [ "checkout_session_id", "checkout_session_url" ], "properties": { "checkout_session_id": { "type": "string", "description": "Identificador de la sessió de pagament allotjada (p. ex. `cs_test_a1B2c3...`). Útil per a la conciliació al costat del servidor." }, "checkout_session_url": { "type": "string", "format": "uri", "description": "URL de la pàgina de pagament allotjada d'un sol ús. Redirigeix el client aquí per completar el pagament." } } }, "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àlid: falta l'import, no és un número, està per sota del mínim de \\$50 o per sobre del màxim de \\$20,000, o bé l'organització té un contracte anual Enterprise. El cos de l'error és una matriu 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 $20,000." ] }, "Annual plan": { "value": [ "You have an annual plan. Contact your account manager to top up." ] } } } } }, "403": { "description": "Falta la clau d'API, no és vàlida o està revocada, o la clau no pot crear sessions de recàrrega per a aquesta organització. Si falta la clau, es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `Retry-After`.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/": { "get": { "summary": "Llista les destinacions del webhook", "description": "Llista totes les destinacions del webhook (array no paginat, les més antigues primer). Cada element conté la configuració de la destinació, les seves mètriques de lliurament dels darrers 30 dies (`metrics_window_days`) amb una entrada `daily_points` per dia, i el seu estat (`health_status`, `failing_streak`, `failing_since`, `last_success_at`). La llista no té cap objecte `summary` i mai no inclou el secret de signatura: cada element mostra només `secret_last4`. Obtén una única destinació (`GET /v3/webhook/destinations/{destination_uuid}/`) per llegir `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": "Llista de destinacions del webhook (sense paginar, les més antigues primer).", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador de destinació estable; utilitza'l com a `{destination_uuid}` per actualitzar o eliminar." }, "label": { "type": "string", "description": "Nom fàcil de llegir que es mostra a la Console." }, "url": { "type": "string", "format": "uri", "description": "URL de destinació que rep sol·licituds `POST` amb el payload del webhook." }, "enabled": { "type": "boolean", "description": "Quan és `false`, Didit omet silenciosament el lliurament a aquesta destinació." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Versió de l'esquema del payload enviat a aquesta destinació. `v3` és el format actual/recomanat." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "subscribed_events_count": { "type": "integer", "description": "Longitud a la memòria cau de `subscribed_events`, útil per a la renderització de la interfície d'usuari." }, "deliveries_count": { "type": "integer", "description": "Intents de lliurament (inclosos els reintents) fets a aquesta destinació en els darrers 30 dies." }, "failed_deliveries_count": { "type": "integer", "description": "Intents de lliurament en els darrers 30 dies en què la destinació va respondre amb HTTP 400 o superior, o no va respondre (temps d'espera esgotat, connexió rebutjada o adreça bloquejada)." }, "average_response_time_ms": { "type": "integer", "nullable": true, "description": "Temps de resposta mitjà en mil·lisegons durant els darrers 30 dies, arrodonit a un enter. `null` quan no hi ha hagut cap lliurament en aquesta finestra." }, "error_rate_percentage": { "type": "integer", "description": "`round(failed_deliveries_count / deliveries_count * 100)` durant els darrers 30 dies; `0` quan no hi ha lliuraments." }, "last_delivery_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de temps de l'intent de lliurament més recent (satisfactori o fallit). `null` si mai no s'ha lliurat." }, "metrics_window_days": { "type": "integer", "description": "Durada en dies de la finestra que cobreixen `deliveries_count`, `failed_deliveries_count`, `average_response_time_ms`, `error_rate_percentage` i `daily_points`. Sempre és `30`." }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Estat del lliurament. `failing`: 3 o més esdeveniments consecutius han fallat en el seu primer intent de lliurament des que la destinació va respondre satisfactòriament per darrera vegada (consulta `failing_streak`). `degraded`: no és failing, però un intent de lliurament ha fallat en les darreres 24 hores i cap intent posterior ha lliurat aquest esdeveniment; un reintent o reenviament que el lliuri neteja aquest estat. `healthy`: cap dels dos. Independent d'`enabled`. Un intent fallit és un que ha rebut una resposta HTTP 400 o superior, o que no ha rebut cap resposta." }, "failing_streak": { "type": "integer", "description": "Quants esdeveniments consecutius han fallat en el seu primer intent de lliurament des que la destinació va respondre satisfactòriament per última vegada, durant els darrers 30 dies. Els reintents no es comptabilitzen, i qualsevol intent satisfactori, inclòs un reintent o un reenviament, posa fi a la ratxa. `0` quan cap esdeveniment ha fallat des de l'últim èxit." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va fer el primer intent fallit de la `failing_streak` actual. `null` quan `failing_streak` és `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan la destinació va respondre per darrera vegada a un lliurament amb un estat HTTP inferior a 400, en els darrers 30 dies. `null` si no ho ha fet en aquest interval." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Entorn de l'aplicació propietària de la destinació." }, "daily_points": { "type": "array", "description": "Una entrada per dia UTC dels darrers 30 dies, el més antic primer, inclosos els dies sense lliuraments. Compta cada intent, reintents inclosos.", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "El dia UTC." }, "total_deliveries": { "type": "integer", "description": "Intents de lliurament fets aquell dia." }, "failed_deliveries": { "type": "integer", "description": "Intents realitzats aquell dia als quals es va respondre amb HTTP 400 o superior, o que no es van respondre en absolut." } } } }, "secret_last4": { "type": "string", "description": "Últims quatre caràcters del secret de signatura actual de la destinació, perquè puguis distingir els secrets. No són suficients per verificar una signatura." }, "created_by_email": { "type": "string", "nullable": true, "description": "Correu electrònic del membre de la Business Console que ha creat la destinació. `null` per a una destinació creada amb una clau d'API." }, "created_by_name": { "type": "string", "nullable": true, "description": "Nom del membre de la Business Console que ha creat la destinació. `null` per a una destinació creada amb una clau d'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": "Falta la clau d'API, està mal formada, ha caducat o està assignada a una aplicació diferent. Si falta la clau es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crea una destinació del webhook", "description": "Crea una destinació del webhook. La resposta inclou el secret de signatura HMAC `secret_shared_key` generat automàticament (també consultable posteriorment mitjançant `GET /v3/webhook/destinations/{destination_uuid}/`). Envia sempre `subscribed_events` amb almenys un esdeveniment (sense caràcters comodí): una llista buida explícita es rebutja amb un 400, i ometre el camp crea una destinació no subscrita a res, que no rep mai cap webhook. El parell `(application, url)` ha de ser únic entre les destinacions de l'aplicació.", "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": "Nom fàcil de llegir mostrat a Console → Webhooks. Ajuda a distingir les destinacions quan en tens diverses (p. ex., \"Prod\", \"Staging mirror\")." }, "url": { "type": "string", "format": "uri", "description": "URL HTTPS que rebrà sol·licituds `POST`. Ha de ser única entre les destinacions de l'aplicació. Fes servir un endpoint estable i protegit: Didit reintenta els lliuraments fallits seguint un calendari de reintents amb espera progressiva.", "maxLength": 2000 }, "enabled": { "type": "boolean", "default": true, "description": "Quan és `false`, la destinació es desa però Didit no hi enviarà cap webhook. Útil per a configuracions de preproducció que vulguis mantenir pausades." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Versió de l'esquema del payload que enviarà Didit. `v3` és el format actual/recomanat; les versions anteriors es mantenen per garantir la compatibilitat amb les integracions heretades." }, "subscribed_events": { "allOf": [ { "$ref": "#/components/schemas/WebhookSubscribedEvents" } ], "description": "Esdeveniments a lliurar. Pràcticament obligatori: un `[]` explícit es rebutja amb 400, i ometre el camp crea una destinació sense subscripcions que no rep res." } } }, "examples": { "session_updates": { "summary": "Actualitzacions de dades i de l'estat de la sessió", "value": { "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "webhook_version": "v3", "subscribed_events": [ "status.updated", "data.updated" ] } }, "transaction_updates": { "summary": "Actualitzacions del monitoratge de transaccions", "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": "Actualitzacions de les entitats d'usuari i d'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": "Destinació creada. `secret_shared_key` és el secret de signatura HMAC; desa'l ara.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador de destinació estable. Utilitza'l com a `{destination_uuid}` en crides posteriors." }, "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": "Secret de signatura HMAC generat automàticament i vinculat a aquesta destinació (token de 43 caràcters segur per a URL). Utilitza'l per verificar les capçaleres de signatura als webhooks entrants. Sempre es retorna complet als qui criden amb clau d'API; els usuaris de la consola necessiten el permís `read:webhooks`, altrament veuen una cadena buida." }, "secret_last4": { "type": "string", "description": "Últims quatre caràcters del secret de signatura actual de la destinació, perquè puguis distingir els secrets. No són suficients per verificar una signatura." }, "previous_secret_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Establert durant 24 hores després que el secret de signatura de la destinació es roti a la Business Console. Fins aquest moment, cada lliurament a la destinació també inclou `X-Signature-Previous`, `X-Signature-V2-Previous` i `X-Signature-Simple-Previous`, generats amb el secret substituït (consulta [Verificació de la signatura](/ca/integration/webhooks#verificació-de-la-signatura)). `null` quan no s'ha produït cap rotació en les darreres 24 hores." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "created_by_email": { "type": "string", "nullable": true, "description": "Correu electrònic del membre de la Business Console que ha creat la destinació. `null` per a una destinació creada amb una clau d'API." }, "created_by_name": { "type": "string", "nullable": true, "description": "Nom del membre de la Business Console que ha creat la destinació. `null` per a una destinació creada amb una clau d'API." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Estat del lliurament. `failing`: 3 o més esdeveniments consecutius han fallat en el seu primer intent de lliurament des que la destinació va respondre satisfactòriament per darrera vegada (consulta `failing_streak`). `degraded`: no és failing, però un intent de lliurament ha fallat en les darreres 24 hores i cap intent posterior ha lliurat aquest esdeveniment; un reintent o reenviament que el lliuri neteja aquest estat. `healthy`: cap dels dos. Independent d'`enabled`. Un intent fallit és un que ha rebut una resposta HTTP 400 o superior, o que no ha rebut cap resposta." }, "failing_streak": { "type": "integer", "description": "Quants esdeveniments consecutius han fallat en el seu primer intent de lliurament des que la destinació va respondre satisfactòriament per última vegada, durant els darrers 30 dies. Els reintents no es comptabilitzen, i qualsevol intent satisfactori, inclòs un reintent o un reenviament, posa fi a la ratxa. `0` quan cap esdeveniment ha fallat des de l'últim èxit." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va fer el primer intent fallit de la `failing_streak` actual. `null` quan `failing_streak` és `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan la destinació va respondre per darrera vegada a un lliurament amb un estat HTTP inferior a 400, en els darrers 30 dies. `null` si no ho ha fet en aquest interval." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Entorn de l'aplicació propietària de la destinació." }, "summary": { "type": "object", "description": "Mètriques de lliurament dels darrers `metrics_window_days` (30) dies. `last_delivery_at` és l'intent més recent, independentment de quan es va fer.", "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": "Durada en dies de la finestra que cobreixen les altres mètriques de resum. Sempre és `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ó ha fallat: normalment un URL duplicat, `subscribed_events` absent o no vàlid, o un nom d'esdeveniment desconegut.", "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": "Falta la clau d'API, està mal formada, ha caducat o està assignada a una aplicació diferent. Si falta la clau es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/{destination_uuid}/": { "get": { "summary": "Obtenir la destinació del webhook", "description": "Recupera una destinació de webhook amb el seu secret de signatura `secret_shared_key`, el seu estat (`health_status`, `failing_streak`, `failing_since`, `last_success_at`) i un resum de lliuraments (`summary`) dels darrers 30 dies. Les crides amb clau d'API reben sempre el secret complet; els usuaris de la consola sense `read:webhooks` veuen una cadena buida.", "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 de la destinació (el `uuid` retornat en crear o llistar).", "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": "Detalls de la destinació del 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": "Secret de signatura HMAC (token de 43 caràcters compatible amb URL). Sempre es retorna complet per a qui crida amb clau d'API; els usuaris de la consola necessiten `read:webhooks`, en cas contrari es retorna una cadena buida." }, "secret_last4": { "type": "string", "description": "Últims quatre caràcters del secret de signatura actual de la destinació, perquè puguis distingir els secrets. No són suficients per verificar una signatura." }, "previous_secret_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Establert durant 24 hores després que el secret de signatura de la destinació es roti a la Business Console. Fins aquest moment, cada lliurament a la destinació també inclou `X-Signature-Previous`, `X-Signature-V2-Previous` i `X-Signature-Simple-Previous`, generats amb el secret substituït (consulta [Verificació de la signatura](/ca/integration/webhooks#verificació-de-la-signatura)). `null` quan no s'ha produït cap rotació en les darreres 24 hores." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "created_by_email": { "type": "string", "nullable": true, "description": "Correu electrònic del membre de la Business Console que ha creat la destinació. `null` per a una destinació creada amb una clau d'API." }, "created_by_name": { "type": "string", "nullable": true, "description": "Nom del membre de la Business Console que ha creat la destinació. `null` per a una destinació creada amb una clau d'API." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Estat del lliurament. `failing`: 3 o més esdeveniments consecutius han fallat en el seu primer intent de lliurament des que la destinació va respondre satisfactòriament per darrera vegada (consulta `failing_streak`). `degraded`: no és failing, però un intent de lliurament ha fallat en les darreres 24 hores i cap intent posterior ha lliurat aquest esdeveniment; un reintent o reenviament que el lliuri neteja aquest estat. `healthy`: cap dels dos. Independent d'`enabled`. Un intent fallit és un que ha rebut una resposta HTTP 400 o superior, o que no ha rebut cap resposta." }, "failing_streak": { "type": "integer", "description": "Quants esdeveniments consecutius han fallat en el seu primer intent de lliurament des que la destinació va respondre satisfactòriament per última vegada, durant els darrers 30 dies. Els reintents no es comptabilitzen, i qualsevol intent satisfactori, inclòs un reintent o un reenviament, posa fi a la ratxa. `0` quan cap esdeveniment ha fallat des de l'últim èxit." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va fer el primer intent fallit de la `failing_streak` actual. `null` quan `failing_streak` és `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan la destinació va respondre per darrera vegada a un lliurament amb un estat HTTP inferior a 400, en els darrers 30 dies. `null` si no ho ha fet en aquest interval." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Entorn de l'aplicació propietària de la destinació." }, "summary": { "type": "object", "description": "Mètriques de lliurament dels darrers `metrics_window_days` (30) dies. `last_delivery_at` és l'intent més recent, independentment de quan es va fer.", "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": "Durada en dies de la finestra que cobreixen les altres mètriques de resum. Sempre és `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": "Falta la clau d'API, està mal formada, ha caducat o està assignada a una aplicació diferent. Si falta la clau es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap destinació amb aquest UUID, pertany a una aplicació diferent o s'ha suprimit.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualitza la destinació del webhook", "description": "Actualitza una destinació del webhook. **`subscribed_events` es REEMPLAÇA completament, no es fusiona**: consulta primer, afegeix i torna a enviar. El secret no es rota. Si hi ha un `uuid` al cos, s'ignora: el camí indica la destinació.", "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 de la destinació que cal actualitzar.", "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": "Nou nom llegible per a les persones." }, "url": { "type": "string", "format": "uri", "description": "Nova URL de destinació. Ha de ser única dins de l'aplicació." }, "enabled": { "type": "boolean", "description": "Estableix-ho a `false` per pausar els lliuraments a aquesta destinació sense eliminar-la." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Nova versió de l'esquema de payload per a lliuraments futurs." }, "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": "Destinació del webhook actualitzada. El cos té la mateixa 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": "Últims quatre caràcters del secret de signatura actual de la destinació, perquè puguis distingir els secrets. No són suficients per verificar una signatura." }, "previous_secret_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Establert durant 24 hores després que el secret de signatura de la destinació es roti a la Business Console. Fins aquest moment, cada lliurament a la destinació també inclou `X-Signature-Previous`, `X-Signature-V2-Previous` i `X-Signature-Simple-Previous`, generats amb el secret substituït (consulta [Verificació de la signatura](/ca/integration/webhooks#verificació-de-la-signatura)). `null` quan no s'ha produït cap rotació en les darreres 24 hores." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "created_by_email": { "type": "string", "nullable": true, "description": "Correu electrònic del membre de la Business Console que ha creat la destinació. `null` per a una destinació creada amb una clau d'API." }, "created_by_name": { "type": "string", "nullable": true, "description": "Nom del membre de la Business Console que ha creat la destinació. `null` per a una destinació creada amb una clau d'API." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Estat del lliurament. `failing`: 3 o més esdeveniments consecutius han fallat en el seu primer intent de lliurament des que la destinació va respondre satisfactòriament per darrera vegada (consulta `failing_streak`). `degraded`: no és failing, però un intent de lliurament ha fallat en les darreres 24 hores i cap intent posterior ha lliurat aquest esdeveniment; un reintent o reenviament que el lliuri neteja aquest estat. `healthy`: cap dels dos. Independent d'`enabled`. Un intent fallit és un que ha rebut una resposta HTTP 400 o superior, o que no ha rebut cap resposta." }, "failing_streak": { "type": "integer", "description": "Quants esdeveniments consecutius han fallat en el seu primer intent de lliurament des que la destinació va respondre satisfactòriament per última vegada, durant els darrers 30 dies. Els reintents no es comptabilitzen, i qualsevol intent satisfactori, inclòs un reintent o un reenviament, posa fi a la ratxa. `0` quan cap esdeveniment ha fallat des de l'últim èxit." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va fer el primer intent fallit de la `failing_streak` actual. `null` quan `failing_streak` és `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan la destinació va respondre per darrera vegada a un lliurament amb un estat HTTP inferior a 400, en els darrers 30 dies. `null` si no ho ha fet en aquest interval." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Entorn de l'aplicació propietària de la destinació." }, "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": "Durada en dies de la finestra que cobreixen les altres mètriques de resum. Sempre és `30`." } }, "description": "Mètriques de lliurament dels darrers `metrics_window_days` (30) dies. `last_delivery_at` és l'intent més recent, independentment de quan es va fer." } } }, "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ó ha fallat (URL duplicada, llista d'esdeveniments buida o amb esdeveniments desconeguts, cos amb format incorrecte).", "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": "Falta la clau d'API, està mal formada, ha caducat o està assignada a una aplicació diferent. Si falta la clau es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "La destinació amb aquest UUID no existeix (o s'ha suprimit, o pertany a una altra aplicació).", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Elimina la destinació del webhook", "description": "Elimina permanentment una destinació de webhook, el seu secret de signatura i tot el seu registre de lliuraments. Aquesta acció no es pot desfer. No s'enviarà cap webhook nou a la URL de la destinació; les altres destinacions subscrites als mateixos esdeveniments continuaran rebent-los. Després, la destinació ja no apareixerà a `GET /v3/webhook/destinations/`, i totes les rutes sota `/v3/webhook/destinations/{destination_uuid}/`, incloent-hi els seus lliuraments, el detall d'un lliurament i el seu reenviament, respondran amb un 404. El camp heretat `webhook_url` de l'aplicació s'estableix amb la URL de la destinació habilitada restant més antiga, o s'esborra si no queda cap destinació habilitada. Cridar DELETE de nou retorna 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 de la destinació que cal suprimir.", "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": "Destinació, secret de signatura i registre de lliuraments suprimits permanentment. Sense cos de resposta." }, "403": { "description": "Falta la clau d'API, està mal formada, ha caducat o està assignada a una aplicació diferent. Si falta la clau es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap destinació amb aquest UUID per a l'aplicació (ja s'ha suprimit o mai no ha existit).", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/wallet-screening/": { "post": { "summary": "Fes el cribratge d'una adreça de cartera", "description": "Executa un cribratge AML sota demanda per a una única cartera o adreça cripto sense crear cap transacció. Resol el proveïdor d'anàlisi de blockchain configurat a la teva aplicació, fa el cribratge de l'adreça de manera síncrona i retorna el resultat de risc normalitzat. LIGHTNING només està disponible amb una connexió BYOK d'Elliptic o Chainalysis afegida a través del Marketplace. No s'escriu res a la taula de transaccions. Es factura un ús de monitoratge AML per cada cribratge satisfactori (les aplicacions de sandbox no es facturen).", "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": "L'adreça de criptomoneda o l'identificador de xarxa que cal analitzar. Ha de coincidir amb la xarxa seleccionada (p. ex., una adreça de 40 caràcters hexadecimals amb el prefix `0x` per a cadenes EVM). Àlies: `address`.", "example": "0x94f1b9b64e2932f6a2db338f616844400cd58e8a" }, "blockchain": { "type": "string", "description": "Identificador de xarxa opcional. Si s'omet, la xarxa es llegeix a partir del format de l'adreça: les adreces `bc1`, `1` i `3` són Bitcoin (BTC), les adreces `T` són Tron (TRX) i les claus públiques base58 són Solana (SOL). Una adreça `0x` és vàlida a totes les xarxes EVM, de manera que ometre `blockchain` per a aquesta respon 422 amb les xarxes candidates a `candidate_chains`. El cribratge gestionat admet 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) i HBAR (Hedera). USDT i USDC són àlies heretats d'Ethereum, no cerques multixarxa. La cobertura de proveïdors connectats varia. LIGHTNING requereix un proveïdor connectat compatible. CELO (Celo), MODE (Mode) i PLUME (Plume) es cribren mitjançant un compte connectat de TRM Labs; el cribratge gestionat respon 400 per a aquests. Àlies: `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 l'adreça s'està cribrant com a contrapart entrant (dipòsit) o sortint (retirada). Accepta `inbound`, `outbound`, `deposit` o `withdrawal`. Per defecte aplica un cribratge neutre previ a la transferència si s'omet. Això només es passa al proveïdor com a context; no canvia el `risk_score`, la `severity` ni el desglossament de `source_of_funds`/`destination_of_funds` retornats, que es retornen sempre tots dos independentment de `direction`. Per tant, canviar o ometre `direction` no requereix tornar a cribrar una adreça.", "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 resultat normalitzat del cribratge de carteres.", "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ó — adreça de cartera mal formada, falta `wallet_address`, `blockchain` no admès, `blockchain` omès per a una adreça el format de la qual no especifica cap xarxa, o LIGHTNING sense una connexió del Marketplace BYOK d'Elliptic o Chainalysis." }, "401": { "description": "Falta l'`x-api-key` o no és vàlid." }, "409": { "description": "No hi ha cap proveïdor d'AML configurat per a l'aplicació, o el proveïdor configurat encara no admet el cribratge de carteres. Configura primer el monitoratge de transaccions." }, "422": { "description": "`blockchain` omès per a una adreça `0x`, que comparteixen totes les xarxes EVM. No s'analitza ni es factura res; torna-ho a enviar amb `blockchain` establert a una de les `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 proveïdor d'AML no ha pogut completar el cribratge. Torna-ho a provar més tard." } } } }, "/v3/wallet-screening/pdf/": { "post": { "summary": "Generar el resultat d'un cribratge de carteres en PDF", "description": "Complement sense estat per a `POST /v3/wallet-screening/`: torna a enviar exactament el cos JSON que va retornar aquest endpoint —incloent-hi la `report_signature` que va afegir— i rep un PDF amb la marca de Didit del mateix resultat. No es crida a cap proveïdor i no es factura ni es desa res de manera persistent; això només torna a renderitzar un resultat que Didit ja havia generat. La signatura vincula el PDF a un resultat no modificat: editar `risk_score`, `severity`, `sanctions_hit` o qualsevol altre camp signat abans de tornar a enviar falla amb `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": "L'objecte JSON sense modificar retornat per `POST /v3/wallet-screening/`, incloent-hi `report_signature`.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WalletScreeningResult" } ], "required": [ "report_signature" ], "description": "La mateixa estructura que la resposta de `POST /v3/wallet-screening/`; passa aquest cos de resposta literalment, incloent-hi `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 document PDF renderitzat, retornat directament com a binari `application/pdf`: no hi ha cap contenidor JSON.", "headers": { "Content-Disposition": { "description": "`attachment; filename=wallet_screening_{address}.pdf`, derivat de `wallet_address` (o `transaction_hash`) en el resultat republicat.", "schema": { "type": "string", "example": "attachment; filename=wallet_screening_0x28c6c06298d514db0899.pdf" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "El cos no és un objecte JSON que coincideixi amb l'estructura del resultat del cribratge de carteres, o falta `report_signature` o no coincideix amb els camps reenviats (editat o truncat abans del reenviament).", "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": "Falta l'`x-api-key` o no és vàlid." } } } }, "/v3/transactions/": { "get": { "summary": "Llista les transaccions", "description": "Llista paginada de transaccions monitorades, les més recents primer (`txn_date` desc). `count` està limitat a 100; fes servir `total_transactions` per obtenir el recompte real de files. Aquest endpoint no admet paràmetres de filtre ni de cerca.", "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": "Mida de la pàgina. Per defecte és 50 si s'omet. No hi ha cap màxim imposat, però mantén les pàgines petites per reduir la latència." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Desplaçament basat en zero del primer registre a retornar. És preferible seguir l'URL `next` de la pàgina anterior." }, { "name": "travel_rule_status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Retorna només les transaccions la transferència de Travel Rule de les quals estigui en aquest estat exacte (per exemple `ON_HOLD` o `AWAITING_COUNTERPARTY`). `count` segueix aquest filtre; `total_transactions` continua comptant totes les transaccions de l'aplicació." }, { "name": "assignee", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Separats per comes; una transacció coincideix quan compleix qualsevol dels valors. `unassigned` és el que encara no té ningú assignat, `rules` és el que les regles han decidit pel seu compte sense un revisor, i el correu d'un membre coincideix amb el revisor que té assignat. `me` és el revisor que ha iniciat sessió a la Console, de manera que una clau d'API que enviï `me` rep un `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": "Llista paginada de resums de transaccions, les més recents primer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Recompte limitat de transaccions coincidents (exacte fins a 100, limitat a partir d'aquí). Fes servir `total_transactions` per obtenir el recompte real en paginar." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta de la pàgina següent, o `null` a l'última pàgina." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta de la pàgina anterior, o `null` a la primera pàgina." }, "total_transactions": { "type": "integer", "description": "Nombre total exacte de transaccions (no suprimides) per a l'aplicació. Present en respostes paginades." }, "results": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador de transacció de Didit estable. Utilitza'l com a `{transaction_id}` en crides de detall, notes o relacionades." }, "transaction_number": { "type": "integer", "description": "Número seqüencial de transacció en l'àmbit de l'aplicació que es mostra a la consola (p. ex. `4123`)." }, "txn_id": { "type": "string", "description": "Identificador proporcionat pel client a la crida de creació (màx. 128 caràcters). Únic per aplicació." }, "transaction_type": { "type": "string", "description": "Categoria de primer nivell tal com s'emmagatzema: `finance`, `kyc`, `travelRule`, `userPlatformEvent`, `gamblingBet`, `gamblingLimitChange`, `gamblingBonusChange`, `auditTrailEvent`. Tingues en compte que els valors de diverses paraules es retornen en camelCase fins i tot quan s'envien en snake_case." }, "action_type": { "type": "string", "description": "Subtipus dins de la categoria (p. ex. `deposit`, `withdrawal`, `transfer`)." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Veredicte de monitoratge actual." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Direcció relativa al subjecte. S'emmagatzema en majúscules independentment de les majúscules o minúscules enviades." }, "amount": { "type": "string", "description": "Import de la transacció com a cadena decimal sense els zeros finals (p. ex., `\"1500\"`, `\"0.5\"`, `\"0.123456789012345678\"`). Fins a 18 decimals." }, "currency": { "type": "string", "description": "Codi de moneda de `amount`. S'accepta qualsevol codi alfabètic ISO 4217 (p. ex. `EUR`, `USD`, `NGN`), així com un símbol d'actiu cripto (p. ex. `BTC`). És preferible utilitzar un codi actualment en circulació. No tots els codis acceptats tenen tipus de canvi: quan no n'hi ha cap de disponible per al codi (per exemple, la unitat de compte ISO `XSU`, o un símbol cripto que Didit no cotitza), la conversió automàtica falla i `preferred_currency_amount` es retorna null tret que la sol·licitud hagi proporcionat un `amount_in_default_currency` preconvertit." }, "preferred_currency_amount": { "type": "string", "nullable": true, "description": "`amount` convertit a la moneda preferida de l'aplicació, quan estigui disponible." }, "preferred_currency_code": { "type": "string", "nullable": true, "description": "Codi de moneda preferida utilitzat per a `preferred_currency_amount`: la moneda base de l'aplicació, qualsevol codi ISO 4217 en circulació actualment. Un codi sense tipus de canvi disponible deixa `preferred_currency_amount` com a null tret que la sol·licitud hagi proporcionat un `amount_in_default_currency` preconvertit." }, "payment_details": { "type": "string", "nullable": true, "description": "Referència de pagament o concepte de text lliure de l'enviament." }, "score": { "type": "integer", "description": "Puntuació de risc (normalment 0–100). Com més alta, més risc." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "description": "Gravetat de risc categòrica establerta per regles/proveïdors (`UNKNOWN`, `LOW`, `MEDIUM`, `HIGH`, `CRITICAL`). `null` fins que algun element l'estableixi." }, "subject_name": { "type": "string", "nullable": true, "description": "Nom complet de la part `APPLICANT`." }, "subject_vendor_data": { "type": "string", "nullable": true, "description": "El teu identificador intern d'usuari/empresa per al sol·licitant." }, "subject_country": { "type": "string", "nullable": true, "description": "Codi de país del sol·licitant, a partir de l'`address.country` enviat (normalment ISO 3166-1 alpha-3)." }, "counterparty_name": { "type": "string", "nullable": true, "description": "Nom complet de la part `COUNTERPARTY`, si n'hi ha." }, "counterparty_vendor_data": { "type": "string", "nullable": true, "description": "El teu identificador intern per a la contrapart." }, "counterparty_country": { "type": "string", "nullable": true, "description": "Codi de país de la contrapart, a partir de l'`address.country` enviat." }, "tags": { "type": "array", "description": "Etiquetes adjuntades a la transacció (manualment o per regles).", "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 l'etiqueta és un valor predefinit de Didit o una etiqueta personalitzada." } } } }, "txn_date": { "type": "string", "format": "date-time", "description": "Quan va tenir lloc la transacció (a partir de `transaction_at` en el moment de la creació)." }, "created_at": { "type": "string", "format": "date-time", "description": "Quan Didit ha registrat l'enviament." }, "decision_reason_code": { "type": "string", "nullable": true, "description": "Motiu llegible per màquina per a l'`status` actual (p. ex., `WALLET_HIGH_RISK`)." }, "decision_reason_label": { "type": "string", "nullable": true, "description": "Etiqueta fàcil de llegir per a `decision_reason_code`." }, "assigned_to_name": { "type": "string", "nullable": true, "description": "Nom visible del revisor de la consola assignat a aquesta transacció." }, "travel_rule_status": { "type": "string", "nullable": true, "description": "Estat de la transferència de Travel Rule de la transacció (per exemple `COMPLETED`), o `null` quan no en té cap." }, "travel_rule": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TransactionTravelRule" } ], "description": "La transferència de Travel Rule de la transacció, el mateix bloc que `travel_rule` a `GET /v3/transactions/{transaction_id}/`, o `null` quan la transacció no en té cap." } } } } } }, "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": "Clau d'API absent, no vàlida o revocada, o bé la clau no pot llistar transaccions per a aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `Retry-After`.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crea una transacció", "description": "Envia una transacció per al monitoratge sincrònic de risc/AML. La transacció es crea com a `APPROVED`, després les teves regles (i el cribratge de criptomonedes, si escau) s'executen en línia i poden canviar l'`status` retornat a `IN_REVIEW` o `DECLINED`. **`transaction_id` és la teva clau d'idempotència** (màx. 128 caràcters, única per aplicació); reutilitzar-la retorna 400. S'emet un webhook `transaction.created` si la sol·licitud és satisfactòria per a aplicacions de producció. Les aplicacions de sandbox no es facturen i no emeten webhooks `transaction.created` ni `transaction.status.updated`. Els intercanvis de Travel Rule a sandbox sí que emeten webhooks `travel_rule.status.updated` amb `environment: sandbox`. Una transferència de Travel Rule s'emmagatzema i es retorna abans de contactar amb cap contrapart: `travel_rule.status` torna com a `AWAITING_COUNTERPARTY` (o `NOT_APPLICABLE` per sota del teu llindar, `UNCONFIRMED_OWNERSHIP` per a una cartera autoallotjada declarada, `COMPLETED` quan l'altra cartera és la teva pròpia cartera verificada) i `travel_rule.protocol` és null. A continuació, Didit tria la xarxa i envia l'intercanvi, i cada canvi d'estat posterior de la transferència, inclòs `COUNTERPARTY_VASP_NOT_FOUND` quan cap xarxa arriba a la contrapart, arriba com un webhook `travel_rule.status.updated`. Les teves regles es tornen a executar quan canvia la xarxa o l'estat.", "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": "El teu identificador únic per a aquesta transacció (màxim 128 caràcters).", "example": "your-txn-2026-05-17-001" }, "transaction_at": { "type": "string", "format": "date-time", "description": "Quan va tenir lloc la transacció. Per defecte pren l'hora actual si s'omet." }, "time_zone": { "type": "string", "description": "Identificador de zona horària IANA, p. ex. `Europe/Madrid`." }, "transaction_category": { "type": "string", "description": "Categoria de la transacció. També s'accepten àlies en CamelCase (`travelRule`, `userPlatformEvent`, `gamblingBet`, …); el valor emmagatzemat/retornat és en camelCase per a les categories de diverses paraules.", "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": "Detalls financers principals de la transacció.", "required": [ "direction", "amount", "currency" ], "properties": { "direction": { "type": "string", "description": "Direcció de la transacció relativa al subjecte. Insensible a majúscules i minúscules; s'accepten `in`/`out` com a àlies. Es retorna en majúscules (`INBOUND`/`OUTBOUND`).", "example": "outbound", "enum": [ "inbound", "outbound", "in", "out" ] }, "amount": { "type": "number", "description": "Import de la transacció (fins a 18 decimals). Envia'l com a cadena decimal (p. ex., `\"0.123456789012345678\"`) quan la precisió exacta sigui important: un número JSON s'analitza primer com a float binari, de manera que els dígits que superin aproximadament 15 dígits significatius s'arrodoneixen abans que s'emmagatzemi l'import. Ha de ser zero o superior: la direcció porta el signe, i un import negatiu retorna `400`.", "example": 1500 }, "currency": { "type": "string", "description": "Codi de moneda. S'accepta qualsevol codi alfabètic ISO 4217 (p. ex. `EUR`, `USD`, `NGN`), així com un símbol d'actiu cripto (p. ex. `BTC`). És preferible utilitzar un codi actualment en circulació. No tots els codis acceptats tenen tipus de canvi: quan no n'hi ha cap de disponible per al codi (per exemple, la unitat de compte ISO `XSU`, o un símbol cripto que Didit no cotitza), la conversió automàtica falla i `preferred_currency_amount` es retorna null tret que la sol·licitud hagi proporcionat un `amount_in_default_currency` preconvertit.", "example": "EUR" }, "currency_kind": { "type": "string", "description": "Indica si la moneda és `fiat` o `crypto`." }, "amount_in_default_currency": { "type": "number", "nullable": true, "description": "Import preconvertit en la moneda per defecte. Si s'omet, s'intenta la conversió automàtica de divises. Ha de ser zero o superior." }, "default_currency": { "type": "string", "description": "El codi de moneda per defecte per a l'import convertit. Qualsevol codi ISO 4217 actualment en circulació." }, "payment_details": { "type": "string", "nullable": true, "description": "Referència de pagament o concepte de text lliure." }, "payment_reference_id": { "type": "string", "nullable": true, "description": "Referència del sistema de pagament extern. Per al cribratge AML del hash de transaccions cripto, envia el hash de la transacció a la blockchain i proporciona també `subject.payment_method.account_id` amb l'adreça associada." }, "action_type": { "type": "string", "nullable": true, "description": "Subtipus de la transacció, p. ex. `deposit`, `withdrawal`, `transfer`." }, "crypto_params": { "type": "object", "description": "Selecció de la xarxa cripto, independent de la moneda (el símbol de l'actiu). Registrar un símbol de token personalitzat no garanteix la cobertura del hash de transacció per al seu contracte.", "properties": { "crypto_chain": { "type": "string", "description": "Xarxa real utilitzada per al cribratge. El cribratge gestionat admet 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) i HBAR (Hedera). També s'accepten els noms comuns de les xarxes, com per exemple POLYGON o POL per a MATIC, BSC per a BNB i TRON per a TRX. Especifica-ho sempre per a tokens multixarxa. Quan falta per a USDT, USDC o ETH enviat amb un hash de transacció 0x, Didit cerca el hash a Ethereum, BNB Chain, Polygon, Base, Arbitrum i Optimism i el cribra a la xarxa on es troba; si cap xarxa el té, la transacció no es cribra i custom_values.aml_screening_status és FAILED amb el motiu a custom_values.aml_screening_error. Quan falta per a USDT o USDC cribrats per cartera (sense hash de transacció), una adreça de Tron es cribra a Tron, una adreça de Solana a Solana, i una adreça 0x a la primera d'aquestes sis xarxes on hagi enviat una transacció o tingui el token, o a Ethereum si no està activa a cap d'elles. La cobertura dels proveïdors connectats varia; LIGHTNING requereix un proveïdor connectat compatible.", "example": "BASE" } } } } }, "subject": { "type": "object", "description": "El subjecte (sol·licitant) de la transacció.", "required": [ "vendor_data", "full_name" ], "properties": { "entity_type": { "type": "string", "description": "Tipus d'entitat: `individual` o `company`." }, "vendor_data": { "type": "string", "description": "El teu identificador intern d'usuari/empresa.", "example": "user-12345" }, "full_name": { "type": "string", "description": "Nom complet del subjecte.", "example": "Maria Garcia" }, "first_name": { "type": "string", "description": "Nom de pila de la persona." }, "last_name": { "type": "string", "description": "Cognom del subjecte." }, "date_of_birth": { "type": "string", "format": "date", "description": "Data de naixement (YYYY-MM-DD)." }, "address": { "type": "object", "description": "Objecte d'adreça.", "properties": { "country": { "type": "string", "description": "Codi de país (es recomana ISO 3166-1 alpha-3). Es copia al `country_code` de la part." }, "town": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" }, "post_code": { "type": "string" } } }, "institution_details": { "type": "object", "description": "Detalls de la institució (per a subjectes institucionals).", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "address": { "type": "object" } } }, "device_context": { "type": "object", "description": "Context del dispositiu capturat en el moment de la transacció. browser_family i platform s'han d'enviar com a claus explícites de primer nivell; no es deriven de user_agent. L'àlies en camelCase device també s'accepta a la sol·licitud.", "properties": { "fingerprint": { "type": "string", "description": "Petjada digital única del dispositiu." }, "persistent_device_id": { "type": "string", "description": "Identificador de dispositiu estable entre sessions (esquema d'empremta digital v2)." }, "user_agent": { "type": "string", "description": "Cadena de l'agent d'usuari del navegador o de l'aplicació. Àlies en CamelCase: userAgent." }, "browser_family": { "type": "string", "description": "Família del navegador (p. ex., Chrome, Firefox, Safari). S'ha d'enviar explícitament; no es deriva de user_agent. Àlies en CamelCase: browserFamily." }, "browser_version": { "type": "string", "description": "Cadena de la versió del navegador. S'ha d'enviar explícitament. Àlies en CamelCase: browserVersion." }, "platform": { "type": "string", "description": "Identificador de plataforma (web, ios, android, macos, windows, linux). S'ha d'enviar explícitament; no es deriva de user_agent." }, "os_family": { "type": "string", "description": "Família del sistema operatiu (p. ex., iOS, Android, Windows). Àlies CamelCase: osFamily." }, "os_version": { "type": "string", "description": "Cadena de la versió del sistema operatiu. Àlies CamelCase: osVersion." }, "accept_language": { "type": "string", "description": "Valor de la capçalera Accept-Language. Àlies en CamelCase: acceptLang." }, "session_id": { "type": "string", "description": "Identificador de sessió de la sessió actual de l'usuari. S'emmagatzema a les metadades. Àlies en camelCase: sessionId." }, "session_age_ms": { "type": "number", "description": "Antiguitat de la sessió de l'usuari en mil·lisegons en el moment de la transacció. Àlies en CamelCase: sessionAgeMs." }, "network_context": { "type": "object", "description": "Context de xarxa amb adreça IP i geolocalització. També s'inclou un bloc ipInfo de nivell superior en aquest objecte.", "properties": { "ip_address": { "type": "string", "description": "Adreça IP del client. Àlies CamelCase: ip." }, "ip_country_code": { "type": "string", "description": "País geolocalitzat de la IP (ISO 3166-1 alfa-3). Àlies en CamelCase: countryCode3." }, "latitude": { "type": "number", "description": "Latitud geogràfica de la IP. Àlies en CamelCase: lat." }, "longitude": { "type": "number", "description": "Longitud geogràfica de la IP. Àlies en CamelCase: lon." } } } } }, "payment_method": { "type": "object", "description": "Mètode de pagament utilitzat pel subjecte.", "properties": { "method_type": { "type": "string", "description": "Tipus de mètode de pagament: `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`." }, "account_id": { "type": "string", "description": "Identificador de compte (p. ex., IBAN, adreça de cartera). Per al cribratge de criptomonedes, ha de contenir l'adreça de cartera d'aquest participant. El cribratge de hash de transacció entrant requereix l'adreça de dipòsit del servei/client del subjecte. El cribratge sortint utilitza la cartera de destinació de la contrapart. En una transferència de criptomonedes a bitcoin o Lightning pot ser una sol·licitud de pagament de Lightning (factura BOLT11, oferta BOLT12, LNURL) o una Lightning Address: Didit emmagatzema el beneficiari que s'hi indica com a compte (\"\" quan no n'indica cap) i el que diu la sol·licitud a `chain_details.lightning` de la transferència de Travel Rule. Com a màxim 255 caràcters un cop emmagatzemat. En una transferència de criptomonedes a bitcoin o Lightning pot ser una sol·licitud de pagament de Lightning (factura BOLT11, oferta BOLT12, LNURL) o una Lightning Address: Didit emmagatzema el beneficiari que s'hi indica com a compte (\"\" quan no n'indica cap) i el que diu la sol·licitud a `chain_details.lightning` de la transferència de Travel Rule. Com a màxim 255 caràcters un cop emmagatzemat." }, "memo": { "type": "string", "maxLength": 256, "description": "El destination tag o memo que forma part de la cartera en una xarxa de memo (XRP, XLM, EOS, ATOM, HBAR). En una única adreça d'exchange compartida, cada memo és el seu propi mètode de pagament. XRP: un destination tag, un nombre enter de 0 a 4294967295 (s'accepta un número JSON). XLM: un memo de text de fins a 28 bytes, un ID de 64 bits o un hash de 32 bytes en hex. EOS: fins a 256 bytes. ATOM: fins a 256 caràcters. HBAR: fins a 100 bytes. Les carteres de Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin i Lightning no admeten memo: incloure'n un retorna un `400`. Àlies: `destinationTag` o `destination_tag`." }, "issuing_country": { "type": "string", "description": "Codi de país ISO 3166-1 alpha-3 de l'emissor." } } } } }, "counterparty": { "type": "object", "description": "La contrapart de la transacció (opcional).", "properties": { "entity_type": { "type": "string", "description": "Tipus d'entitat: `individual` o `company`." }, "vendor_data": { "type": "string", "description": "El teu identificador intern per a la contrapart." }, "full_name": { "type": "string", "description": "Nom complet de la contrapart." }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "address": { "type": "object", "description": "Objecte d'adreça amb `country` (ISO 3166-1 alfa-3)." }, "institution_details": { "type": "object" }, "device_context": { "type": "object", "description": "Context del dispositiu per a la contrapart. browser_family i platform s'han d'enviar com a claus explícites de primer nivell; no es deriven de user_agent.", "properties": { "fingerprint": { "type": "string", "description": "Petjada digital única del dispositiu." }, "persistent_device_id": { "type": "string", "description": "Identificador de dispositiu estable entre sessions (esquema d'empremta digital v2)." }, "user_agent": { "type": "string", "description": "Cadena de l'agent d'usuari del navegador o de l'aplicació. Àlies en CamelCase: userAgent." }, "browser_family": { "type": "string", "description": "Família del navegador (p. ex., Chrome, Firefox, Safari). S'ha d'enviar explícitament; no es deriva de user_agent. Àlies en CamelCase: browserFamily." }, "browser_version": { "type": "string", "description": "Cadena de la versió del navegador. S'ha d'enviar explícitament. Àlies en CamelCase: browserVersion." }, "platform": { "type": "string", "description": "Identificador de plataforma (web, ios, android, macos, windows, linux). S'ha d'enviar explícitament; no es deriva de user_agent." }, "os_family": { "type": "string", "description": "Família del sistema operatiu (p. ex., iOS, Android, Windows). Àlies CamelCase: osFamily." }, "os_version": { "type": "string", "description": "Cadena de la versió del sistema operatiu. Àlies CamelCase: osVersion." }, "accept_language": { "type": "string", "description": "Valor de la capçalera Accept-Language. Àlies en CamelCase: acceptLang." }, "session_id": { "type": "string", "description": "Identificador de sessió per a la sessió de la contrapart. S'emmagatzema a les metadades. Àlies en camelCase: sessionId." }, "session_age_ms": { "type": "number", "description": "Antiguitat de la sessió de l'usuari en mil·lisegons en el moment de la transacció. Àlies en CamelCase: sessionAgeMs." }, "network_context": { "type": "object", "description": "Context de xarxa amb adreça IP i geolocalització. També s'inclou un bloc ipInfo de nivell superior en aquest objecte.", "properties": { "ip_address": { "type": "string", "description": "Adreça IP del client. Àlies CamelCase: ip." }, "ip_country_code": { "type": "string", "description": "País geolocalitzat de la IP (ISO 3166-1 alfa-3). Àlies en CamelCase: countryCode3." }, "latitude": { "type": "number", "description": "Latitud geogràfica de la IP. Àlies en CamelCase: lat." }, "longitude": { "type": "number", "description": "Longitud geogràfica de la IP. Àlies en CamelCase: lon." } } } } }, "payment_method": { "type": "object", "description": "Mètode de pagament utilitzat per la contrapart. A les transaccions de Travel Rule, `method_type: \"unhosted_wallet\"` declara la cartera de la contrapart com a autoallotjada: la transferència omet l'encaminament cap al VASP de la contrapart, es crea directament a `UNCONFIRMED_OWNERSHIP` i (quan `auto_wallet_verification` està activat) es genera automàticament una sessió de widget de titularitat de la cartera i es retorna al bloc `action_required` de la transacció.", "properties": { "method_type": { "type": "string", "description": "Tipus de mètode de pagament: `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`. Fes servir `unhosted_wallet` per declarar una cartera autoallotjada per a la Travel Rule." }, "account_id": { "type": "string", "description": "Identificador de compte (p. ex., IBAN o adreça de cartera). En una transferència de criptomonedes a bitcoin o Lightning pot ser una sol·licitud de pagament de Lightning (factura BOLT11, oferta BOLT12, LNURL) o una Lightning Address: Didit emmagatzema el beneficiari que s'hi indica com a compte (\"\" quan no n'indica cap) i el que diu la sol·licitud a `chain_details.lightning` de la transferència de Travel Rule. Com a màxim 255 caràcters un cop emmagatzemat. En una transferència de criptomonedes a bitcoin o Lightning pot ser una sol·licitud de pagament de Lightning (factura BOLT11, oferta BOLT12, LNURL) o una Lightning Address: Didit emmagatzema el beneficiari que s'hi indica com a compte (\"\" quan no n'indica cap) i el que diu la sol·licitud a `chain_details.lightning` de la transferència de Travel Rule. Com a màxim 255 caràcters un cop emmagatzemat." }, "memo": { "type": "string", "maxLength": 256, "description": "El destination tag o memo que forma part de la cartera en una xarxa de memo (XRP, XLM, EOS, ATOM, HBAR). En una única adreça d'exchange compartida, cada memo és el seu propi mètode de pagament. XRP: un destination tag, un nombre enter de 0 a 4294967295 (s'accepta un número JSON). XLM: un memo de text de fins a 28 bytes, un ID de 64 bits o un hash de 32 bytes en hex. EOS: fins a 256 bytes. ATOM: fins a 256 caràcters. HBAR: fins a 100 bytes. Les carteres de Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin i Lightning no admeten memo: incloure'n un retorna un `400`. Àlies: `destinationTag` o `destination_tag`." }, "issuing_country": { "type": "string" } } } } }, "custom_properties": { "type": "object", "description": "Parells clau-valor arbitraris adjunts a la transacció. Cada clau es pot referenciar a les condicions de les regles amb la ruta de camp `custom_values.`.", "additionalProperties": true, "example": { "merchant_id": "test", "bank_name": "test_2" } }, "travel_rule_details": { "type": "object", "description": "Dades de Travel Rule. Quan Travel Rule està activat i transaction_category és travel_rule, Didit gestiona l'intercanvi directament: ignora status, protocol, required i obligations_count, i utilitza originator_data, beneficiary_data i metadata. En cas contrari, Didit emmagatzema aquests valors com un registre passiu de Travel Rule. Mentre Travel Rule està actiu, una transferència sortint igual o superior al teu llindar ha d'incloure el que requereix el seu règim (TFR de la UE o Recomanació 16 del GAFI), comprovat en les parts que envies: un camp absent respon 400 sota `travel_rule_details.originator_data` o `travel_rule_details.beneficiary_data`, per exemple \"EU TFR requires the originator name.\"", "required": [ "status" ], "properties": { "status": { "type": "string", "description": "Obligatori sempre que enviïs travel_rule_details. Un dels estats de transferència de la Travel Rule (per exemple AWAITING_COUNTERPARTY, COMPLETED, NOT_APPLICABLE); també s'accepten i es mapegen les variants en minúscules i en camelCase, així com els valors antics UNKNOWN, COMPLIANT, PENDING_ACTION, PENDING_COUNTERPARTY, FAILED i EXEMPT. Qualsevol altre valor retorna 400." }, "protocol": { "type": "string" }, "required": { "type": "boolean" }, "obligations_count": { "type": "integer" }, "originator_data": { "type": "object", "description": "Part ordenant, com a camps plans o com una persona IVMS 101. Per al teu usuari amb una verificació KYC aprovada, Didit substitueix els camps que conté la verificació pels valors verificats (consulta `metadata.originator_provenance`). Ha de ser un objecte: qualsevol altra cosa és un `400`. En una xarxa amb memo, una clau `memo` indica el memo o l'etiqueta de la cartera de l'ordenant." }, "beneficiary_data": { "type": "object", "description": "Part beneficiària, com a camps plans o una persona IVMS 101. Ha de ser un objecte: qualsevol altra cosa és un `400`. Per encaminar la transferència, Didit llegeix `wallet_address` (si està buit s'omple des de `counterparty.payment_method.account_id`), `chain` (omplert des de `transaction_details.crypto_params.crypto_chain` o la `currency` quan aquesta anomena una xarxa admesa), `name` (recorrent a `counterparty.full_name`), `travel_address`, `counterparty_vasp_name`, `counterparty_vasp_lei` i `counterparty_vasp_email`. En una xarxa amb memo, `memo` indica el memo o etiqueta de la cartera del beneficiari; `wallet_address` i `memo` prevalen sobre el mètode de pagament de la contrapart." }, "metadata": { "type": "object" }, "utxo": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleUtxo" } ], "description": "Opcional, només per a cadenes UTXO (BTC, LTC, BCH, DOGE). Les entrades i sortides de la transacció, a partir de les quals Didit infereix la cartera de l'ordenant i la sortida del beneficiari quan no les declares." }, "originator": { "type": "object", "description": "Un bloc d'ordenant IVMS 101: `originatorPersons` (una `naturalPerson` o `legalPerson`; una persona jurídica fa que la part sigui una empresa) i `accountNumber` (adreces de cartera). S'utilitza per a `originator_data` quan aquest objecte està buit. Un bloc mal format respon 400 identificat pel seu camí, per exemple `originator.originatorPersons`." }, "beneficiary": { "type": "object", "description": "Un bloc de beneficiari IVMS 101: `beneficiaryPersons` (una `naturalPerson` o `legalPerson`; una persona jurídica fa que la part sigui una empresa) i `accountNumber` (adreces de cartera). S'utilitza per a `beneficiary_data` quan aquest objecte està buit. Un bloc mal format retorna un 400 amb la clau del seu camí, per exemple `beneficiary.beneficiaryPersons`." }, "ivms101": { "type": "object", "description": "Els blocs `originator` i `beneficiary` embolicats en un sol objecte IVMS 101 (també s'accepta `IVMS101`). Els blocs de nivell superior prevalen sobre els de l'embolcall." } } }, "network_snapshot": { "type": "object", "description": "Instantània precalculada del graf de xarxa.", "properties": { "nodes": { "type": "array", "items": { "type": "object" } }, "edges": { "type": "array", "items": { "type": "object" } }, "metrics": { "type": "object" } } }, "include_crypto_screening": { "type": "boolean", "nullable": true, "description": "Sobreescriptura per transacció per al cribratge d'analítica blockchain de criptomonedes. Quan és `true`, el cribratge de criptomonedes es realitza independentment del valor per defecte de l'aplicació. Quan és `false`, el cribratge de criptomonedes s'omet encara que estigui activat a la configuració de l'aplicació. Si s'omet o és `null`, s'utilitza el valor per defecte a nivell d'aplicació configurat a la consola. El cribratge de criptomonedes requereix `transaction_details.direction`, `currency_kind: \"crypto\"`, una cadena/moneda i l'adreça de la cartera seleccionada segons la direcció: el cribratge previ a la transferència entrant utilitza `counterparty.payment_method.account_id`, el cribratge per hash de transacció entrant utilitza `subject.payment_method.account_id`, i el cribratge sortint utilitza `counterparty.payment_method.account_id`. Quan `transaction_details.payment_reference_id` conté un hash de transacció de blockchain, Didit realitza el cribratge de la transacció i retorna l'enriquiment del resum de la transacció quan estigui disponible." } }, "required": [ "transaction_id", "transaction_category", "transaction_details", "subject" ] }, "examples": { "Minimal fiat withdrawal": { "summary": "Payload acceptable més petit per a una transferència sortint de moneda fiduciària", "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": "Retirada cripto sortint a una cartera autoallotjada, cribratge opcional", "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": "Transferència cripto sortint amb dades d'ordenant/beneficiari de 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ó enviada i monitorada. El cos és el detall complet de la transacció (mateixa estructura que `GET /v3/transactions/{transaction_id}/`), reflectint els resultats de les regles ja aplicats.", "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ó ha fallat (falten camps obligatoris, `transaction_id` duplicat, valor d'enum desconegut, 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": "Clau d'API absent, no vàlida o revocada, o bé la clau no pot enviar transaccions per a aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "409": { "description": "Una altra sol·licitud amb el mateix `transaction_id` ha creat la transacció mentre es processava aquesta, de manera que només un dels dos enviaments simultanis té èxit. Llegeix la transacció existent en lloc de tornar-la a enviar.", "content": { "application/json": { "examples": { "Concurrent duplicate": { "value": { "detail": "A transaction with this transaction_id already exists." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència: les creacions de transaccions i la ingesta d'esdeveniments (`POST /v3/transactions/`, `POST /v3/events/`, `POST /v3/events/batch/`) comparteixen un pressupost de 600 sol·licituds per minut per clau d'API, independent de les 300 que comparteixen la resta de sol·licituds d'escriptura. Espera els segons indicats a `Retry-After` i reintenta-ho.", "headers": { "Retry-After": { "description": "Segons d'espera abans de reintentar, arrodonits a l'alça perquè el reintent caigui a la finestra següent.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Ingestion rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-didit-sdk": { "resource": "transactions", "method": "create", "auth": "api_key", "server": true } } }, "/v3/transactions/{transaction_id}/": { "get": { "summary": "Obtenir la transacció", "description": "Recupera el registre complet de monitoratge per a una transacció: parts, puntuació/gravetat, execucions de regles, alertes, resultat de Travel Rule i sessió de correcció.", "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 de transacció estable de Didit (el `uuid` retornat de create / list, **no** el teu `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": "Detall complet de la transacció.", "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": "Clau d'API absent, no vàlida o revocada, o bé la clau no pot llegir les transaccions d'aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap transacció amb aquest UUID per a l'aplicació (s'ha suprimit, no s'ha creat mai, pertany a una altra aplicació o el segment de la ruta no és un UUID vàlid).", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `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": "Genera un token de transacció de l'SDK", "description": "Genera un token d'abast limitat de curta durada que la teva aplicació passa als SDK de Didit perquè puguin enviar transaccions directament des del dispositiu de l'usuari final mitjançant `POST /v1/transactions/`. El token està vinculat a un `vendor_data` (el teu ID d'usuari): cada transacció enviada amb ell té la identitat del subjecte aplicada al costat del servidor a partir d'aquesta vinculació, de manera que un client manipulat no pugui fer enviaments en nom d'un altre usuari. Genera els tokens des del teu backend; no incloguis mai la clau d'API en una aplicació. També s'accepten àlies 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": "El teu identificador intern per a l'usuari final a qui s'aplica aquest token. S'aplica com la identitat del subjecte de cada transacció enviada amb el token.", "example": "user-042" }, "ttl_seconds": { "type": "integer", "default": 900, "maximum": 86400, "description": "Temps de vida del token en segons. Per defecte és 900 (15 minuts); màxim 86400 (24 hores)." }, "max_uses": { "type": "integer", "nullable": true, "description": "Nombre màxim d'enviaments satisfactoris permesos amb aquest token. Omet o defineix com a null per a usos il·limitats dins 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 emès. Lliura `sdk_token` a la teva aplicació; autentica els endpoints de `/v1/transactions/` orientats al dispositiu mitjançant la capçalera `X-Transaction-Token` fins a `expires_at`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sdk_token": { "type": "string", "description": "El token de transacció amb abast que s'ha de passar a l'SDK." }, "expires_at": { "type": "string", "format": "date-time", "description": "Quan el token deixa de ser acceptat." } } }, "example": { "sdk_token": "q7Zt...urlsafe", "expires_at": "2026-07-07T12:15:00Z" } } } }, "400": { "description": "La validació ha fallat: falta `vendor_data` o `ttl_seconds` està fora del rang permès.", "content": { "application/json": { "examples": { "Missing vendor_data": { "value": { "vendor_data": [ "This field is required." ] } } } } } }, "403": { "description": "Clau d'API absent, no vàlida o revocada.", "content": { "application/json": { "examples": { "Invalid API Key": { "value": { "detail": "Invalid API Key." } } } } } } } } }, "/v1/transactions/": { "post": { "summary": "Envia una transacció des d'un SDK", "description": "Endpoint orientat a dispositius que els SDK de Didit criden per enviar una transacció directament des del dispositiu de l'usuari final. L'autenticació és un token amb abast obtingut de `POST /v3/transactions/sdk-token/` enviat a la capçalera `X-Transaction-Token` en lloc d'una clau d'API, i l'endpoint té CORS habilitat perquè els navegadors puguin cridar-lo entre orígens diferents. El payload utilitza els àlies en camelCase que es mostren a continuació (els mètodes `submitTransaction` de l'SDK el construeixen per tu). Tres garanties del costat del servidor: l'aplicació sempre s'obté del token; la identitat del subjecte (`externalUserId`) sempre s'aplica des del `vendor_data` del token, de manera que els valors suplantats del payload s'ignoren; i la intel·ligència del dispositiu (la petjada digital del dispositiu de l'SDK més la IP i el user agent derivats pel servidor) s'associa automàticament al subjecte.", "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": "El teu identificador únic per a aquesta transacció (correspon a `transaction_id`, màxim 128 caràcters).", "example": "wd-2026-07-07-0042" }, "txnDate": { "type": "string", "format": "date-time", "description": "Quan va tenir lloc la transacció (s'assigna a `transaction_at`). Per defecte pren l'hora actual si s'omet." }, "zoneId": { "type": "string", "description": "Identificador de zona horària IANA (es correlaciona amb `time_zone`), p. ex. `Europe/Madrid`." }, "type": { "type": "string", "description": "Categoria de la transacció (s'assigna a `transaction_category`), p. ex., `finance`, `kyc`, `travelRule`, `userPlatformEvent`, `gamblingBet`.", "example": "travelRule" }, "info": { "type": "object", "description": "Detalls financers principals de la transacció (correspon a `transaction_details`).", "required": [ "direction", "amount", "currency" ], "properties": { "direction": { "type": "string", "description": "Direcció relativa al subjecte. Insensible a majúscules i minúscules; s'accepten `in`/`out` com a àlies. Es retorna en majúscules (`INBOUND`/`OUTBOUND`).", "example": "out" }, "amount": { "type": "number", "description": "Import de la transacció (fins a 18 decimals). També s'accepta una cadena decimal i és l'única manera de conservar més d'uns 15 dígits significatius: un número JSON s'analitza primer com a float binari, de manera que `0.123456789012345678` s'emmagatzema com a `0.12345678901234568`.", "example": 0.25 }, "currency": { "type": "string", "description": "Codi de moneda. S'accepta qualsevol codi alfabètic ISO 4217 (p. ex. `EUR`, `USD`, `NGN`), així com un símbol d'actiu cripto (p. ex. `BTC`). És preferible utilitzar un codi actualment en circulació. No tots els codis acceptats tenen tipus de canvi: quan no n'hi ha cap de disponible per al codi (per exemple, la unitat de compte ISO `XSU`, o un símbol cripto que Didit no cotitza), la conversió automàtica falla i `preferred_currency_amount` es retorna null tret que la sol·licitud hagi proporcionat un `amountInDefaultCurrency` preconvertit.", "example": "ETH" }, "currencyType": { "type": "string", "description": "Indica si la moneda és `fiat` o `crypto` (correspon a `currency_kind`)." }, "amountInDefaultCurrency": { "type": "number", "nullable": true, "description": "Import preconvertit en la moneda per defecte (es mapeja a `amount_in_default_currency`). Si s'omet, s'intenta la conversió automàtica de divises." }, "defaultCurrencyCode": { "type": "string", "description": "El codi de moneda per defecte per a l'import convertit (correspon a `default_currency`). Qualsevol codi ISO 4217 actualment en circulació." }, "paymentDetails": { "type": "string", "nullable": true, "description": "Referència de pagament o concepte de text lliure (s'assigna a `payment_details`)." }, "paymentTxnId": { "type": "string", "nullable": true, "description": "Referència de pagament externa (es vincula amb `payment_reference_id`); el hash de la transacció on-chain per a transaccions cripto." }, "type": { "type": "string", "nullable": true, "description": "Subtipus de la transacció (s'assigna a `action_type`), p. ex. `deposit`, `withdrawal`, `transfer`." }, "cryptoParams": { "type": "object", "description": "Paràmetres específics de cripto, p. ex. `{\"crypto_chain\": \"ETH\"}`." } } }, "subject": { "type": "object", "description": "El subjecte (sol·licitant) de la transacció. `externalUserId` s'ignora aquí: la identitat del subjecte es determina sempre a partir de `vendor_data` del token.", "required": [ "fullName" ], "properties": { "type": { "type": "string", "description": "Tipus d'entitat (s'assigna a `entity_type`): `individual` (per defecte) o `company`." }, "externalUserId": { "type": "string", "description": "S'ignora al subjecte: s'aplica al servidor a partir del camp `vendor_data` del token." }, "fullName": { "type": "string", "example": "Jane Doe" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "dob": { "type": "string", "format": "date", "description": "Data de naixement (YYYY-MM-DD; s'assigna a `date_of_birth`)." }, "address": { "type": "object", "description": "Objecte d'adreça amb `country` (ISO 3166-1 alfa-3), `town`, `state`, `street`, `post_code`." }, "institutionInfo": { "type": "object", "description": "Detalls de la institució per a participants institucionals (s'associa a `institution_details`)." }, "device": { "type": "object", "description": "Context de dispositiu explícit opcional. Es fusiona amb la intel·ligència de dispositiu capturada automàticament; en cas de conflicte, prevalen els camps derivats pel servidor." }, "paymentMethod": { "type": "object", "description": "Mètode de pagament utilitzat pel subjecte (s'assigna a `payment_method`).", "properties": { "type": { "type": "string", "description": "Tipus de mètode de pagament (s'assigna a `method_type`), p. ex. `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`." }, "accountId": { "type": "string", "description": "Identificador de compte (s'assigna a `account_id`): IBAN, empremta de targeta o adreça de cartera." }, "issuingCountry": { "type": "string", "description": "Codi de país ISO 3166-1 alpha-3 de l'emissor (correspon a `issuing_country`)." } } } } }, "counterparty": { "type": "object", "description": "La contrapart de la transacció (opcional). Té la mateixa estructura que `subject`; `externalUserId` és rellevant aquí.", "properties": { "type": { "type": "string", "description": "Tipus d'entitat (s'assigna a `entity_type`): `individual` o `company`." }, "externalUserId": { "type": "string", "description": "El teu identificador intern per a la contrapart (correspon 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ètode de pagament utilitzat per la contrapart (s'assigna a `payment_method`). A les transaccions de Travel Rule, `type: \"unhosted_wallet\"` declara la cartera de la contrapart com a autoallotjada: la transferència omet l'encaminament cap al VASP de la contrapart, es crea directament a `UNCONFIRMED_OWNERSHIP` i (quan `auto_wallet_verification` està activat) es genera automàticament una sessió de widget de titularitat de la cartera i es retorna a `action_required` perquè l'SDK la pugui iniciar.", "properties": { "type": { "type": "string", "description": "Tipus de mètode de pagament (s'assigna a `method_type`), p. ex. `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`. Utilitza `unhosted_wallet` per declarar una cartera autoallotjada per a la Travel Rule." }, "accountId": { "type": "string", "description": "Identificador de compte (s'assigna a `account_id`): IBAN, empremta de targeta o adreça de cartera." }, "issuingCountry": { "type": "string" } } } } }, "props": { "type": "object", "additionalProperties": true, "description": "Parells clau-valor personalitzats (s'assignen a `custom_properties`). Cada clau es pot referenciar a les condicions de les regles com a `custom_values.`." }, "travelRule": { "type": "object", "description": "Detalls de Travel Rule (es correlaciona amb `travel_rule_details`). Quan Travel Rule està activat per a l'aplicació, Didit ignora qualsevol `status` que enviïs i gestiona l'intercanvi directament.", "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": "Sobreescriptura per transacció per al cribratge d'analítica blockchain de criptomonedes (s'assigna a `include_crypto_screening`)." }, "fingerprint_v2": { "type": "object", "description": "El payload d'empremta digital del dispositiu `didit-fp-v2`. Injectat automàticament pels SDK; només és rellevant quan es crida directament a la wire API." } }, "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ó enviada i monitorada. Mateixa estructura de detall que `GET /v3/transactions/{transaction_id}/`, incloent-hi el bloc `action_required` quan l'usuari final ha de completar una acció de seguiment (els SDK la inicien automàticament per defecte).", "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ó ha fallat (falten camps obligatoris, `txnId` duplicat, categoria desconeguda).", "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": "El token de la transacció s'ha rebutjat: falta, és desconegut, s'ha revocat, ha superat el seu `max_uses` o ha caducat. Les respostes de token caducat sempre contenen la paraula `expired` al detall, que és com els SDK distingeixen els errors `expired_token` dels errors `invalid_token`.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "Invalid transaction token." } }, "Expired token": { "value": { "detail": "Transaction token expired." } } } } } }, "409": { "description": "Una altra sol·licitud amb el mateix `txnId` ha creat la transacció mentre es processava aquesta, de manera que només un dels dos enviaments simultanis té èxit. Llegeix la transacció existent en lloc de tornar-la a enviar.", "content": { "application/json": { "examples": { "Concurrent duplicate": { "value": { "detail": "A transaction with this transaction_id already exists." } } } } } } } } }, "/v1/transactions/{transaction_id}/": { "get": { "summary": "Obtenir una transacció des d'un SDK", "description": "Endpoint de lectura orientat a dispositius, autenticat amb el mateix `X-Transaction-Token` utilitzat per a l'enviament. Els SDK en fan sondeig (polling) després que es completi un flux d'acció llançat automàticament o es tanqui la seva finestra, de manera que l'estat final mai depèn d'una sola notificació. Retorna el mateix detall de la transacció que la resposta d'enviament, inclòs el bloc `action_required` actual (`null` un cop resolta l'acció).", "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 de transacció estable de Didit (el `uuid` de la resposta d'enviament, **no** el teu `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 detall complet de la transacció, incloent-hi `action_required` (`null` un cop resolta l'acció pendent).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetail" } } } }, "401": { "description": "El token de la transacció s'ha rebutjat: falta, és desconegut, s'ha revocat, ha superat el seu `max_uses` o ha caducat.", "content": { "application/json": { "examples": { "Expired token": { "value": { "detail": "Transaction token expired." } } } } } }, "404": { "description": "No existeix cap transacció amb aquest UUID per a l'aplicació del token, o el segment de la ruta no és un UUID vàlid.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } } } } }, "/v3/businesses/": { "get": { "summary": "Llista les empreses", "description": "Llista les [empreses](/entities/businesses) que Didit reuneix a partir de sessions de KYB que comparteixen el mateix `vendor_data` (cadena de text lliure, NO pas un UUID), a més de les empreses creades mitjançant l'API. Paginat, ordenat per `last_session_at` descendent. Aquest endpoint no admet paràmetres de filtre ni de cerca; obtén les pàgines i filtra al costat del client.", "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": "Mida de la pàgina. Per defecte és 50 si s'omet. No hi ha cap màxim imposat, però mantén les pàgines petites per reduir la latència." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Desplaçament basat en zero del primer registre a retornar. És preferible seguir l'URL `next` de la pàgina anterior abans que calcular-ho manualment." } ], "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": "Llista paginada d'empreses amb estat, recomptes de sessions i desglossament de funcionalitats.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Nombre de files coincidents: exacte fins a 100, limitat a 100 a partir d'aquí per motius de rendiment. No el facis servir per detectar la darrera pàgina; confia en canvi que `next` sigui `null`." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta de la pàgina següent, o `null` a l'última pàgina." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta de la pàgina anterior, o `null` a 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": "Clau d'API absent, no vàlida o revocada, o bé la clau no pot llistar empreses per a aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/customization/": { "get": { "summary": "Obtenir la personalització de marca", "description": "Retorna la configuració de marca blanca de l'aplicació, resolta a partir de la clau d'API: colors, tipografies, radis de vora, URL de logotips i opcions d'UI/UX. La configuració del domini personalitzat i del correu electrònic de marca blanca només es gestiona a la Business Console i no forma part d'aquesta resposta.", "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": "Personalització de marca actual per a l'aplicació.", "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": "Falta la clau d'API, està mal formada, ha caducat o està assignada a una aplicació diferent. Si falta la clau es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Reintenta amb un retrocés exponencial." } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualitzar personalització de marca", "description": "Actualització parcial de la marca blanca de l'aplicació. Envia `application/json` per canviar colors, tipografies, radis i opcions d'interfície d'usuari, o `multipart/form-data` per pujar imatges de logotip. Només es modifiquen els camps que incloguis. El domini personalitzat i el correu de marca blanca no es poden configurar mitjançant aquest endpoint; fes servir la Business Console per a aquests canvis.", "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": "Canviar els colors i el tipus de lletra de la marca", "value": { "color_primary": "#123456", "color_button_1": "#2567FF", "font_family": "AR One Sans", "border_radius_buttons": 16 } }, "Update UI options": { "summary": "Canviar el nom públic i les opcions del flux", "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": "Elimina el logotip rectangular actual", "value": { "delete_logo_rectangular": true } }, "Remove the dark-mode logo": { "summary": "Elimina el logotip actual per al mode fosc", "value": { "delete_logo_rectangular_dark": true } } } }, "multipart/form-data": { "schema": { "type": "object", "description": "Utilitza multipart/form-data només per pujar imatges de logotip. Els camps de marca anteriors també es poden enviar com a camps de formulari a la mateixa sol·licitud.", "properties": { "image_square": { "type": "string", "format": "binary", "description": "Logotip quadrat (relació d'aspecte 1:1). PNG, JPG o WebP, com a mínim 512 px al costat llarg, com a màxim **1 MB**." }, "image_rectangular": { "type": "string", "format": "binary", "description": "Logotip rectangular (relació d'aspecte 2:1). PNG, JPG o WebP, com a mínim 512 px al costat llarg, com a màxim **1 MB**." }, "image_rectangular_dark": { "type": "string", "format": "binary", "description": "Logotip rectangular per al mode fosc (relació d'aspecte 2:1), mostrat sobre un fons fosc. PNG, JPG o WebP, com a mínim 512 px al costat llarg, com a màxim **1 MB**. Es retorna com a `logo_rectangular_dark`." }, "image_favicon": { "type": "string", "format": "binary", "description": "Imatge del favicon. Mida màxima: **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": "Imatge de marca actualitzada. Es retorna l'objecte de marca COMPLET (tots els camps, no només els que has modificat).", "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": "Cos no vàlid. Per exemple: un color hexadecimal amb format incorrecte, una família o gruix de tipus de lletra desconeguts, un camp exclusiu de la Business Console (`domain`, `from_email`, `verify_domain`, `force_remove_domain`, `verify_email_domain`, `force_remove_email_domain` i els seus homòlegs de només lectura), o una càrrega de logotip que no és una imatge PNG, JPG o WebP, fa menys de 512 px al seu costat llarg, supera 1 MB o té una relació d'aspecte incorrecta. També es retorna en establir `disable_login_with_didit` a `false` mentre hi ha un domini personalitzat configurat.", "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 és una imatge PNG, JPG o WebP (per exemple, un SVG)", "value": { "image_rectangular_dark": [ "Upload a PNG, JPG or WebP image." ] } }, "Logo too small": { "summary": "Menys de 512 px al costat llarg", "value": { "image_rectangular": [ "Image must be at least 512 px on its long side. Got 400x200 image dimensions" ] } }, "Logo too large": { "summary": "Més d'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": "Falta la clau d'API, està mal formada, ha caducat o està assignada a una aplicació diferent. Si falta la clau es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Reintenta amb un retrocés exponencial." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/businesses/{vendor_data}/": { "get": { "summary": "Obtenir l'empresa", "description": "Obtén una [empresa](/entities/businesses) per `vendor_data` (coincidència exacta). Afegeix `metadata` i `updated_at` a la vista de llista. Les empreses eliminades retornen 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": "El teu identificador únic per a l'empresa — una cadena de text lliure (NO un UUID), que coincideix exactament amb el valor enviat.", "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": "Detall complet de l'empresa, incloses les metadades i les dades agregades de la sessió.", "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": "Clau d'API absent, no vàlida o revocada, o bé la clau no pot llegir les empreses d'aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap empresa (no eliminada) amb el `vendor_data` proporcionat per a aquesta aplicació.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualitzar empresa", "description": "Actualització parcial d'una empresa: `display_name`, `legal_name`, `registration_number`, `country_code`, `status`, `metadata`. `metadata` es reemplaça completament. Si s'estableix `status` en `BLOCKED`, s'afegeix el `vendor_data` a la llista de bloqueig del sistema; si es canvia de `BLOCKED` a un altre estat, s'elimina aquesta entrada. Cada modificació queda registrada a l'activitat de l'empresa: un canvi d'estat amb el camp opcional `reason`, i un canvi a `display_name`, `legal_name`, `registration_number`, `country_code` o `metadata` com a actualització de 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": "El teu identificador únic per a l'empresa (cadena de text lliure, NO un UUID).", "example": "company-123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Cos d'actualització parcial. Proporciona només els camps que vulguis canviar.", "properties": { "display_name": { "type": "string", "nullable": true, "description": "Nom descriptiu que es mostra a la consola (té prioritat sobre `legal_name` per a la visualització a la interfície d'usuari)." }, "legal_name": { "type": "string", "nullable": true, "description": "Nom legal oficial obtingut del registre mercantil o introduït manualment." }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registre o de constitució de l'empresa." }, "country_code": { "type": "string", "nullable": true, "description": "País de constitució (ISO 3166-1 alpha-2, p. ex. `GB`, `US`)." }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Estat del cicle de vida de l'empresa. En establir `BLOCKED`, s'afegeix automàticament el valor de `vendor_data` a la llista de bloqueig del sistema; en canviar de `BLOCKED` a un altre estat, s'elimina aquesta entrada de la llista de bloqueig." }, "metadata": { "type": "object", "nullable": true, "description": "Objecte JSON arbitrari que adjuntes a l'empresa. **Substitueix completament** les metadades existents en actualitzar; fusiona-les al costat del client si només vols afegir claus." }, "reason": { "type": "string", "nullable": true, "maxLength": 1000, "description": "Per què ha canviat l'estat. Es registra a l'entrada de canvi d'estat de l'apartat **Activitat** de l'empresa a la Business Console, només quan l'estat canvia realment. Els webhooks no l'inclouen." } } }, "examples": { "Update name": { "summary": "Actualitza el nom visible", "value": { "display_name": "Acme Corp" } }, "Flag for review": { "summary": "Canvia l'estat", "value": { "status": "FLAGGED" } }, "Add metadata": { "summary": "Substitueix el JSON de metadades", "value": { "metadata": { "industry": "fintech", "risk_level": "low" } } }, "Fix registry data": { "summary": "Corregir els camps extrets", "value": { "legal_name": "Acme Trading International Ltd", "registration_number": "12345678", "country_code": "GB" } }, "Flag with reason": { "summary": "Marca l'empresa i registra'n el motiu", "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 actualitzada. Es retorna el registre complet i actualitzat de l'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": "Cos no vàlid: normalment un `status` desconegut, `metadata` amb format incorrecte o un `reason` de més de 1000 caràcters.", "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": "Clau d'API absent, no vàlida o revocada, o bé la clau no pot actualitzar empreses per a aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap empresa (no eliminada) amb el `vendor_data` proporcionat per a aquesta aplicació.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `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": "Actualitza l'estat de l'empresa", "description": "Canvia només el `status` del cicle de vida d'una empresa: `ACTIVE`, `FLAGGED` o `BLOCKED` (no els estats de sessió). `BLOCKED` afegeix el `vendor_data` a la llista de bloqueig del sistema; sortir de `BLOCKED` elimina aquesta entrada. Cada canvi es registra a l'activitat de l'empresa, amb el `reason` opcional. Enviar l'estat actual no canvia res ni registra cap `reason`. El webhook `business.status.updated` no inclou el `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": "El teu identificador únic per a l'empresa (cadena de text lliure, 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": "Per què ha canviat l'estat. Es registra a l'entrada de canvi d'estat de l'apartat **Activitat** de l'empresa a la Business Console, només quan l'estat canvia realment. Els webhooks no l'inclouen." } } } ] }, "examples": { "Flag": { "summary": "Marca l'empresa per a revisió", "value": { "status": "FLAGGED" } }, "Block": { "summary": "Bloquejar l'empresa (s'afegeix a la llista de bloqueig del sistema)", "value": { "status": "BLOCKED" } }, "Reactivate": { "summary": "Reactivar l'empresa", "value": { "status": "ACTIVE" } }, "Block with reason": { "summary": "Bloquejar l'empresa i registrar-ne el motiu", "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": "Estat de l'empresa actualitzat. Es retorna el registre complet de l'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": "Falta l'`status` o no és vàlid, o el `reason` supera els 1000 caràcters.", "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": "Clau d'API absent, no vàlida o revocada, o bé la clau no pot actualitzar empreses per a aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap empresa (no eliminada) amb el `vendor_data` proporcionat per a aquesta aplicació.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `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 empreses en lot", "description": "**Elimina permanentment** empreses — aquesta acció no es pot desfer. Per bloquejar, utilitza preferentment [Actualitza l'estat de l'empresa](#patch-/v3/businesses/-vendor_data-/update-status/) amb `BLOCKED`.\n\n**Informes regulatoris presentats:** si les dades seleccionades formen part d'un informe regulatori finalitzat, es rebutja tota la sol·licitud amb un `409` i no s'elimina res. El cos utilitza `code: in_filed_report` i identifica cada informe amb `uuid`, `report_number`, `report_type` i `case_uuid`. Elimina els informes i, tot seguit, repeteix la sol·licitud.", "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`. Ordre de prioritat si se'n transmeten diversos: `delete_all` > `vendor_data_list` > `didit_internal_id_list` (només s'utilitza el selector de màxima prioritat).", "properties": { "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Els teus propis identificadors a eliminar, coincidits exactament com es van enviar." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "UUID interns de Didit (`didit_internal_id`) per eliminar." }, "delete_all": { "type": "boolean", "default": false, "description": "Si és `true`, elimina totes les empreses de l'aplicació. No es pot combinar amb els selectors de llista." } } }, "examples": { "Specific businesses": { "summary": "Elimina per vendor_data", "value": { "vendor_data_list": [ "company-123", "company-456" ] } }, "Specific internal IDs": { "summary": "Elimina per didit_internal_id", "value": { "didit_internal_id_list": [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "b2c3d4e5-f6a7-8901-bcde-f12345678901" ] } }, "All businesses": { "summary": "Esborra totes les empreses d'aquesta aplicació", "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": "Empreses suprimides. Retorna el nombre de files eliminades realment.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "integer", "description": "Nombre d'empreses eliminades (exclou els valors de vendor_data que no han coincidit amb res)." } } }, "examples": { "Deleted some": { "value": { "deleted": 2 } }, "Nothing matched": { "value": { "deleted": 0 } } } } } }, "400": { "description": "No s'ha proporcionat cap selector (tots els camps `vendor_data_list`, `didit_internal_id_list` i `delete_all` manquen o estan buits). El cos d'error és una matriu JSON.", "content": { "application/json": { "examples": { "Missing selector": { "value": [ "Provide vendor_data_list, didit_internal_id_list, or set delete_all=true." ] } } } } }, "403": { "description": "Clau d'API absent, no vàlida o revocada, o bé la clau no pot suprimir empreses per a aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } }, "409": { "description": "No s'elimina res. `code` n'indica el motiu: `in_filed_report` quan la selecció inclou una empresa en un informe regulador finalitzat, `subject_deletion_in_progress` quan una altra sol·licitud encara està eliminant una de les empreses seleccionades. Repeteix la sol·licitud quan hagi acabat aquesta eliminació.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/InFiledReportError" }, { "$ref": "#/components/schemas/SubjectDeletionInProgressError" } ] } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/users/aml-monitoring/": { "post": { "summary": "Habilita o inhabilita el monitoratge AML continu per a usuaris", "description": "Activa o desactiva el monitoratge AML continu per als usuaris seleccionats, amb la mateixa semàntica que la Business Console. Es manté exactament un cribratge AML monitorat per usuari, de manera que un perfil que s'ha verificat diverses vegades es monitora i es factura un sol cop; si es desactiva, s'apaga el monitoratge de tots els cribratges del perfil. Els usuaris sense cap cribratge AML es cribren primer (es factura com un cribratge AML habitual) si tenen el nom complet, la data de naixement i el país necessaris; en cas contrari, s'informa com a `skipped_no_identity_data`.\n\nDefineix `estimate_only: true` per previsualitzar els recomptes i els costos sense escriure res. Les seleccions de 20 perfils o menys es resolen en línia i retornen `200` amb el treball completat; les seleccions més grans retornen `202` i s'executen en segon pla: consulta periòdicament [Get AML monitoring job](#get-/v3/aml-monitoring/jobs/-job_id-/) amb el `job_id` retornat. L'activació es rebutja amb un error `403` si el saldo de l'organització no cobreix l'estimació. Els identificadors que no coincideixen amb res es llisten a `unmatched` i mai no fan fallar la sol·licitud: una selecció que no coincideix amb res es completa com un treball buit (`total` 0), seguint la mateixa convenció que els endpoints d'eliminació per lots.", "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 usuaris amb `vendor_data_list`, `didit_internal_id_list`, o amb totes dues (les dues llistes s'avaluen amb un OR lògic). Com a màxim 1000 identificadors per sol·licitud entre ambdues llistes.", "properties": { "is_enabled": { "type": "boolean", "description": "true per activar el monitoratge, false per desactivar-lo." }, "estimate_only": { "type": "boolean", "default": false, "description": "Quan és cert, retorna l'estimació del cost i no realitza cap escriptura: sense cribratge, sense facturació i sense tasca." }, "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Els teus propis identificadors dels usuaris a commutar, coincidits exactament com es van enviar." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "ID interns de Didit dels usuaris per activar o desactivar: el `didit_internal_id` retornat pels endpoints de creació, obtenció i llistat." } } }, "examples": { "Estimate first": { "summary": "Previsualitza el cost sense escriure dades", "value": { "is_enabled": true, "estimate_only": true, "vendor_data_list": [ "user-123", "user-456" ] } }, "Enable": { "summary": "Habilita el monitoratge per a dos usuaris", "value": { "is_enabled": true, "vendor_data_list": [ "user-123", "user-456" ] } }, "Disable": { "summary": "Desactiva el monitoratge mitjançant l'ID intern 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": "L'estimació (quan `estimate_only` és cert) o la tasca completada per a una selecció processada en línia.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringToggleResult" } } } }, "202": { "description": "Les seleccions més grans s'executen en segon pla. Consulta periòdicament l'endpoint de tasques amb `job_id`; `results` s'omple a mesura que es processen els perfils.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringJob" } } } }, "400": { "description": "Error de validació: falta `is_enabled`, no hi ha cap selector o hi ha més de 1000 identificadors entre totes dues llistes." }, "401": { "description": "Falta la clau d'API o no és vàlida." }, "403": { "description": "Saldo insuficient per habilitar el monitoratge per a aquesta selecció. La resposta inclou l'`estimate` perquè puguis recarregar l'import adequat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "estimate": { "type": "object", "description": "Vista prèvia del cost. Es retorna directament quan estimate_only és true (no s'escriu res).", "properties": { "users_total": { "type": "integer", "description": "Perfils que coincideixen amb la selecció." }, "already_enabled": { "type": "integer", "description": "Perfils que ja estan monitorats (res a fer en activar; són els que es desactiven en desactivar)." }, "with_existing_aml": { "type": "integer", "description": "Perfils el cribratge AML existent dels quals passarà a estar monitorat (sense nou cribratge)." }, "needing_screening": { "type": "integer", "description": "Perfils sense cap cribratge AML als quals es farà primer un cribratge (facturat com un cribratge AML ordinari)." }, "skipped_no_identity_data": { "type": "integer", "description": "Perfils que no es poden sotmetre a cribratge perquè manquen dades d'identitat." }, "skipped_blocked": { "type": "integer", "description": "Usuaris bloquejats que s'ometran (sempre 0 per a empreses)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Cost únic dels nous cribratges." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Cost de monitoratge anual dels perfils que passaran a estar monitorats." }, "balance_sufficient": { "type": "boolean", "description": "Si el saldo de l'organització cobreix el cribratge més el primer any de monitoratge." } } } } } } } } } } }, "/v3/businesses/aml-monitoring/": { "post": { "summary": "Habilita o inhabilita el monitoratge AML continu per a empreses", "description": "Activa o desactiva el monitoratge AML continu per a les empreses seleccionades, amb la mateixa semàntica que la Business Console. Es manté exactament un cribratge AML monitorat per empresa, de manera que un perfil que s'ha verificat diverses vegades es monitora i es factura un sol cop; si es desactiva, s'apaga el monitoratge de tots els cribratges del perfil. Les empreses sense cap cribratge AML es cribren primer (es factura com un cribratge AML habitual) si tenen la raó social o el nom visible necessari; en cas contrari, s'informa com a `skipped_no_identity_data`.\n\nDefineix `estimate_only: true` per previsualitzar els recomptes i els costos sense escriure res. Les seleccions de 20 perfils o menys es resolen en línia i retornen `200` amb el treball completat; les seleccions més grans retornen `202` i s'executen en segon pla: consulta periòdicament [Get AML monitoring job](#get-/v3/aml-monitoring/jobs/-job_id-/) amb el `job_id` retornat. L'activació es rebutja amb un error `403` si el saldo de l'organització no cobreix l'estimació. Els identificadors que no coincideixen amb res es llisten a `unmatched` i mai no fan fallar la sol·licitud: una selecció que no coincideix amb res es completa com un treball buit (`total` 0), seguint la mateixa convenció que els endpoints d'eliminació per lots.", "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 empreses amb `vendor_data_list`, `didit_internal_id_list`, o amb totes dues (les dues llistes s'avaluen amb un OR lògic). Com a màxim 1000 identificadors per sol·licitud entre ambdues llistes.", "properties": { "is_enabled": { "type": "boolean", "description": "true per activar el monitoratge, false per desactivar-lo." }, "estimate_only": { "type": "boolean", "default": false, "description": "Quan és cert, retorna l'estimació del cost i no realitza cap escriptura: sense cribratge, sense facturació i sense tasca." }, "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Els teus propis identificadors de les empreses a commutar, coincidits exactament com es van enviar." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "ID interns de Didit de les empreses per activar o desactivar: el `didit_internal_id` retornat pels endpoints de creació, obtenció i llistat." } } }, "examples": { "Estimate first": { "summary": "Previsualitza el cost sense escriure dades", "value": { "is_enabled": true, "estimate_only": true, "vendor_data_list": [ "company-123", "company-456" ] } }, "Enable": { "summary": "Habilita el monitoratge per a dues empreses", "value": { "is_enabled": true, "vendor_data_list": [ "company-123", "company-456" ] } }, "Disable": { "summary": "Desactiva el monitoratge mitjançant l'ID intern 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": "L'estimació (quan `estimate_only` és cert) o la tasca completada per a una selecció processada en línia.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringToggleResult" } } } }, "202": { "description": "Les seleccions més grans s'executen en segon pla. Consulta periòdicament l'endpoint de tasques amb `job_id`; `results` s'omple a mesura que es processen els perfils.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringJob" } } } }, "400": { "description": "Error de validació: falta `is_enabled`, no hi ha cap selector o hi ha més de 1000 identificadors entre totes dues llistes." }, "401": { "description": "Falta la clau d'API o no és vàlida." }, "403": { "description": "Saldo insuficient per habilitar el monitoratge per a aquesta selecció. La resposta inclou l'`estimate` perquè puguis recarregar l'import adequat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "estimate": { "type": "object", "description": "Vista prèvia del cost. Es retorna directament quan estimate_only és true (no s'escriu res).", "properties": { "users_total": { "type": "integer", "description": "Perfils que coincideixen amb la selecció." }, "already_enabled": { "type": "integer", "description": "Perfils que ja estan monitorats (res a fer en activar; són els que es desactiven en desactivar)." }, "with_existing_aml": { "type": "integer", "description": "Perfils el cribratge AML existent dels quals passarà a estar monitorat (sense nou cribratge)." }, "needing_screening": { "type": "integer", "description": "Perfils sense cap cribratge AML als quals es farà primer un cribratge (facturat com un cribratge AML ordinari)." }, "skipped_no_identity_data": { "type": "integer", "description": "Perfils que no es poden sotmetre a cribratge perquè manquen dades d'identitat." }, "skipped_blocked": { "type": "integer", "description": "Usuaris bloquejats que s'ometran (sempre 0 per a empreses)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Cost únic dels nous cribratges." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Cost de monitoratge anual dels perfils que passaran a estar monitorats." }, "balance_sufficient": { "type": "boolean", "description": "Si el saldo de l'organització cobreix el cribratge més el primer any de monitoratge." } } } } } } } } } } }, "/v3/aml-monitoring/jobs/{job_id}/": { "get": { "summary": "Obtenir la tasca de monitoratge AML continu", "description": "Estat, comptadors de resultats i resultats per registre d'una tasca d'activació o desactivació de monitoratge iniciada des de `POST /v3/users/aml-monitoring/` o `POST /v3/businesses/aml-monitoring/`. Fes sondeig cada dos segons mentre `status` sigui `PENDING` o `PROCESSING`; `results` està complet un cop sigui `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` retornat per l'endpoint d'activació/desactivació." } ], "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": "La tasca.", "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 quan la tasca activa el monitoratge, false quan el desactiva." }, "target_type": { "type": "string", "enum": [ "user", "business" ], "description": "Quina família de perfils commuta la tasca." }, "total": { "type": "integer", "description": "Perfils que processa la tasca." }, "processed": { "type": "integer", "description": "Perfils processats fins ara." }, "outcomes": { "type": "object", "description": "Comptadors de resultats per registre. Cada perfil seleccionat s'assigna exactament a un comptador; no s'omet res silenciosament.", "properties": { "enabled": { "type": "integer", "description": "Monitoratge activat en un cribratge AML existent." }, "screened_and_enabled": { "type": "integer", "description": "S'ha creat un nou cribratge AML (facturat) i s'hi ha activat el monitoratge." }, "already_enabled": { "type": "integer", "description": "El monitoratge ja estava actiu; no s'ha modificat res ni s'ha facturat res." }, "disabled": { "type": "integer", "description": "Monitoratge desactivat a tots els cribratges AML del perfil." }, "skipped_no_identity_data": { "type": "integer", "description": "Omès: el perfil no disposa del nom complet, la data de naixement i el país (usuaris) o del nom (empreses) necessaris per cribrar." }, "skipped_blocked": { "type": "integer", "description": "Omès: l'usuari està bloquejat." }, "skipped_sandbox": { "type": "integer", "description": "Omès: aplicació de sandbox, no es crea cap cribratge." }, "failed_provider": { "type": "integer", "description": "No s'ha pogut completar el cribratge; reintenta-ho més tard." }, "failed_insufficient_balance": { "type": "integer", "description": "El saldo s'ha esgotat mentre s'executava la tasca." } } }, "results": { "type": "array", "description": "Una entrada per perfil processat, en ordre de processament. Creix mentre s'executa la tasca; es completa un cop l'estat és COMPLETED. Es registra per a les tasques iniciades mitjançant l'API; una tasca iniciada des de la Business Console només reporta comptadors.", "items": { "type": "object", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "ID intern de Didit del perfil." }, "vendor_data": { "type": "string", "nullable": true, "description": "El teu propi identificador per al 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": "Missatge d'error genèric quan l'estat és FAILED; la causa detallada es manté a la plataforma." }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true } } } } } }, "401": { "description": "Falta la clau d'API o no és vàlida." }, "404": { "description": "No existeix aquesta tasca per a aquesta aplicació." } } } }, "/v3/users/{vendor_data}/update-status/": { "patch": { "summary": "Actualitza l'estat de l'usuari", "description": "Canvia només el `status` del cicle de vida d'un usuari: `ACTIVE`, `FLAGGED` o `BLOCKED` (no els estats de sessió). `BLOCKED` afegeix el `vendor_data` a la llista de bloqueig del sistema; sortir de `BLOCKED` elimina aquesta entrada. Cada canvi es registra com una activitat `STATUS_CHANGED` a l'usuari, amb el `reason` opcional com a `comment`. Enviar l'estat actual no canvia res ni registra cap `reason`. El webhook `user.status.updated` no inclou el `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": "El teu identificador únic per a l'usuari." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityStatusUpdateRequest" }, { "type": "object", "properties": { "reason": { "type": "string", "nullable": true, "maxLength": 1000, "description": "Per què ha canviat l'estat. Es registra a l'entrada de canvi d'estat de l'activitat de l'usuari (`comments[].comment`, i **Activitat** a la Business Console), només quan l'estat canvia realment. Els webhooks no l'inclouen." } } } ] }, "examples": { "Activate": { "summary": "Reactivar l'usuari", "value": { "status": "ACTIVE" } }, "Flag": { "summary": "Marca l'usuari per a revisió", "value": { "status": "FLAGGED" } }, "Block": { "summary": "Bloquejar l'usuari (s'afegeix a la llista de bloqueig del sistema)", "value": { "status": "BLOCKED" } }, "Block with reason": { "summary": "Bloquejar l'usuari i registrar-ne el motiu", "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": "Estat de l'usuari actualitzat. Es retorna el registre complet de l'usuari.", "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": "Falta l'`status` o no és vàlid, o el `reason` supera els 1000 caràcters.", "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 s'han proporcionat credencials. Les sol·licituds a rutes `/v3/users/*` sense una capçalera `x-api-key` (o token `Authorization: Bearer`) són rebutjades pel middleware d'autenticació abans d'arribar a l'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 clau no pot actualitzar usuaris per a aquesta aplicació. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap usuari (no eliminat) amb el `vendor_data` proporcionat per a aquesta aplicació.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `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": "Crea una empresa", "description": "Precrea una [empresa](/entities/businesses) *sense* una sessió de KYB. Tots els camps són opcionals, però hauries d'enviar sempre `vendor_data`: sense aquest camp, el registre no es pot vincular a sessions o transaccions. Quan es proporciona, `vendor_data` ha de ser únic entre les empreses no eliminades (coincidència exacta; els conflictes retornen 400). No és idempotent.", "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": "El teu identificador únic per a aquesta empresa (cadena de text lliure, NO un UUID). Opcional però molt recomanable. Quan es proporciona, ha de ser únic entre les empreses no eliminades per a l'aplicació; coincideix exactament amb el valor enviat." }, "display_name": { "type": "string", "nullable": true, "maxLength": 255, "description": "Nom descriptiu que es mostra a la consola (té prioritat sobre `legal_name` per a la visualització a la interfície d'usuari)." }, "legal_name": { "type": "string", "nullable": true, "maxLength": 255, "description": "Nom legal oficial de l'empresa." }, "registration_number": { "type": "string", "nullable": true, "maxLength": 100, "description": "Número de registre o de constitució de l'empresa." }, "country_code": { "type": "string", "nullable": true, "maxLength": 10, "description": "País de constitució (ISO 3166-1 alpha-2, p. ex. `GB`, `US`)." }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "default": "ACTIVE", "description": "Estat inicial del cicle de vida. Per defecte és `ACTIVE`." }, "metadata": { "type": "object", "nullable": true, "description": "Objecte JSON arbitrari que adjuntes a l'empresa. Per defecte és `{}`." } } }, "examples": { "Basic": { "summary": "Mínim recomanat", "value": { "vendor_data": "company-456", "legal_name": "New Corp Ltd", "country_code": "US" } }, "Full": { "summary": "Tots els camps", "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. Es retorna el registre complet de l'empresa (la mateixa estructura que a Obtenir empresa).", "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": "Cos no vàlid — normalment un `vendor_data` duplicat, un `status` desconegut o `metadata` amb format incorrecte.", "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": "Falta la clau d'API, no és vàlida o està revocada, o la clau no pot crear empreses per a aquesta aplicació. Si falta la clau, es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `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": "Crea un usuari", "description": "Crea un [usuari](/entities/users) mitjançant `vendor_data`, abans d'una sessió de verificació o sense fer-ne cap. `vendor_data` ha de ser únic entre els usuaris de l'aplicació (un duplicat retorna `400`). No és idempotent.\n\n**Dades de contacte:** `email` i `phone_number` s'emmagatzemen a `metadata.contact`, i `country` a `metadata.address`. Si envies `first_name` o `last_name` sense `full_name`, Didit els combina en `full_name`.\n\n**Enllaç de verificació:** amb `send_verification_link: true`, Didit també crea una sessió de verificació per a la persona en el flux de treball `workflow_id` i li envia l'enllaç per correu electrònic a `email`. La sessió executa les mateixes comprovacions que [Crear una sessió](/ca/sessions-api/create-session), com ara la llista de bloqueig i el teu saldo de crèdit. La persona i la sessió es creen juntes o no es creen: si falla qualsevol comprovació, no s'escriu res i no s'envia cap correu electrònic. El camp `verification_link` de la resposta descriu la sessió, i és `null` si no sol·licites cap enllaç.\n\n**Accés amb clau d'API:** una clau d'API amb abast necessita permisos d'escriptura a `users`. Amb `send_verification_link: true` també necessita permisos d'escriptura a `sessions`, o la crida respondrà amb `403` abans que s'escrigui res. Les claus amb accés complet no es veuen afectades. Consulta [Claus d'API](/ca/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": "El teu identificador únic per a aquest usuari (cadena de text lliure, NO un UUID). Ha de ser únic entre els usuaris de l'aplicació; coincideix exactament amb el valor enviat." }, "full_name": { "type": "string", "nullable": true, "maxLength": 512, "description": "Nom legal complet de l'usuari." }, "display_name": { "type": "string", "nullable": true, "description": "Nom descriptiu que es mostra a la consola (té prioritat sobre `full_name` per a la visualització a la interfície d'usuari).", "maxLength": 255 }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Data de naixement en format `YYYY-MM-DD`." }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "default": "ACTIVE", "description": "Estat inicial del cicle de vida. Per defecte és `ACTIVE`." }, "metadata": { "type": "object", "nullable": true, "description": "Objecte JSON arbitrari que adjuntes a l'usuari. Per defecte és `{}`." }, "approved_emails": { "type": "array", "items": { "type": "string" }, "description": "Adreces de correu electrònic de confiança prèvia per a aquest usuari, p. ex. `[\"john@example.com\"]`." }, "approved_phones": { "type": "array", "items": { "type": "string" }, "description": "Números de telèfon de confiança prèvia per a aquest usuari, p. ex. `[\"+14155551234\"]`." }, "issuing_states": { "type": "array", "items": { "type": "string" }, "description": "Països emissors preenregistrats (ISO 3166-1 alfa-3), p. ex. `[\"USA\"]`." }, "first_name": { "type": "string", "maxLength": 255, "description": "Nom de pila. Quan no s'envia `full_name`, Didit uneix `first_name` i `last_name` amb un espai per formar `full_name`. No es retorna com a camp separat." }, "last_name": { "type": "string", "maxLength": 255, "description": "Cognom. S'uneix amb `first_name` per formar `full_name` quan no s'envia `full_name`. No es retorna com a camp separat." }, "email": { "type": "string", "format": "email", "description": "Correu electrònic de contacte, emmagatzemat a `metadata.contact.email` (substitueix un `email` que enviïs dins de `metadata.contact`). Obligatori quan `send_verification_link` és `true`: l'enllaç s'envia a aquesta adreça. Si `metadata.contact` no és un objecte JSON, la crida respon `400` en aquest camp." }, "phone_number": { "type": "string", "maxLength": 32, "description": "Número de telèfon de contacte, emmagatzemat a `metadata.contact.phone_number`. Si `metadata.contact` no és un objecte JSON, la crida respon `400` en aquest camp." }, "country": { "type": "string", "maxLength": 3, "description": "País com a codi ISO 3166, alpha-2 o alpha-3 (`ES` o `ESP`). S'emmagatzema en majúscules a `metadata.address.country`. Si `metadata.address` no és un objecte JSON, la crida retorna `400` per a aquest camp." }, "send_verification_link": { "type": "boolean", "default": false, "description": "Quan és `true`, Didit crea una sessió de verificació per a la persona a `workflow_id` i li envia l'enllaç per correu electrònic a `email`. Requereix `email` i `workflow_id`. Una clau d'API amb abast també necessita escriptura a `sessions`." }, "workflow_id": { "type": "string", "format": "uuid", "description": "El flux de treball de la sessió de verificació. Obligatori quan `send_verification_link` és `true`. Ha de verificar una persona: es rebutja un flux de treball de Verificació d'empreses (KYB). S'ignora en cas contrari." }, "language": { "type": "string", "maxLength": 10, "description": "Idioma del correu electrònic de verificació, com a codi d'[idioma admès](/ca/integration/supported-languages). Anglès si s'omet. S'ignora quan `send_verification_link` no és `true`." } } }, "examples": { "Basic": { "summary": "Crea amb informació bàsica", "value": { "vendor_data": "user-abc-123", "full_name": "John Doe" } }, "Full": { "summary": "Tots els camps", "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": "Nom, correu electrònic, telèfon i 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": "Crea la persona i envia-li un enllaç de verificació per correu electrònic", "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": "Usuari creat. El registre complet de l'usuari (mateixa estructura que a Get User), més `verification_link`: la sessió de verificació que Didit ha enviat per correu electrònic quan `send_verification_link` era `true`; altrament, `null`.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserDetailItem" }, { "type": "object", "required": [ "verification_link" ], "properties": { "verification_link": { "type": "object", "nullable": true, "description": "La sessió de verificació que Didit ha creat i ha enviat per correu electrònic a la persona. Sempre present: `null` quan `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 sessió de verificació." }, "session_number": { "type": "integer", "description": "Número seqüencial de la sessió dins de la teva aplicació." }, "status": { "type": "string", "description": "Estat de la sessió, `Not Started` per a una sessió acabada de crear." }, "url": { "type": "string", "format": "uri", "description": "L'enllaç de verificació que Didit ha enviat per correu electrònic a la persona." }, "workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "El flux de treball que executa la sessió." }, "email": { "type": "string", "format": "email", "description": "L'adreça a la qual s'ha enviat l'enllaç." } } } } } ] }, "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": "Cos no vàlid, desglossat per camp: normalment un `vendor_data` duplicat, un camp obligatori que falta o un valor amb format incorrecte. Amb `send_verification_link: true`, també pot ser un `email` o `workflow_id` que falta, un flux de treball desconegut o de Verificació d'empreses (KYB), un `language` no admès (amb clau `contact_details.email_lang`), un `vendor_data` a la llista de bloqueig o crèdits insuficients per iniciar la sessió. No s'escriu res.", "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 s'han proporcionat credencials. Les sol·licituds a rutes `/v3/users/*` sense una capçalera `x-api-key` (o token `Authorization: Bearer`) són rebutjades pel middleware d'autenticació abans d'arribar a l'API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Clau d'API no vàlida o revocada, o la clau no pot crear usuaris per a aquesta aplicació. Una clau d'API amb abast restringit necessita escriptura a `users`, i també escriptura a `sessions` quan `send_verification_link` és `true`; no s'escriu res. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } }, "No sessions write": { "summary": "La clau amb abast sol·licita un enllaç de verificació sense tenir el permís d'escriptura de sessions", "value": { "detail": "This API key has no write access to sessions." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho després de l'interval indicat a `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": "Puja la cara de l'usuari", "description": "Adjunta una imatge facial importada de confiança a un perfil d'usuari existent. Utilitza-ho després de crear o recuperar un usuari mitjançant `vendor_data` i llegir el seu `didit_internal_id`. La cara pujada s'emmagatzema al perfil d'usuari i s'indexa per a la detecció de duplicats i la cerca facial. No s'afegeix a cap llista de bloqueig 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 l'organització propietària de l'aplicació." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació propietària del perfil d'usuari." }, { "name": "didit_internal_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID d'usuari intern de Didit, retornat com a `didit_internal_id` per `GET /v3/users/{vendor_data}/` i `POST /v3/users/create/`." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "image" ], "properties": { "image": { "type": "string", "format": "byte", "description": "Imatge facial en brut en format JPG o PNG codificada en base64. No incloguis el prefix `data:image/...;base64,`. Mida màxima un cop descodificada: 2 MB." }, "comment": { "type": "string", "description": "Nota opcional visible per a l'operador sobre la cara carregada.", "default": "" } } }, "examples": { "Imported face": { "summary": "Adjunta una cara importada d'un proveïdor 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": "Cara carregada i adjuntada al perfil d'usuari.", "content": { "application/json": { "schema": { "type": "object", "required": [ "uuid", "image_url", "comment", "uploaded_by", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID del registre facial d'usuari pujat." }, "image_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL signada per a la imatge facial pujada." }, "comment": { "type": "string", "nullable": true, "description": "Comentari proporcionat quan es va carregar la cara." }, "uploaded_by": { "type": "string", "nullable": true, "description": "Correu electrònic o identificador d'actor de qui ha pujat el fitxer, quan estigui disponible." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de temps de la pujada." } } }, "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": "Cos de la sol·licitud o imatge no vàlids. Causes comunes: base64 no vàlid, imatge no vàlida, cap cara detectable, imatge de més de 2 MB, embedding absent o l'usuari ja té 5 cares carregades.", "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": "Falta la clau d'API o no és vàlida.", "content": { "application/json": { "examples": { "Missing key": { "value": { "detail": "Authentication credentials were not provided." } } } } } }, "403": { "description": "La credencial és vàlida però no pot escriure perfils d'usuari per a aquesta aplicació.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No existeix cap usuari per a aquest `didit_internal_id` a l'aplicació.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència; redueix el ritme de les sol·licituds i reintenta-ho.", "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": "Actualitzar dades de KYC extretes del document d'identitat en una sessió de verificació", "description": "Corregeix els camps d'identitat extrets (OCR / NFC) del document d'identitat de l'usuari —noms mal llegits, dates, números de document, etc.— un cop finalitzada la verificació. Normalment qui crida aquest endpoint és un analista de compliment des del teu propi entorn administratiu o una tasca de conciliació automatitzada. Tots els camps del cos són opcionals: només s'escriuen les claus que envies i la resta es manté sense canvis (semàntica `PATCH`).\n\nLa sessió ha de pertànyer a la teva aplicació i estar en estat `Approved`, `Declined`, `In Review` o `Kyc Expired`. Les sessions en qualsevol altre estat (per exemple, encara `In Progress`) retornen un `404` amb `\"No Session matches the given query.\"` —a diferència del `\"Not found.\"` que es retorna per a un `sessionId` desconegut o eliminat. La sessió també ha d'incloure un registre de verificació d'identitat (KYC): les sessions en què el flux de treball mai no ha executat un pas de verificació d'identitat retornen un `404` (`\"The session does not have a KYC.\"`). En els fluxos de treball de graf amb diversos passos de verificació d'identitat, apunta a un pas específic amb `node_id` (paràmetre de consulta o camp del cos); si s'omet, s'actualitza el registre KYC més recent.\n\nEn cada crida es tornen a calcular dos camps derivats: `full_name` (a partir de `first_name` + `last_name`) i `issuing_state_name` (a partir de `issuing_state`). Si el text lliure d'`address` canvia, el servidor també pot tornar-lo a geocodificar i actualitzar `parsed_address` (s'omet en sessions de sandbox). `extra_fields` i `parsed_address` es fusionen clau per clau en lloc de substituir-se; consulta les descripcions de cada camp per conèixer la semàntica d'utilitzar `null` per eliminar.\n\nEnviar almenys un camp vàlid activa el [webhook](/ca/integration/webhooks) `data.updated` (activador `manual_review`), fins i tot quan els valors enviats són iguals als emmagatzemats. Quan els valors canvien realment, s'afegeix una entrada d'activitat `KYC_DATA_UPDATED` que registra els camps modificats amb els valors anteriors i nous a `reviews` de la sessió, visible a [Get Decision](#get-/v3/session/-sessionId-/decision/) i a la cronologia d'activitat de la consola. L'estat i la decisió de la sessió **no** es tornen a avaluar; utilitza [Update Status](#patch-/v3/session/-sessionId-/update-status/) per modificar el resultat. S'accepta un cos JSON buit (`{}`) i simplement retorna les dades de KYC actuals sense activar el webhook.\n\nAccepta una clau d'API o un token d'usuari de la consola; en ambdós casos, la credencial necessita el permís `write:sessions`. Tant els errors d'autenticació com els de permisos retornen un `403` —aquesta API mai no respon amb `401`. Tingues en compte que la cerca de la sessió s'executa abans de les comprovacions de credencials, de manera que un `sessionId` desconegut retorna un `404` fins i tot si falten les credencials. Aquest endpoint té un límit de freqüència dedicat de 10 sol·licituds per minut per clau d'API (les sol·licituds no vàlides també compten); el pressupost d'escriptura compartit de 300 sol·licituds per minut també s'aplica.", "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 sessió de Verificació d'usuaris (KYC) les dades extretes del document de la qual estàs corregint. Els ID de sessió d'empresa (KYB) no són vàlids aquí; per a dades d'empresa utilitza [Update KYB Company Data](#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": "Node del graf del flux de treball el registre de KYC del qual s'ha de modificar, per a fluxos de treball basats en grafs amb múltiples passos de verificació d'identitat (també s'accepta com a camp `node_id` al cos). Quan s'omet, es modifica el registre de KYC més recent de la sessió. Si no existeix cap KYC per al node indicat, la crida retorna `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": "Tots els camps són opcionals — envia només el que vulguis canviar.", "properties": { "document_type": { "type": "string", "description": "Codi de tipus de document. Accepta els codis curts indicats a l'enum, a més de sis àlies llargs normalitzats al servidor abans de la validació: `Passport` → `P`, `Identity Card` → `ID`, `Driver's License` → `DL`, `Residence Permit` → `RP`, `Health Insurance Card` → `HIC`, `Tax Card` → `TC`. Qualsevol altre valor (incloent-hi `PASSPORT` en majúscules) retorna `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": "Subtipus de document del registre de documents, incloent-hi el prefix de regió quan el registre distingeix variants regionals." }, "document_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Número de document tal com apareix imprès al document d'identitat.", "example": "PAB123456" }, "personal_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Número d'identificació personal o nacional quan el document en conté un (p. ex., DNI espanyol en un passaport).", "example": "99999999R" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Data de naixement en `YYYY-MM-DD`. Qualsevol altre format retorna `400`.", "example": "1980-01-01" }, "date_of_issue": { "type": "string", "format": "date", "nullable": true, "description": "Data d'emissió del document en `YYYY-MM-DD`." }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "description": "Data de caducitat del document en format `YYYY-MM-DD`." }, "issuing_state": { "type": "string", "nullable": true, "description": "País emissor com a codi ISO 3166-1 alfa-3. No distingeix entre majúscules i minúscules (`esp` s'emmagatzema com a `ESP`); el valor llegible per humans `issuing_state_name` mostrat a [Obtenir decisió](#get-/v3/session/-sessionId-/decision/) es recalcula a partir d'aquest valor. Els codis no vàlids retornen `400`.", "example": "ESP" }, "first_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nom(s) de pila. El camp `full_name` emmagatzemat es torna a calcular com a `first_name + ' ' + last_name` en cada crida a aquest endpoint.", "example": "Carmen" }, "last_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Cognom(s). També alimenta el `full_name` recalculat.", "example": "Espanola Espanola" }, "gender": { "type": "string", "enum": [ "M", "F", "U" ], "nullable": true, "description": "Sexe tal com està imprès al document: `M` (home), `F` (dona) o `U` (desconegut). Qualsevol altre valor —incloent-hi `X`— retorna `400`." }, "address": { "type": "string", "maxLength": 255, "nullable": true, "description": "Adreça en text lliure tal com està impresa al document. Quan aquest valor canvia (només en sessions que no són de sandbox) i l'adreça estructurada encara falta o està incompleta, el servidor la torna a geocodificar sincrònicament abans de respondre — el cos de la resposta 200 ja reflecteix la `parsed_address` actualitzada. La nova geocodificació també requereix que `issuing_state` estigui present al registre de KYC." }, "place_of_birth": { "type": "string", "maxLength": 255, "nullable": true, "description": "Lloc de naixement tal com està imprès al document." }, "nationality": { "type": "string", "maxLength": 32, "nullable": true, "description": "Nacionalitat tal com està impresa al document. Text lliure de fins a 32 caràcters; normalment en format de codi ISO 3166-1 alpha-3 (p. ex., `ESP`), però no es valida com a tal." }, "marital_status": { "type": "string", "enum": [ "SINGLE", "MARRIED", "DIVORCED", "WIDOWED", "UNKNOWN" ], "description": "Estat civil quan el document l'inclou. Qualsevol altre valor retorna `400`." }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Sobreescriptures per clau per a camps addicionals específics del document (p. ex., `blood_group`, `dl_categories`, `mrz_string`). Les claus es fusionen al mapa de sobreescriptures existent: envia una clau amb un valor per definir-la, o amb `null` / `\"\"` per eliminar aquesta clau de la visualització fusionada. Envia tot el camp com a `null` per esborrar totes les sobreescriptures aplicades anteriorment. Ha de ser un objecte JSON, en cas contrari es retornarà un `400`. La resposta sempre retorna la visualització fusionada (valors extrets per OCR amb les teves sobreescriptures aplicades)." }, "parsed_address": { "type": "object", "nullable": true, "description": "Adreça estructurada. Només s'accepten aquestes claus niades: `address_type`, `city`, `region`, `street_1`, `street_2`, `postal_code`, `country` — qualsevol altra clau retorna `400`. Semàntica per clau: un valor estableix la clau, `null` l'elimina. `formatted_address` es recalcula al servidor unint `street_1`, `street_2`, `city`, `region`, `postal_code` i `country` i es retorna a la resposta — no es pot establir directament.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Classificació d'adreça de format lliure (p. ex. `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Estat / província / comunitat 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": "Codi de país ISO 3166-1 alfa-2. L'entrada en minúscules es normalitza a majúscules; els codis alfa-3 es rebutgen amb un `400`.", "example": "ES" } } } } }, "examples": { "Correct name and DOB": { "summary": "Corregir el nom, la data de naixement i l'adreça estructurada que l'OCR hagi llegit malament", "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": "Elimina una clau de camp addicional i mantén la resta", "value": { "extra_fields": { "blood_group": null } } }, "Long-form document type": { "summary": "L'àlies en format llarg es normalitza al codi curt (aquí P)", "value": { "document_type": "Passport" } } } } } }, "responses": { "200": { "description": "Dades de KYC actualitzades. Retorna el **registre de KYC actual complet** (tots els camps actualitzables amb el seu valor emmagatzemat, a més dels `extra_fields` fusionats i l'`parsed_address` actual), no només els camps que has enviat. El webhook `data.updated` s'activa quan hi ha hagut almenys un camp vàlid al payload.", "content": { "application/json": { "schema": { "type": "object", "properties": { "document_type": { "type": "string", "description": "Codi de tipus de document. Accepta els codis curts indicats a l'enum, a més de sis àlies llargs normalitzats al servidor abans de la validació: `Passport` → `P`, `Identity Card` → `ID`, `Driver's License` → `DL`, `Residence Permit` → `RP`, `Health Insurance Card` → `HIC`, `Tax Card` → `TC`. Qualsevol altre valor (incloent-hi `PASSPORT` en majúscules) retorna `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": "Subtipus de document del registre de documents, incloent-hi el prefix de regió quan el registre distingeix variants regionals." }, "document_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Número de document tal com apareix imprès al document d'identitat.", "example": "PAB123456" }, "personal_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Número d'identificació personal o nacional quan el document en conté un (p. ex., DNI espanyol en un passaport).", "example": "99999999R" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Data de naixement en `YYYY-MM-DD`. Qualsevol altre format retorna `400`.", "example": "1980-01-01" }, "date_of_issue": { "type": "string", "format": "date", "nullable": true, "description": "Data d'emissió del document en `YYYY-MM-DD`." }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "description": "Data de caducitat del document en format `YYYY-MM-DD`." }, "issuing_state": { "type": "string", "nullable": true, "description": "País emissor com a codi ISO 3166-1 alfa-3. No distingeix entre majúscules i minúscules (`esp` s'emmagatzema com a `ESP`); el valor llegible per humans `issuing_state_name` mostrat a [Obtenir decisió](#get-/v3/session/-sessionId-/decision/) es recalcula a partir d'aquest valor. Els codis no vàlids retornen `400`.", "example": "ESP" }, "first_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nom(s) de pila. El camp `full_name` emmagatzemat es torna a calcular com a `first_name + ' ' + last_name` en cada crida a aquest endpoint.", "example": "Carmen" }, "last_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Cognom(s). També alimenta el `full_name` recalculat.", "example": "Espanola Espanola" }, "gender": { "type": "string", "enum": [ "M", "F", "U" ], "nullable": true, "description": "Sexe tal com està imprès al document: `M` (home), `F` (dona) o `U` (desconegut). Qualsevol altre valor —incloent-hi `X`— retorna `400`." }, "address": { "type": "string", "maxLength": 255, "nullable": true, "description": "Adreça en text lliure tal com està impresa al document. Quan aquest valor canvia (només en sessions que no són de sandbox) i l'adreça estructurada encara falta o està incompleta, el servidor la torna a geocodificar en segon pla de la mateixa sol·licitud i pot sobreescriure `parsed_address` amb el resultat del geocodificador." }, "place_of_birth": { "type": "string", "maxLength": 255, "nullable": true, "description": "Lloc de naixement tal com està imprès al document." }, "nationality": { "type": "string", "maxLength": 32, "nullable": true, "description": "Nacionalitat tal com està impresa al document. Text lliure de fins a 32 caràcters; normalment en format de codi ISO 3166-1 alpha-3 (p. ex., `ESP`), però no es valida com a tal." }, "marital_status": { "type": "string", "enum": [ "SINGLE", "MARRIED", "DIVORCED", "WIDOWED", "UNKNOWN" ], "description": "Estat civil quan el document l'inclou. Qualsevol altre valor retorna `400`." }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Visualització fusionada dels camps addicionals del document: els valors extrets per OCR amb totes les sobreescriptures de l'operador aplicades. Les claus eliminades mitjançant una sobreescriptura amb `null` no apareixen en aquest mapa." }, "parsed_address": { "type": "object", "nullable": true, "description": "Adreça estructurada actual (sense les claus de gestió interna), o `null` quan no n'hi ha cap. Inclou la `formatted_address` recalculada juntament amb les set claus editables.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Classificació d'adreça de format lliure (p. ex. `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Estat / província / comunitat 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": "Codi de país ISO 3166-1 alfa-2. L'entrada en minúscules es normalitza a majúscules; els codis alfa-3 es rebutgen amb un `400`.", "example": "ES" }, "formatted_address": { "type": "string", "nullable": true, "description": "Forma concatenada i llegible per humans de l'adreça estructurada. Recalculada al costat del servidor després de cada edició de `parsed_address`.", "example": "Avda de Madrid 34, Madrid, 28013, ES" } } } } }, "examples": { "Updated KYC": { "summary": "Registre complet de KYC després de la correcció", "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\": [\"\"]}`; els errors en claus niades de `parsed_address` / `extra_fields` utilitzen un valor d'objecte: `{\"parsed_address\": {\"\": \"\"}}`.", "content": { "application/json": { "examples": { "Invalid gender": { "summary": "gender ha de ser M, F o U", "value": { "gender": [ "\"X\" is not a valid choice." ] } }, "Invalid document type": { "summary": "No és un codi curt ni un àlies en format llarg", "value": { "document_type": [ "\"PASSPORT\" is not a valid choice." ] } }, "Invalid issuing state": { "summary": "issuing_state no és 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 forma part de l'enum", "value": { "marital_status": [ "\"ENGAGED\" is not a valid choice." ] } }, "Bad date format": { "summary": "Les dates han de ser AAAA-MM-DD", "value": { "date_of_birth": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } }, "Unsupported parsed_address key": { "summary": "Només es permeten les set claus documentades", "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 niat ha de ser alpha-2, no alpha-3", "value": { "parsed_address": { "country": "Invalid ISO 3166-1 alpha-2 country code." } } }, "extra_fields not an object": { "summary": "extra_fields ha de ser un objecte JSON", "value": { "extra_fields": [ "This field must be a JSON object." ] } } } } } }, "403": { "description": "Falten les credencials o els permisos són insuficients. Si falta la clau, es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Falta l'x-api-key o no és vàlid", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La credencial no té write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Sessió desconeguda, sessió en un estat no editable o cap registre de KYC per modificar. Cada cas té un missatge `detail` diferent (vegeu els exemples). La cerca de sessió desconeguda s'executa abans de les comprovacions de credencials.", "content": { "application/json": { "examples": { "Unknown session": { "summary": "No hi ha cap sessió amb aquest ID a la teva aplicació (o s'ha suprimit)", "value": { "detail": "Not found." } }, "Wrong session state": { "summary": "La sessió existeix però no està en estat Approved / Declined / In Review / Kyc Expired", "value": { "detail": "No Session matches the given query." } }, "No KYC record": { "summary": "El flux de treball mai no ha executat un pas de Verificació d'identitat", "value": { "detail": "The session does not have a KYC." } }, "No KYC for node": { "summary": "s'ha indicat node_id però no existeix cap KYC per a aquest", "value": { "detail": "The session does not have a KYC for node 'feature_missing'." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència dedicat: 10 actualitzacions de dades de KYC per minut i clau d'API (les sol·licituds rebutjades compten per al pressupost). El pressupost compartit d'escriptura de 300/min també es pot activar amb el seu propi missatge. Inspecciona `Retry-After` i les capçaleres de resposta `X-RateLimit-*` abans de reintentar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Pressupost d'actualització de KYC esgotat", "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": "Actualitzar l'estat d'una funcionalitat (pas) individual", "description": "Estableix l'estat d'una funcionalitat de verificació (pas) individual dins d'una sessió. Selecciona la funcionalitat mitjançant el seu `nodeId` del graf del flux de treball. En els fluxos de treball sense graf, els passos dels quals no tenen node, utilitza `default` i passa també `feature_type` per indicar a quin pas et refereixes.\n\nFunciona tant per a sessions de Verificació d'usuaris (KYC) com de Verificació d'empreses (KYB) i per a cada tipus de pas: ID/OCR, Prova de vida, Coincidència facial, NFC, AML, Comprovant de domicili, Telèfon, Correu electrònic, Validació en bases de dades, Qüestionari i les comprovacions de registre mercantil / documents / persones clau de KYB. Aquest endpoint **no** està disponible per a sessions d'API independents (`session_type = API`).\n\n`new_status` ha de ser un d'entre `Approved`, `Declined` o `In Review`, i ha de ser diferent de l'estat actual de la funcionalitat.\n\n**Quan s'aplica la substitució.** Sense `defer_until_flow_finishes` (o amb `false`), la substitució s'aplica immediatament, com sempre; quan la persona encara està en el flux, es registra com a `forced`. Amb `defer_until_flow_finishes: true` mentre la persona encara és al flux (la sessió està en `Not Started`, `In Progress` o `Resubmitted` i no ha finalitzat), la substitució s'emmagatzema com a `pending_until_flow_finishes` i s'aplica quan el flux finalitza, després que el flux arribi a la seva pròpia decisió. En una sessió el flux de la qual ja ha finalitzat, s'aplica immediatament en ambdós casos. Una substitució en espera es cancel·la si la persona torna a fer el pas abans d'acabar, si una substitució més recent a la mateixa comprovació la reemplaça, si la sessió surt del flux sense finalitzar (abandonada, caducada o decidida a mig flux), o si la cancel·les amb `POST /v3/session/{sessionId}/features/overrides/{overrideId}/cancel/`. Consulta les substitucions d'una sessió amb `GET /v3/session/{sessionId}/features/overrides/`.\n\n**Efecte sobre la sessió.** Una sessió que ja té una decisió la manté: només canvia la comprovació. Quan la sessió encara no té cap decisió i el seu flux de treball està esperant exactament aquest pas, l'aplicació de la substitució completa el pas: el flux de treball avança, s'executen els passos posteriors i un node d'estat pot establir la decisió de la sessió i disparar `status.updated`.\n\n**Webhooks i activitat.** Es dispara un webhook `data.updated` quan s'aplica la substitució (immediatament o quan el flux finalitza), mai mentre està en espera o quan es cancel·la. Cada substitució es registra a l'activitat de la sessió com a `FEATURE_OVERRIDE_PENDING`, `FEATURE_OVERRIDE_APPLIED` o `FEATURE_OVERRIDE_CANCELLED`, juntament amb qui l'ha feta; l'entrada de la sol·licitud inclou el teu `comment`.\n\nAutentica't amb la teva clau d'API (`x-api-key`) o amb una capçalera d'autorització d'usuari que contingui el permís `write:sessions`; una clau d'API amb àmbit restringit necessita accés d'escriptura a les decisions.", "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 sessió de verificació. Accepta tant IDs de sessió d'usuari (KYC) com d'empresa (KYB); el servei resol l'ID entre tots dos tipus de sessió.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "in": "path", "name": "nodeId", "required": true, "description": "ID del node del graf del flux de treball de la funcionalitat que cal actualitzar (per exemple `feature_ocr_1`). Utilitza el valor literal `default` per a fluxos de treball que no siguin de tipus graf (d'un sol pas) on la funcionalitat no tingui cap ID de node.", "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": "Estat de destinació per a aquesta funcionalitat. Ha de ser diferent del valor actual.", "enum": [ "Approved", "Declined", "In Review" ], "example": "Approved" }, "comment": { "type": "string", "description": "Nota opcional en text lliure registrada al registre de revisió de la sessió per a aquest canvi de funcionalitat.", "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": "A quin tipus de pas s'adreça. Necessari en fluxos de treball que no són de graf (`nodeId` = `default`), on cap pas comparteix node; opcional en cas contrari. Un valor desconegut retorna `400`.", "example": "LIVENESS" }, "defer_until_flow_finishes": { "type": "boolean", "default": false, "description": "Mentre la persona encara estigui al flux, desa l'anul·lació com a `pending_until_flow_finishes` i aplica-la quan finalitzi el flux, en lloc de fer-ho immediatament. Si s'omet o és `false`, l'anul·lació s'aplica immediatament. En una sessió el flux de la qual ja ha acabat, s'aplica immediatament en qualsevol dels dos casos.", "example": false } } }, "examples": { "Apply Now": { "summary": "Aprova el pas de document d'identitat immediatament", "value": { "new_status": "Approved", "comment": "Document manually verified by compliance." } }, "Wait For The Flow": { "summary": "Aprova el pas de prova de vida un cop la persona finalitzi el flux", "value": { "new_status": "Approved", "comment": "Liveness retried with a reviewer present.", "defer_until_flow_finishes": true } }, "Non-graph Workflow": { "summary": "Apunta al pas de prova de vida d'un flux de treball sense nodes (nodeId = default)", "value": { "new_status": "In Review", "feature_type": "LIVENESS" } } } } } }, "responses": { "200": { "description": "La substitució s'ha registrat. `new_status` és l'estat de la comprovació tal com s'ha desat: el sol·licitat un cop aplicada la substitució, el no modificat mentre s'espera que acabi el flux. `override` indica què ha passat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid" }, "node_id": { "type": "string", "nullable": true, "description": "El node del flux de treball del pas actualitzat, o `null` per a un pas sense node (el camí `default` en un flux de treball sense graf).", "example": "feature_ocr_1" }, "feature_type": { "type": "string", "description": "Nom del model de la funcionalitat actualitzada (p. ex., `KYC`, `Face`, `FaceMatch`, `AML`, `POA`).", "example": "KYC" }, "new_status": { "type": "string", "description": "L'estat emmagatzemat de la comprovació: el sol·licitat un cop aplicada la sobreescriptura, o el que no ha canviat mentre la sobreescriptura espera que acabi el flux.", "example": "Approved" }, "override": { "$ref": "#/components/schemas/FeatureStatusOverride" } }, "required": [ "session_id", "node_id", "feature_type", "new_status", "override" ] }, "examples": { "Applied": { "summary": "La substitució s'ha aplicat immediatament", "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 mentre la persona encara és al flux", "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ó. Es retorna quan `new_status` no és vàlid o no ha canviat, quan `feature_type` és desconegut o quan la sessió és una sessió d'API autònoma.", "content": { "application/json": { "examples": { "Same Status": { "summary": "new_status és igual a l'estat actual", "value": { "new_status": [ "The new status is the same as the current status." ] } }, "API Session": { "summary": "L'estat de la funcionalitat no es pot canviar en sessions d'API autònomes", "value": [ "Cannot change feature status for API sessions." ] }, "Unknown feature_type": { "summary": "feature_type no és un tipus de pas conegut", "value": { "feature_type": [ "Unknown feature_type 'SELFIE'." ] } } } } } }, "401": { "description": "La clau d'API amb abast ha caducat.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Clau d'API amb abast que ha superat la data de caducitat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falten les credencials o els permisos són insuficients.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Falta l'x-api-key o no és vàlid", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La clau d'API no té write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Clau d'API amb abast sense accés d'escriptura a decisions", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "No s'ha trobat la sessió, o no té cap funcionalitat amb el `nodeId` indicat.", "content": { "application/json": { "examples": { "Session Not Found": { "summary": "session_id desconegut", "value": { "detail": "Session not found." } }, "Feature Not Found": { "summary": "Cap funcionalitat per a aquest 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": "Actualitzar l'estat de revisió d'una alerta d'AML", "description": "Estableix l'estat de revisió d'una **única coincidència d'AML** (una possible coincidència amb sancions / PEP / llistes de vigilància / mitjans adversos) retornada pel cribratge AML, sense canviar la decisió global de la sessió. Identifica la coincidència pel seu `hit_id` (l'`id` d'una entrada a la matriu `hits` de la comprovació d'AML; consulta la decisió de la sessió). Un id de coincidència retornat en el format anterior encara s'accepta; la resposta sempre anomena la coincidència pel seu `id` actual.\n\n`review_status` és un dels valors següents: `Unreviewed`, `Confirmed Match`, `False Positive` o `Inconclusive`. Les decisions del revisor es conserven al llarg de les actualitzacions del monitoratge continu, de manera que una coincidència que marquis com a `False Positive` es manté així quan el proveïdor torna a fer el cribratge.\n\nUna crida satisfactòria activa un webhook `data.updated` i afegeix una entrada d'activitat (amb atribució de l'actor) al registre de revisió de la sessió. Per a fluxos de treball de graf amb diverses comprovacions d'AML, passa `node_id` per dirigir-te a una comprovació específica.\n\nAutentica't amb la teva clau d'API (`x-api-key`) o amb una capçalera d'autorització d'usuari; qualsevol de les dues ha d'incloure el permís `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 sessió de verificació. Accepta tant IDs de sessió d'usuari (KYC) com d'empresa (KYB); el servei resol l'ID entre tots dos tipus de sessió.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "in": "query", "name": "node_id", "required": false, "description": "ID del node del graf del flux de treball. Només és obligatori quan la sessió té múltiples comprovacions AML (una per node); omet-ho per a sessions amb un sol 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": "L'`id` de la coincidència a la matriu `hits` del cribratge AML (`hit_...`). Encara s'accepta un id de coincidència retornat en el format anterior.", "example": "hit_7c1e9a40b2d35f86e0a4c912" }, "review_status": { "type": "string", "description": "El nou estat de revisió per a la coincidència.", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ], "example": "False Positive" }, "node_id": { "type": "string", "description": "ID opcional del node del graf. Utilitza'l (aquí o com a paràmetre de consulta) quan la sessió tingui múltiples comprovacions d'AML.", "example": "feature_aml_1" } } }, "example": { "hit_id": "hit_7c1e9a40b2d35f86e0a4c912", "review_status": "False Positive" } } } }, "responses": { "200": { "description": "Estat de revisió de la coincidència actualitzat.", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "hit_id", "review_status" ], "properties": { "message": { "type": "string", "description": "Sempre `Hit status updated successfully`." }, "hit_id": { "type": "string", "description": "L'`id` de la coincidència actualitzada, tal com el retorna la decisió de la sessió, també quan la sol·licitud ha identificat la coincidència mitjançant un id en el format anterior." }, "review_status": { "type": "string", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ], "description": "L'estat de revisió emmagatzemat actualment a la coincidència." } } }, "example": { "message": "Hit status updated successfully", "hit_id": "hit_7c1e9a40b2d35f86e0a4c912", "review_status": "False Positive" } } } }, "400": { "description": "Error de validació — `hit_id` buit o `review_status` no és un dels valors permesos.", "content": { "application/json": { "example": { "review_status": [ "\"Maybe\" is not a valid choice." ] } } } }, "403": { "description": "Falten les credencials o els permisos són insuficients. Si falta la clau, es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Falta l'x-api-key o no és vàlid", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La clau d'API no té write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No s'ha trobat la sessió, la sessió no té cap comprovació AML (opcionalment per al `node_id` indicat), o no hi ha cap coincidència amb `hit_id`.", "content": { "application/json": { "examples": { "No AML Check": { "summary": "La sessió no té cap comprovació AML", "value": { "detail": "The session does not have an AML check." } }, "Hit Not Found": { "summary": "hit_id desconegut", "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": "Actualització massiva dels estats de revisió de coincidències AML", "description": "Actualitza l'estat de revisió de **múltiples coincidències AML** en una sola crida. Proporciona `hit_updates`, una llista de parells `{ hit_id, review_status }`. `review_status` és un dels valors següents: `Unreviewed`, `Confirmed Match`, `False Positive` o `Inconclusive`.\n\nL'actualització és de tipus tot o res: si algun `hit_id` no es troba a la comprovació AML, la sol·licitud retorna `404` i no es canvia cap coincidència. Una crida satisfactòria activa un únic webhook `data.updated` i registra una entrada d'activitat que cobreix tots els canvis. Per a fluxos de treball de tipus graf amb múltiples comprovacions AML, passa `node_id` per dirigir-te a una comprovació específica.\n\nAutentica't amb la teva clau d'API (`x-api-key`) o amb una capçalera d'autorització d'usuari; qualsevol de les dues ha d'incloure el privilegi `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 sessió de verificació. Accepta tant IDs de sessió d'usuari (KYC) com d'empresa (KYB); el servei resol l'ID entre tots dos tipus de sessió.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "in": "query", "name": "node_id", "required": false, "description": "ID del node del graf del flux de treball. Només és obligatori quan la sessió té múltiples comprovacions AML (una per node); omet-ho per a sessions amb un sol 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": "Llista no buida d'actualitzacions de coincidències.", "items": { "type": "object", "required": [ "hit_id", "review_status" ], "properties": { "hit_id": { "type": "string", "example": "hit_7c1e9a40b2d35f86e0a4c912", "description": "L'`id` de la coincidència a la matriu `hits` del cribratge AML (`hit_...`). Encara s'accepta un id de coincidència retornat en el format anterior." }, "review_status": { "type": "string", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ], "example": "Confirmed Match" } } } }, "node_id": { "type": "string", "description": "ID opcional del node del graf. Utilitza'l (aquí o com a paràmetre de consulta) quan la sessió tingui múltiples comprovacions d'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": "Totes les coincidències s'han actualitzat.", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "updated_hits" ], "properties": { "message": { "type": "string", "description": "`Updated {n} hit(s) successfully`, on `n` és el nombre d'entrades a `hit_updates`." }, "updated_hits": { "type": "array", "items": { "type": "string" }, "description": "L'`id` de la coincidència que indica cada entrada de `hit_updates`, tal com el retorna la decisió de la sessió, en l'ordre de la sol·licitud, incloses les coincidències l'estat de les quals no ha canviat." } } }, "example": { "message": "Updated 2 hit(s) successfully", "updated_hits": [ "hit_7c1e9a40b2d35f86e0a4c912", "hit_3b8f20d6a91c4e75f0b2d6a8" ] } } } }, "400": { "description": "Error de validació — `hit_updates` buit, o falta `hit_id` / `review_status` en una entrada o conté un valor no vàlid.", "content": { "application/json": { "example": { "hit_updates": [ "hit_updates cannot be empty" ] } } } }, "403": { "description": "Falten les credencials o els permisos són insuficients. Si falta la clau, es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Falta l'x-api-key o no és vàlid", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La clau d'API no té write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No s'ha trobat la sessió, la sessió no té cap comprovació AML, o un o més `hit_id` no existeixen (en aquest cas no es modifica cap coincidència).", "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": "Actualitzar dades de Comprovant de domicili extretes del document de comprovant de domicili en una sessió de verificació", "description": "Corregeix els camps extrets del document de Comprovant de domicili de l'usuari — factura de serveis, extracte bancari o una altra prova d'adreça — un cop finalitzada la verificació: emissor, dates, el nom imprès, l'adreça mateixa i les dades bancàries. Tots els camps del cos són opcionals: només s'escriuen les claus que enviïs, i tota la resta es manté sense canvis (semàntica de `PATCH`).\n\nLa sessió ha de pertànyer a la teva aplicació i estar en estat `Approved`, `Declined`, `In Review` o `Kyc Expired`. Les sessions en qualsevol altre estat (per exemple, encara `In Progress`) retornen `404` amb `\"No Session matches the given query.\"` — diferent del `\"Not found.\"` que es retorna per a un `sessionId` desconegut o eliminat. La sessió també ha d'incloure un registre de POA: les sessions el flux de treball de les quals mai hagi executat un pas de Comprovant de domicili retornen `404` (`\"The session does not have a POA.\"`). Per a fluxos de treball de graf amb diversos passos de POA, apunta a un pas específic amb `node_id` (paràmetre de consulta o camp del cos); si s'omet, s'actualitza el registre de POA més recent.\n\n`extra_fields` es fusiona clau per clau: nou claus conegudes (`bank_iban`, `additional_names`, …) s'escriuen directament a columnes dedicades de POA, qualsevol altra clau es manté com a extra personalitzat, i `null` / `\"\"` elimina una clau. `poa_parsed_address` només accepta les set claus documentades i recalcula `formatted_address` / `poa_formatted_address` després de cada edició. Si el camp de text lliure `poa_address` canvia, el servidor també pot tornar-lo a geocodificar i actualitzar l'adreça estructurada (s'omet per a sessions de sandbox).\n\nA diferència de la variant de KYC d'aquest endpoint, el [webhook](/ca/integration/webhooks) `data.updated` (activador `manual_review`) només es dispara quan almenys un valor emmagatzemat ha **canviat realment** — tornar a enviar valors idèntics és una operació silenciosa sense efecte. Quan els valors canvien, s'afegeix una entrada d'activitat `POA_DATA_UPDATED` que registra els camps modificats amb els valors anteriors i nous a `reviews` de la sessió, visible a [Get Decision](#get-/v3/session/-sessionId-/decision/) i a la línia de temps d'activitat de la consola. L'estat i la decisió de la sessió **no** es reavaluen — utilitza [Update Status](#patch-/v3/session/-sessionId-/update-status/) per canviar el resultat.\n\nAccepta una clau d'API o un token d'usuari de la consola; en ambdós casos, la credencial necessita el permís `write:sessions`. Els errors d'autenticació i de permisos retornen tots dos `403` — aquesta API mai respon `401`. Tingues en compte que la cerca de la sessió s'executa abans de les comprovacions de credencials, de manera que un `sessionId` desconegut retorna `404` fins i tot si falten les credencials. Aquest endpoint té un límit de freqüència dedicat de 10 sol·licituds per minut per clau d'API (les sol·licituds no vàlides també compten); el pressupost compartit d'escriptura de 300 sol·licituds per minut també s'aplica.\n\nUn cos JSON buit `{}` no té cap efecte: retorna `200` amb el registre de POA actual sense disparar el webhook (`has_changes` es manté en fals).", "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 sessió de Verificació d'usuaris (KYC) de la qual estàs corregint el registre adjunt de comprovant de domicili.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "Node del graf del flux de treball el registre de POA del qual s'ha de modificar, per a fluxos de treball basats en grafs amb múltiples passos de Comprovant de domicili (també s'accepta com a camp `node_id` al cos). Quan s'omet, es modifica el registre de POA més recent de la sessió. Si no existeix cap POA per al node indicat, la crida retorna `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": "Tots els camps són opcionals — envia només el que vulguis canviar.", "properties": { "issuing_state": { "type": "string", "nullable": true, "description": "País que ha emès el document de comprovant de domicili (POA), ISO 3166-1 alpha-3. No distingeix entre majúscules i minúscules (es normalitza a majúscules); els codis no vàlids retornen `400`.", "example": "ESP" }, "document_type": { "type": "string", "enum": [ "UTILITY_BILL", "BANK_STATEMENT", "GOVERNMENT_ISSUED_DOCUMENT", "OTHER_POA_DOCUMENT", "UNKNOWN" ], "description": "Categoria del document de POA. Els valors van en majúscules; les variants en minúscules com `utility_bill` retornen `400`.", "example": "UTILITY_BILL" }, "document_language": { "type": "string", "maxLength": 50, "nullable": true, "description": "Idioma del document, normalment un codi ISO 639-1 (p. ex., `es`). Text lliure: no es valida com a codi d'idioma.", "example": "es" }, "issuer": { "type": "string", "maxLength": 255, "nullable": true, "description": "Organització que ha emès el document (empresa de subministraments, banc, organisme públic).", "example": "Energy Provider S.A." }, "issue_date": { "type": "string", "format": "date", "nullable": true, "description": "Data d'emissió del document de comprovant de domicili en `YYYY-MM-DD`. Qualsevol altre format retorna `400`.", "example": "2026-04-12" }, "poa_address": { "type": "string", "nullable": true, "description": "Adreça en text lliure tal com està impresa al document. Quan aquest valor canvia (només en sessions que no són de sandbox) i l'adreça estructurada encara falta o està incompleta, el servidor la torna a geocodificar en segon pla de la mateixa sol·licitud i pot sobreescriure `poa_parsed_address` / `poa_formatted_address` amb el resultat del geocodificador. La nova geocodificació també requereix que `issuing_state` estigui present al registre de POA.", "example": "Avda de Madrid 34, 28013 Madrid" }, "name_on_document": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nom del destinatari tal com apareix imprès al document.", "example": "Carmen Espanola" }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Camps addicionals específics del document, fusionats clau per clau. Nou claus s'assignen a columnes dedicades de POA: `bank_account_number`, `bank_iban`, `bank_sort_code`, `bank_routing_number`, `bank_swift_bic`, `bank_branch_name`, `bank_branch_address`, `document_phone_number` i `additional_names` (ha de ser una llista de cadenes o `null`; en cas contrari, `400`). Qualsevol altra clau s'emmagatzema com a camp addicional personalitzat. Semàntica per clau: un valor defineix la clau; `null` o `\"\"` l'elimina. Ha de ser un objecte JSON; en cas contrari, `400`." }, "poa_parsed_address": { "type": "object", "nullable": true, "description": "Adreça estructurada. Només s'accepten aquestes claus niades: `address_type`, `city`, `region`, `street_1`, `street_2`, `postal_code`, `country` — qualsevol altra clau retorna `400`. Semàntica per clau: un valor estableix la clau, `null` l'elimina. `formatted_address` (i el camp de nivell superior `poa_formatted_address`) es recalcula al servidor unint `street_1`, `street_2`, `city`, `region`, `postal_code` i `country` — no es pot establir directament.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Classificació d'adreça de format lliure (p. ex. `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Estat / província / comunitat 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": "Codi de país ISO 3166-1 alfa-2. L'entrada en minúscules es normalitza a majúscules; els codis alfa-3 es rebutgen amb un `400`.", "example": "ES" } } } } }, "examples": { "Correct issuer and address": { "summary": "Corregir la classificació del document, l'emissor i l'adreça 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": "Elimina una clau de camp addicional i mantén la resta", "value": { "extra_fields": { "bank_iban": null } } } } } } }, "responses": { "200": { "description": "Dades de POA actualitzades. Retorna el **registre complet i actual de POA** (tots els camps actualitzables amb el seu valor emmagatzemat, a més del mapa `extra_fields` complet, `poa_parsed_address` i `poa_formatted_address`), no només els camps enviats. El webhook `data.updated` només s'activa quan realment canvia com a mínim un valor.", "content": { "application/json": { "schema": { "type": "object", "properties": { "issuing_state": { "type": "string", "nullable": true, "description": "País que ha emès el document de comprovant de domicili (POA), ISO 3166-1 alpha-3. No distingeix entre majúscules i minúscules (es normalitza a majúscules); els codis no vàlids retornen `400`.", "example": "ESP" }, "document_type": { "type": "string", "enum": [ "UTILITY_BILL", "BANK_STATEMENT", "GOVERNMENT_ISSUED_DOCUMENT", "OTHER_POA_DOCUMENT", "UNKNOWN" ], "description": "Categoria del document de POA. Els valors van en majúscules; les variants en minúscules com `utility_bill` retornen `400`.", "example": "UTILITY_BILL" }, "document_language": { "type": "string", "maxLength": 50, "nullable": true, "description": "Idioma del document, normalment un codi ISO 639-1 (p. ex., `es`). Text lliure: no es valida com a codi d'idioma.", "example": "es" }, "issuer": { "type": "string", "maxLength": 255, "nullable": true, "description": "Organització que ha emès el document (empresa de subministraments, banc, organisme públic).", "example": "Energy Provider S.A." }, "issue_date": { "type": "string", "format": "date", "nullable": true, "description": "Data d'emissió del document de comprovant de domicili en `YYYY-MM-DD`. Qualsevol altre format retorna `400`.", "example": "2026-04-12" }, "poa_address": { "type": "string", "nullable": true, "description": "Adreça en text lliure tal com està impresa al document. Quan aquest valor canvia (només en sessions que no són de sandbox) i l'adreça estructurada encara falta o està incompleta, el servidor la torna a geocodificar en segon pla de la mateixa sol·licitud i pot sobreescriure `poa_parsed_address` / `poa_formatted_address` amb el resultat del geocodificador.", "example": "Avda de Madrid 34, 28013 Madrid" }, "name_on_document": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nom del destinatari tal com apareix imprès al document.", "example": "Carmen Espanola" }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Sempre present a la resposta: les nou claus conegudes (amb `null` per a les no establertes, `additional_names` per defecte a `[]`) més qualsevol clau personalitzada desada prèviament." }, "poa_parsed_address": { "type": "object", "nullable": true, "description": "Adreça estructurada actual, o `null` quan no n'hi ha cap. Inclou la `formatted_address` recalculada juntament amb les set claus editables. Es retorna tal com està emmagatzemada; després d'una geocodificació al servidor pot contenir claus de gestió interna (p. ex. `raw_results`) juntament amb les claus editables.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Classificació d'adreça de format lliure (p. ex. `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Estat / província / comunitat 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": "Codi de país ISO 3166-1 alfa-2. L'entrada en minúscules es normalitza a majúscules; els codis alfa-3 es rebutgen amb un `400`.", "example": "ES" }, "formatted_address": { "type": "string", "nullable": true, "description": "Forma concatenada i llegible per humans de l'adreça estructurada. Recalculada al costat del servidor després de cada edició de `poa_parsed_address`.", "example": "Avda de Madrid 34, Madrid, 28013, ES" } } }, "poa_formatted_address": { "type": "string", "nullable": true, "description": "Còpia de primer nivell del `formatted_address` recalculat, que es manté sincronitzada quan canvia l'adreça estructurada.", "example": "Avda de Madrid 34, Madrid, 28013, ES" } } }, "examples": { "Updated POA": { "summary": "Registre complet de POA després de la correcció", "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ó. Els errors de camp arriben com a `{\"\": [\"\"]}`; els errors en claus niades de `poa_parsed_address` / `extra_fields` utilitzen un valor d'objecte: `{\"extra_fields\": {\"\": \"\"}}`.", "content": { "application/json": { "examples": { "Invalid document type": { "summary": "L'enumeració va en majúscules; les variants en minúscules es rebutgen", "value": { "document_type": [ "\"utility_bill\" is not a valid choice." ] } }, "Invalid issuing state": { "summary": "issuing_state no és 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 accepta una llista de cadenes o null", "value": { "extra_fields": { "additional_names": "Must be a list or null." } } }, "Unsupported poa_parsed_address key": { "summary": "Només es permeten les set claus documentades", "value": { "poa_parsed_address": { "zipcode": "Unsupported key. Allowed keys: address_type, city, region, street_1, street_2, postal_code, country" } } }, "Bad date format": { "summary": "Les dates han de ser AAAA-MM-DD", "value": { "issue_date": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } } } } } }, "403": { "description": "Falten les credencials o els permisos són insuficients. Si falta la clau, es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Falta l'x-api-key o no és vàlid", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La credencial no té write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Sessió desconeguda, sessió en un estat no editable o cap registre de POA per modificar. Cada cas té un missatge `detail` diferent (vegeu els exemples). La cerca de sessió desconeguda s'executa abans de les comprovacions de credencials.", "content": { "application/json": { "examples": { "Unknown session": { "summary": "No hi ha cap sessió amb aquest ID a la teva aplicació (o s'ha suprimit)", "value": { "detail": "Not found." } }, "Wrong session state": { "summary": "La sessió existeix però no està en estat Approved / Declined / In Review / Kyc Expired", "value": { "detail": "No Session matches the given query." } }, "No POA record": { "summary": "El flux de treball mai no ha executat un pas de Comprovant de domicili", "value": { "detail": "The session does not have a POA." } }, "No POA for node": { "summary": "s'ha indicat node_id però no existeix cap POA per a aquest", "value": { "detail": "The session does not have a POA for node 'feature_missing'." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència dedicat: 10 actualitzacions de dades de POA per minut i clau d'API (les sol·licituds rebutjades compten per al pressupost). El pressupost compartit d'escriptura de 300/min també es pot activar amb el seu propi missatge. Inspecciona `Retry-After` i les capçaleres de resposta `X-RateLimit-*` abans de reintentar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Pressupost d'actualització de POA esgotat", "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": "Actualitza les dades de l'empresa extretes del registre en una sessió de Verificació d'empreses (KYB)", "description": "Corregeix les dades de l'empresa extretes del registre en una sessió de Verificació d'empreses (KYB) —nom de l'empresa, número de registre, adreces, estat, dades de contacte— identificada per `companyUuid`. Els usuaris habituals que fan aquesta crida són un analista de compliment que corregeix una lectura errònia del registre o la teva oficina administrativa sincronitzant dades corregides de l'empresa. Cada camp del cos és opcional (semàntica `PATCH`); un cos JSON buit (`{}`) és una operació nul·la que simplement retorna el registre actual de l'empresa.\n\nLes modificacions s'escriuen en dos llocs alhora: els camps amb una columna canònica d'empresa (nom, número de registre, país, data de constitució, número fiscal, tipus, estats, camps de capital (`registered_capital`, `registered_capital_amount`, `registered_capital_currency`), noms alternatius, activitat de l'empresa, lloc web, correu electrònic, telèfon, LEI, ubicació i `legal_address` → `registered_address`) actualitzen aquesta columna, i **cada** clau enviada també es fusiona a la instantània de `registry_data` (dates com a cadenes ISO) perquè la vista «extreta del registre» reflecteixi la correcció. Els camps sense columna —`region`, `registration_date`, `dissolution_date`, `control_scheme`— només es guarden a `registry_data`. `user_provided_data` (el que l'usuari final ha confirmat al flux allotjat) no es modifica mai, i s'afegeix la marca de temps `last_console_edit_at` a cada PATCH no buit.\n\nA diferència dels endpoints d'actualització de KYC/POA, **no hi ha cap restricció per l'estat de la sessió**: l'empresa es pot editar en qualsevol moment del cicle de vida de la sessió d'empresa. L'empresa ha de pertànyer a la sessió indicada a la ruta (en cas contrari, `404` amb `\"KYB company does not belong to the given session.\"`) i a la teva aplicació. Cada PATCH no buit activa el [webhook](/ca/integration/webhooks) `data.updated` a la sessió d'empresa (activador `console_registry_edit`), fins i tot quan els valors enviats coincideixen amb els emmagatzemats. L'estat i la decisió de la sessió **no** es tornen a avaluar, i no es registra cap entrada de revisió ni d'auditoria.\n\nAccepta una clau d'API o un token d'usuari de la consola; en qualsevol cas, la credencial necessita el permís `write:businesses`. Tant els errors d'autenticació com els de permisos retornen `403` —aquesta API mai no respon amb `401`. Tingues en compte que la cerca de la sessió s'executa abans de comprovar les credencials, de manera que un `sessionId` desconegut retorna `404` fins i tot si falten credencials. S'aplica el límit d'escriptura compartit de 300 sol·licituds per minut per clau d'API.\n\nPer a sessions de Verificació d'usuaris, l'equivalent de KYC és `PATCH /v3/session/{sessionId}/update-data/`; per canviar la decisió de la sessió pròpiament dita, utilitza `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 sessió pare de Verificació d'empreses (KYB).", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "companyUuid", "in": "path", "required": true, "description": "UUID del registre d'empresa que cal actualitzar (`registry_checks[].company.uuid` a la decisió de la sessió d'empresa). Ha de pertànyer a la sessió a la qual fa referència `sessionId`.", "schema": { "type": "string", "format": "uuid", "example": "88888888-9999-aaaa-bbbb-cccccccccccc" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Tots els camps són opcionals — envia només el que vulguis canviar. Els camps proporcionats actualitzen les columnes canòniques de l'empresa (on n'hi hagi una) i es fusionen amb la instantània de `registry_data`.", "properties": { "company_name": { "type": "string", "maxLength": 255, "description": "Nom legal de l'empresa. S'escriu a la columna canònica i a la instantània del registre.", "example": "Docs Probe Corp" }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registre oficial al registre mercantil.", "example": "DPC-001" }, "country_code": { "type": "string", "maxLength": 2, "description": "País de constitució, ISO 3166-1 alpha-2. No distingeix entre majúscules i minúscules (`us` s'emmagatzema com a `US`). Els codis alpha-3 no compleixen el límit de 2 caràcters i retornen un error `400`.", "example": "US" }, "region": { "type": "string", "maxLength": 10, "nullable": true, "description": "Etiqueta de subdivisió o regió quan el registre en disposa d'una (p. ex. estat dels EUA). Només s'emmagatzema a la instantània del registre — no té columna canònica." }, "incorporation_date": { "type": "string", "format": "date", "description": "Data de constitució en format `YYYY-MM-DD`. Com tots els altres camps, és opcional: el `PATCH` és parcial. Qualsevol altre format de data retorna `400`.", "example": "2015-04-12" }, "registration_date": { "type": "string", "format": "date", "nullable": true, "description": "Data de registre quan el registre la distingeix de la constitució. Només s'emmagatzema a la instantània del registre." }, "dissolution_date": { "type": "string", "format": "date", "nullable": true, "description": "Data de dissolució per a empreses que ja no estan actives. S'emmagatzema només a la instantània del registre." }, "tax_number": { "type": "string", "maxLength": 100, "description": "Identificador fiscal." }, "legal_address": { "type": "string", "description": "Adreça legal / registrada. S'utilitza com a àlies al servidor de la columna canònica `registered_address` — la resposta la retorna sota `registered_address`, mentre que la instantània del registre mercantil manté la clau `legal_address` que has enviat.", "example": "1 Example Plaza, Wilmington, DE 19801" }, "company_type": { "type": "string", "maxLength": 100, "description": "Tipus d'entitat jurídica (p. ex., `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": "Estat de l'empresa notificat pel registre. En minúscules, alguns valors contenen espais (p. ex. `struck off`, `no longer authorised`). Qualsevol altre valor retorna `400`.", "example": "active" }, "verification_status": { "type": "string", "enum": [ "verified", "failed", "unknown" ], "nullable": true, "description": "Resultat de la verificació del registre. Qualsevol altre valor retorna `400`.", "example": "verified" }, "alternative_names": { "type": "string", "description": "Noms comercials, noms legals anteriors, noms DBA (text lliure)." }, "nature_of_business": { "type": "string", "description": "Descripció breu de l'activitat de l'empresa.", "example": "Software development" }, "registered_capital": { "type": "string", "maxLength": 100, "description": "Capital social registrat llegible per a humans (p. ex. `USD 50000`). Utilitza `registered_capital_amount` + `registered_capital_currency` per a valors estructurats, o aquest camp per a text lliure.", "example": "USD 50000" }, "registered_capital_amount": { "type": "number", "format": "double", "nullable": true, "description": "Import numèric del capital registrat (fins a 20 dígits, 2 decimals). Estableix la columna `registered_capital_amount` i es reflecteix a `registry_data` com una cadena decimal; la resposta el retorna com una cadena decimal (p. ex., `\"1500000.50\"`)." }, "registered_capital_currency": { "type": "string", "maxLength": 3, "nullable": true, "description": "Codi de moneda ISO 4217 per a `registered_capital_amount`. No distingeix entre majúscules i minúscules (`usd` s'emmagatzema com a `USD`); els valors que no tinguin exactament 3 lletres retornen `400` amb el missatge d'ISO 4217. Estableix la columna canònica `registered_capital_currency` i es replica a `registry_data`.", "example": "USD" }, "website": { "type": "string", "maxLength": 500, "description": "Lloc web de l'empresa. S'accepten dominis simples i es normalitzen amb el prefix `https://` (`docsprobe.example.com` s'emmagatzema com a `https://docsprobe.example.com`); els valors que continuïn fallant la validació d'URL retornen `400`.", "example": "https://docsprobe.example.com" }, "email": { "type": "string", "format": "email", "description": "Correu electrònic de contacte registrat al registre.", "example": "legal@docsprobe.example.com" }, "phone": { "type": "string", "maxLength": 50, "description": "Telèfon de contacte. Ha de coincidir amb `+`, dígits, espais, guions, punts o parèntesis, amb 7-15 dígits en total; en cas contrari, `400`.", "example": "+1 302 555 0143" }, "legal_entity_identifier": { "type": "string", "maxLength": 50, "description": "LEI, si l'empresa en té." }, "location_of_registration": { "type": "string", "maxLength": 255, "description": "Ciutat / subdivisió del registre oficial." }, "vat_number": { "type": "string", "maxLength": 64, "description": "Número d'IVA de la UE. Només es fusiona amb la instantània de `registry_data`: editar-lo aquí no torna a executar la validació de l'IVA i de l'identificador fiscal, de manera que `vat_validation_status` i els altres camps de resultat `vat_*` no canvien." }, "control_scheme": { "type": "string", "description": "Esquema de control / governança quan el registre l'exposa. Només s'emmagatzema a la instantània del registre." } } }, "examples": { "Correct registry data": { "summary": "Corregeix els camps de l'empresa extrets del registre", "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": "Només s'escriuen les claus que envies", "value": { "registry_status": "dissolved" } }, "No-op": { "summary": "Un cos buit retorna el registre actual sense activar el webhook", "value": {} } } } } }, "responses": { "200": { "description": "Dades de l'empresa actualitzades (o retornades sense canvis per a un cos buit). Retorna el registre complet de l'empresa de KYB —amb la mateixa estructura que `registry_checks[].company` a la decisió de la sessió d'empresa. Tingues en compte que `legal_address` es retorna com a `registered_address`. `registered_capital_amount`/`registered_capital_currency` emplenen les seves columnes canòniques i es reflecteixen a `registry_data`.", "content": { "application/json": { "schema": { "type": "object", "description": "Registre complet d'empresa KYB: la mateixa estructura que l'objecte `company` dins de `registry_checks[]` a la decisió de la sessió d'empresa.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador del registre de l'empresa (el paràmetre de ruta `companyUuid`)." }, "node_id": { "type": "string", "nullable": true, "description": "Node del graf del flux de treball al qual pertany aquest registre d'empresa, quan el flux de treball està basat en grafs." }, "status": { "type": "string", "description": "Estat del cicle de vida de la funcionalitat per a la comprovació al registre (p. ex. `Not Finished`, `Approved`, `Declined`, `In Review`)." }, "registry_status": { "type": "string", "nullable": true, "description": "Estat de l'empresa notificat pel registre (p. ex. `active`, `dissolved`, `struck off`)." }, "data_resolved": { "type": "boolean", "description": "`true` quan les dades de l'empresa estan completes — sempre `true` per a empreses introduïdes manualment; per a empreses obtingudes del registre, `true` un cop s'ha resolt l'obtenció del registre." }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true, "description": "País de constitució segons 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": "Adreça registrada canònica — s'actualitza quan envies `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` quan l'empresa s'ha emplenat prèviament a partir d'una cerca al registre en comptes d'introduir-se manualment." }, "fetch_status": { "type": "string", "nullable": true, "description": "Cicle de vida de l'obtenció del registre per a empreses procedents del registre (`pending` / `resolved`); `null` per a entrades manuals." }, "alternative_names": { "type": "string", "nullable": true, "description": "Noms alternatius, comercials, anteriors o en l'idioma original de l'empresa com a text, quan s'hagin informat." }, "nature_of_business": { "type": "string", "nullable": true }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Columna canònica. Es retorna com una cadena decimal (p. ex. `\"2750000.00\"`)." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Columna canònica. S'estableix mitjançant el flux del registre o mitjançant edicions a la consola o a l'API a través d'aquest 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 d'IVA de la UE, quan es recull durant el pas de registre allotjat o s'edita posteriorment." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Resultat de la validació del número d'IVA o, si no n'hi ha, del `tax_number`, en enviar al registre. `valid` / `invalid`: determinat pel registre oficial del país (VIES de la UE, Noruega, Suïssa, Brasil, Colòmbia, Costa Rica, Equador, Paraguai; Polònia també pel seu registre intern d'IVA). `format_valid` / `invalid_format`: determinat per les regles de format i dígit de control del país on no es pot consultar cap registre. `could_not_validate`: el registre no estava disponible. `not_applicable`: sense número, un país sense registre o regles, o una sessió de sandbox." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "El número que s'ha comprovat, tal com el coneix la font (per exemple, el número d'IVA derivat d'un SIREN francès o d'un RSIN holandès). `null` quan no s'ha executat cap comprovació." }, "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 font que ha determinat `vat_validation_status`: un registre oficial o `format_rules`. `null` quan no s'ha executat cap comprovació." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Nom registrat amb la font que ha validat el número, quan en revela un. Només s'estableix quan l'estat és `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Adreça registrada amb la font que ha validat el número, quan en divulga una. Només s'estableix quan l'estat és `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de temps de la comprovació. `null` quan no s'ha executat cap comprovació." }, "financial_summary": { "type": "object", "nullable": true, "additionalProperties": true }, "officers": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Administradors / càrrecs vinculats a l'empresa, inclòs el progrés de KYC per persona." }, "beneficial_owners": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Titulars reals associats a l'empresa, inclòs el progrés de KYC per persona." }, "addresses": { "type": "array", "nullable": true, "items": { "type": "object", "additionalProperties": true }, "description": "Detall de l'adreça del registre, si el registre n'ha retornat algun." }, "industries": { "type": "array", "nullable": true, "items": { "type": "object", "additionalProperties": true }, "description": "Classificació sectorial del registre, quan estigui disponible." }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Dates de presentació al registre, quan estiguin disponibles. Els informes anuals i les juntes generals utilitzen last_annual_return_date i last_agm_date; són diferents dels comptes financers." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Què va escriure l'usuari final durant el pas allotjat de confirmació del registre. Aquest endpoint no ho modifica mai." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan l'usuari final va confirmar les dades de l'empresa en el flux allotjat." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "S'afegeix a cada PATCH no buit satisfactori, de manera que les interfícies d'usuari poden mostrar el context \"editat per l'operador\"." }, "is_editable": { "type": "boolean", "description": "`true` mentre l'usuari final encara pot editar les dades obtingudes del registre en el flux allotjat (obtingudes del registre i encara no confirmades)." } } }, "examples": { "Updated company": { "summary": "Registre complet de l'empresa després de la correcció", "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ó. Els errors de camp arriben com a `{\"\": [\"\"]}`. Les comprovacions de longitud màxima s'executen abans que les de format, de manera que `country_code: \"USA\"` notifica el límit de 2 caràcters en lloc del missatge d'ISO.", "content": { "application/json": { "examples": { "Alpha-3 country code": { "summary": "country_code ha de ser alpha-2 — la comprovació de longitud s'executa primer", "value": { "country_code": [ "Ensure this field has no more than 2 characters." ] } }, "Non-alphabetic country code": { "summary": "2 caràcters que no són lletres", "value": { "country_code": [ "country_code must be a 2-letter ISO 3166-1 alpha-2 code." ] } }, "Invalid currency": { "summary": "3 caràcters que no són un codi 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èfon no supera la comprovació de format o nombre de dígits", "value": { "phone": [ "Invalid phone number format." ] } }, "Invalid registry status": { "summary": "registry_status no és a l'enum", "value": { "registry_status": [ "\"liquidated\" is not a valid choice." ] } }, "Invalid email": { "summary": "Adreça de correu electrònic amb format incorrecte", "value": { "email": [ "Enter a valid email address." ] } }, "Invalid website": { "summary": "El valor no supera la validació d'URL fins i tot després de la normalització a https://", "value": { "website": [ "Enter a valid URL." ] } }, "Bad date format": { "summary": "Les dates han de ser AAAA-MM-DD", "value": { "incorporation_date": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } } } } } }, "403": { "description": "Falten les credencials o els permisos són insuficients. Si falta la clau, es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Falta l'x-api-key o no és vàlid", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La credencial no té write:businesses", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Sessió desconeguda, empresa desconeguda o una empresa que pertany a una sessió diferent. Cada cas té un missatge `detail` diferent (vegeu els exemples). La cerca de sessió desconeguda s'executa abans de les comprovacions de credencials.", "content": { "application/json": { "examples": { "Unknown session": { "summary": "No hi ha cap sessió amb aquest ID a la teva aplicació (o s'ha suprimit)", "value": { "detail": "Not found." } }, "Unknown company": { "summary": "No hi ha cap empresa amb aquest UUID a la teva aplicació", "value": { "detail": "No KYBCompany matches the given query." } }, "Company / session mismatch": { "summary": "companyUuid existeix però pertany a una altra sessió", "value": { "detail": "KYB company does not belong to the given session." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència d'escriptura compartit (300 sol·licituds POST/PATCH/DELETE per minut per clau d'API). Revisa les capçaleres de resposta `Retry-After` i `X-RateLimit-*` abans de reintentar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Pressupost d'escriptura esgotat", "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": "Ometre (o tornar a requerir) una part de Persones clau en una sessió de Verificació d'empreses (KYB)", "description": "Eximeix de la verificació una part de Persones Clau, o torna-la a incloure en l'abast. Aquesta és la sortida d'emergència de l'operador per a una part que mai no pot finalitzar la seva pròpia comprovació; gairebé sempre perquè la sessió individual de KYC assignada a un UBO o administrador s'ha eliminat, cosa que congela l'estat d'aquest fill i deixa el KYB aturat a `Awaiting User` sense res més que el pugui fer avançar.\n\nDefinir `is_skipped: true` treu la part de l'agregació de Persones Clau i recalcula immediatament el `KYBKeyPeopleCheck` i l'estat de la sessió pare, de manera que la sessió d'empresa es pot resoldre i després ser aprovada o rebutjada. Enviar `is_skipped: false` torna a posar la part en l'abast i la comprovació torna a quedar a l'espera d'ella.\n\nA diferència de l'omissió per a la persona sol·licitant a la pantalla allotjada de Persones Clau, aquest endpoint **no** està limitat pel paràmetre `allow_skip` del rol; aquest senyalador limita el que pot decidir la persona sol·licitant, no el que pot sobreescriure el teu analista. `requires_verification` es deixa expressament intacte, de manera que una part sobreescrita es llegeix com a `requires_verification: true` **i** `is_skipped: true`, i el registre continua mostrant el que demanaven les regles.\n\nLa part ha de pertànyer a la sessió de la ruta (en cas contrari `404` amb `\"Party does not belong to the given session.\"`), i a la teva aplicació. Un PATCH que realment canviï el senyalador activa el [webhook](/ca/integration/webhooks) `data.updated` a la sessió d'empresa amb l'activador `console_key_people_skip`; un PATCH que estableixi el senyalador al seu valor actual és una operació nul·la que retorna la mateixa part com a resposta.\n\nAccepta una clau d'API o un token d'usuari de la consola; en tots dos casos la credencial necessita el permís `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 sessió pare de Verificació d'empreses (KYB).", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "partyUuid", "in": "path", "required": true, "description": "UUID de la part de Persones clau que cal actualitzar (`key_people_checks[].submitted.parties[].uuid` a la decisió de la sessió d'empresa). Ha de pertànyer a la sessió a la qual fa referència `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` eximeix la part de la verificació perquè la comprovació de persones clau es pugui resoldre sense ella; `false` la torna a incloure en l'abast.", "example": true } } } } } }, "responses": { "200": { "description": "Part actualitzada (o retornada sense canvis quan el senyalador ja tenia aquest valor). Retorna la part, amb la mateixa estructura que una entrada de `key_people_checks[].submitted.parties[]` a la decisió de la sessió de l'empresa.", "content": { "application/json": { "schema": { "type": "object", "description": "Registre de la part corresponent a una persona clau: la mateixa estructura que una entrada de `key_people_checks[].submitted.parties[]` a la decisió de la sessió d'empresa.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador de la part." }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Si la part és una persona física o una empresa." }, "name": { "type": "string", "description": "Nom visible de la part." }, "is_skipped": { "type": "boolean", "description": "Si la part està exempta de verificació." }, "requires_verification": { "type": "boolean", "description": "El que demanaven les regles de rol i llindar. Aquest endpoint no ho modifica." }, "kyc_session_status": { "type": "string", "nullable": true, "description": "Estat de la sessió KYC individual vinculada, congelat en el moment en què es va eliminar la sessió." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "Enllaç a la sessió de KYC individual vinculada. `null` quan no n'hi ha cap o quan s'ha eliminat." }, "kyc_session_deleted": { "type": "boolean", "description": "La sessió de KYC individual vinculada s'ha suprimit, de manera que no es podrà resoldre mai." }, "kyb_sub_session_deleted": { "type": "boolean", "description": "Equivalent per a entitats corporatives de `kyc_session_deleted`." } } } } } }, "400": { "description": "Error de validació al cos de la sol·licitud. `is_skipped` és l'únic camp que llegeix aquest endpoint, i és obligatori. Els errors de camp arriben com a `{\"\": [\"\"]}`. La validació del cos s'executa *després* de la cerca de la part, de manera que un `is_skipped` mal format enviat a una part que no existeix retorna `404`, no `400`.", "content": { "application/json": { "examples": { "Missing is_skipped": { "summary": "Cos buit, o un cos que omet `is_skipped`", "value": { "is_skipped": [ "This field is required." ] } }, "Non-boolean is_skipped": { "summary": "El valor no és un booleà: `\"maybe\"`, `2`, `[]`. S'accepten booleans a més de `\"true\"`/`\"false\"`, `1`/`0` i `\"yes\"`/`\"no\"`", "value": { "is_skipped": [ "Must be a valid boolean." ] } }, "Null is_skipped": { "summary": "`is_skipped` és present però és `null`", "value": { "is_skipped": [ "This field may not be null." ] } } } } } }, "403": { "description": "Falten les credencials o els permisos són insuficients. Si falta la clau, es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Falta l'x-api-key o no és vàlid", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "La credencial no té write:businesses", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Part desconeguda, o una part que pertany a una sessió diferent. Cada cas té un missatge `detail` diferent (vegeu els exemples). Les comprovacions de credencials i permisos s'executen abans de cercar la part, de manera que una crida no autoritzada retorna `403` en lloc de `404`. No hi ha una cerca de sessió independent: un `sessionId` desconegut combinat amb una part teva retorna el missatge de discrepància.", "content": { "application/json": { "examples": { "Unknown party": { "summary": "No hi ha cap part amb aquest UUID a la teva aplicació", "value": { "detail": "Not found." } }, "Party / session mismatch": { "summary": "partyUuid existeix però depèn d'una altra sessió", "value": { "detail": "Party does not belong to the given session." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència d'escriptura compartit (300 sol·licituds POST/PATCH/DELETE per minut per clau d'API). Revisa les capçaleres de resposta `Retry-After` i `X-RateLimit-*` abans de reintentar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Pressupost d'escriptura esgotat", "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": "Obtenir la configuració de Travel Rule", "description": "Llegeix la configuració de Travel Rule i el perfil de VASP de l'aplicació. Crea automàticament una fila de configuració per defecte (desactivada) i un perfil buit en la primera lectura.", "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ó actual de Travel Rule i 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": "Actualitzar configuració de Travel Rule", "description": "Fes un upsert de la configuració de Travel Rule i del perfil de VASP de l'aplicació. Actualització parcial: envia només els camps que vulguis canviar. Establir `is_enabled: true` requereix un `legal_name` no buit (ja emmagatzemat o inclòs a la mateixa sol·licitud); en cas contrari, retorna 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ó i perfil actualitzats, amb la mateixa estructura que GET.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleSettingsDetail" } } } }, "400": { "description": "Error de validació; p. ex., activació sense un legal_name, una sunrise_policy o non_responsive_policy diferent de HOLD, REJECT, PROCEED o buida, un camp desconegut a `matching_rules` o una opció de `data_sharing_fields` que no pot complir les obligacions de l'ordenant del règim de la teva jurisdicció (els errors s'indexen per tipus d'entitat sota `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": "Envia la confirmació de compliment per correu electrònic", "description": "Envia per correu electrònic un enllaç de confirmació d'un sol ús al compliance_email del teu perfil de VASP. Obrir l'enllaç i prémer el seu botó de confirmació confirma l'adreça, que la xarxa de Didit necessita abans d'incloure el teu perfil a la llista. Una nova sol·licitud substitueix l'enllaç anterior; l'enllaç deixa de funcionar quan el correu electrònic de compliment canvia. Un correu per minut per adreça.", "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": "S'ha enviat el correu electrònic de confirmació.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sent_to": { "type": "string", "format": "email" } } }, "example": { "sent_to": "compliance@your-vasp.example" } } } }, "400": { "description": "No s'ha definit cap correu electrònic de compliment normatiu, o ja està confirmat.", "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": "S'ha enviat una confirmació a aquesta adreça fa menys d'un minut." }, "503": { "description": "No s'ha pogut enviar el correu electrònic. No s'ha fet cap canvi; torna-ho a provar d'aquí a un moment." } } } }, "/v3/travel-rule/wallet-addresses/": { "get": { "summary": "Llista les entrades de la llibreta d'adreces de carteres", "description": "Llista paginada de la llibreta d'adreces de carteres de la Travel Rule de la teva aplicació, les més recents primer.", "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": "Entrades de la llibreta d'adreces de carteres paginades.", "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": "Registra una adreça de cartera", "description": "Afegeix una entrada a la llibreta d'adreces de carteres de la Travel Rule perquè les transferències entrants per la via INTERNAL s'hi puguin associar.", "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": "L'entrada creada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressEntry" } } } }, "400": { "description": "Cartera duplicada (adreça, cadena i memo) per a aquesta aplicació, un memo o adreça X que la cadena no pot admetre, una `address` absent, una `travel_address` no vàlida, `self_declared: true` mentre `allow_self_declaration` està desactivat, o `self_declared: true` mentre `ownership_validation_mode` és `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": "Actualitza les metadades del titular de l'adreça de la cartera", "description": "Actualització parcial de holder_name, holder_vendor_data, entity_type i travel_address. Si s'estableix travel_address, s'associa una adreça d'encaminament TRP a l'entrada; els valors no vàlids es rebutgen amb 400. La resposta només reflecteix aquests quatre camps.", "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": "Els camps actualitzats.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressEntryUpdate" } } } }, "400": { "description": "`travel_address` no és una Travel Address vàlida.", "content": { "application/json": { "examples": { "Invalid travel address": { "value": { "travel_address": [ "Invalid travel address." ] } } } } } }, "404": { "description": "Entrada desconeguda o suprimida." } } }, "delete": { "summary": "Elimina una adreça de cartera", "description": "Elimina l'entrada juntament amb les seves proves de titularitat i les captures de pantalla que s'hi havien emmagatzemat. Deixa de coincidir immediatament amb noves transferències i l'adreça s'allibera per tornar-se a registrar. Les transferències que ja hagin utilitzat la cartera conserven el seu propi registre d'aquesta, que es continua llegint de la mateixa manera. L'eliminació és 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": "Eliminat." }, "404": { "description": "Entrada desconeguda o ja suprimida." }, "503": { "description": "`wallet_address_deletion_incomplete`: no s'ha pogut suprimir un fitxer emmagatzemat, de manera que la supressió s'ha aturat abans d'acabar. L'entrada de la llibreta d'adreces continua allà; reintenta la mateixa sol·licitud per finalitzar-la.", "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": "Cercar al directori de VASP", "description": "Cerca paginada i ordenada per nom al directori de VASP: les entrades del directori compartit, que Didit genera a partir del registre provisional MiCA de l'ESMA, el directori públic de TRISA, el registre global LEI i la seva pròpia selecció, a més dels membres de la xarxa Didit. Cada fila inclou les rutes de què disposa la teva aplicació cap a aquest VASP actualment. El perfil de la teva pròpia aplicació no apareix mai a la llista. Les files també inclouen l'avaluació de diligència deguda compartida i la decisió de la teva aplicació, el cribratge de l'entitat i els qüestionaris.", "operationId": "listTravelRuleVasps", "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string", "maxLength": 255 }, "description": "Un fragment de nom o àlies (sense distinció entre majúscules i minúscules), un LEI exacte o un domini (example.com o una URL que en formi part). Els membres de la xarxa Didit coincideixen pel seu nom legal, LEI o el domini del seu correu electrònic de compliment normatiu." }, { "name": "network", "in": "query", "schema": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA", "TRISA" ] }, "description": "Només entrades de directori que el directori de membres d'una xarxa llista actualment." }, { "name": "jurisdiction", "in": "query", "schema": { "type": "string" }, "description": "Codi de país ISO 3166 alfa-2 o alfa-3. 400 per a qualsevol altre valor." }, { "name": "reachable", "in": "query", "schema": { "type": "boolean" }, "description": "true: només els VASP cap als quals la teva aplicació té una ruta disponible (inclosos els membres de la xarxa Didit). false: només les entrades del directori a les quals no es pot accedir avui." }, { "name": "kind", "in": "query", "schema": { "type": "string", "enum": [ "directory", "didit" ] }, "description": "Només entrades de directori, o només membres de la xarxa de Didit." }, { "name": "risk", "in": "query", "schema": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "description": "Només entrades de directori el risk_level de les quals sigui aquesta franja. Els membres de la xarxa de Didit, que no estan puntuats, mai no coincideixen." }, { "name": "responsiveness", "in": "query", "schema": { "type": "string", "enum": [ "RESPONSIVE", "UNRESPONSIVE", "UNKNOWN" ] }, "description": "Només entrades de directori el responsiveness.status de les quals sigui aquest valor. Els membres de la xarxa de Didit mai no coincideixen." }, { "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": "Resultats del directori de VASP paginats i ordenats per nom.", "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 filtre no és vàlid: el cos indica cada camp, per exemple una xarxa, codi de país, franja de risc o estat de capacitat de resposta desconeguts.", "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": "Obtenir una entrada del directori de VASP", "description": "Una entrada del directori o membre de la xarxa de Didit segons l'identificador que ha retornat la cerca, amb els mateixos camps i les rutes que la teva aplicació hi té.", "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": "L'id d'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": "L'entrada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaspDirectoryEntry" } } } }, "404": { "description": "Cap entrada ni membre llistat de la xarxa Didit té aquest 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": "Obtenir la teva decisió sobre un VASP", "description": "La decisió de la teva aplicació sobre una contrapart (una entrada del directori o un membre de la xarxa Didit): aprovada, restringida o bloquejada. Una entitat d'una marca sense decisió pròpia segueix la decisió de la marca, indicada a inherited_from. Privada per a la teva aplicació.", "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": "L'id d'una fila de GET /v3/travel-rule/vasps/: una entrada de directori o un membre de la xarxa 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ó que s'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": "Cap entrada del directori ni membre llistat de la xarxa Didit té aquest id. El teu propi perfil de VASP mai és la teva contrapart.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } } } }, "put": { "summary": "Estableix la teva decisió sobre un VASP", "description": "Pren o modifica la decisió de la teva aplicació sobre una contrapart: APPROVED, RESTRICTED o BLOCKED, amb un motiu opcional. Mai no modifica l'entrada del directori compartit i només actua a través de les teves regles de transacció (counterparty_dd_status). Una decisió sobre una marca també cobreix cadascuna de les seves entitats que no tingui una decisió pròpia.", "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": "L'id d'una fila de GET /v3/travel-rule/vasps/: una entrada de directori o un membre de la xarxa 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ó tal com s'aplica ara.", "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ó o no és una d'APPROVED, RESTRICTED o BLOCKED, o el motiu té més de 255 caràcters.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "example": { "decision": [ "\"MAYBE\" is not a valid choice." ] } } } }, "404": { "description": "Cap entrada del directori ni membre llistat de la xarxa Didit té aquest id. El teu propi perfil de VASP mai és la teva contrapart.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } } } }, "delete": { "summary": "Esborra la teva decisió sobre un VASP", "description": "Esborra la decisió pròpia de la teva aplicació sobre una contrapart. La resposta mostra la decisió que s'aplica després: null, o bé, per a una entitat d'una marca, la decisió de la marca, que l'entitat torna 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": "L'id d'una fila de GET /v3/travel-rule/vasps/: una entrada de directori o un membre de la xarxa 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ó s'ha esborrat; el cos mostra la decisió que s'aplica ara.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyDecisionResponse" }, "example": { "decision": null } } } }, "404": { "description": "Cap contrapart té aquest id, o la teva aplicació no té cap decisió pròpia sobre ella (una decisió que només hereta de la seva marca no es pot esborrar aquí: esborra 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": "Obtenir el cribratge de l'entitat d'un VASP", "description": "Indica si el cribratge de contraparts està activat per a la teva aplicació, quant costa un cribratge a la teva organització, quant de temps es manté vigent un resultat i el teu darrer cribratge de sancions i mitjans adversos de la contrapart. Consultar-ho és gratuït.", "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": "L'id d'una fila de GET /v3/travel-rule/vasps/: una entrada de directori o un membre de la xarxa 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": "La teva configuració de cribratge, el seu preu i el teu darrer cribratge.", "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 contracte de la teva organització no té cap tarifa configurada per al cribratge de contraparts.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No contract rate is configured for this usage type." } } } }, "404": { "description": "Cap entrada del directori ni membre llistat de la xarxa Didit té aquest id. El teu propi perfil de VASP mai és la teva contrapart.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } } } }, "post": { "summary": "Fes el cribratge d'un VASP", "description": "Fes el cribratge de l'entitat contrapart contra sancions i mitjans adversos per a la teva aplicació. Activació opcional: counterparty_screening_enabled ha d'estar activat a la teva configuració de Travel Rule. Cada cribratge nou es factura al preu de Cribratge AML d'empreses de la teva organització; es retorna un cribratge de menys de 30 dies en el seu lloc (200, no facturat) tret que enviïs refresh: true. S'executa un sol cribratge d'una contrapart alhora per aplicació. El resultat és privat per a la teva aplicació. Les aplicacions de sandbox no se sotmeten mai a cribratge.", "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": "L'id d'una fila de GET /v3/travel-rule/vasps/: una entrada de directori o un membre de la xarxa 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": "Ja existia un cribratge recent i s'ha retornat. No s'ha facturat res.", "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": "S'ha executat un nou cribratge i s'ha facturat.", "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 cos no és vàlid, o la contrapart no té cap nom per analitzar.", "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 la teva organització no pot cobrir el cribratge (codi insufficient_credits; no s'ha executat res ni s'ha facturat res), o el teu contracte no té cap tarifa configurada per a aquest.", "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": "Cap entrada del directori ni membre llistat de la xarxa Didit té aquest id. El teu propi perfil de VASP mai és la teva contrapart.", "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 s'ha executat res ni s'ha facturat res: el cribratge de contraparts està desactivat per a la teva aplicació, l'aplicació és de sandbox o ja s'està executant un cribratge d'aquesta contrapart.", "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 s'ha pogut completar el cribratge. No s'ha facturat res; torna-ho a provar d'aquí a un moment.", "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": "Llista els qüestionaris de diligència deguda amb un VASP", "description": "Tots els qüestionaris de diligència deguda que la teva aplicació ha enviat a la contrapart, del més recent al més antic, amb el seu estat i, un cop contestats, les respostes. Privats per a la teva aplicació.", "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": "L'id d'una fila de GET /v3/travel-rule/vasps/: una entrada de directori o un membre de la xarxa 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": "Els teus qüestionaris amb aquesta contrapart.", "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": "Cap entrada del directori ni membre llistat de la xarxa Didit té aquest id. El teu propi perfil de VASP mai és la teva contrapart.", "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 qüestionari de diligència deguda a un VASP", "description": "Envia per correu electrònic el qüestionari estàndard de diligència deguda de Didit a una adreça de compliment registrada per a la contrapart, amb un enllaç de resposta d'un sol ús. La contrapart té 30 dies per respondre a totes les preguntes; les respostes es mantenen vigents durant 365 dies. Un nou enviament substitueix el qüestionari anterior sense resposta enviat a la mateixa contrapart, l'enllaç del qual deixarà de funcionar. Un correu electrònic per minut i per adreça.", "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": "L'id d'una fila de GET /v3/travel-rule/vasps/: una entrada de directori o un membre de la xarxa 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 qüestionari s'ha enviat per correu electrònic.", "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 és una adreça de correu electrònic vàlida o no és una adreça de compliment registrada per a la contrapart, o la contrapart no té cap adreça de compliment 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": "Cap entrada del directori ni membre llistat de la xarxa Didit té aquest id. El teu propi perfil de VASP mai és la teva contrapart.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } }, "429": { "description": "S'ha enviat un qüestionari a aquesta adreça fa menys d'un minut." }, "503": { "description": "No s'ha pogut enviar el correu electrònic i no s'ha creat cap qüestionari. Torna-ho a provar d'aquí a un moment." } } } }, "/v3/transactions/{transaction_id}/travel-rule/": { "patch": { "summary": "Finalitzar, cancel·lar, reenviar o actualitzar la cartera ordenant d'una transferència de la Travel Rule", "description": "Proporciona `payment_txn_id` per informar del hash on-chain i passar una transferència sortint COMPLETED a FINISHED (la seva contrapart del rail INTERNAL també passa a FINISHED), `{\"action\": \"cancel\"}` per cancel·lar una transferència no terminal, o `{\"action\": \"resend\"}` per tornar a encaminar una transferència sortint blocada a COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE o NOT_ENOUGH_COUNTERPARTY_DATA (millora primer les dades de la contrapart, p. ex. afegeix una travel_address a l'entrada de la cartera de destinació). resend només s'aplica a transferències sortints. `{\"action\": \"update_compliance_email\", \"compliance_email\": \"desk@example.com\"}` substitueix el correu de compliment d'una transferència sortint en un d'aquests tres estats, la solució per a `reason: email_undeliverable`: l'estat no canvia i el següent `resend` envia la sol·licitud a aquesta adreça. Un reenviament s'encua, no s'executa dins de la sol·licitud: la resposta mostra la transferència de nou a AWAITING_COUNTERPARTY amb una entrada de `resend queued` a la cronologia i un `delivery` encuat, i la informació sobre on ha anat arriba com un webhook `travel_rule.status.updated`. Quan la transferència s'ha fet a través de GTR, VerifyVASP o Sygna Bridge, la xarxa rep el hash on-chain o la cancel·lació després de la resposta, amb reintents; `delivery` mostra l'estat d'aquest missatge. `{\"action\": \"update_originator_wallet\", \"wallet_address\": \"...\"}` registra la cartera des d'on han sortit realment els fons en una transferència sortint, per exemple l'adreça des d'on s'ha difós una retirada UTXO en lloc de la cartera principal declarada. Només modifica el registre: no es torna a enviar res a la contrapart i l'estat es manté. L'ordenant passa a ser `chain_details.originator` amb `source: updated`, el canvi s'afegeix a la `timeline` amb la cartera anterior i la nova, i la contrapart del rail INTERNAL de la transferència s'actualitza de la mateixa manera. `{\"action\": \"beneficiary_vasp\", \"beneficiary_vasp\": \"\"}` indica la contrapart manualment quan el descobriment no ho ha pogut fer, en una transferència sortint a COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE o NOT_ENOUGH_COUNTERPARTY_DATA: la transferència s'encamina cap a aquest VASP i es torna 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 de transacció estable de Didit que posseeix la transferència.", "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 transferència actualitzada. Després de `update_compliance_email`, el seu estat no canvia i manté `reason: email_undeliverable` fins al següent `resend`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTransferDetail" } } } }, "400": { "description": "No s'ha proporcionat ni payment_txn_id ni una acció admesa, falta `compliance_email` o no és una adreça de correu electrònic a `update_compliance_email`, o bé, per a `update_originator_wallet`, falta wallet_address, la cartera o el memo no són compatibles amb la cadena de la transferència, o la cartera no és una de les entrades UTXO de la transferència, o bé falta `beneficiary_vasp` o no és un identificador de VASP del directori vàlid.", "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ó desconeguda, la transacció no té cap transferència de Travel Rule o (acció `beneficiary_vasp`) cap entrada del directori té aquest id." }, "409": { "description": "La transferència no està en un estat que permeti aquesta operació (p. ex., no està en COMPLETED/sortint per a finalitzar, ja és terminal per a cancel·lar, o no és una transferència sortint en un estat reenviable per a reenviar). `update_compliance_email` respon `409` per a una transferència entrant, i per a una de sortint que no estigui a COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE o NOT_ENOUGH_COUNTERPARTY_DATA. `update_originator_wallet` respon `409` per a una transferència entrant, cancel·lada o caducada. `beneficiary_vasp` respon `409` tret que la transferència sigui sortint i estigui a 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 denegar la titularitat de la cartera", "description": "Resol una transferència que espera la titularitat de la cartera: crida-la des del teu costat de la transferència quan estigui en UNCONFIRMED_OWNERSHIP, o quan sigui una transferència entrant en ON_HOLD. Confirmar marca l'entrada coincident de la llibreta d'adreces de carteres com a titularitat verificada (per a una transferència entrant en ON_HOLD sense entrada, Didit en crea una a partir de beneficiary_data.wallet_address) i executa la coincidència del nom del beneficiari a ambdós costats de la transferència; denegar rebutja ambdós costats. Una transferència entrant el dipòsit de la qual ja s'ha liquidat passa a FINISHED quan la coincidència és satisfactòria. Quan la cartera de la contrapart s'ha declarat com a autoallotjada (counterparty.payment_method.method_type: unhosted_wallet), confirmar registra que el client ha verificat qui controla aquesta cartera i completa la transferència (COMPLETED) en ambdues direccions, o a FINISHED per a un dipòsit entrant el hash on-chain del qual ja es coneix. La cartera verificada és la de la contrapart: la destinació d'una retirada sortint, o l'origen (la cartera de l'ordenant) d'un dipòsit entrant. Si encara no és a la teva llibreta d'adreces de carteres, Didit l'afegeix amb la titularitat verificada sota el nom de la contrapart; si la llibreta ja la conté sota un nom de titular diferent, la transferència passa a COUNTERPARTY_MISMATCHED_DATA. Per a una transferència TRP entrant en UNCONFIRMED_OWNERSHIP, ON_HOLD o COUNTERPARTY_MISMATCHED_DATA, Didit envia la teva decisió al VASP ordenant: aprovar retorna l'adreça de pagament (wallet_address, o l'adreça de l'entrada coincident) i mou la transferència a COMPLETED, i denegar la rebutja. La mateixa crida també decideix una transferència entrant enviada per una contrapart de GTR o Sygna Bridge que espera la teva revisió (`UNCONFIRMED_OWNERSHIP`, `ON_HOLD` o `COUNTERPARTY_MISMATCHED_DATA`): `confirmed: true` l'aprova (passa `wallet_address` quan la transferència no n'indiqui cap) i `confirmed: false` la rebutja, i es respon a la xarxa després de la resposta, amb reintents. VerifyVASP obté la seva resposta quan la demana, de manera que una transferència de VerifyVASP que necessités la teva revisió es rebutja a l'instant i no es pot decidir més endavant.", "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ó que la teva aplicació manté per a aquesta transferència: la transacció del costat del beneficiari en una transferència per rail INTERNAL, o la transacció que has creat (sortint o entrant) quan la cartera de la contrapart es va declarar autoallotjada.", "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 transferència actualitzada. Per a una transferència entrant, les dades originator_data/beneficiary_data de la contrapart es mantenen emmascarades (`data_masked: true`) fins que es confirma la titularitat; després, `data_unmasked` registra quan, per què i per qui.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTransferDetail" } } } }, "409": { "description": "La transferència no està pendent de confirmació de titularitat, cap entrada de la llibreta d'adreces de carteres no coincideix amb la seva cartera de la contrapart, una transferència INTERNAL d'un altre client de Didit requereix una prova de control (un missatge signat o un dipòsit de prova) abans de poder-se confirmar, o ja s'ha respost a una transferència de xarxa a través de la seva xarxa (una transferència VerifyVASP, o una transferència GTR o Sygna Bridge sobre la qual tu o Didit ja heu decidit).", "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ó: falta confirmed, una aprovació TRP entrant no té wallet_address ni cap adreça alternativa a la qual recórrer, o `confirmed: true` en una transferència declarada de cartera autoallotjada que no especifica cap cartera de contrapart i no s'ha enviat cap `wallet_address`.", "content": { "application/json": { "examples": { "No payment address": { "value": { "wallet_address": [ "wallet_address is required to approve." ] } } } } } }, "404": { "description": "Transacció desconeguda, o la transacció no té cap transferència de Travel Rule." }, "502": { "description": "Només per a transferències TRP entrants: Didit no ha pogut lliurar la teva decisió al VASP ordenant, de manera que l'estat de la transferència no canvia.", "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": "Llista els missatges de Travel Rule", "description": "Missatges i sol·licituds de documents intercanviats amb el VASP contrapart sobre aquesta transferència.", "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 de transacció estable de Didit que posseeix la transferència.", "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": "Els missatges, ordenats del més antic al més recent.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleMessage" } } } } }, "404": { "description": "Transacció o token desconeguts, o la transacció no té cap transferència de Travel Rule." } } }, "post": { "summary": "Enviar un missatge de Travel Rule o una sol·licitud de document", "description": "Envia un missatge o una sol·licitud de document al VASP contrapart. Funciona en transferències INTERNAL (l'altre client de Didit el veu al seu costat del parell) i transferències EMAIL (s'envia un correu electrònic a la contrapart i respon al portal de recollida). Una transferència mitjançant TRP, GTR, TRUST, VerifyVASP o Sygna no transmet missatges, perquè aquests protocols no en tenen. Límits: 100 missatges per transferència, 5000 caràcters per cos, 10 documents sol·licitats, 5 fitxers de 10 MB cadascun.", "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 de transacció estable de Didit que posseeix la transferència.", "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 missatge emmagatzemat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleMessage" } } } }, "400": { "description": "Cos no vàlid, un tipus o mida de fitxer no acceptat, més de 100 missatges a la transferència o un `reply_to` que no és un missatge d'aquesta transferència.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "requested_documents": [ "Name at least one document the counterparty should send." ] } } } }, "404": { "description": "Transacció o token desconeguts, o la transacció no té cap transferència de Travel Rule." }, "409": { "description": "Cap missatge no pot arribar a la contrapart. `detail` n'indica el motiu: la transferència s'executa a través d'una via de xarxa (TRP, GTR, TRUST, VerifyVASP o Sygna), encara no té contrapart, les dades d'una transferència INTERNAL no coincidien amb el titular de la cartera i res no ha arribat al destinatari, o l'enllaç de recollida d'una transferència EMAIL ha caducat o la transferència està tancada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } } } }, "/v3/travel-rule/pickup/{token}/": { "get": { "summary": "Obtenir la informació de recollida de l'email-rail", "description": "Públic, no autenticat. Permet que un VASP contrapart que no és de Didit previsualitzi l'intercanvi pendent des de l'enllaç de recollida enviat per correu electrònic. El token mateix és l'autenticació.", "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=` de l'enllaç, el contacte al qual s'ha enviat l'enllaç. Es retorna com a `contact` sense canvis; no es valida." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl https://verification.didit.me/v3/travel-rule/pickup/{token}/" } ], "responses": { "200": { "description": "Previsualització de recollida.", "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 desconegut." }, "410": { "description": "La finestra s'ha tancat: la contrapart ja ha respost, la transferència ha sortit d'AWAITING_COUNTERPARTY, o s'ha superat el termini límit." } } } }, "/v3/travel-rule/pickup/{token}/respond/": { "post": { "summary": "Respondre a una recollida per canal de correu electrònic", "description": "Públic, sense autenticació. Accepta o rebutja l'intercanvi des de l'enllaç de recollida enviat per correu electrònic. En acceptar-lo, beneficiary_name es comprova contra la política name_matching_strictness de l'ordenant.", "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=` de l'enllaç. S'utilitza quan el cos no envia cap `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": "L'estat resultant de l'intercanvi: COMPLETED o COUNTERPARTY_MISMATCHED_DATA després d'una acceptació, COUNTERPARTY_VASP_GENERAL_DECLINE després d'un rebuig, que també reflecteix `decline_reason`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "decline_reason": { "type": "string", "description": "Present després d'un rebuig." } } }, "examples": { "accepted": { "value": { "status": "COMPLETED" } }, "declined": { "value": { "status": "COUNTERPARTY_VASP_GENERAL_DECLINE", "decline_reason": "not_our_customer" } } } } } }, "400": { "description": "Un camp no és vàlid: per exemple, falta `decision` o no és `accept` ni `decline`, falta `decline_detail` en un rebuig amb `decline_reason: other`, una `ivms_response` que no és un objecte IVMS 101 o té més de 16384 caràcters, o un `contact` al cos que no és 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 desconegut." }, "410": { "description": "La finestra s'ha tancat: la contrapart ja ha respost, la transferència ha sortit d'AWAITING_COUNTERPARTY, o s'ha superat el termini límit." } } } }, "/v3/travel-rule/pickup/{token}/messages/": { "get": { "summary": "Llista els missatges de recollida", "description": "Públic, no autenticat. Els missatges d'una transferència pel canal EMAIL tal com els llegeix el VASP contrapart: el que ha enviat el client és `INBOUND` i està signat amb el nom del VASP del client. El token és l'autenticació.", "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": "Els missatges, ordenats del més antic al més recent, per part de la contrapart.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleMessage" } } } } }, "404": { "description": "Token desconegut." }, "410": { "description": "L'enllaç de recollida ha caducat o la transferència està tancada." } } }, "post": { "summary": "Respondre al portal de recollida", "description": "Públic, no autenticat. El VASP contrapart respon en una transferència pel canal EMAIL. El mateix cos que els missatges de la transacció; els fitxers adjunts han de ser PDF, PNG, JPEG o WebP. El token és l'autenticació.", "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 missatge emmagatzemat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleMessage" } } } }, "400": { "description": "Cos no vàlid, un tipus o mida de fitxer no acceptat, més de 100 missatges a la transferència o un `reply_to` que no és un missatge d'aquesta transferència.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "requested_documents": [ "Name at least one document the counterparty should send." ] } } } }, "404": { "description": "Token desconegut." }, "410": { "description": "L'enllaç de recollida ha caducat o la transferència està tancada." } } } }, "/v3/travel-rule/inbound/": { "post": { "summary": "Registra una transferència entrant posterior al dipòsit (sunrise)", "description": "Registra dades de Travel Rule per a un dipòsit cripto que ja s'ha liquidat on-chain abans que es produís cap intercanvi. Crea una transacció travelRule entrant (o reutilitza un dipòsit no reclamat) i resol la transferència respecte a la llibreta d'adreces de la teva cartera. Per a una transacció acabada de crear, Didit envia primer transaction.created i després els 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": "Ja s'havia registrat una transferència per a aquest txid i wallet_address; es retorna l'existent sense canvis (created és false).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleInboundResponse" } } } }, "201": { "description": "S'ha registrat una nova transferència Travel Rule, en una nova transacció entrant o en un dipòsit no reclamat existent (created és cert).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleInboundResponse" } } } }, "400": { "description": "Falta un camp obligatori (`chain`, `txid`, `wallet_address`, `amount`, `currency`), `originating_vasp.lei` no és un LEI vàlid, `originating_vasp.travel_address` no és una Travel Address vàlida, un memo, una X-address o un `utxo` que la cadena no pot admetre, o `originator_data` / `beneficiary_data` que no és un objecte.", "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": "Activar una transferència entrant des del Test VASP de Didit (sandbox)", "description": "Només per a aplicacions de sandbox. El VASP de prova de Didit envia a la teva aplicació una transferència entrant de Travel Rule, de manera que pots provar d'extrem a extrem la part receptora d'un intercanvi abans de passar a producció. La transferència es registra i es decideix amb la mateixa lògica amb què una transferència entrant real d'una xarxa s'executa contra la teva llibreta d'adreces de carteres, de manera que la safata d'entrada, la decisió i el flux de titularitat de la cartera es comporten com en producció. Res no surt de Didit. Una aplicació en producció rep un 400. Torna a enviar la mateixa `reference` per obtenir la transferència que ha registrat la primera crida en lloc d'una de segona.", "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 transferència entrant s'ha registrat i s'ha pres una decisió. Si es repeteix amb la mateixa `reference`, es retorna el mateix cos.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTestVaspInboundResponse" } } } }, "400": { "description": "Cos no vàlid, un `scenario` desconegut o no admès, o bé l'aplicació és una aplicació de producció.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "La transferència no s'ha pogut registrar, per exemple perquè Travel Rule no està habilitat per a l'aplicació.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } } } }, "/v3/travel-rule/widget-session/": { "post": { "summary": "Genera una sessió del widget de titularitat de la cartera", "description": "Genera un URL/token del widget allotjat per demostrar la titularitat de la cartera. Envia el client a l'URL retornat perquè demostri el control d'una cartera (signatura de missatges, prova de Satoshi, captura de pantalla o autodeclaració). En aquesta versió, el widget només és web: obre l'URL al navegador del sistema o en una pestanya personalitzada, mai dins d'un webview de l'SDK mòbil.", "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 sessió del widget emesa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetSessionResponse" } } } }, "400": { "description": "Cos no vàlid: `callback_url` no és una URL absoluta http(s), `expires_in_minutes` està fora de l'interval de 5 a 10080, `transaction_id` no és un UUID o un camp supera el seu límit.", "content": { "application/json": { "examples": { "Invalid callback_url": { "value": { "callback_url": [ "callback_url must be an absolute http(s) URL." ] } } } } } }, "404": { "description": "`transaction_id` no indica cap transferència de Travel Rule en aquesta aplicació." } } } }, "/v3/travel-rule/widget/{token}/": { "get": { "summary": "Obtenir el context del giny de titularitat de la cartera", "description": "Endpoint públic de lectura identificat pel token de sessió del widget, sense necessitat de cap clau d'API. Retorna el context del widget a més de l'estat de cada prova, de manera que pots fer-ne sondeig per detectar quan s'ha completat; completed_at deixa de ser nul un cop la prova s'ha verificat. Una prova SATOSHI_TEST pot romandre en estat PENDING mentre el seu dipòsit es detecta on-chain però encara no està confirmat: una tasca en segon pla el torna a comprovar automàticament i la completa un cop es confirma el dipòsit, per la qual cosa no cal cap acció per part del client mentre s'espera. Cada prova conté els camps que el seu mètode necessita: deposit_address, expected_amount i el seu propi expires_at per a SATOSHI_TEST; challenge per a MESSAGE_SIGNING. És preferible fer servir el webhook travel_rule.status.updated en lloc de fer sondeig quan la sessió està vinculada a una transferència.", "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 sessió opac retornat quan s'ha creat la sessió 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 context del widget i els estats de les proves.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetContext" } } } }, "404": { "description": "Token desconegut." }, "410": { "description": "La sessió ha caducat sense completar-se." } } } }, "/v3/travel-rule/widget/{token}/vasps/": { "get": { "summary": "Cerca VASP des del giny de cartera", "description": "Endpoint públic de lectura identificat pel token de sessió del widget, sense necessitat de cap clau d'API: el selector de VASP del widget de l'usuari final. Mateixa cerca i filtres que GET /v3/travel-rule/vasps/ per a l'aplicació del widget, indicant únicament la identitat de cada VASP i si és accessible.", "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 sessió opac retornat quan s'ha creat la sessió del widget.", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string", "maxLength": 255 }, "description": "Un fragment de nom o àlies (sense distinció entre majúscules i minúscules), un LEI exacte o un domini (example.com o una URL que en formi part). Els membres de la xarxa Didit coincideixen pel seu nom legal, LEI o el domini del seu correu electrònic de compliment normatiu." }, { "name": "network", "in": "query", "schema": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA", "TRISA" ] }, "description": "Només entrades de directori que el directori de membres d'una xarxa llista actualment." }, { "name": "jurisdiction", "in": "query", "schema": { "type": "string" }, "description": "Codi de país ISO 3166 alfa-2 o alfa-3. 400 per a qualsevol altre valor." }, { "name": "reachable", "in": "query", "schema": { "type": "boolean" }, "description": "true: només els VASP cap als quals la teva aplicació té una ruta disponible (inclosos els membres de la xarxa Didit). false: només les entrades del directori a les quals no es pot accedir avui." }, { "name": "kind", "in": "query", "schema": { "type": "string", "enum": [ "directory", "didit" ] }, "description": "Només entrades de directori, o només membres de la xarxa 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": "Resultats paginats i ordenats per nom.", "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 filtre no és vàlid: el cos indica cada camp, per exemple una xarxa o codi de país desconeguts.", "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 desconegut." }, "410": { "description": "La sessió ha caducat." } } }, "post": { "summary": "Tria el VASP de la contrapart al widget de cartera", "description": "Endpoint públic d'escriptura identificat pel token de sessió del widget, sense necessitat de cap clau d'API: l'usuari final ha triat el VASP de destinació que el descobriment automàtic no ha pogut determinar. Només una transferència sortint en estat COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE o NOT_ENOUGH_COUNTERPARTY_DATA ho accepta. La transferència s'encamina cap a aquest VASP i es torna a enviar; el descobriment automàtic mai no sobreescriu aquesta elecció.", "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 sessió opac retornat quan s'ha creat la sessió del widget.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "vasp" ], "properties": { "vasp": { "type": "string", "format": "uuid", "description": "L'`id` d'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": "S'ha registrat la selecció i la transferència s'està tornant a enviar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "transfer_status": { "type": "string", "description": "L'estat de la transferència després de la selecció." }, "counterparty_vasp": { "type": "string", "description": "El nom del VASP que ha seleccionat l'usuari final." } } }, "example": { "detail": "Counterparty VASP selected; the transfer is being resent.", "transfer_status": "AWAITING_COUNTERPARTY", "counterparty_vasp": "Northwind Exchange" } } } }, "400": { "description": "Falta `vasp`, o cap entrada del directori actiu té aquest id.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "example": { "vasp": [ "No directory entry has this id." ] } } } }, "404": { "description": "Token desconegut." }, "409": { "description": "La sessió del widget no està enllaçada a una transferència de Travel Rule, o la transferència no és de sortida en un estat que accepti una contrapart." }, "410": { "description": "La sessió ha caducat." } } } }, "/v3/organization/{organization_id}/application/{application_id}/vendor-users/toggle-ongoing-monitoring/": { "patch": { "summary": "Activa o desactiva el monitoratge AML continu per a usuaris", "description": "Habilita o inhabilita el monitoratge AML continu a nivell d'usuari. Es manté exactament un cribratge AML monitorat per usuari; als usuaris sense cap cribratge AML (per exemple, els usuaris importats) se'ls en crea i analitza un primer, facturat com un cribratge AML ordinari. Estableix estimate_only per previsualitzar recomptes i costos sense escriure dades. Els lots de 20 o menys es resolen en línia (200, COMPLETED); els lots més grans retornen 202 i s'executen de manera 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "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ó (quan s'utilitza estimate_only) o la tasca completada per a lots petits processats en línia.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleResult" } } } }, "202": { "description": "Els lots més grans es processen de manera asíncrona; consulta periòdicament l'endpoint de tasques amb el job_id retornat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "403": { "description": "Falta el privilegi write:sessions, o el saldo és insuficient per activar-lo (l'estimació s'inclou al cos de l'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": "Obtenir la tasca de monitoratge AML continu", "description": "Progrés i comptadors de cada resultat d'una tasca d'activació o desactivació del monitoratge. Fes sondeig cada parell de segons mentre l'estat sigui 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la tasca de monitoratge retornat per l'endpoint de commutació." } ], "responses": { "200": { "description": "La tasca.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "404": { "description": "Tasca desconeguda per a aquesta aplicació." } }, "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": "Activa o desactiva el monitoratge AML continu per a empreses", "description": "Equivalent a nivell d'empresa de la commutació d'usuaris: un cribratge AML monitorat per empresa, sotmetent a cribratge primer les empreses que no tinguin cap cribratge AML (entitat jurídica). Mateix funcionament per a estimate_only, via ràpida síncrona i contracte de tasca asíncrona.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "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ó (quan s'utilitza estimate_only) o la tasca completada per a lots petits processats en línia.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleResult" } } } }, "202": { "description": "Els lots més grans es processen de manera asíncrona; consulta periòdicament l'endpoint de tasques amb el job_id retornat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "403": { "description": "Falta el privilegi write:sessions, o el saldo és insuficient per activar-lo (l'estimació s'inclou al cos de l'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": "Obtenir la tasca de monitoratge AML continu", "description": "Progrés i comptadors de cada resultat d'una tasca d'activació o desactivació del monitoratge. Fes sondeig cada parell de segons mentre l'estat sigui 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la tasca de monitoratge retornat per l'endpoint de commutació." } ], "responses": { "200": { "description": "La tasca.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "404": { "description": "Tasca desconeguda per a aquesta aplicació." } }, "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": "Activa o desactiva el monitoratge AML continu per a sessions d'empresa", "description": "Commutador a nivell de sessió per a verificacions KYB, identificat mitjançant el número de sessió. A les sessions sense un cribratge AML se'n crea un i s'adjunta a la mateixa sessió. Mateix contracte d'estimate_only, via ràpida en línia i tasca asíncrona que els endpoints a nivell d'usuari. Substitueix el comportament síncron heretat que ometia les sessions sense un cribratge 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "is_enabled" ], "properties": { "is_enabled": { "type": "boolean", "description": "true per activar el monitoratge, false per desactivar-lo." }, "estimate_only": { "type": "boolean", "default": false, "description": "Quan és cert, retorna l'estimació del cost i no realitza cap escriptura." }, "update_all": { "type": "boolean", "default": false, "description": "Aplica a totes les entitats de l'aplicació (delimitades pels paràmetres filter_* quan són presents)." }, "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 sessió d'empresa que s'han d'activar o desactivar. Obligatori tret que update_all (o l'àlies heretat toggle_all) sigui cert." }, "toggle_all": { "type": "boolean", "default": false, "description": "Àlies antic d'update_all." }, "filter_workflow_id": { "type": "string" } } }, "example": { "is_enabled": true, "session_numbers": [ "1001", "1002" ] } } } }, "responses": { "200": { "description": "Estimació (quan s'utilitza estimate_only) o la tasca completada per a lots petits processats en línia.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleResult" } } } }, "202": { "description": "Els lots més grans es processen de manera asíncrona; consulta periòdicament l'endpoint de tasques amb el job_id retornat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "403": { "description": "Falta el privilegi write:sessions, o el saldo és insuficient per activar-lo (l'estimació s'inclou al cos de l'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": "Obtenir la tasca de monitoratge AML continu", "description": "Progrés i comptadors de cada resultat d'una tasca d'activació o desactivació del monitoratge. Fes sondeig cada parell de segons mentre l'estat sigui 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la tasca de monitoratge retornat per l'endpoint de commutació." } ], "responses": { "200": { "description": "La tasca.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "404": { "description": "Tasca desconeguda per a aquesta aplicació." } }, "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": "Llista els casos", "description": "Llista els casos de l'aplicació, els més recents primer. Admet filtres, cerca i ordenació; consulta els paràmetres de consulta. Paginat amb `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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Mida de la pàgina. Per defecte és 50." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Desplaçament basat en zero del primer registre." }, { "name": "status__in", "in": "query", "schema": { "type": "string" }, "description": "Estats separats per comes que cal incloure, p. ex. OPEN,AWAITING_USER." }, { "name": "priority", "in": "query", "schema": { "type": "string" }, "description": "Prioritats separades per comes que cal incloure." }, { "name": "source__in", "in": "query", "schema": { "type": "string" }, "description": "Fonts separades per comes que cal incloure." }, { "name": "blueprint", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Filtra pels casos d'aquest blueprint." }, { "name": "assigned_to", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Filtra pels casos assignats a aquest usuari." }, { "name": "unassigned", "in": "query", "schema": { "type": "boolean" }, "description": "true per a casos no assignats, false per a casos assignats." }, { "name": "tag", "in": "query", "schema": { "type": "string" }, "description": "Filtra pels casos que tinguin exactament aquesta etiqueta." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Coincideix amb title, case_number, tag, nom/UUID/ID extern del subjecte, UUID de la sessió enllaçada o UUID de la transacció enllaçada." }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Límit inferior de la data de creació (inclusiu)." }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Límit superior de la data de creació (inclusiu)." }, { "name": "due_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Límit superior de due_at." }, { "name": "overdue", "in": "query", "schema": { "type": "boolean" }, "description": "true per retornar només els casos vençuts en estat obert o en espera de l'usuari." }, { "name": "ordering", "in": "query", "schema": { "type": "string", "enum": [ "created_at", "-created_at", "due_at", "-due_at" ], "default": "-created_at" }, "description": "Criteri d'ordenació. due_at situa els valors nuls 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": "Llista paginada de casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Nombre de files coincidents. Exacte fins a 100, limitat a 100 a partir d'aquí per motius de rendiment. Fes servir el fet que `next` sigui null per detectar l'última pàgina." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta de la pàgina següent, 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": "Crea un cas", "description": "Crea un cas vinculat exactament a un subjecte (un usuari o una empresa), directament o derivant el subjecte d'un enllaç de sessió/transacció adjunt. L'origen sempre és `MANUAL` per als casos creats mitjançant l'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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "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. Omet-ho si no hi ha cap blueprint." }, "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": "Obligatori tret que es proporcioni links; l'únic subjecte del cas.", "properties": { "type": { "type": "string", "enum": [ "user", "business" ] }, "uuid": { "type": "string", "format": "uuid" } } }, "links": { "type": "array", "description": "Sessions/sessions d'empresa/transaccions per adjuntar en crear, p. ex. [{\"entity_type\": \"transaction\", \"entity_uuid\": \"...\"}]. Quan s'omet el subjecte, el subjecte es deriva del propietari del primer enllaç.", "items": { "type": "object" } }, "assigned_to": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID de l'usuari que s'ha d'assignar immediatament." }, "review_duplicates": { "type": "boolean", "default": false, "description": "Torna a comprovar les investigacions existents abans de crear el cas. Quan és cert, un subjecte amb casos existents requereix un separate_incident_reason no buit. La consola sempre activa aquesta protecció. Ometre-ho manté el comportament existent de l'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": "Cas creat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "400": { "description": "No s'ha proporcionat ni subject ni links, o no s'ha trobat el subject/blueprint/assignee.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "La revisió de duplicats està activada i s'ha trobat un cas existent sense cap motiu d'incident separat. No s'ha creat cap cas." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/": { "get": { "summary": "Obtenir el cas", "description": "Recupera un cas amb el seu subjecte, blueprint, notes, esdeveniments, enllaços i llista de verificació.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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": "Detall del cas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "404": { "description": "No s'ha trobat el cas (o el recurs niat) en aquesta aplicació.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualitza el cas", "description": "Actualitza el títol, la prioritat, la data de venciment, les etiquetes o l'equip de revisió propietari del cas. Envia només els camps que vulguis canviar; els camps que ometis mantenen el seu valor. `tags` substitueix tota la llista d'etiquetes. `team` pren l'uuid d'un equip de revisió actiu d'aquesta aplicació (llista'ls amb `GET .../cases/teams/`), o null per esborrar l'equip. Requereix una clau d'API d'accés complet, o `write:cases` per a un membre de la consola: una clau amb accés restringit rep un 403. Registra els esdeveniments PRIORITY_CHANGED, DUE_DATE_CHANGED, TAG_ADDED, TAG_REMOVED i TEAM_CHANGED segons correspongui; un canvi de títol es desa sense cap esdeveniment a la cronologia. Retorna el cas actualitzat.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 255, "description": "Nou títol del cas." }, "priority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "due_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Nova data límit. Envia null per esborrar-la." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "La llista completa d'etiquetes. Substitueix les etiquetes actuals." }, "team": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID de l'equip de revisió propietari del cas. Ha de ser un equip actiu d'aquesta aplicació. Envia null per esborrar l'equip." } } }, "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": "Cas actualitzat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "400": { "description": "Un camp no ha superat la validació. Les claus del cos són els noms dels camps. `team` es rebutja quan no és un equip de revisió actiu d'aquesta aplicació.", "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 clau d'API pertany a una altra aplicació o és una clau amb accés restringit: els endpoints de Cases necessiten una clau amb accés complet. Un token de membre de la consola necessita `write:cases`.", "content": { "application/json": { "examples": { "Restricted API Key": { "summary": "Clau d'API amb accés restringit", "value": { "detail": "This API key has no access to this endpoint." } }, "Missing Privilege": { "summary": "Membre de la consola sense write:cases, o una clau d'una altra aplicació", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No s'ha trobat el cas en aquesta aplicació.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No Case matches the given query." } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Elimina el cas", "description": "Elimina un cas permanentment. Els seus esborranys d'informes regulatoris s'eliminen amb ell. Les verificacions, persones, empreses i transaccions vinculades no s'eliminen. No hi ha cap endpoint per desfer l'eliminació.\n\nSi el cas té un informe regulatori finalitzat, tota la sol·licitud es rebutja amb `409` i no s'elimina res. El cos utilitza `code: in_filed_report` i anomena cada informe amb `uuid`, `report_number`, `report_type` i `case_uuid`. Elimina els informes i després repeteix la sol·licitud.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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": "Cas suprimit." }, "403": { "description": "La clau no pot suprimir casos. Requereix una clau d'accés complet amb `write:cases`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "404": { "description": "El cas no existeix en aquesta aplicació o ja s'ha suprimit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "409": { "description": "El cas té un informe reglamentari finalitzat. No se suprimeix res.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/assign/": { "post": { "summary": "Assigna o desassigna el cas", "description": "Assigna el cas a un usuari, o desassigna'l enviant assignee_user_id: null. assignee_email/assignee_name creen automàticament un registre d'usuari quan l'assignat encara no existeix.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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 per desassignar." }, "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": "Cas assignat/desassignat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/resolve/": { "post": { "summary": "Resoldre el cas", "description": "Resol el cas amb una de les cinc resolucions: FALSE_POSITIVE (cap problema detectat), VALID_THREAT (amenaça confirmada), INCONCLUSIVE, REQUIREMENTS_NOT_MET o REQUIREMENTS_SATISFIED. Es bloqueja amb un error 400 si la llista de verificació del blueprint no és opcional i queden elements incomplets, o si el blueprint requereix una nota de resolució i no se n'indica cap. Quan el blueprint del cas té un pas de verificació de quatre ulls (four_eyes_checker_blueprint), la resolució queda pendent (case.pending_resolution) i el cas es mou al blueprint de revisió en comptes de resoldre's immediatament; un responsable diferent ha de cridar approve o reject-approval. Envia una resolució de quatre ulls com a membre de la consola: una resolució enviada per una clau d'API no té cap autor registrat, de manera que approve i reject-approval retornen 403 per a qualsevol sol·licitant. En un blueprint de quatre ulls pots indicar el membre que ha d'aprovar amb `checker`: aleshores només aquest membre podrà aprovar o rebutjar la resolució, i el camp `checker` de la resposta l'identificarà. Sense `checker`, la resolució espera a la cua del blueprint de revisió. Si s'envia `checker` per a un blueprint sense pas de revisor, es retorna un error 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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": "Obligatori quan el blueprint estableix require_resolution_note." }, "checker": { "type": "string", "format": "uuid", "nullable": true, "description": "Només esquemes de quatre ulls. L'uuid d'usuari del membre que ha d'aprovar aquesta resolució (el mateix identificador que `assigned_to.uuid` en un cas, o `members[].user_id` en un equip de revisió). El membre ha de tenir accés de cas a aquesta aplicació i no pot ser el responsable que envia la resolució. Omet-lo o envia null per deixar la resolució a la cua de revisors." } } }, "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": "Resolt, o en espera d'aprovació de 4 ulls.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "400": { "description": "S'ha rebutjat la resolució. Els errors no vinculats a camps es retornen com una llista de cadenes: una llista de comprovació incompleta, una nota obligatòria absent o un `checker` que no s'ha pogut comprovar o no és un revisor actiu amb accés als casos d'aquesta aplicació. Els errors de `checker` s'identifiquen pel camp: el membre indicat és el responsable que envia la resolució, o el disseny del cas no té cap pas de verificador.", "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": "Reobrir el cas", "description": "Torna a obrir un cas en espera d'usuari o resolt, netejant resolution, resolution_notes, resolved_at i 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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": "Reobre el cas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/request-info/": { "post": { "summary": "Sol·licitar informació (a l'espera de l'usuari)", "description": "Mou un cas obert a awaiting_user mentre es recopila més informació de l'usuari verificat. Falla amb 400 si una resolució està pendent de l'aprovació de quatre ulls.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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": "Sol·licitar informació (a l'espera de l'usuari).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/escalate/": { "post": { "summary": "Escalar cas", "description": "Mou el cas a l'escalation_blueprint configurat al seu blueprint. Requereix que el blueprint actual tingui escalation_enabled i un escalation_blueprint establert, altrament retorna 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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 cas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/transfer/": { "post": { "summary": "Transferir cas", "description": "Mou el cas a un blueprint diferent i actiu de la mateixa aplicació. Requereix que el blueprint actual tingui transfer_enabled; altrament, retorna 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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": "Cas transferit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/approve/": { "post": { "summary": "Aprova la resolució per etapes (4 ulls)", "description": "Aplica una resolució preparada per resolve en un esquema de quatre ulls. L'emissor de la crida ha de ser un responsable diferent del que la va enviar; en cas contrari, es rep un 403. Quan la resolució designa un verificador (el `checker` del cas), només aquest membre la pot aprovar: qualsevol altre emissor de la crida, inclosa una clau d'API, rep un 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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ó aplicada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "409": { "description": "El cas no té cap resolució pendent d'aprovació.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "403": { "description": "L'emissor de la crida no pot aprovar aquesta resolució: l'ha enviada ell, el cas no té cap autor registrat, o la resolució indica un revisor diferent. Una clau d'API sempre rep aquest 403 quan s'indica un revisor.", "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": "Rebutjar la resolució preparada (4 ulls)", "description": "Rebutja una resolució preparada per resoldre i retorna el cas al seu esquema maker. El cridador ha de ser un responsable diferent del que la va enviar; en cas contrari, es retorna 403. Quan la resolució especifica un revisor (el `checker` del cas), només aquest membre pot rebutjar-la: qualsevol altre cridador, inclosa una clau d'API, rep un 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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ó rebutjada, el cas s'ha retornat a la plantilla del creador.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "409": { "description": "El cas no té cap resolució pendent d'aprovació.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "403": { "description": "L'emissor de la crida no pot rebutjar aquesta resolució: l'ha enviada ell, el cas no té cap autor registrat, o la resolució indica un revisor diferent. Una clau d'API sempre rep aquest 403 quan s'indica un revisor.", "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 referència pertany al payload d'una altra acció." } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Aplica una acció explícita al subjecte del cas. Proporciona una client_reference única per obtenir un rebut de l'acció i fer que els reintents siguin idempotents. Reutilitzar aquesta referència amb un payload diferent retorna un 409. Amb una referència, inspecciona receipt.status fins i tot quan l'estat HTTP sigui 200: FAILED significa que no s'ha aplicat cap acció. Repetir una sol·licitud fallida no la torna a executar tret que retry sigui true. Ometre client_reference conserva la resposta heretada.", "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": "Imprimeix el cas (PDF)", "description": "Genera el cas complet (resum, assumpte, estat de la llista de comprovació, notes, sessions/transaccions adjuntes, esdeveniments, llista d'informes de la UIF) com a PDF i retorna una URL de descàrrega presignada.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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 presignada 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": "Quin camp s'ha d'utilitzar per ordenar els resultats.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Nombre de resultats que cal retornar per pàgina.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "L'índex inicial a partir del qual es retornen els resultats.", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseCollaborationPaginatedCaseNoteList" } } }, "description": "" }, "403": { "description": "L'emissor de la crida no té el permís de casos requerit." }, "404": { "description": "El cas o la nota no estan disponibles per a aquest emissor de la crida." } }, "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": "L'emissor de la crida no té el permís de casos requerit." }, "404": { "description": "El cas o la nota no estan disponibles per a aquest emissor de la crida." }, "409": { "description": "Aquesta referència de client ja s'havia utilitzat per a una altra nota o per a una nota que s'ha eliminat." } }, "tags": [ "Case Management" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Afegeix una nota vinculada a un cas. Un client_reference opcional fa que un reintent sense canvis retorni la mateixa nota sense duplicar activitat ni notificacions. reply_to ha d'identificar una nota activa en aquest cas. La resposta inclou un fragment delimitat de l'element superior sense copiar aquest fragment a la resposta desada.", "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": "L'emissor de la crida no té el permís de casos requerit." }, "404": { "description": "El cas o la nota no estan disponibles per a aquest emissor de la crida." } }, "tags": [ "Case Management" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Fixa o desfixa una nota existent. Les notes fixades apareixen primer. Els canvis de fixació es registren a l'activitat del cas i no modifiquen les proves ni les decisions d'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 s'elimina permanentment. Les respostes es mantenen, sense el fragment de la nota pare eliminada. Els fitxers adjunts s'eliminen tret que una altra nota encara els utilitzi." }, "403": { "description": "L'emissor de la crida no té el permís de casos requerit." }, "404": { "description": "El cas o la nota no estan disponibles per a aquest emissor de la crida." } }, "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": "Puja un fitxer adjunt de la nota", "description": "Puja un fitxer (JPEG, PNG, WebP, PDF, text pla o CSV; màx. 5 MB) per adjuntar-lo a una nota. Retorna el s3_key que s'ha de passar a l'array d'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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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": "Fitxer penjat.", "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": "Sense fitxer, tipus de contingut no admès o el fitxer supera els 5 MB.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "get": { "summary": "Obtenir l'URL del fitxer adjunt de la nota", "description": "Genera un nou URL de descàrrega presignat per a un fitxer adjunt ja emmagatzemat en una de les notes del cas.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." }, { "name": "s3_key", "in": "query", "schema": { "type": "string" }, "description": "El s3_key del fitxer adjunt, tal com el retorna la càrrega o apareix a 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 presignada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "s3_key": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "filename": { "type": "string" } } } } } }, "404": { "description": "s3_key falta o no pertany a aquest cas.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/links/": { "get": { "summary": "Llista els enllaços del cas", "description": "Llista les sessions, sessions d'empresa i transaccions associades al cas.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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": "Enllaços del cas.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseLink" } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Afegeix l'enllaç del cas", "description": "Adjunta una sessió, sessió d'empresa o transacció al cas. Es rebutja amb 400 si l'entitat pertany a un subjecte diferent del cas.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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": "Enllaç creat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseLink" } } } }, "400": { "description": "L'entitat pertany a un perfil diferent del subjecte del cas.", "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 l'enllaç del cas", "description": "Desvincula del cas una sessió enllaçada, una sessió d'empresa enllaçada o una transacció enllaçada.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." }, { "name": "link_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "11000000-0000-4000-8000-000000000004" }, "description": "UUID de l'enllaç." } ], "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": "Enllaç eliminat." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/events/": { "get": { "summary": "Llista els esdeveniments del cas", "description": "Cronologia d'auditoria de només lectura del cas (creació, canvis d'estat, assignació, resolució, escalada, transferències, canvis d'etiqueta/prioritat/data de venciment, accions sobre entitats i 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Mida de la pàgina." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Desplaçament basat en zero." } ], "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": "Esdeveniments paginats, els més recents primer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Nombre de files coincidents. Exacte fins a 100, limitat a 100 a partir d'aquí per motius de rendiment. Fes servir el fet que `next` sigui null per detectar l'última pàgina." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta de la pàgina següent, 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": "Llista la llista de verificació del cas", "description": "Llista els elements de la llista de comprovació del cas, copiats de content_config.checklist.items del model en crear-se, ordenats.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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": "Elements de la llista de verificació.", "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": "Activa o desactiva l'element de la llista de verificació", "description": "Marca un element de la llista de comprovació com a completat o incomplet. La resolució es bloqueja mentre hi hagi algun element incomplet, tret que la plantilla marqui la llista de comprovació com a 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." }, { "name": "item_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c4ec0000-0000-4000-8000-000000000005" }, "description": "UUID de l'element de la llista de verificació." } ], "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": "Element de la llista de verificació actualitzat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseChecklistItem" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/aml/": { "get": { "summary": "Llista les coincidències AML del cas", "description": "Llistar les coincidències de cribratge AML per al subjecte del cas. El mateix format que les coincidències retornades per 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "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": "Coincidències 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 per a l'interval de dates (per defecte, els darrers 30 dies; màxim 731 dies). Els gràfics, les taules, els totals, els esdeveniments d'assignació i els recomptes actuals de les cues utilitzen els mateixos filtres amb abast d'aplicació. Els filtres utilitzen els valors actuals dels casos. Les dates s'apliquen a cada esdeveniment de mètrica, de manera que els casos més antics assignats o resolts durant el període continuen inclosos. La profunditat de la cua és independent de l'interval de dates. Els filtres no vàlids retornen 400; un blueprint o persona assignada desconeguts retornen un resultat buit.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Inici de l'interval (inclòs). Per defecte són 30 dies enrere." }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Final de l'interval (inclòs). Per defecte és avui." }, { "name": "blueprint", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Filtra per l'UUID del blueprint actual." }, { "name": "assigned_to", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Filtra per l'UUID de l'usuari revisor assignat actualment." }, { "name": "priority", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "description": "Filtra per la prioritat actual del cas." }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "MANUAL", "AML_SCREENING", "TRANSACTION_RULE", "WORKFLOW_BUILDER" ] }, "description": "Filtra per origen de creació del cas." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ] }, "description": "Filtra per l'estat actual del cas." } ], "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 d'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ó: correu electrònic del responsable, \"blueprint_name:uuid\", font o estat. \"unassigned\"/\"none\" per a dimensions que falten." }, "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ó: correu electrònic del responsable, \"blueprint_name:uuid\", font o estat. \"unassigned\"/\"none\" per a dimensions que falten." }, "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ó: correu electrònic del responsable, \"blueprint_name:uuid\", font o estat. \"unassigned\"/\"none\" per a dimensions que falten." }, "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ó: correu electrònic del responsable, \"blueprint_name:uuid\", font o estat. \"unassigned\"/\"none\" per a dimensions que falten." }, "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ània en temps real, no limitada a l'interval de dates.", "properties": { "open": { "type": "integer" }, "overdue": { "type": "integer" } } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/bulk/status/": { "post": { "summary": "Actualització massiva de l'estat dels casos", "description": "Aplica la mateixa transició d'estat a diversos casos en una sola crida: OPEN reobre, AWAITING_USER sol·licita informació, RESOLVED resol (resolució requerida). Cada cas s'avalua de manera independent; les fallades de les condicions prèvies (llista de verificació incompleta, nota requerida absent) s'informen per cas sense avortar el lot.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "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": "Obligatori quan status és 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": "Resultats per cas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBulkUpdateResult" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/bulk/assign/": { "post": { "summary": "Assignar casos en bloc", "description": "Assigna (o desassigna, amb assignee_user_id: null) diversos casos alhora. Tots els casos han de compartir el mateix blueprint; les discordances s'informen per cas sense avortar el lot.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "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": "Resultats per cas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBulkUpdateResult" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/": { "get": { "summary": "Llista els blueprints", "description": "Llista els blueprints de casos per a l'aplicació.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Mida de la pàgina." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Desplaçament basat en zero." } ], "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": "Llista paginada de blueprints.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Nombre de files coincidents, limitat a 100 per motius de rendiment." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseBlueprintListItem" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crea un blueprint", "description": "Crea una plantilla de cas: configuració general (assignació, escalat, transferència, revisió de quatre ulls) més content_config, les sis seccions que articulen la pàgina del cas. Defineix publish=false per crear un esborrany no publicat; Publicar en crea la primera versió en producció. Si descartes un esborrany mai publicat, s'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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "assignee_pool" ], "properties": { "name": { "type": "string", "maxLength": 24, "description": "Màxim 24 caràcters, p. ex. \"Investigació AML\"." }, "description": { "type": "string", "nullable": true }, "assignee_pool": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "description": "Llista d'UUID d'usuari. Les matrius buides es rebutgen amb \"Tria com a mínim un assignat\"." }, "assignment_method": { "type": "string", "enum": [ "MANUAL", "AUTOMATIC" ], "default": "MANUAL" }, "max_active_cases": { "type": "integer", "nullable": true, "minimum": 1, "description": "Llindar del mode automàtic: «menys de N casos assignats d'aquest model»." }, "escalation_enabled": { "type": "boolean", "default": false }, "escalation_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID del blueprint de destinació. No es fa complir en desar, però l'acció d'escalada falla amb 400 fins que tant escalation_enabled com escalation_blueprint estiguin configurats." }, "transfer_enabled": { "type": "boolean", "default": false }, "four_eyes_checker_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "Això habilita la revisió a quatre ulls: les resolucions d'aquest pla passen a la cua del pla del 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": "Data límit predeterminada per als casos oberts recentment. Les dates límit dels casos existents no es modifiquen." }, "publish": { "type": "boolean", "writeOnly": true, "default": true, "description": "Estableix a false per desar un esborrany mai publicat. El registre roman inactiu a la versió 0 fins que l'esborrany es publica explícitament. Ometre aquest camp manté la creació immediata per a integracions existents." } } }, "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 creat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintDetail" } } } }, "400": { "description": "Nom de més de 24 caràcters, assignee_pool buit o no s'ha trobat un model referenciat creuadament (escalada/verificador).", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/": { "get": { "summary": "Obtenir el pla", "description": "Recupera un blueprint, incloses les seves fonts de creació connectades (configuració AML, regles de transacció, nodes del flux de treball) i quins blueprints escalen cap a ell.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "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": "Detall del blueprint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualitzar plantilla", "description": "Actualitza parcialment la configuració general o content_config d'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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "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àxim 24 caràcters, p. ex. \"Investigació AML\"." }, "description": { "type": "string", "nullable": true }, "assignee_pool": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "description": "Llista d'UUID d'usuari. Les matrius buides es rebutgen amb \"Tria com a mínim un assignat\"." }, "assignment_method": { "type": "string", "enum": [ "MANUAL", "AUTOMATIC" ] }, "max_active_cases": { "type": "integer", "nullable": true, "minimum": 1, "description": "Llindar del mode automàtic: «menys de N casos assignats d'aquest model»." }, "escalation_enabled": { "type": "boolean" }, "escalation_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID del blueprint de destinació. No es fa complir en desar, però l'acció d'escalada falla amb 400 fins que tant escalation_enabled com escalation_blueprint estiguin configurats." }, "transfer_enabled": { "type": "boolean" }, "four_eyes_checker_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "Això habilita la revisió a quatre ulls: les resolucions d'aquest pla passen a la cua del pla del 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": "Data límit predeterminada per als casos oberts recentment. Les dates límit dels casos existents no es modifiquen." }, "expected_version": { "type": "integer", "minimum": 1, "description": "La versió oberta per l'editor. Una versió obsoleta retorna 409 sense canviar la política de revisió." } } }, "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": "Esquema actualitzat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintDetail" } } } }, "409": { "description": "La política de revisió ha canviat des d'expected_version. Revisa l'última versió abans de reintentar." } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Elimina el blueprint", "description": "Elimina un blueprint. L'eliminació sempre té èxit i no afecta els casos del blueprint: els casos existents mantenen la seva referència al blueprint i la seva configuració se'ls continua aplicant. Un blueprint eliminat ja no apareix a les llistes de blueprints i ja no es pot triar com a destinació de transferència; si s'elimina un blueprint de creador mentre una resolució està pendent d'aprovació a quatre ulls, una resolució rebutjada deixa el cas al blueprint de revisor.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "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 suprimit." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/presets/": { "get": { "summary": "Llista els valors predefinits de blueprints", "description": "Llista els quatre ajustos predefinits integrats (Coincidència de cribratge, Investigació AML, Activitat sospitosa, Revisió KYC) amb el seu content_config i si cadascun ja està instal·lat en aquesta aplicació.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "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àleg predefinit.", "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": "Instal·lar ajustos predefinits del blueprint", "description": "Copia un o més valors predefinits a l'aplicació com a plantilles editables. Idempotent per preset_key; omet preset_keys per instal·lar tots els valors predefinits que encara no estiguin instal·lats.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "preset_keys": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Subconjunt de screening_hit, aml_investigation, suspicious_activity, kyc. Omet-ho per instal·lar-ho tot." } } }, "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": "Un o més valors predefinits instal·lats.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintPresetInstallResult" } } } }, "200": { "description": "No hi ha cap ajust predefinit nou per instal·lar (tots els ajustos predefinits sol·licitats ja existeixen).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintPresetInstallResult" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/report-templates/": { "get": { "summary": "Llista les plantilles d'informe", "description": "Llista les plantilles d'informe FIU per a l'aplicació.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Mida de la pàgina." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Desplaçament basat en zero." } ], "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": "Plantilles paginades.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Nombre de files coincidents, limitat a 100 per motius de rendiment." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTemplateDetail" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crea una plantilla d'informe", "description": "Crea una plantilla reutilitzable de capçalera de goAML per jurisdicció i per tipus d'informe. Es rebutja amb 400 si falta algun dels camps obligatoris de la plantilla (rentity_id, submission_code, currency_code_local) a field_config; una plantilla no vàlida no es pot desar ni utilitzar per crear un informe. Els camps de capçalera específics de cada presentació (action, submission_date, transactions) s'exigeixen en el moment de validar o finalitzar l'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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "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": "Codi de país ISO 3166-1 alfa-2, convertit a majúscules en desar-se." }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "field_config": { "type": "object", "description": "Valors per defecte reutilitzables de capçalera de goAML. Camps obligatoris a nivell de plantilla: rentity_id, submission_code i currency_code_local (de 3 lletres). Opcionals: enabled_fields (quins blocs d'informe opcionals cal incloure) a més dels valors per defecte de reporting_person, location, reason i action. Els camps de capçalera per declaració (action, submission_date, transactions, jurisdiction) s'exigeixen quan l'informe es valida o es finalitza, no a 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ó no reconeguda, o field_config no supera la validació de camps obligatoris.", "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": "Obtenir la plantilla d'informe", "description": "Recuperar una plantilla d'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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "template_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "7ec00000-0000-4000-8000-000000000006" }, "description": "UUID de la plantilla d'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": "Detall de la plantilla.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplateDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualitza la plantilla d'informe", "description": "Actualitza parcialment una plantilla d'informe. Torna a validar els camps obligatoris de goAML en desar.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "template_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "7ec00000-0000-4000-8000-000000000006" }, "description": "UUID de la plantilla d'informe." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Codi de país ISO 3166-1 alfa-2, convertit a majúscules en desar-se." }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "field_config": { "type": "object", "description": "Valors per defecte reutilitzables de capçalera de goAML. Camps obligatoris a nivell de plantilla: rentity_id, submission_code i currency_code_local (de 3 lletres). Opcionals: enabled_fields (quins blocs d'informe opcionals cal incloure) a més dels valors per defecte de reporting_person, location, reason i action. Els camps de capçalera per declaració (action, submission_date, transactions, jurisdiction) s'exigeixen quan l'informe es valida o es finalitza, no a 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 actualitzada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplateDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Elimina la plantilla d'informe", "description": "Elimina una plantilla d'informe. Els informes ja creats a partir d'aquesta no es veuen afectats.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "template_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "7ec00000-0000-4000-8000-000000000006" }, "description": "UUID de la plantilla d'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 suprimida." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/": { "get": { "summary": "Llista els informes del cas", "description": "Llista els informes FIU generats per al cas.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Mida de la pàgina." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Desplaçament basat en zero." } ], "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 paginats per al cas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportList" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crea un informe a partir d'un cas", "description": "Crea un esborrany d'informe de la UIF per al cas: estat DRAFT, emplenat automàticament a partir de la plantilla opcional més el subjecte del cas, les transaccions vinculades i la descripció dels fets. Valida'l i després finalitza'l per generar el fitxer XML goAML i 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID del cas." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ], "description": "Obligatori tret que s'indiqui una plantilla; en cas contrari, s'utilitza el report_type de la plantilla." }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Obligatori tret que s'indiqui una plantilla." }, "template": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID de la plantilla d'informe; el seu field_config inicialitza l'esborrany abans de fusionar-hi les dades derivades del cas." }, "transactions": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true, "description": "Transaccions a adjuntar; per defecte són les transaccions enllaçades al cas." }, "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": "Informe en esborrany creat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "400": { "description": "No s'ha trobat 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": "Llista els informes", "description": "Llista d'informes de la UIF en l'àmbit de l'aplicació, opcionalment filtrada per status, report_type o cas.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Mida de la pàgina." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Desplaçament basat en zero." }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "DRAFT", "VALIDATED", "FINALIZED" ] }, "description": "Filtra per estat." }, { "name": "report_type", "in": "query", "schema": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "description": "Filtra per tipus d'informe." }, { "name": "case", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Filtra pels informes d'aquest cas." } ], "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 paginats de tota l'aplicació.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportList" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crea un informe independent", "description": "Crea un esborrany d'informe de la UIF des de la pàgina independent Informes: tant el cas com la plantilla són obligatoris (a diferència de la creació en l'àmbit del cas, que pot ometre 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "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": "Obligatori tret que s'indiqui una plantilla; en cas contrari, s'utilitza el report_type de la plantilla." }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Obligatori tret que s'indiqui una plantilla." }, "transactions": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true, "description": "Transaccions a adjuntar; per defecte són les transaccions enllaçades al cas." }, "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": "Informe en esborrany creat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "400": { "description": "No s'ha trobat 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": "Obtenir l'informe", "description": "Recuperar un informe regulador.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID de l'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": "Detall de l'informe.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualitza l'informe", "description": "Edita els camps d'un informe en esborrany o validat. Els informes finalitzats no es poden 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID de l'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 actualitzat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "409": { "description": "L'informe ja està finalitzat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Elimina l'informe", "description": "Elimina un informe regulatori permanentment. L'informe, la seva narrativa i motius copiats, els seus enllaços de transaccions i el seu XML de goAML i PDF generats s'esborren, inclosa cada versió emmagatzemada d'aquests fitxers. L'informe desapareix de les llistes i els URL de descàrrega deixen de funcionar. Altres registres, inclosos el cas, les transaccions, les persones i les empreses, no s'eliminen. No es pot desfer.\n\nUn informe en esborrany o validat es pot eliminar sense un cos de sol·licitud. Eliminar un informe finalitzat requereix `confirm_delete: true` al cos de la sol·licitud. Si l'informe no es troba, la sol·licitud retorna `404`; si s'envia un informe finalitzat sense confirmació, retorna `400` i no s'elimina res.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID de l'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 suprimit, incloent-hi els fitxers generats." }, "400": { "description": "S'ha enviat un informe finalitzat sense `confirm_delete: true`. No s'elimina res.", "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 clau d'API no pot suprimir informes. L'endpoint requereix `write:cases`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "404": { "description": "No s'ha trobat l'informe en aquesta aplicació.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "409": { "description": "L'informe ja s'està eliminant. Repeteix la sol·licitud per acabar d'esborrar-ne els fitxers.", "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 s'han pogut esborrar els fitxers de l'informe ara mateix. L'informe encara es conserva. Repeteix la sol·licitud.", "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": "Obligatori només per a un informe finalitzat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "confirm_delete": { "type": "boolean", "description": "Estableix-ho a true per confirmar que un informe finalitzat i els fitxers generats s'eliminen permanentment." } }, "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": "Comprova l'informe respecte als camps obligatoris de la capçalera de goAML (reporting entity ID, submission code, local currency, action taken, submission date), a més d'almenys una transacció adjunta i una jurisdicció de 2 lletres, sense generar cap fitxer. També desa el resultat a l'informe: validation_errors i validated_at s'actualitzen, i l'estat d'un informe no finalitzat passa a VALIDATED (sense errors) o torna a DRAFT (amb errors).", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID de l'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": "Resultat de la validació.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "DRAFT", "VALIDATED", "FINALIZED" ] }, "is_valid": { "type": "boolean" }, "errors": { "type": "array", "description": "Buit quan és vàlid.", "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": "Finalitzar l'informe", "description": "Torna a validar, renderitza el PDF i l'XML de goAML i puja tots dos a l'S3. En informes SAR/STR/TFR, això també mou les alertes de transacció del cas 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID de l'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 finalitzat; xml_s3_key i pdf_s3_key estan establerts.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "400": { "description": "La validació de l'informe ha fallat.", "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": "L'informe no es troba en un estat finalitzable.", "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": "Obtenir l'URL de descàrrega de l'informe", "description": "Genera un URL presignat per al fitxer XML o PDF de goAML d'un informe finalitzat.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID de l'informe." }, { "name": "file", "in": "query", "schema": { "type": "string", "enum": [ "pdf", "xml" ], "default": "pdf" }, "description": "Quin fitxer s'ha de descarregar." } ], "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 descàrrega presignada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "download_url": { "type": "string", "format": "uri" }, "file": { "type": "string", "enum": [ "pdf", "xml" ] } } } } } }, "409": { "description": "L'informe encara no està finalitzat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "status": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/transactions/rules/": { "get": { "summary": "Llista les regles", "description": "Llista les regles de monitoratge de transaccions de l'aplicació: les teves regles personalitzades a més de qualsevol ajust predefinit de la biblioteca que hagis instal·lat. Filtra per origen, categoria, mode, paquet o cerca de text lliure; ordena amb `ordering` (run_count, approved_pct, reviewed_pct, declined_pct, latest_triggered_at, title, created_at, source, cadascun amb un prefix `-` 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 per categoria 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": "Filtra els valors predefinits per paquet" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Coincidència que no distingeix majúscules de minúscules amb el títol i la descripció" }, { "name": "ordering", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Camps d'ordenació separats per comes; per defecte, source,-run_count" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Mida de la pàgina" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Desplaçament de pàgina" } ], "responses": { "200": { "description": "Regles paginades.", "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": "Crea una regla", "description": "Crea una regla CUSTOM de monitoratge de transaccions. Els títols són únics per aplicació (duplicat -> 400). Una acció `change_status` dirigida a `AWAITING_USER` ha d'incloure `workflow_id`. Les regles creades en mode ACTIVE s'apliquen a les noves transaccions immediatament - el flux de treball recomanat és crear-les en mode TEST, fer proves retroactives i després canviar el mode a ACTIVE. Per modificar una regla de la biblioteca, crea-la com a còpia: envia la definició de la regla de la biblioteca amb `metadata.based_on` (la seva clau de biblioteca) i `metadata.based_on_rule_uuid`.", "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ó - títol duplicat, operador/mètrica desconeguts, finestra mal formada, direcció d'abast no vàlida o AWAITING_USER sense 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": "L'uuid de la regla obtingut en llistar o crear." } ], "get": { "summary": "Obtenir la regla", "description": "Recupera una regla amb la seva configuració completa i els comptadors d'execució.", "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 existeix aquesta regla en aquesta aplicació.", "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": "Actualitza la regla", "description": "Actualitza parcialment una regla. Les regles personalitzades accepten tots els camps de configuració. Les regles de la biblioteca (PRESET) només accepten `mode`: utilitza'l per activar, desactivar o canviar un valor predefinit a TEST; qualsevol altre camp retorna 400, perquè Didit manté les regles de la biblioteca i n'aplica les actualitzacions automàticament. Per canviar les condicions d'una regla de la biblioteca, crea una còpia personalitzada amb `POST /v3/transactions/rules/` utilitzant la definició de la regla de la biblioteca i `metadata.based_on` (la clau de la biblioteca) i `metadata.based_on_rule_uuid`, i després desactiva la regla de la biblioteca amb `mode: DISABLED` perquè una transacció no alerti dues vegades. Una còpia instal·lada d'una regla de la biblioteca retinguda es desactiva: establir el seu `mode` en qualsevol valor que no sigui `DISABLED` retorna 400 (\"Aquesta regla de la biblioteca encara no es pot executar: les seves condicions llegeixen dades que el motor de regles no pot avaluar.\").", "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 actualitzada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleDetail" } } } }, "400": { "description": "Error de validació, un camp que no és de mode en una regla de biblioteca o un mode diferent de DISABLED en una regla de biblioteca retinguda.", "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": "Elimina la regla", "description": "Elimina una regla CUSTOM. L'eliminació és immediata i permanent: la regla deixa d'avaluar-se per a noves transaccions i desapareix dels llistats, mentre que les execucions anteriors de la regla en transaccions ja avaluades mantenen els seus resultats registrats. Les regles de la biblioteca no es poden eliminar; desinstal·la-les mitjançant l'endpoint d'instal·lació (sempre es poden tornar a instal·lar des de la biblioteca).", "operationId": "deleteTransactionRule", "x-didit-sdk": { "resource": "transactions.rules", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "204": { "description": "Eliminat." }, "400": { "description": "La regla és un valor predefinit de la biblioteca; desinstal·la-la en comptes d'això.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "detail": "Library rules cannot be deleted. Uninstall them via the rules install endpoint instead." } } } }, "404": { "description": "No existeix aquesta regla en aquesta aplicació.", "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ó de la regla de backtest", "description": "Avalua una configuració hipotètica de regla contra les teves transaccions recents (les més recents primer, fins al límit de backtest) sense crear cap regla ni modificar cap transacció. Utilitza-ho abans d'activar una regla per veure amb quina freqüència hauria coincidit i a quants subjectes hauria afectat.", "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ístiques de 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": "Llista la biblioteca de regles", "description": "Explora la biblioteca completa de regles predefinides (150+ regles) amb la configuració completa de cada entrada i un indicador `is_installed` per a aquesta aplicació. Filtra per paquet, categoria o cerca de text lliure. Si una regla de la biblioteca té condicions que llegeixen dades que el motor de regles encara no pot avaluar, es reté fins que pugui executar-se. Les regles retingudes no es llisten.", "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 per paquet, p. ex. finance, aml_ctf, crypto_monitoring, travel_rule" }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filtra per categoria" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Coincidència que no distingeix majúscules de minúscules amb el títol i la descripció" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Mida de la pàgina" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Desplaçament de pàgina" } ], "responses": { "200": { "description": "Entrades paginades de la biblioteca.", "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": "Instal·lar regles de la biblioteca", "description": "Instal·la un o més ajustos predefinits a l'aplicació, mitjançant `library_keys` o un `bundle` sencer. Un ajust predefinit instal·lat s'activa immediatament si el monitoratge de transaccions està activat, i s'inhabilita en cas contrari; s'ometen les claus que ja estiguin instal·lades. Una regla de la biblioteca les condicions de la qual llegeixin dades que el motor de regles encara no pot avaluar es reté fins que es pugui executar. Una sol·licitud que n'especifiqui una a `library_keys` respon amb 400 i no n'instal·la cap («Aquestes regles de la biblioteca encara no es poden executar: les seves condicions llegeixen dades que el motor de regles encara no pot avaluar.» seguit de les claus), i una instal·lació de `bundle` l'omet. Una regla retinguda s'activa automàticament un cop es puguin avaluar les seves condicions. Una entrada a `library_keys` que no sigui a la biblioteca s'omet, no es rebutja.", "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è s'ha instal·lat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleInstallResult" }, "example": { "installed_library_keys": [ "structuring-inbound", "structuring-outbound" ], "installed_count": 2 } } } }, "400": { "description": "No s'ha proporcionat ni library_keys ni bundle, `library_keys` no és una llista o una entrada de `library_keys` està retinguda. Una entrada desconeguda s'omet i respon 200 sense 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": "Desinstal·lar regles de la biblioteca", "description": "Elimina els preajustos instal·lats de l'aplicació, per `library_keys` o per un `bundle` sencer. Els preajustos desinstal·lats deixen d'avaluar-se immediatament i es poden reinstal·lar des de la biblioteca en qualsevol moment.", "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": "Quants valors predefinits s'han suprimit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleInstallResult" }, "example": { "uninstalled_count": 5 } } } }, "400": { "description": "No s'ha proporcionat 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": "Llista les xarxes", "description": "Llista les xarxes de frau detectades a l'organització d'aquesta aplicació, per defecte ordenades de major a menor risc. Per defecte, les xarxes descartades s'exclouen; passa status per incloure-les. Les aplicacions de sandbox mai tenen xarxes: el clustering exclou completament les dades de sandbox. Cada resposta inclou el `sharing_mode` de l'organització i si se li apliquen senyals interorganitzacionals (`cross_org_available`, `cross_org_unavailable_reason`). `kpis` agrega les xarxes que coincideixen amb els teus filtres i `counts` agrega totes les xarxes que l'aplicació pot veure; passa `summary=false` per ometre tots dos quan només necessitis la pàgina. Requereix una clau d'API d'accés complet o `list:networks` per a un membre 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "status", "in": "query", "schema": { "type": "string" }, "description": "Estats separats per comes que cal incloure: active,in_review,resolved,dismissed. Omet-ho per excloure dismissed." }, { "name": "scope", "in": "query", "schema": { "type": "string", "enum": [ "identity", "transactions" ] }, "description": "`transactions` conserva les xarxes els membres de les quals són tots parts de la transacció; `identity` conserva totes les altres xarxes. Omet-ho per a ambdues. També redueix `counts.views` i `counts.facets`. Qualsevol altre valor retorna 400." }, { "name": "signal_type", "in": "query", "schema": { "type": "string" }, "description": "Tipus de senyal separats per comes: ip_address,device,face,document_number,phone,email,address." }, { "name": "pattern_type", "in": "query", "schema": { "type": "string" }, "description": "Tipus de patró separats per comes, p. ex. exact_same_device,same_email." }, { "name": "risk_band", "in": "query", "schema": { "type": "string" }, "description": "Franges separades per comes: low,medium,high." }, { "name": "min_size", "in": "query", "schema": { "type": "integer" }, "description": "Nombre mínim de membres." }, { "name": "max_size", "in": "query", "schema": { "type": "integer" }, "description": "Nombre màxim de membres." }, { "name": "assignee", "in": "query", "schema": { "type": "string" }, "description": "Assignats separats per comes: `unassigned`, correus electrònics de membres (coincidència sense distingir majúscules de minúscules), o `me` per al membre de la consola que fa la crida. Una xarxa coincideix amb qualsevol valor. `me` necessita un token de membre de la consola: una clau d'API rep 400 `{\"assignee\": [\"\\\"me\\\" needs a user token; an API key has no assignee identity.\"]}`." }, { "name": "priority", "in": "query", "schema": { "type": "string" }, "description": "Prioritats separades per comes: `low`, `medium`, `high` o `none` per a xarxes sense prioritat. Qualsevol altre valor retorna 400 `{\"priority\": \"Unknown priority: .\"}`." }, { "name": "risk_min", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 100 }, "description": "Puntuació de risc mínima, un nombre enter del 0 al 100. Un valor que no sigui un nombre enter retorna 400 `{\"risk_min\": \"Use a whole number from 0 to 100.\"}`." }, { "name": "has_case", "in": "query", "schema": { "type": "boolean" }, "description": "`true` manté les xarxes per a les quals la teva aplicació ha obert un cas; `false`, les altres. Qualsevol altre valor s'ignora." }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Límit inferior per a last_activity_at (data o data i hora en format ISO 8601)." }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Límit superior de first_activity_at (data o data i hora en format ISO 8601)." }, { "name": "q", "in": "query", "schema": { "type": "string" }, "description": "Cerca de text lliure pel nom de la xarxa, noms dels membres, el network_id (N-0001) i tokens exactes de pattern_type." }, { "name": "ordering", "in": "query", "schema": { "type": "string" }, "description": "Un de risk_score, -risk_score, last_activity_at, -last_activity_at, first_activity_at, -first_activity_at, network_number, -network_number. Per defecte és -risk_score,-last_activity_at." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 100, "minimum": 1, "maximum": 500 }, "description": "Mida de la pàgina, 1-500. Per defecte és 100." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Desplaçament basat en zero del primer registre." }, { "name": "summary", "in": "query", "schema": { "type": "boolean", "default": true }, "description": "`false` retorna només la pàgina i el seu `count`, sense `kpis` ni `counts`. Per defecte és `true`. Qualsevol valor diferent de `true` o `false` retorna 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": "Llista paginada de xarxes, amb el mode de compartició de l'organització i la disponibilitat entre organitzacions, a més de `kpis` i `counts` tret que `summary=false`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "integer", "nullable": true, "description": "Desplaçament de la pàgina següent, o null a l'última pàgina." }, "previous": { "type": "integer", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkListItem" } }, "kpis": { "type": "object", "description": "Cada clau és {value, delta} sobre els resultats que coincideixen amb els filtres actuals. S'omet quan `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 mode de compartició entre organitzacions de l'organització. Només `global` compara xarxes entre organitzacions; `private` i `off` les mantenen a l'historial propi de l'organització.", "example": "global" }, "cross_org_available": { "type": "boolean", "description": "Indica si els senyals entre organitzacions s'apliquen a aquesta organització. Necessiten tant el pla Enterprise com el mode de compartició `global`.", "example": true }, "cross_org_unavailable_reason": { "type": "string", "enum": [ "plan", "sharing_mode" ], "nullable": true, "description": "Per què no s'apliquen els senyals interorganitzacionals, comprovats en aquest ordre. `plan`: el pla de l'organització no inclou la xarxa de frau interorganitzacional (necessita el pla Enterprise), independentment del mode de compartició. `sharing_mode`: el pla la inclou, però el mode de compartició és `private` o `off`. Null quan `cross_org_available` és `true`.", "example": null } }, "required": [ "count", "next", "previous", "results", "sharing_mode", "cross_org_available", "cross_org_unavailable_reason" ] } } } }, "400": { "description": "Un valor no vàlid de filtre, ordenació, paginació o `summary`.", "content": { "application/json": { "examples": { "Invalid summary": { "summary": "Resum no vàlid", "value": { "summary": [ "Must be \"true\" or \"false\"." ] } }, "Invalid scope": { "summary": "Abast no vàlid", "value": { "scope": [ "Use identity or transactions." ] } }, "Unsupported ordering": { "summary": "Criteri d'ordenació no admès", "value": [ "Unsupported ordering." ] } } } } }, "401": { "description": "Falten les credencials o no són vàlides.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Present en errors codificats, per exemple `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falten les credencials o no són vàlides", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "La clau d'API pertany a una altra aplicació o és una clau amb accés restringit: els endpoints de Networks necessiten una clau amb accés complet. Un token de membre de la consola necessita `list:networks`. També es retorna amb `code: networks_not_entitled` quan Networks no està habilitat per a l'organització.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Present en errors codificats, per exemple `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Xarxes no habilitades", "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": "Clau d'API restringida", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Sense permís", "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": "Obtenir la xarxa", "description": "Recupera el detall complet d'una sola xarxa: estadístiques, etiquetes de frau i senyals de risc, a més del `sharing_mode` de l'organització i la disponibilitat interorganitzativa, les `tags` de la teva aplicació a la xarxa, els `outcomes` dels membres i les puntuacions de patrons (`patterns`). Requereix una clau d'API d'accés complet, o `read:networks` per a un membre 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID de la xarxa." } ], "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": "Detall de la xarxa.", "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": "No s'ha trobat la xarxa (o no és visible per a aquesta aplicació).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "401": { "description": "Falten les credencials o no són vàlides.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Present en errors codificats, per exemple `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falten les credencials o no són vàlides", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "La clau d'API pertany a una altra aplicació o és una clau amb accés restringit: els endpoints de Networks necessiten una clau amb accés complet. Un token de membre de la consola necessita `read:networks`. També es retorna amb `code: networks_not_entitled` quan Networks no està habilitat per a l'organització.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Present en errors codificats, per exemple `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Xarxes no habilitades", "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": "Clau d'API restringida", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Sense permís", "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": "Obtenir el graf de la xarxa", "description": "Recupera la xarxa com un graf de nodes de subjecte (usuaris del proveïdor, empreses del proveïdor, parts de transacció) i nodes de senyal (els valors compartits de dispositiu/IP/cara/document/telèfon/correu electrònic/adreça que els connecten), amb arestes que representen relacions de pertinença.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID de la xarxa." }, { "name": "depth", "in": "query", "schema": { "type": "string", "enum": [ "1", "2", "3", "all" ] }, "description": "Salts des del subjecte principal que cal incloure. Per defecte, tots (sense límit)." }, { "name": "focus_kind", "in": "query", "schema": { "type": "string", "enum": [ "vendor_user", "vendor_business", "transaction_party" ] }, "description": "Tipus de subjecte sobre el qual centrar el graf. Cal proporcionar-lo juntament amb focus_id; per defecte pren un membre arbitrari quan la profunditat està delimitada i no s'especifica cap dels dos." }, { "name": "focus_id", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "UUID del subjecte sobre el qual centrar el graf." } ], "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": "Graf de xarxa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkGraph" } } } }, "404": { "description": "No s'ha trobat la xarxa (o no és visible per a aquesta aplicació).", "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": "Llista els membres de la xarxa", "description": "Llista els subjectes (usuaris del proveïdor, empreses del proveïdor o parts de la transacció) que pertanyen a aquesta xarxa.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID de la xarxa." } ], "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": "Membres de la xarxa. No està paginat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkMember" } } } } } } }, "404": { "description": "No s'ha trobat la xarxa (o no és visible per a aquesta aplicació).", "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": "Llista els senyals de la xarxa", "description": "Llista els senyals (dispositius, adreces IP, cares, números de document, telèfons, correus electrònics o adreces compartits) que vinculen els membres d'aquesta xarxa.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID de la xarxa." } ], "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": "Senyals de la xarxa. No està paginat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkSignal" } } } } } } }, "404": { "description": "No s'ha trobat la xarxa (o no és visible per a aquesta aplicació).", "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": "Obtenir la cronologia de la xarxa", "description": "Sense `contract`: els esdeveniments propis de la xarxa (detecció, la darrera observació de cada senyal i la seva revisió), primer els més antics i sense paginació. S'ignoren `limit`, `cursor` i `event_type`. Amb `contract=2`: la línia temporal tipada, primer els més recents i paginada per cursor. Afegeix el que han fet els comptes dels membres (intents de verificació, transaccions, inicis de sessió que publiquis mitjançant l'API d'esdeveniments i les regles actives que s'han activat) i els casos oberts per a la xarxa. Els esdeveniments `note_added` només es retornen als membres de la consola, mai a una clau d'API. Requereix una clau d'API amb accés complet o `read:networks` per a un membre 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID de la xarxa." }, { "name": "contract", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2" ] }, "description": "`2` retorna la cronologia tipada. Omet-lo per a la cronologia per defecte. Qualsevol altre valor retorna 400." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 }, "description": "Només per a la cronologia tipada. Esdeveniments per pàgina, d'1 a 500. El valor per defecte és 100." }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Només per a la cronologia tipada. El `next_cursor` de la pàgina anterior. Un cursor buit o no vàlid retorna 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": "Només per a la cronologia tipada. Tipus d'esdeveniments que cal mantenir, repetits o separats per comes, com a màxim 20 valors. Per defecte inclou tots els tipus." } ], "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": "Sense `contract`: `{results}`, els més antics primer, sense paginar. Amb `contract=2`: `{results, next_cursor}`, els més recents primer.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/NetworkTimeline" }, { "$ref": "#/components/schemas/NetworkTimelinePage" } ] }, "examples": { "Default timeline": { "summary": "Sense 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": "Amb 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": "Amb `contract` present: un valor de `contract`, `limit`, `cursor` o `event_type` no vàlid.", "content": { "application/json": { "examples": { "Unsupported contract": { "summary": "Contracte no admès", "value": { "contract": [ "\"3\" is not a valid choice." ] } }, "Invalid cursor": { "summary": "Cursor no vàlid", "value": { "cursor": [ "This cursor is not valid. Reload the feed." ] } }, "Limit too large": { "summary": "Límit massa gran", "value": { "limit": [ "Ensure this value is less than or equal to 500." ] } }, "Unknown event type": { "summary": "Tipus d'esdeveniment desconegut", "value": { "event_type": { "0": [ "\"logout\" is not a valid choice." ] } } } } } } }, "401": { "description": "Falten les credencials o no són vàlides.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Present en errors codificats, per exemple `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falten les credencials o no són vàlides", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "La clau d'API pertany a una altra aplicació o és una clau amb accés restringit: els endpoints de Networks necessiten una clau amb accés complet. Un token de membre de la consola necessita `read:networks`. També es retorna amb `code: networks_not_entitled` quan Networks no està habilitat per a l'organització.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Present en errors codificats, per exemple `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Xarxes no habilitades", "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": "Clau d'API restringida", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Sense permís", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No s'ha trobat la xarxa (o no és visible per a aquesta aplicació).", "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": "Obtenir el mapa de la xarxa", "description": "Punts geogràfics on convergeixen les adreces/ubicacions dels membres d'aquesta xarxa, obtinguts a partir de les sessions, sessions d'empresa i transaccions que sustenten les seves afiliacions.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID de la xarxa." } ], "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 xarxa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkMap" } } } }, "404": { "description": "No s'ha trobat la xarxa (o no és visible per a aquesta aplicació).", "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": "Llista les xarxes d'una sessió", "description": "Llista les xarxes a les quals pertany l'usuari del proveïdor de la sessió. Es resol a través de l'usuari vinculat a vendor_data de la sessió.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la sessió." } ], "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": "Xarxes a les quals pertany aquesta entitat. No estan paginades.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "No s'ha trobat l'entitat en aquesta aplicació o no té cap subjecte enllaçat per 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": "Llista les xarxes d'una sessió d'empresa", "description": "Llista les xarxes a les quals pertany l'empresa del proveïdor de la sessió d'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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "business_session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la sessió d'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": "Xarxes a les quals pertany aquesta entitat. No estan paginades.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "No s'ha trobat l'entitat en aquesta aplicació o no té cap subjecte enllaçat per 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": "Llista les xarxes d'un usuari", "description": "Llista les xarxes a les quals pertany un usuari del proveïdor.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "vendor_user_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'usuari proveïdor." } ], "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": "Xarxes a les quals pertany aquesta entitat. No estan paginades.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "No s'ha trobat l'entitat en aquesta aplicació o no té cap subjecte enllaçat per 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": "Llista les xarxes d'una empresa", "description": "Llista les xarxes a les quals pertany una empresa del proveïdor.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "vendor_business_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'empresa proveïdora." } ], "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": "Xarxes a les quals pertany aquesta entitat. No estan paginades.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "No s'ha trobat l'entitat en aquesta aplicació o no té cap subjecte enllaçat per 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": "Llista les xarxes d'una transacció", "description": "Llista les xarxes a les quals pertany el subjecte de KYC/KYB de suport de la transacció (resolt a través de la sessió o sessió d'empresa de la transacció).", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "transaction_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la transacció." } ], "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": "Xarxes a les quals pertany aquesta entitat. No estan paginades.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "No s'ha trobat l'entitat en aquesta aplicació o no té cap subjecte enllaçat per 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": "Llista les xarxes d'una part de la transacció", "description": "Llista les xarxes a les quals pertany una part de la transacció (ordenant, beneficiari o contrapart), resoltes a través de la mateixa part en lloc de la sessió de suport de la transacció.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "transaction_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la transacció." }, { "name": "transaction_party_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la part de la transacció." } ], "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": "Xarxes a les quals pertany aquesta entitat. No estan paginades.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "No s'ha trobat l'entitat en aquesta aplicació o no té cap subjecte enllaçat per consultar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/biometric-templates/": { "get": { "summary": "Llista les plantilles biomètriques conservades", "description": "Una aplicació que hi ha optat manté una plantilla biomètrica facial gestionada per separat i sense imatges ancorada a l'usuari quan se suprimeix una sessió (consulta `DELETE /v3/session/{sessionId}/delete/`). Les plantilles són dades biomètriques amb un `expires_at` finit; mai contenen imatges, dades de sessió ni camps d'identitat, i es purguen en suprimir l'usuari, per supressió per privadesa, per caducitat o mitjançant una purga explícita. Aquests endpoints només accepten claus d'API d'aplicació (`x-api-key`); els tokens d'usuari de la Business Console es rebutgen amb `403`.\n\nRetorna una llista paginada de les plantilles que l'aplicació té actualment. Les plantilles purgades no s'inclouen a la llista.", "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": "Coincidència de subcadena que no distingeix majúscules de minúscules al `vendor_data` actual de l'usuari propietari.", "schema": { "type": "string" } }, { "in": "query", "name": "vendor_user_uuid", "required": false, "description": "Coincidència exacta amb l'usuari propietari.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "status", "required": false, "description": "Estat del cicle de vida. Les plantilles purgades mai no es llisten.", "schema": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed" ] } }, { "in": "query", "name": "source_type", "required": false, "description": "Com es va crear la plantilla.", "schema": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ] } }, { "in": "query", "name": "retained_from", "required": false, "description": "Plantilles conservades en aquest moment o després.", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "retained_to", "required": false, "description": "Plantilles conservades en aquest moment o abans. No pot ser anterior a `retained_from` (`400`).", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "ordering", "required": false, "description": "Criteri d'ordenació.", "schema": { "type": "string", "enum": [ "retained_at", "-retained_at", "expires_at", "-expires_at" ], "default": "-retained_at" } }, { "in": "query", "name": "limit", "required": false, "description": "Mida de la pàgina.", "schema": { "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "description": "Desplaçament de paginació.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Plantilles paginades.", "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. Generat aleatòriament; no es deriva de la sessió suprimida ni de la seva cara." }, "vendor_user_uuid": { "type": "string", "format": "uuid", "description": "L'usuari propietari." }, "vendor_data": { "type": "string", "nullable": true, "description": "El `vendor_data` actual de l'usuari, resolt en llegir la plantilla (mai es copia)." }, "source_type": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ], "description": "Com es va crear la plantilla: una supressió de sessió (API o Console), la finestra automàtica de conservació de dades de l'aplicació o un emplenament retroactiu operat per Didit segons les teves instruccions." }, "provenance_reference": { "type": "string", "format": "uuid", "description": "Referència opaca que vincula la plantilla al seu registre d'auditoria. No és l'id de la sessió suprimida i no es pot utilitzar per resoldre'l." }, "retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "La política de l'aplicació en el moment de la conservació." }, "retention_override": { "type": "boolean", "nullable": true, "description": "El valor `retain_face_embeddings` enviat en la supressió, o `null` si s'ha aplicat la política." }, "retained_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time", "description": "Quan la plantilla caduca i es purga automàticament. Sempre definit." }, "retained_by": { "type": "string", "nullable": true, "description": "Identitat principal que ha donat la instrucció: l'id de l'aplicació per a claus d'API, l'id de membre de la Console per a accions de la Console o un identificador `service:` per a la conservació automàtica. Mai una adreça de correu electrònic." }, "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": "L'`instruction_id` enviat en la supressió, o un id generat per Didit." }, "held_out_of_use": { "type": "boolean", "description": "`true` només mentre s'aplica una retenció legal. Una plantilla retinguda s'exclou de totes les coincidències." }, "status": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed", "purged" ], "description": "Només les plantilles `active` que no estiguin retingudes, no hagin superat `expires_at` i l'usuari de les quals encara existeixi participen en la coincidència." }, "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 filtre no vàlid, o `retained_to` és anterior a `retained_from`. Errors de validació desglossats per camp.", "content": { "application/json": { "examples": { "Bad range": { "value": { "retained_to": [ "Must be on or after retained_from." ] } } } } } }, "403": { "description": "Token d'usuari de la consola, o la clau d'API no està permesa. Aquests endpoints només accepten claus d'API d'aplicació.", "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": "Compta les plantilles biomètriques conservades", "description": "Una aplicació que hi ha optat manté una plantilla biomètrica facial gestionada per separat i sense imatges ancorada a l'usuari quan se suprimeix una sessió (consulta `DELETE /v3/session/{sessionId}/delete/`). Les plantilles són dades biomètriques amb un `expires_at` finit; mai contenen imatges, dades de sessió ni camps d'identitat, i es purguen en suprimir l'usuari, per supressió per privadesa, per caducitat o mitjançant una purga explícita. Aquests endpoints només accepten claus d'API d'aplicació (`x-api-key`); els tokens d'usuari de la Business Console es rebutgen amb `403`.\n\nRetorna el nombre de plantilles que coincideixen amb els mateixos filtres que l'endpoint de llistat. Utilitza-ho per comprovar què afectaria una purga massiva filtrada amb `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": "Coincidència de subcadena que no distingeix majúscules de minúscules al `vendor_data` actual de l'usuari propietari.", "schema": { "type": "string" } }, { "in": "query", "name": "vendor_user_uuid", "required": false, "description": "Coincidència exacta amb l'usuari propietari.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "status", "required": false, "description": "Estat del cicle de vida. Les plantilles purgades mai no es llisten.", "schema": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed" ] } }, { "in": "query", "name": "source_type", "required": false, "description": "Com es va crear la plantilla.", "schema": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ] } }, { "in": "query", "name": "retained_from", "required": false, "description": "Plantilles conservades en aquest moment o després.", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "retained_to", "required": false, "description": "Plantilles conservades en aquest moment o abans. No pot ser anterior a `retained_from` (`400`).", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Recompte.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0 } } }, "examples": { "Count": { "value": { "count": 128 } } } } } }, "400": { "description": "Valor de filtre no vàlid, o `retained_to` és anterior a `retained_from`. Errors de validació desglossats per camp.", "content": { "application/json": { "examples": { "Bad range": { "value": { "retained_to": [ "Must be on or after retained_from." ] } } } } } }, "403": { "description": "Token d'usuari de la consola, o la clau d'API no està permesa. Aquests endpoints només accepten claus d'API d'aplicació.", "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": "Obtenir una plantilla biomètrica conservada", "description": "Una aplicació que hi ha optat manté una plantilla biomètrica facial gestionada per separat i sense imatges ancorada a l'usuari quan se suprimeix una sessió (consulta `DELETE /v3/session/{sessionId}/delete/`). Les plantilles són dades biomètriques amb un `expires_at` finit; mai contenen imatges, dades de sessió ni camps d'identitat, i es purguen en suprimir l'usuari, per supressió per privadesa, per caducitat o mitjançant una purga explícita. Aquests endpoints només accepten claus d'API d'aplicació (`x-api-key`); els tokens d'usuari de la Business Console es rebutgen amb `403`.\n\nRetorna una plantilla. La resposta mai inclou cap imatge, cap vector, l'id de la sessió suprimida ni dades d'identitat.", "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 com es retorna a `biometric_template_uuid` pels endpoints de supressió de sessions, `biometric_template_id` en una coincidència de cerca facial o l'endpoint de llistat.", "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. Generat aleatòriament; no es deriva de la sessió suprimida ni de la seva cara." }, "vendor_user_uuid": { "type": "string", "format": "uuid", "description": "L'usuari propietari." }, "vendor_data": { "type": "string", "nullable": true, "description": "El `vendor_data` actual de l'usuari, resolt en llegir la plantilla (mai es copia)." }, "source_type": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ], "description": "Com es va crear la plantilla: una supressió de sessió (API o Console), la finestra automàtica de conservació de dades de l'aplicació o un emplenament retroactiu operat per Didit segons les teves instruccions." }, "provenance_reference": { "type": "string", "format": "uuid", "description": "Referència opaca que vincula la plantilla al seu registre d'auditoria. No és l'id de la sessió suprimida i no es pot utilitzar per resoldre'l." }, "retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "La política de l'aplicació en el moment de la conservació." }, "retention_override": { "type": "boolean", "nullable": true, "description": "El valor `retain_face_embeddings` enviat en la supressió, o `null` si s'ha aplicat la política." }, "retained_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time", "description": "Quan la plantilla caduca i es purga automàticament. Sempre definit." }, "retained_by": { "type": "string", "nullable": true, "description": "Identitat principal que ha donat la instrucció: l'id de l'aplicació per a claus d'API, l'id de membre de la Console per a accions de la Console o un identificador `service:` per a la conservació automàtica. Mai una adreça de correu electrònic." }, "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": "L'`instruction_id` enviat en la supressió, o un id generat per Didit." }, "held_out_of_use": { "type": "boolean", "description": "`true` només mentre s'aplica una retenció legal. Una plantilla retinguda s'exclou de totes les coincidències." }, "status": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed", "purged" ], "description": "Només les plantilles `active` que no estiguin retingudes, no hagin superat `expires_at` i l'usuari de les quals encara existeixi participen en la coincidència." }, "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 d'usuari de la consola, o la clau d'API no està permesa. Aquests endpoints només accepten claus d'API d'aplicació.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Plantilla desconeguda, una plantilla d'una altra aplicació o (en `GET`) una plantilla eliminada.", "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": "Purga una plantilla biomètrica conservada", "description": "Una aplicació que ha donat el seu consentiment manté una plantilla biomètrica facial gestionada per separat i sense imatges ancorada a l'usuari quan se suprimeix una sessió (consulta `DELETE /v3/session/{sessionId}/delete/`). Les plantilles són dades biomètriques amb un `expires_at` finit; mai contenen imatges, dades de sessió ni camps d'identitat, i es purguen en suprimir l'usuari, per esborrat per motius de privacitat, per caducitat o mitjançant una purga explícita. Aquests endpoints només accepten claus d'API d'aplicació (`x-api-key`); els tokens d'usuari de la Business Console es rebutgen amb `403`.\n\nPurga una plantilla: s'elimina de qualsevol tipus de coincidència i la plantilla emmagatzemada se suprimeix. És irreversible i queda registrada al registre d'auditoria amb l'actor principal.\n\n**Semàntica de reintents:** Didit suprimeix primer la plantilla emmagatzemada i només després marca la plantilla com a purgada. Si un magatzem biomètric no està disponible, la crida retorna `503`, la plantilla passa a `status: purge_failed` i ja queda exclosa de les coincidències; repeteix la mateixa crida per finalitzar. Repetir la purga d'una plantilla ja purgada retorna `already_purged`.\n\nLes plantilles també es purguen mitjançant `POST /v3/users/delete/` per a l'usuari propietari, per qualsevol supressió de sessions d'aquest usuari amb `deletion_instruction: privacy_erasure` i automàticament a `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 com es retorna a `biometric_template_uuid` pels endpoints de supressió de sessions, `biometric_template_id` en una coincidència de cerca facial o l'endpoint de llistat.", "schema": { "type": "string", "format": "uuid", "example": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b" } } ], "responses": { "200": { "description": "Resultat 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 d'usuari de la consola, o la clau d'API no està permesa. Aquests endpoints només accepten claus d'API d'aplicació.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Plantilla desconeguda, una plantilla d'una altra aplicació o (en `GET`) una plantilla eliminada.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Biometric template not found." } } } } } }, "503": { "description": "Un magatzem biomètric no estava disponible en conservar o purgar una plantilla biomètrica. No s'ha eliminat res; repeteix la mateixa sol·licitud. Els reintents són idempotents i convergeixen 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": "Purga massiva de plantilles biomètriques conservades", "description": "Una aplicació adherida manté una única plantilla biomètrica facial gestionada per separat i sense imatges, vinculada a l'usuari quan s'elimina una sessió (vegeu `DELETE /v3/session/{sessionId}/delete/`). Les plantilles són dades biomètriques amb un `expires_at` finit; mai contenen imatges, dades de la sessió ni camps d'identitat, i es purguen en eliminar l'usuari, per supressió de privadesa, per caducitat o mitjançant una purga explícita. Aquests endpoints només accepten claus d'API d'aplicació (`x-api-key`); els tokens d'usuari de la Business Console es rebutgen amb `403`.\n\nPurga múltiples plantilles en una sola crida, mitjançant una llista explícita d'ID o amb `delete_all: true`, opcionalment acotada pels mateixos filtres que l'endpoint de llistat. Les plantilles es purguen una per una i cada resultat indica `purged` o `already_purged`. Si un magatzem biomètric no està disponible, la crida retorna `503` en la primera plantilla fallida: les plantilles purgades prèviament a la sol·licitud romanen purgades, la que falla passa a `purge_failed` (ja exclosa de la cerca de coincidències), i repetir la sol·licitud completa la tasca.\n\n**`delete_all: true` sense filtres purga totes les plantilles biomètriques de l'aplicació i no es pot desfer.** Executa primer l'endpoint de recompte amb els mateixos filtres.", "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": "Plantilles per purgar. Obligatòries tret que `delete_all` sigui `true`. Els identificadors ja purgats s'informen com a `already_purged`." }, "delete_all": { "type": "boolean", "default": false, "description": "Quan és `true`, purga totes les plantilles que coincideixin amb els filtres següents (totes les plantilles de l'aplicació si no s'especifica cap filtre). S'ignora `template_uuids`. Irreversible." }, "vendor_data": { "type": "string", "description": "Només amb `delete_all`: coincidència de subcadena sense distinció entre majúscules i minúscules sobre el `vendor_data` de l'usuari propietari." }, "vendor_user_uuid": { "type": "string", "format": "uuid", "description": "Només amb `delete_all`: coincidència exacta sobre l'usuari propietari." }, "status": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed" ], "description": "Només amb `delete_all`." }, "source_type": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ], "description": "Només amb `delete_all`." }, "retained_from": { "type": "string", "format": "date-time", "description": "Només amb `delete_all`." }, "retained_to": { "type": "string", "format": "date-time", "description": "Només amb `delete_all`. No ha de 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": "Resultats de la purga per 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ó — no es purga res.", "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 d'usuari de la consola, o la clau d'API no està permesa. Aquests endpoints només accepten claus d'API d'aplicació.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "503": { "description": "Un magatzem biomètric no estava disponible en conservar o purgar una plantilla biomètrica. No s'ha eliminat res; repeteix la mateixa sol·licitud. Els reintents són idempotents i convergeixen 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 al registre mercantil per a KYB amb accionistes (independent)", "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": "Recupera el perfil Lite **més els accionistes directes** (persones físiques i entitats jurídiques, amb els seus trams de titularitat) d'un candidat retornat per `POST /v3/kyb/search/`.\n\n**Associació amb la cerca.** Passa el `kyb_response_id` del candidat exactament com l'ha retornat una cerca de la mateixa aplicació. Cerca al nivell que tinguis intenció d'adquirir (`tier` a `POST /v3/kyb/search/`), perquè la cerca s'executa a la cadena de registres que dona servei a aquest nivell i una cerca Lite buida no és prova que el registre no contingui l'empresa. Quan les dades de titularitat del país es troben en un altre registre, Didit torna a cercar l'empresa allà pel número de registre, sense cap cost addicional.\n\n**Facturació.** Es factura al preu de Shareholders del país; consulta els [preus del registre de KYB](/ca/getting-started/kyb-registry-pricing). Quan el registre no té cap registre d'accionistes de l'empresa (o el país no ofereix cap dada de titularitat), es lliura i es factura el perfil Lite en el seu lloc: consulta `registry_tier_delivered` i `registry_ownership_status`. El saldo es comprova respecte al preu de Shareholders abans de qualsevol crida al registre (`403` si és insuficient).\n\n**Disponibilitat.** Només v3. Cada crida crea una sessió d'empresa (el seu id és el `request_id`).\n\n**Informes pendents.** Quan un informe encara s'està preparant, o la secció de titularitat encara no s'ha recuperat del registre, l'endpoint retorna 202 Accepted, kyb_registry.fetch_status=pending, kyb_registry.registry_ownership_status=pending i registry_tier_delivered=null. Conserva request_id i consulta GET /v3/session/{request_id}/decision/ fins que registry_checks[0].company.fetch_status estigui resolt. Didit completa l'informe automàticament i cobra el nivell lliurat un cop estigui llest. No repeteixis la compra mentre estigui pendent; cada nou POST crea una sol·licitud independent.", "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 d'empresa retornat i facturat segons el nivell proporcionat. Els informes de titularitat que encara s'estan preparant poden retornar 202; conserva request_id per recuperar la seva decisió desada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sessió de l'empresa creada per a aquesta recuperació. El registre emmagatzemat (visible a la consola) es continua actualitzant si la consulta al registre mercantil es resol després de la resposta." }, "registry_tier_requested": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "El nivell que ven aquest endpoint: `basic` (Lite) per a select, `shareholders`, `ubo`." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "El nivell realment lliurat i facturat. És inferior al sol·licitat quan els registres del país no contenen dades de titularitat, o el registre no té cap registre de titularitat per a aquesta empresa.", "nullable": true }, "kyb_registry": { "type": "object", "description": "Perfil complet de l'empresa al registre.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID de Didit per a aquest registre d'empresa." }, "node_id": { "type": "string", "example": "feature_kyb_registry" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review" ], "description": "Avaluació de Didit de la comprovació del registre (p. ex., `In Review` quan l'empresa no està activa al registre o no s'han pogut derivar les dades de titularitat)." }, "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": "Estat normalitzat de l'empresa tal com l'informa el registre." }, "data_resolved": { "type": "boolean", "description": "`true` un cop el registre ha retornat el perfil complet. `false` quan el registre encara estava processant després del sondeig; el registre emmagatzemat es completa automàticament un cop el registre es resol." }, "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": "Codi de subdivisió quan el registre és regional (p. ex. `CA` per a `US-CA`); buit en cas contrari." }, "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": "Nivell de risc notificat pel registre, quan estigui disponible." }, "verification_status": { "type": "string", "enum": [ "verified", "failed", "unknown" ], "nullable": true, "description": "Estat de verificació entre jurisdiccions: `verified` quan l'estat del registre mercantil estableix vigència (`active`), `failed` quan indica que l'empresa ja no està vigent (per exemple `dissolved`), i altrament `unknown`. `null` per a una empresa que no prové d'un registre mercantil i mentre una selecció encara estigui en `pending`." }, "is_from_registry": { "type": "boolean", "description": "Sempre `true` per a aquest endpoint: el perfil s'ha obtingut d'un registre oficial." }, "fetch_status": { "type": "string", "enum": [ "pending", "resolved" ], "description": "Cicle de vida de l'obtenció del registre. Reflectit per `data_resolved`." }, "alternative_names": { "type": "string", "nullable": true, "description": "Noms alternatius, comercials, anteriors o en l'idioma original de l'empresa com a text, quan s'hagin informat." }, "nature_of_business": { "type": "string", "nullable": true, "description": "Descripció de l'activitat o codi de classificació, quan s'informa." }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Quantitat decimal com a cadena de text, quan s'informa." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Codi ISO 4217, quan es comunica." }, "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, quan s'hagi informat." }, "location_of_registration": { "type": "string", "nullable": true, "description": "Registre/jurisdicció en què està registrada l'empresa, quan s'hagi notificat." }, "vat_number": { "type": "string", "nullable": true, "description": "Número d'IVA de la UE, quan es recull durant el pas de registre allotjat o s'edita posteriorment. En el moment de la selecció, normalment encara no està establert: la validació de l'IVA i de l'identificador fiscal s'executa quan l'usuari final envia el pas de registre al flux allotjat." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Resultat de la validació del número d'IVA o, si no n'hi ha, del `tax_number`, en enviar al registre. `valid` / `invalid`: determinat pel registre oficial del país (VIES de la UE, Noruega, Suïssa, Brasil, Colòmbia, Costa Rica, Equador, Paraguai; Polònia també pel seu registre intern d'IVA). `format_valid` / `invalid_format`: determinat per les regles de format i dígit de control del país on no es pot consultar cap registre. `could_not_validate`: el registre no estava disponible. `not_applicable`: sense número, un país sense registre o regles, o una sessió de sandbox." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "El número que s'ha comprovat, tal com el coneix la font (per exemple, el número d'IVA derivat d'un SIREN francès o d'un RSIN holandès). `null` quan no s'ha executat cap comprovació." }, "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 font que ha determinat `vat_validation_status`: un registre oficial o `format_rules`. `null` quan no s'ha executat cap comprovació." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Nom registrat amb la font que ha validat el número, quan en revela un. Només s'estableix quan l'estat és `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Adreça registrada amb la font que ha validat el número, quan en divulga una. Només s'estableix quan l'estat és `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de temps de la comprovació. `null` quan no s'ha executat cap comprovació." }, "financial_summary": { "type": "object", "nullable": true, "description": "Detalls sobre accions/capital notificats pel registre (moneda, accions totals, classes d'accions), quan estiguin 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": "Denominació en el registre en brut (p. ex., `Director`, `Secretary`)." }, "role": { "type": "string", "description": "Rol normalitzat derivat de la designació. Conjunt complet de 17 valors del model; l'anàlisi del registre mercantil en aquest endpoint sol emetre 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` quan el registre indica que l'administrador ha dimitit." }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending", null ], "description": "Estat d'una sessió de KYC associada, quan se'n va iniciar una per a aquest administrador. `null` en cas contrari." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "URL de verificació de la sessió de KYC associada, quan n'existeix una." }, "first_name": { "type": "string", "nullable": true, "description": "Nom de pila quan el registre el reporta explícitament; no deduït del nom complet." }, "last_name": { "type": "string", "nullable": true, "description": "Cognom quan el registre mercantil l'informa explícitament." }, "address": { "type": "string", "nullable": true, "description": "Adreça de l'administrador notificada pel registre mercantil." }, "appointment_date": { "type": "string", "nullable": true, "description": "Data en què es va nomenar el directiu.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Data en què va finalitzar el càrrec, quan s'ha notificat.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Data de naixement completa informada pel registre. Null quan només es coneix l'any o el mes de naixement.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Any de naixement notificat pel registre, inclòs quan la data completa no està disponible." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Mes de naixement notificat pel registre. Nul quan només es coneix l'any." } } }, "description": "Administradors, secretaris i altres càrrecs extrets del registre." }, "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 titular és una persona física o una persona jurídica." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Rols normalitzats (p. ex. `ubo`, `shareholder`)." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Límit inferior del tram de titularitat comunicat pel registre (p. ex., `25%`)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Límit superior de la franja de titularitat informada pel registre mercantil." }, "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": "Percentatge de titularitat analitzat (límit màxim, amb alternativa al límit mínim)." }, "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": "Data de naixement completa quan s'ha informat.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Data de nomenament quan s'ha informat.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } }, "description": "Titulars reals / persones amb control significatiu extrets del registre. Pot estar buit quan el registre no exposa la titularitat." }, "addresses": { "type": "array", "nullable": true, "description": "Totes les adreces que indica el registre, en un format canònic. Null si no n'indica cap.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "Les activitats sota les quals el registre classifica l'empresa, en un format canònic. Null si no n'indica cap.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Dates de presentació al registre, quan estiguin disponibles. Els informes anuals i les juntes generals utilitzen last_annual_return_date i last_agm_date; són diferents dels comptes financers." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "description": "Sempre `null` en aquest endpoint (utilitzat pel flux de KYB allotjat quan els usuaris finals editen dades del registre)." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Sempre `null` en aquest endpoint." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "S'estableix quan un revisor de la consola edita el registre més endavant." }, "is_editable": { "type": "boolean", "description": "Si les dades provinents del registre encara es poden editar al flux allotjat o a la consola." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "Igual que el `registry_tier_delivered` de nivell superior.", "nullable": true }, "registry_ownership_status": { "type": "string", "nullable": true, "enum": [ "not_requested", "delivered", "not_held", "unavailable", "pending", null ], "description": "`delivered` quan s'han obtingut les dades de titularitat, `not_held` quan el registre de titularitat ha respost i no llista aquesta empresa (consulta `registry_data.ownership_error`), `unavailable` quan s'ha sol·licitat un nivell de titularitat però el registre no en tenia per a aquesta empresa o no s'ha pogut consultar (consulta `registry_data.ownership_error`), `pending` quan la secció de titularitat encara no s'ha recuperat del registre i Didit encara l'està completant, `not_requested` al nivell Lite." }, "ownership": { "$ref": "#/components/schemas/KYBRegistryOwnership" }, "registry_tier": { "type": "string", "nullable": true, "description": "El nivell de registre que ha sol·licitat el flux de treball: `basic`, `shareholders` o `ubo`. També a `ownership.tier_requested`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "El monitor de registre més recent per a l'empresa, o `null` quan no n'existeix cap.", "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": "Els camps de l'empresa que el monitor supervisa." } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò del `vendor_data` que has enviat." }, "metadata": { "type": "object", "nullable": true, "description": "Ressò de les `metadata` que has enviat." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved company": { "summary": "Perfil complet del registre (llista d'administradors truncada per brevetat)", "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ó. Els problemes a nivell de camp utilitzen l'embolcall estàndard de DRF.", "content": { "application/json": { "examples": { "Missing kyb_response_id": { "summary": "`kyb_response_id` és obligatori", "value": { "kyb_response_id": [ "This field is required." ] } }, "save_api_request=false rejected": { "summary": "Les seleccions sempre es conserven", "value": { "save_api_request": [ "KYB registry select must be saved so billing and retrieval can be tracked." ] } } } } } }, "403": { "description": "Permís denegat. Es retorna quan falta la capçalera `x-api-key`, i també quan el saldo de l'organització que fa la crida no pot cobrir la crida; una clau incorrecta, revocada o caducada retorna `401`. Si falta la clau es retorna `403` amb `{\"detail\": ...}`; una clau incorrecta, revocada o caducada retorna `401`. La manca de crèdit retorna `403` amb `{\"error\": ...}` abans que es produeixi cap cribratge o crida al proveïdor.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de l'organització no pot cobrir la crida", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Més de 300 sol·licituds d'escriptura en el minut 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 acceptat i encara en processament. Quan un informe encara s'està preparant, l'endpoint retorna 202 Accepted, kyb_registry.fetch_status=pending i registry_tier_delivered=null. Conserva request_id i consulta GET /v3/session/{request_id}/decision/ fins que registry_checks[0].company.fetch_status estigui resolt. Didit completa l'informe automàticament i cobra el nivell lliurat un cop estigui a punt. No repeteixis la compra mentre estigui pendent; cada nou POST crea una sol·licitud independent.", "content": { "application/json": { "schema": { "$ref": "#/paths/~1v3~1kyb~1shareholders~1/post/responses/200/content/application~1json/schema" }, "examples": { "Pending (registry still resolving)": { "summary": "L'informe de titularitat encara s'està processant; recupera la decisió desada", "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 al registre mercantil per a KYB amb titulars reals (independent)", "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": "Recupera el perfil Lite, els accionistes directes **i els titulars reals** resolts a través de la cadena de titularitat (`registry_data.ubo_resolution` inclou la cadena de la matriu corporativa) d'un candidat retornat per `POST /v3/kyb/search/`.\n\n**Associació amb la cerca.** Passa el `kyb_response_id` del candidat exactament com l'ha retornat una cerca de la mateixa aplicació. Cerca al nivell que tinguis intenció d'adquirir (`tier` a `POST /v3/kyb/search/`), perquè la cerca s'executa a la cadena de registres que dóna servei a aquest nivell i una cerca Lite buida no és prova que el registre no contingui l'empresa. Quan les dades de titularitat del país es troben en un altre registre, Didit torna a cercar l'empresa allà pel número de registre, sense cap cost addicional.\n\n**Facturació.** Es factura al preu d'UBO del país; consulta els [preus del registre de KYB](/ca/getting-started/kyb-registry-pricing). El nivell lliurat és el més alt que el país i el registre poden oferir: Shareholders quan l'informe resolt no identifica cap persona física com a titular real, Lite quan no hi ha cap registre de titularitat; `registry_tier_delivered` indica el que s'ha facturat. El saldo es comprova respecte al preu d'UBO abans de qualsevol crida al registre (`403` si és insuficient).\n\n**Disponibilitat.** Només v3. Cada crida crea una sessió d'empresa (el seu id és el `request_id`).\n\n**Informes pendents.** Quan un informe encara s'està preparant, o la secció de titularitat encara no s'ha recuperat del registre, l'endpoint retorna 202 Accepted, kyb_registry.fetch_status=pending, kyb_registry.registry_ownership_status=pending i registry_tier_delivered=null. Conserva request_id i consulta GET /v3/session/{request_id}/decision/ fins que registry_checks[0].company.fetch_status estigui resolt. Didit completa l'informe automàticament i cobra el nivell lliurat un cop estigui llest. No repeteixis la compra mentre estigui pendent; cada nou POST crea una sol·licitud independent.", "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 d'empresa retornat i facturat segons el nivell proporcionat. Els informes de titularitat que encara s'estan preparant poden retornar 202; conserva request_id per recuperar la seva decisió desada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de la sessió de l'empresa creada per a aquesta recuperació. El registre emmagatzemat (visible a la consola) es continua actualitzant si la consulta al registre mercantil es resol després de la resposta." }, "registry_tier_requested": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "El nivell que ven aquest endpoint: `basic` (Lite) per a select, `shareholders`, `ubo`." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "El nivell realment lliurat i facturat. És inferior al sol·licitat quan els registres del país no contenen dades de titularitat, quan el registre no té cap registre de titularitat per a aquesta empresa, o quan l'informe resolt d'una sol·licitud `ubo` no designa cap persona física com a titular real.", "nullable": true }, "kyb_registry": { "type": "object", "description": "Perfil complet de l'empresa al registre.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID de Didit per a aquest registre d'empresa." }, "node_id": { "type": "string", "example": "feature_kyb_registry" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review" ], "description": "Avaluació de Didit de la comprovació del registre (p. ex., `In Review` quan l'empresa no està activa al registre o no s'han pogut derivar les dades de titularitat)." }, "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": "Estat normalitzat de l'empresa tal com l'informa el registre." }, "data_resolved": { "type": "boolean", "description": "`true` un cop el registre ha retornat el perfil complet. `false` quan el registre encara estava processant després del sondeig; el registre emmagatzemat es completa automàticament un cop el registre es resol." }, "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": "Codi de subdivisió quan el registre és regional (p. ex. `CA` per a `US-CA`); buit en cas contrari." }, "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": "Nivell de risc notificat pel registre, quan estigui disponible." }, "verification_status": { "type": "string", "enum": [ "verified", "failed", "unknown" ], "nullable": true, "description": "Estat de verificació entre jurisdiccions: `verified` quan l'estat del registre mercantil estableix vigència (`active`), `failed` quan indica que l'empresa ja no està vigent (per exemple `dissolved`), i altrament `unknown`. `null` per a una empresa que no prové d'un registre mercantil i mentre una selecció encara estigui en `pending`." }, "is_from_registry": { "type": "boolean", "description": "Sempre `true` per a aquest endpoint: el perfil s'ha obtingut d'un registre oficial." }, "fetch_status": { "type": "string", "enum": [ "pending", "resolved" ], "description": "Cicle de vida de l'obtenció del registre. Reflectit per `data_resolved`." }, "alternative_names": { "type": "string", "nullable": true, "description": "Noms alternatius, comercials, anteriors o en l'idioma original de l'empresa com a text, quan s'hagin informat." }, "nature_of_business": { "type": "string", "nullable": true, "description": "Descripció de l'activitat o codi de classificació, quan s'informa." }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Quantitat decimal com a cadena de text, quan s'informa." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Codi ISO 4217, quan es comunica." }, "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, quan s'hagi informat." }, "location_of_registration": { "type": "string", "nullable": true, "description": "Registre/jurisdicció en què està registrada l'empresa, quan s'hagi notificat." }, "vat_number": { "type": "string", "nullable": true, "description": "Número d'IVA de la UE, quan es recull durant el pas de registre allotjat o s'edita posteriorment. En el moment de la selecció, normalment encara no està establert: la validació de l'IVA i de l'identificador fiscal s'executa quan l'usuari final envia el pas de registre al flux allotjat." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Resultat de la validació del número d'IVA o, si no n'hi ha, del `tax_number`, en enviar al registre. `valid` / `invalid`: determinat pel registre oficial del país (VIES de la UE, Noruega, Suïssa, Brasil, Colòmbia, Costa Rica, Equador, Paraguai; Polònia també pel seu registre intern d'IVA). `format_valid` / `invalid_format`: determinat per les regles de format i dígit de control del país on no es pot consultar cap registre. `could_not_validate`: el registre no estava disponible. `not_applicable`: sense número, un país sense registre o regles, o una sessió de sandbox." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "El número que s'ha comprovat, tal com el coneix la font (per exemple, el número d'IVA derivat d'un SIREN francès o d'un RSIN holandès). `null` quan no s'ha executat cap comprovació." }, "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 font que ha determinat `vat_validation_status`: un registre oficial o `format_rules`. `null` quan no s'ha executat cap comprovació." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Nom registrat amb la font que ha validat el número, quan en revela un. Només s'estableix quan l'estat és `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Adreça registrada amb la font que ha validat el número, quan en divulga una. Només s'estableix quan l'estat és `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de temps de la comprovació. `null` quan no s'ha executat cap comprovació." }, "financial_summary": { "type": "object", "nullable": true, "description": "Detalls sobre accions/capital notificats pel registre (moneda, accions totals, classes d'accions), quan estiguin 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": "Denominació en el registre en brut (p. ex., `Director`, `Secretary`)." }, "role": { "type": "string", "description": "Rol normalitzat derivat de la designació. Conjunt complet de 17 valors del model; l'anàlisi del registre mercantil en aquest endpoint sol emetre 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` quan el registre indica que l'administrador ha dimitit." }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending", null ], "description": "Estat d'una sessió de KYC associada, quan se'n va iniciar una per a aquest administrador. `null` en cas contrari." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "URL de verificació de la sessió de KYC associada, quan n'existeix una." }, "first_name": { "type": "string", "nullable": true, "description": "Nom de pila quan el registre el reporta explícitament; no deduït del nom complet." }, "last_name": { "type": "string", "nullable": true, "description": "Cognom quan el registre mercantil l'informa explícitament." }, "address": { "type": "string", "nullable": true, "description": "Adreça de l'administrador notificada pel registre mercantil." }, "appointment_date": { "type": "string", "nullable": true, "description": "Data en què es va nomenar el directiu.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Data en què va finalitzar el càrrec, quan s'ha notificat.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Data de naixement completa informada pel registre. Null quan només es coneix l'any o el mes de naixement.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Any de naixement notificat pel registre, inclòs quan la data completa no està disponible." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Mes de naixement notificat pel registre. Nul quan només es coneix l'any." } } }, "description": "Administradors, secretaris i altres càrrecs extrets del registre." }, "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 titular és una persona física o una persona jurídica." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Rols normalitzats (p. ex. `ubo`, `shareholder`)." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Límit inferior del tram de titularitat comunicat pel registre (p. ex., `25%`)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Límit superior de la franja de titularitat informada pel registre mercantil." }, "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": "Percentatge de titularitat analitzat (límit màxim, amb alternativa al límit mínim)." }, "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": "Data de naixement completa quan s'ha informat.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Data de nomenament quan s'ha informat.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } }, "description": "Titulars reals / persones amb control significatiu extrets del registre. Pot estar buit quan el registre no exposa la titularitat." }, "addresses": { "type": "array", "nullable": true, "description": "Totes les adreces que indica el registre, en un format canònic. Null si no n'indica cap.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "Les activitats sota les quals el registre classifica l'empresa, en un format canònic. Null si no n'indica cap.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Dates de presentació al registre, quan estiguin disponibles. Els informes anuals i les juntes generals utilitzen last_annual_return_date i last_agm_date; són diferents dels comptes financers." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "description": "Sempre `null` en aquest endpoint (utilitzat pel flux de KYB allotjat quan els usuaris finals editen dades del registre)." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Sempre `null` en aquest endpoint." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "S'estableix quan un revisor de la consola edita el registre més endavant." }, "is_editable": { "type": "boolean", "description": "Si les dades provinents del registre encara es poden editar al flux allotjat o a la consola." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "Igual que el `registry_tier_delivered` de nivell superior.", "nullable": true }, "registry_ownership_status": { "type": "string", "nullable": true, "enum": [ "not_requested", "delivered", "not_held", "unavailable", "pending", null ], "description": "`delivered` quan s'han obtingut les dades de titularitat, `not_held` quan el registre de titularitat ha respost i no llista aquesta empresa (consulta `registry_data.ownership_error`), `unavailable` quan s'ha sol·licitat un nivell de titularitat però el registre no en tenia per a aquesta empresa o no s'ha pogut consultar (consulta `registry_data.ownership_error`), `pending` quan la secció de titularitat encara no s'ha recuperat del registre i Didit encara l'està completant, `not_requested` al nivell Lite." }, "ownership": { "$ref": "#/components/schemas/KYBRegistryOwnership" }, "registry_tier": { "type": "string", "nullable": true, "description": "El nivell de registre que ha sol·licitat el flux de treball: `basic`, `shareholders` o `ubo`. També a `ownership.tier_requested`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "El monitor de registre més recent per a l'empresa, o `null` quan no n'existeix cap.", "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": "Els camps de l'empresa que el monitor supervisa." } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò del `vendor_data` que has enviat." }, "metadata": { "type": "object", "nullable": true, "description": "Ressò de les `metadata` que has enviat." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved company": { "summary": "Perfil complet del registre (llista d'administradors truncada per brevetat)", "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ó. Els problemes a nivell de camp utilitzen l'embolcall estàndard de DRF.", "content": { "application/json": { "examples": { "Missing kyb_response_id": { "summary": "`kyb_response_id` és obligatori", "value": { "kyb_response_id": [ "This field is required." ] } }, "save_api_request=false rejected": { "summary": "Les seleccions sempre es conserven", "value": { "save_api_request": [ "KYB registry select must be saved so billing and retrieval can be tracked." ] } } } } } }, "403": { "description": "Permís denegat. Es retorna quan falta la capçalera `x-api-key`, i també quan el saldo de l'organització que fa la crida no pot cobrir la crida; una clau incorrecta, revocada o caducada retorna `401`. Si falta la clau es retorna `403` amb `{\"detail\": ...}`; una clau incorrecta, revocada o caducada retorna `401`. La manca de crèdit retorna `403` amb `{\"error\": ...}` abans que es produeixi cap cribratge o crida al proveïdor.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida/s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de l'organització no pot cobrir la crida", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "S'ha superat el límit de freqüència. Els endpoints POST/PATCH/DELETE comparteixen un pressupost de 300 sol·licituds d'escriptura per minut per clau d'API (la creació de transaccions i la ingesta d'esdeveniments tenen un pressupost independent de 600). La resposta inclou les capçaleres `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` i `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Més de 300 sol·licituds d'escriptura en el minut 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 acceptat i encara en processament. Quan un informe encara s'està preparant, l'endpoint retorna 202 Accepted, kyb_registry.fetch_status=pending i registry_tier_delivered=null. Conserva request_id i consulta GET /v3/session/{request_id}/decision/ fins que registry_checks[0].company.fetch_status estigui resolt. Didit completa l'informe automàticament i cobra el nivell lliurat un cop estigui a punt. No repeteixis la compra mentre estigui pendent; cada nou POST crea una sol·licitud independent.", "content": { "application/json": { "schema": { "$ref": "#/paths/~1v3~1kyb~1ubo~1/post/responses/200/content/application~1json/schema" }, "examples": { "Pending (registry still resolving)": { "summary": "L'informe de titularitat encara s'està processant; recupera la decisió desada", "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": "Totes les carteres d'identitat digital amb el seu endpoint d'inici, països, camps obligatoris i si aquesta aplicació pot iniciar-la en aquest entorn ara mateix. Que estigui llistada no significa que estigui activa.", "summary": "Llistar carteres d'identitat digital", "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": "Falten les credencials (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": "Estat i resultat d'una verificació de cartera: la identitat normalitzada i els atributs propis de la cartera un cop verificada, el codi d'error un cop rebutjada, la següent acció mentre estigui pendent. Una verificació que ha superat expires_at es resol com a timeout.", "summary": "Obtenir una verificació de cartera", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "El request_id que ha retornat l'endpoint d'inici.", "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": "Falten les credencials (x-api-key o Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error not_found: cap verificació de cartera d'aquesta aplicació té aquest 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 i Mobile-ID: pregunta al proveïdor si l'usuari ha confirmat, ha rebutjat o ha deixat expirar l'avís, i verifica la identitat signada quan hagi confirmat. Les carteres de redirecció completen el procés a través del navegador de l'usuari, de manera que per a aquestes només es recupera la verificació. Retorna la verificació tal com queda posteriorment.", "summary": "Consulta periòdicament una verificació de cartera", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "El request_id que ha retornat l'endpoint d'inici.", "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": "Falten les credencials (x-api-key o Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error not_found: cap verificació de cartera d'aquesta aplicació té aquest request_id." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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ó pendent: es rebutja com a cancel·lada i mai no es factura. Una verificació ja decidida es retorna sense canvis. Smart-ID i Mobile-ID: una cancel·lació que arriba mentre un sondeig està comprovant l'inici de sessió espera uns quants segons per a aquest sondeig, i després la rebutja, o la retorna verificada si l'usuari ja havia confirmat. Una verificació que l'usuari està completant en aquest mateix moment no es pot cancel·lar (409 verification_in_progress amb Retry-After): reintenta-ho passats aquests segons per conèixer el seu resultat.", "summary": "Cancel·lar una verificació de cartera", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "El request_id que ha retornat l'endpoint d'inici.", "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": "Falten les credencials (x-api-key o Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error not_found: cap verificació de cartera d'aquesta aplicació té aquest request_id." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error verification_in_progress: l'usuari està completant aquest inici de sessió ara mateix. La capçalera Retry-After indica quan cal reintentar; el reintent retorna la verificació resolta." } }, "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 sessió amb MitID (Danish Agency for Digital Government; DNK) sense cap flux de treball. Es factura un sol cop, només quan es verifica la identitat. La resposta inclou next_action.type=redirect amb l'URL on dirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions de sandbox obtenen una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb MitID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 inici de sessió amb BankID (SWE) (Finansiell ID-Teknik / consorci bancari; SWE) sense cap flux de treball. Es factura un sol cop, només quan la identitat està verificada. La resposta inclou next_action.type=redirect amb l'URL al qual cal redirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Llegeix el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions en sandbox reben una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb BankID (SWE)", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 inici de sessió amb BankID (NOR) (BankID BankAxept AS; NOR) sense cap flux de treball. Es factura un sol cop, només quan la identitat està verificada. La resposta inclou next_action.type=redirect amb l'URL al qual cal redirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Llegeix el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions en sandbox reben una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb BankID (NOR)", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 sessió amb Vipps (Vipps MobilePay / BankID NO; NOR) sense cap flux de treball. Es factura un sol cop, només quan la identitat es verifica. La resposta inclou next_action.type=redirect amb l'URL a la qual dirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions de sandbox reben una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb Vipps", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 inici de sessió amb Buypass ID (Buypass AS; NOR) sense cap flux de treball. Es factura un sol cop, només quan la identitat està verificada. La resposta inclou next_action.type=redirect amb l'URL al qual cal redirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Llegeix el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions en sandbox reben una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb Buypass ID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 inici de sessió amb itsme (Belgian Mobile ID; BEL, LUX, NLD) sense cap flux de treball. Es factura un sol cop, només quan la identitat està verificada. La resposta inclou next_action.type=redirect amb l'URL al qual enviar el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions en sandbox obtenen una simulació determinista (simulated: true) que mai no contacta amb el proveïdor.", "summary": "Inicia la verificació d'itsme", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 una sessió amb iDIN (bancs holandesos (Currence iDIN); NLD) sense cap flux de treball. Es factura un sol cop, només quan la identitat està verificada. La resposta inclou next_action.type=redirect amb l'URL a la qual enviar el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions en sandbox obtenen una simulació determinista (simulated: true) que mai no contacta amb el proveïdor.", "summary": "Inicia la verificació d'iDIN", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 sessió amb Finnish Trust Network (bancs i operadors mòbils finlandesos (FTN); FIN) sense cap flux de treball. Es factura un sol cop, només quan es verifica la identitat. La resposta inclou next_action.type=redirect amb l'URL on dirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions de sandbox obtenen una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb Finnish Trust Network", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 sessió amb Personalausweis (Bundesministerium des Innern (eID); DEU) sense cap flux de treball. Es factura un sol cop, només quan la identitat es verifica. La resposta inclou next_action.type=redirect amb l'URL a la qual dirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions de sandbox reben una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb Personalausweis", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 sessió amb Freja eID (Freja eID Group; SWE) sense cap flux de treball. Es factura un sol cop, només quan es verifica la identitat. La resposta inclou next_action.type=redirect amb l'URL on dirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions de sandbox obtenen una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb Freja eID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 sessió amb UAE PASS (UAE Digital Government Authority; ARE) sense cap flux de treball. Es factura un sol cop, només quan la identitat es verifica. La resposta inclou next_action.type=redirect amb l'URL a la qual dirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions de sandbox reben una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb UAE PASS", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 sessió amb gov.br (Governo Federal do Brasil; BRA) sense cap flux de treball. Es factura un sol cop, només quan la identitat es verifica. La resposta inclou next_action.type=redirect amb l'URL a la qual dirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions de sandbox reben una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació de gov.br", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 sessió amb OneID (OneID (identitat verificada per un banc del Regne Unit); GBR) sense cap flux de treball. Es factura un sol cop, només quan la identitat es verifica. La resposta inclou next_action.type=redirect amb l'URL a la qual dirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions de sandbox reben una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb OneID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 sessió amb GOV.UK Wallet (UK Government Digital Service; GBR) sense cap flux de treball. Es factura un sol cop, només quan es verifica la identitat. La resposta inclou next_action.type=redirect amb l'URL on dirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions de sandbox obtenen una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb GOV.UK Wallet", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 sessió amb Smart-ID (SK ID Solutions; EST, LVA, LTU, BEL) sense cap flux de treball. Es factura un sol cop, només quan es verifica la identitat. La resposta inclou next_action.type=confirm_in_app amb el codi de comparació que s'ha de mostrar a l'usuari; l'usuari el confirma i introdueix el seu PIN a l'aplicació (no recopilis mai el PIN). Crida POST /v3/id-verification/wallets/verifications/{request_id}/poll/ cada poll_interval_seconds, o confia en el webhook: Didit també fa sondejos en segon pla. Les aplicacions de sandbox reben una simulació determinista (simulated: true) que no contacta mai amb el proveïdor.", "summary": "Inicia la verificació amb Smart-ID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 una sessió amb Mobile-ID (SK ID Solutions amb els operadors mòbils nacionals; EST, LTU) sense cap flux de treball. Es factura un sol cop, només quan es verifica la identitat. La resposta inclou next_action.type=confirm_in_app amb el codi de comparació que s'ha de mostrar a l'usuari; l'usuari el confirma i introdueix el seu PIN a l'aplicació (mai recopilis el PIN). Envia una sol·licitud POST a /v3/id-verification/wallets/verifications/{request_id}/poll/ cada poll_interval_seconds, o confia en el webhook: Didit també fa consultes en segon pla. Les aplicacions de sandbox obtenen una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb Mobile-ID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 inici de sessió amb targeta d'identitat estoniana (Junta de Policia i Guàrdia de Fronteres (Estònia); EST) sense cap flux de treball. Es factura un sol cop, només quan la identitat està verificada. La resposta inclou next_action.type=redirect amb l'URL al qual cal redirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Llegeix el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions en sandbox reben una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb Estonian ID-card", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 sessió amb eParaksts mobile (LVRTC (Latvian State Radio and Television Centre); LVA) sense cap flux de treball. Es factura un sol cop, només quan la identitat es verifica. La resposta inclou next_action.type=redirect amb l'URL a la qual dirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions de sandbox reben una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació mòbil d'eParaksts", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 inici de sessió amb Bank iD (Bankovní identita, a.s.; CZE) sense cap flux de treball. Es factura una sola vegada, només quan es verifica la identitat. La resposta inclou next_action.type=redirect amb l'URL al qual cal redirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions de sandbox obtenen una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb Bank iD", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 sessió amb MojeID (CZ.NIC; CZE) sense cap flux de treball. Es factura un sol cop, només quan la identitat es verifica. La resposta inclou next_action.type=redirect amb l'URL a la qual dirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions de sandbox reben una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb MojeID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 inici de sessió amb Diia (Ministeri de Transformació Digital d'Ucraïna; UKR) sense cap flux de treball. Es factura un sol cop, només quan la identitat està verificada. La resposta inclou next_action.type=redirect amb l'URL al qual cal redirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Llegeix el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions en sandbox reben una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb Diia", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 sessió amb FranceConnect (DINUM (estat francès); FRA) sense cap flux de treball. Es factura un sol cop, només quan es verifica la identitat. La resposta inclou next_action.type=redirect amb l'URL on dirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions de sandbox obtenen una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb FranceConnect", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 una sessió amb Auðkenni (Auðkenni (identificador electrònic islandès); ISL) sense cap flux de treball. Es factura una sola vegada, només quan es verifica la identitat. La resposta inclou next_action.type=redirect amb l'URL al qual cal redirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Consulta el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions de sandbox obtenen una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb Auðkenni", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 inici de sessió amb ConnectID (Australian Payments Plus; AUS) sense cap flux de treball. Es factura un sol cop, només quan la identitat està verificada. La resposta inclou next_action.type=redirect amb l'URL al qual cal redirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Llegeix el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions en sandbox reben una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb ConnectID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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 inici de sessió amb EUDI Wallet (el propi estat membre de l'usuari; l'emissor varia segons 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) sense cap flux de treball. Es factura un sol cop, només quan la identitat està verificada. La resposta inclou next_action.type=redirect amb l'URL al qual cal redirigir el navegador de l'usuari; l'usuari torna a return_url amb request_id i result afegits. Llegeix el resultat amb GET /v3/id-verification/wallets/verifications/{request_id}/ o des del webhook, mai des de l'URL. Les aplicacions en sandbox reben una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb EUDI Wallet", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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": "Llista els equips de revisió", "description": "Requereix `list:cases` per a l'aplicació sol·licitada.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "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": "Èxit", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseReviewTeam" } }, "count": { "type": "integer", "description": "Recompte de coincidències, limitat a 100. Segueix next per continuar més enllà del límit." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true } } } } } }, "400": { "description": "Entrada no vàlida." }, "403": { "description": "Permís insuficient." } }, "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": "Crea un equip de revisió", "description": "Requereix `write:cases` per a l'aplicació sol·licitada.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "responses": { "201": { "description": "Èxit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeam" } } } }, "400": { "description": "Entrada no vàlida." }, "403": { "description": "Permís insuficient." } }, "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": "Obtén una comprovació creada prèviament mitjançant el seu `check_id`.", "summary": "Recuperar una comprovació de frau", "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": "Quin camp s'ha d'utilitzar per ordenar els resultats.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Nombre de resultats que cal retornar per pàgina.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "L'índex inicial a partir del qual es retornen els resultats.", "schema": { "type": "integer" } } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingPaginatedCaseRequestList" } } }, "description": "" }, "404": { "description": "La sol·licitud o el cas no està disponible per a aquest sol·licitant." }, "403": { "description": "L'emissor de la crida no té el permís de casos requerit." } }, "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 sol·licitud o el cas no està disponible per a aquest sol·licitant." }, "403": { "description": "L'emissor de la crida no té el permís de casos requerit." }, "400": { "description": "Entrades no vàlides, finalitat no admesa, contacte verificat no disponible o resposta immutable existent." }, "409": { "description": "La previsualització ha canviat o ha caducat. Torna a previsualitzar abans de confirmar." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequest" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Confirma la previsualització signada exacta en un termini de 15 minuts. Només s'accepten plantilles fixes i un contacte verificat per OTP que pertanyi al subjecte del cas. L'ID de sol·licitud fa que els reintents siguin idempotents. El lliurament s'encua; SENT, SIMULATED i UNKNOWN són resultats diferents. Una sol·licitud accionable estableix el cas a Esperant l'usuari. Una actualització de revisió deixa el seu estat sense canvis.", "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": "Envia un o més identificadors tipats i rep normalització, enriquiment actualitzat, validació fidedigna on el país i el tipus d'identificador estiguin coberts, dimensions de risc independents i una recomanació en una única resposta.\n\nAquests perfils admeten comprovacions d'identificadors. La vinculació d'identitat basada en selfie (`biometric_identity`) requereix la versió de perfil `2026-09-14.2` i un CPF brasiler; s'executa només amb el consentiment de l'usuari i quan la teva organització hi té dret. Les versions anteriors l'informen com a `not_available_in_profile_version`. Els mòduls que no es poden executar s'informen com a omesos amb un motiu determinista; una font que no hagi pogut respondre mai s'informa com a no coincidència d'identitat.", "summary": "Executa un control de frau", "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": "Conflicte, retornat sense cap càrrec: el `client_reference` ja s'havia utilitzat amb un cos de sol·licitud diferent; una comprovació amb el mateix `client_reference` encara s'està executant (reintenta després dels segons indicats a `Retry-After` amb la mateixa referència); o la verificació en la qual es registra aquesta comprovació s'ha suprimit abans que la comprovació es completés.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] }, "examples": { "different_body": { "summary": "Referència reutilitzada amb un cos diferent", "value": { "error": "client_reference has already been used with a different request body." } }, "still_running": { "summary": "Una comprovació amb aquesta referència encara s'està executant", "value": { "error": "A check with this client_reference is already running. Retry with the same reference later." } }, "verification_deleted": { "summary": "La verificació s'ha suprimit abans que es completés la comprovació", "value": { "error": "This verification was deleted before the check completed." } } } } }, "headers": { "Retry-After": { "description": "Segons d'espera abans de reintentar, enviat quan una comprovació amb el mateix `client_reference` encara s'està executant.", "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 sol·licitud o el cas no està disponible per a aquest sol·licitant." }, "403": { "description": "L'emissor de la crida no té el permís de casos requerit." }, "400": { "description": "Entrades no vàlides, finalitat no admesa, contacte verificat no disponible o resposta immutable existent." }, "409": { "description": "La previsualització ha canviat o ha caducat. Torna a previsualitzar abans 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 sol·licitud o el cas no està disponible per a aquest sol·licitant." }, "403": { "description": "L'emissor de la crida no té el permís de casos requerit." } }, "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 sol·licitud o el cas no està disponible per a aquest sol·licitant." }, "403": { "description": "L'emissor de la crida no té el permís de casos requerit." } }, "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": "Quin camp s'ha d'utilitzar per ordenar els resultats.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Nombre de resultats que cal retornar per pàgina.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "L'índex inicial a partir del qual es retornen els resultats.", "schema": { "type": "integer" } } ], "tags": [ "Case Assignment" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPaginatedPolicyRevisionList" } } }, "description": "" }, "403": { "description": "Es requereix accés al cas." } }, "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": "Previsualitza un correu electrònic de nova presentació", "description": "Genera una visualització prèvia del correu electrònic que acompanyaria una nova presentació de KYC o KYB sense modificar la sessió, restablir comprovacions, ampliar la seva caducitat, executar comprovacions ni enviar cap correu. Requereix el privilegi `write:sessions` (una clau d'API amb àmbit restringit necessita accés d'escriptura a decisions) i una sessió en estat `Approved`, `Declined`, `In Review`, `Kyc Expired` o `Abandoned`. El servidor valida els passos del flux de treball seleccionats i genera la seva plantilla traduïda fixa amb el remitent verificat i la marca blanca aplicables. La sol·licitud no pot definir cap assumpte, cos del missatge ni URL d'acció.\n\n`email_address` és opcional. Sense aquest paràmetre, el correu s'envia a l'adreça de la mateixa persona: la que hagi verificat en un pas de verificació de correu electrònic del flux, o bé la facilitada a `contact_details` en crear la sessió. L'adreça que indiquis té prioritat (`recipient_source: request`). Quan no es coneix cap adreça i no en proporciones cap, `recipient` i `preview_token` són cadenes buides i no es pot enviar cap correu.\n\nLa resposta inclou el destinatari i el seu origen, el remitent, l'assumpte, l'HTML, l'idioma, els passos resolts, si confirmar l'acció envia el correu (`will_be_sent`, `not_sent_reason`) i un `preview_token` signat. `requires_user_action` és `false` quan tots els passos seleccionats s'executen sense intervenció de la persona: en aquest cas, la nova presentació finalitza pel seu compte i no s'envia cap correu (`not_sent_reason: no_user_action`).\n\nAquesta visualització prèvia no reserva l'estat de la sessió ni autoritza el lliurament del correu. Després de revisar-la, crida [Update Session Status](/ca/sessions-api/update-status) amb `new_status: Resubmitted`, els mateixos `nodes_to_resubmit` i `email_language` previsualitzats, `send_email: true`, `email_address` establert a `recipient` i `email_preview_token` establert a `preview_token`. El resguard caduca al cap de 15 minuts. Quan es proporciona un resguard, qualsevol canvi en les dades d'entrada, el contingut del missatge, el remitent o l'estat de la sessió retorna `409` abans de qualsevol modificació o enviament. Les integracions existents poden ometre el resguard. Torna a generar la visualització prèvia després d'un conflicte. Tracta la resposta com a contingut de verificació confidencial; les respostes utilitzen `Cache-Control: no-store`. Renderitza l'HTML en un marc amb sandbox, mai directament al DOM de la teva aplicació.", "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 sessió de verificació que s'ha d'actualitzar. Accepta tant IDs de sessió d'usuari (KYC) com d'empresa (KYB); el servei resol l'ID entre tots dos tipus de sessió.", "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": "Passos que es previsualitzaran, amb la mateixa validació, selecció i ordre del flux de treball que en un reenviament. Omet per seleccionar automàticament els intents registrats que necessiten reenviament.", "items": { "type": "object", "required": [ "node_id", "feature" ], "properties": { "node_id": { "type": "string", "description": "Identificador del node tal com apareix a la definició del flux de treball de la sessió (per exemple `feature_ocr`, `feature_liveness`).", "example": "feature_ocr" }, "feature": { "type": "string", "description": "Tipus de funcionalitat del node. Els àlies `ID_VERIFICATION`, `POA`, `PHONE` i `EMAIL` es normalitzen al servidor a `OCR`, `PROOF_OF_ADDRESS`, `PHONE_VERIFICATION` i `EMAIL_VERIFICATION`. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` i `KYB` superen la validació de l'esquema, però sempre es rebutgen amb l'error de regla de negoci `400` mostrat als exemples.", "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. Envia el correu electrònic a aquesta adreça en comptes de la pròpia de la persona. Sense aquest camp, el destinatari és l'adreça que la persona ha verificat al flux o bé la indicada a `contact_details`. Aquesta crida no envia cap correu electrònic.", "example": "user@example.com" }, "email_language": { "type": "string", "description": "Idioma per al correu electrònic de notificació. Accepta qualsevol cadena a nivell d'esquema; els codis no admesos tornen silenciosament a l'anglès (`en`).", "default": "en", "example": "en" } } }, "examples": { "Person's Own Address": { "summary": "Previsualitza una nova presentació d'un comprovant de domicili per a l'adreça de la mateixa persona", "value": { "nodes_to_resubmit": [ { "node_id": "feature_poa_1", "feature": "POA" } ], "email_language": "en" } }, "Named Recipient": { "summary": "Previsualitza el correu electrònic per a una adreça que indiquis", "value": { "nodes_to_resubmit": [ { "node_id": "feature_ocr", "feature": "OCR" } ], "email_address": "person@example.com", "email_language": "en" } } } } } }, "responses": { "200": { "description": "Només previsualització. La sessió no canvia i no s'envia cap correu electrònic.", "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": "L'adreça a la qual s'envia el correu electrònic. Una cadena buida quan no es coneix cap adreça per a la persona: en aquest cas no es pot enviar cap correu electrònic i `preview_token` també és buit. Envia-la com a `email_address` en confirmar.", "example": "person@example.com" }, "recipient_source": { "type": "string", "enum": [ "email_verification", "contact_details", "request", "" ], "description": "D'on prové `recipient`. `request`: el `email_address` que has proporcionat. `email_verification`: l'adreça que la persona ha verificat en un pas de verificació de correu electrònic del flux. `contact_details`: l'adreça indicada a `contact_details` en crear la sessió. Una cadena buida quan no hi ha cap adreça.", "example": "email_verification" }, "sender": { "type": "string", "description": "La capçalera `From` amb què s'envia el correu electrònic.", "example": "Example App " }, "sender_name": { "type": "string", "description": "La part del nom visible de `sender`.", "example": "Example App" }, "sender_email": { "type": "string", "format": "email", "description": "La part de l'adreça de `sender`.", "example": "no-reply@mail.example.com" }, "sender_kind": { "type": "string", "enum": [ "customer", "didit" ], "description": "`customer`: el correu electrònic s'envia des del domini de remitent verificat de la teva aplicació (marca blanca). `didit`: s'envia des del remitent propi de Didit.", "example": "customer" }, "subject": { "type": "string", "description": "La línia de l'assumpte exactament tal com s'envia.", "example": "Action Required: Complete your verification in Example App" }, "html": { "type": "string", "description": "L'HTML del correu electrònic exactament com s'envia, amb el seu logotip incrustat com a URL de dades. Renderitza'l en un frame aïllat (sandbox), mai directament al DOM de la teva aplicació.", "example": "..." }, "text": { "type": "string", "description": "El text del correu electrònic com a text pla, tal com el manté el fil de missatges de la persona, per a una previsualització compacta (l'HTML continua sent el correu electrònic que rep 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": "L'idioma en què està escrit el correu electrònic. Anglès (`en`) quan el `email_language` que has demanat no s'ofereix.", "example": "en" }, "will_be_sent": { "type": "boolean", "description": "Indica si confirmar el canvi amb `send_email: true` envia aquest correu electrònic. `false` quan s'ha definit `not_sent_reason`.", "example": true }, "not_sent_reason": { "type": "string", "nullable": true, "enum": [ "no_user_action", "no_recipient", "sandbox", null ], "description": "Per què en confirmar no s'enviaria cap correu electrònic, o `null` quan s'enviarà. `no_user_action`: tots els passos seleccionats s'executen sense la persona, de manera que el reenviament acaba sol i no s'envia cap correu electrònic. `no_recipient`: no es coneix cap adreça per a la persona i no n'has indicat cap. `sandbox`: una sessió de sandbox el destinatari de la qual no ha acceptat el lliurament de correus electrònics en sandbox, per la qual cosa l'enviament només es simula.", "example": null }, "nodes_to_resubmit": { "type": "array", "items": { "type": "object", "required": [ "node_id", "feature" ], "properties": { "node_id": { "type": "string", "description": "Identificador del node tal com apareix a la definició del flux de treball de la sessió (per exemple `feature_ocr`, `feature_liveness`).", "example": "feature_ocr" }, "feature": { "type": "string", "description": "Tipus de funcionalitat del node. Els àlies `ID_VERIFICATION`, `POA`, `PHONE` i `EMAIL` es normalitzen al servidor a `OCR`, `PROOF_OF_ADDRESS`, `PHONE_VERIFICATION` i `EMAIL_VERIFICATION`. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` i `KYB` superen la validació de l'esquema, però sempre es rebutgen amb l'error de regla de negoci `400` mostrat als exemples.", "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 com a mínim una comprovació seleccionada requereix interacció de l'usuari. Això no prediu el resultat final del flux de treball." }, "preview_token": { "type": "string", "description": "Justificant signat per a aquesta adreça electrònica exacta, vàlid durant 15 minuts. Passa'l com a `email_preview_token` a [Actualitzar l'estat de la sessió](/ca/sessions-api/update-status). Una cadena buida quan no hi ha destinatari.", "example": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } } }, "examples": { "Will Be Sent": { "summary": "Destinatari per defecte: l'adreça verificada al flux", "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": "Només se seleccionen passos del servidor, de manera que no s'envia cap correu electrònic", "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": "Sempre `no-store`: la previsualització conté contingut de verificació i no s'ha d'emmagatzemar a la memòria cau.", "schema": { "type": "string", "example": "no-store" } } } }, "400": { "description": "La sessió no es troba en un estat que aquest endpoint accepti, ja està en `Resubmitted`, els passos seleccionats no es poden reenviar o un camp no és vàlid.", "content": { "application/json": { "examples": { "Wrong Current Status": { "summary": "La sessió no es troba en un estat que aquest endpoint accepti", "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 sessió ja està en estat Resubmitted", "value": [ "The new status is the same as the current status." ] }, "Nothing To Resubmit": { "summary": "La selecció automàtica no ha trobat cap pas que requereixi reenviament", "value": { "nodes_to_resubmit": "No features found that need resubmission. All features are already approved." } }, "Invalid Email": { "summary": "email_address no és una adreça de correu electrònic", "value": { "email_address": [ "Enter a valid email address." ] } } } } } }, "401": { "description": "La clau d'API amb abast ha caducat.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Clau d'API amb abast que ha superat la data de caducitat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falten les credencials, qui fa la crida no té el privilegi `write:sessions`, la clau d'API amb abast limitat no té l'accés que necessita aquest endpoint, o el `session_id` pertany a una altra aplicació.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Falta l'x-api-key o no és vàlid", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "L'emissor de la crida no disposa de write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Clau d'API amb abast sense aquest accés", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "No existeix cap sessió de KYC o KYB amb aquest `session_id`.", "content": { "application/json": { "examples": { "Not Found": { "summary": "session_id desconegut", "value": { "detail": "Not found." } } } } } }, "429": { "description": "Els passos que s'han de reenviar són tots passos que només es processen al servidor (AML, DATABASE_VALIDATION, IP_ANALYSIS), i la sessió ja s'ha reenviat per a passos que només es processen al servidor durant els darrers 30 segons, de manera que Update Session Status rebutjaria el reenviament. Reintenta-ho després de l'interval a `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": "Recuperar regla d'encaminament", "description": "Requereix `read:cases` per a l'aplicació sol·licitada.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Èxit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRule" } } } }, "400": { "description": "Entrada no vàlida." }, "403": { "description": "Permís insuficient." }, "404": { "description": "Registre no trobat en aquesta aplicació." } }, "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": "Actualitza la regla d'encaminament", "description": "Requereix `write:cases` per a l'aplicació sol·licitada.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Èxit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRule" } } } }, "400": { "description": "Entrada no vàlida." }, "403": { "description": "Permís insuficient." }, "404": { "description": "Registre no trobat en aquesta aplicació." }, "409": { "description": "La regla d'encaminament ha canviat des de expected_version. Revisa l'última regla abans 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 sol·licitud o el cas no està disponible per a aquest sol·licitant." } }, "security": [ { "CaseRequestToken": [] } ], "description": "Accedeix a una sol·licitud de client utilitzant el seu token específic de sol·licitud. No es retornen conclusions privades del cas, dades d'identitat originals ni l'adreça del destinatari. Les sol·licituds accionables caduquen al cap de set dies. La cancel·lació o la resolució del cas invalida l'enllaç. Les respostes són immutables i romanen com a proves per a l'avaluació del revisor; mai aproven ni actualitzen una verificació d'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 sol·licitud o el cas no està disponible per a aquest sol·licitant." }, "400": { "description": "Entrades no vàlides, finalitat no admesa, contacte verificat no disponible o resposta immutable existent." }, "409": { "description": "La previsualització ha canviat o ha caducat. Torna a previsualitzar abans de confirmar." } }, "security": [ { "CaseRequestToken": [] } ], "description": "Accedeix a una sol·licitud de client utilitzant el seu token específic de sol·licitud. No es retornen conclusions privades del cas, dades d'identitat originals ni l'adreça del destinatari. Les sol·licituds accionables caduquen al cap de set dies. La cancel·lació o la resolució del cas invalida l'enllaç. Les respostes són immutables i romanen com a proves per a l'avaluació del revisor; mai aproven ni actualitzen una verificació d'origen." } }, "/v3/fraud/checks/plan/": { "post": { "operationId": "plan_create", "x-didit-sdk": { "resource": "fraud_checks", "method": "plan", "auth": "api_key", "server": true }, "description": "Valida les comprovacions seleccionades i n'estima el preu sense executar-les, crear cap sessió ni facturar.", "summary": "Planificar un control de frau", "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": "Llista les regles d'encaminament", "description": "Requereix `list:cases` per a l'aplicació sol·licitada.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "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": "Èxit", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseRoutingRule" } }, "count": { "type": "integer", "description": "Recompte de coincidències, limitat a 100. Segueix next per continuar més enllà del límit." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true } } } } } }, "400": { "description": "Entrada no vàlida." }, "403": { "description": "Permís insuficient." } }, "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": "Crea una regla d'encaminament", "description": "Requereix `write:cases` per a l'aplicació sol·licitada. Defineix publish=false per crear un esborrany no publicat; publicar crea la seva primera versió activa. En descartar un esborrany que mai s'ha publicat, s'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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "responses": { "201": { "description": "Èxit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRule" } } } }, "400": { "description": "Entrada no vàlida." }, "403": { "description": "Permís insuficient." } }, "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": "Es requereix accés al cas." }, "409": { "description": "La versió publicada o la revisió de l'esborrany ha canviat. Recarrega abans 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": "La versió publicada o la revisió d'esborrany desada ha canviat. Recarrega abans de reintentar." }, "403": { "description": "Manca el permís de cas requerit." } }, "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 sol·licitud o el cas no està disponible per a aquest sol·licitant." }, "403": { "description": "L'emissor de la crida no té el permís de casos requerit." }, "400": { "description": "Entrades no vàlides, finalitat no admesa, contacte verificat no disponible o resposta immutable existent." }, "409": { "description": "La previsualització ha canviat o ha caducat. Torna a previsualitzar abans de confirmar." } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Genera el correu electrònic de producció sense enviar ni modificar el cas. Retorna exactament el destinatari, remitent, assumpte, cos i un preview_token signat. Envia els mateixos contact_id, purpose, language, request_id, expires_at i preview_token per confirmar-ho en un termini de 15 minuts.", "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": "Llista els rebuts d'accions del subjecte, començant pels més recents, amb un màxim de 20 resultats per pàgina. Fes servir next_offset per a la pàgina següent. El text de la nota d'entrada no s'exposa a l'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": "Elimina la teva nota de xarxa", "description": "Requereix write:networks i ser l'autor autenticat de la nota. L'eliminació és irreversible. Les dades del compte connectat i de la verificació no es veuen afectades.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la xarxa." }, { "name": "note_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Token d'accés d'usuari de la consola en format Bearer ." } ], "responses": { "204": { "description": "Nota eliminada." }, "401": { "description": "Cal autenticació." }, "403": { "description": "Falta el permís o l'accés a Networks." }, "404": { "description": "La xarxa o la nota no és visible per a aquesta aplicació." } }, "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 només aquesta acció de subjecte fallida mitjançant les seves entrades desades. Es comprova el permís d'escriptura actual. Les accions aplicades retornen el seu justificant sense tornar-se a executar. El tancament del cas és independent.", "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": "Manca el permís de cas requerit." } }, "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": "La versió publicada o la revisió d'esborrany desada ha canviat. Recarrega abans de reintentar." }, "403": { "description": "Manca el permís de cas requerit." } }, "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": "Sense cos de resposta" }, "409": { "description": "La versió publicada o la revisió d'esborrany desada ha canviat. Recarrega abans de reintentar." }, "403": { "description": "Manca el permís de cas requerit." } }, "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": "Recuperar equip de revisió", "description": "Requereix `read:cases` per a l'aplicació sol·licitada.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Èxit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeam" } } } }, "400": { "description": "Entrada no vàlida." }, "403": { "description": "Permís insuficient." }, "404": { "description": "Registre no trobat en aquesta aplicació." } }, "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": "Actualitza l'equip de revisió", "description": "Requereix `write:cases` per a l'aplicació sol·licitada.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Èxit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeam" } } } }, "400": { "description": "Entrada no vàlida." }, "403": { "description": "Permís insuficient." }, "404": { "description": "Registre no trobat en aquesta aplicació." } }, "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": "Descarrega un informe de proves de xarxa", "description": "Descarrega un PDF de la xarxa actual de l'organització, les seves connexions de compte observades, referències de senyals i estat de revisió. Requereix read:networks. La intel·ligència global i les notes privades dels analistes no s'inclouen. Cada llista de comptes i senyals està limitada a 500 entrades i l'informe indica quan està incomplet. La sol·licitud no canvia l'estat de la xarxa. Els errors es retornen com a JSON.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la xarxa." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Token d'accés d'usuari de la consola en format Bearer ." } ], "responses": { "200": { "description": "Informe d'evidències de la xarxa. Cache-Control: no-store.", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Cal autenticació." }, "403": { "description": "Falta el permís o l'accés a Networks." }, "404": { "description": "La xarxa o la nota no és visible per a aquesta aplicació." } }, "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": "Llista les notes de xarxa privada", "description": "Els usuaris de la consola amb read:networks poden llegir notes sobre una xarxa visible per a l'aplicació. Les notes romanen dins de l'organització i no s'aporten a la intel·ligència compartida. Les notes més recents apareixen primer.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la xarxa." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Token d'accés d'usuari de la consola en format 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 notes. El recompte està limitat a 100; fes servir next per 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": "Cal autenticació." }, "403": { "description": "Falta el permís o l'accés a Networks." }, "404": { "description": "La xarxa o la nota no és visible per a aquesta aplicació." } }, "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": "Afegeix una nota de xarxa privada", "description": "Requereix un usuari de la consola amb write:networks. L'autor s'assigna a partir de l'usuari autenticat. Proporciona un nou UUID aleatori a client_reference per a cada nota; reintenta amb el mateix cos i referència després d'una resposta incerta per evitar duplicats. Si reutilitzes una referència per a un altre cos, autor o xarxa, es retorna 409. Les notes segueixen la investigació supervivent quan es fusionen xarxes.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de la xarxa." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Token d'accés d'usuari de la consola en format 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 desada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkNote" } } } }, "200": { "description": "Nota privada desada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkNote" } } } }, "400": { "description": "Nota no vàlida o en blanc." }, "409": { "description": "La referència ja s'ha utilitzat per a una altra nota." }, "401": { "description": "Cal autenticació." }, "403": { "description": "Falta el permís o l'accés a Networks." }, "404": { "description": "La xarxa o la nota no és visible per a aquesta aplicació." } }, "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": "Es requereix accés al cas." } }, "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": "Es requereix accés al cas." }, "409": { "description": "La versió publicada o la revisió de l'esborrany ha canviat. Recarrega abans 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": "Sense cos de resposta" }, "403": { "description": "Es requereix accés al cas." }, "409": { "description": "La versió publicada o la revisió de l'esborrany ha canviat. Recarrega abans 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 els casos existents per a un subjecte o un registre d'origen del qual ets titular abans de crear un cas manualment. Es retornen tant les investigacions obertes com les resoltes. Cada pàgina conté com a màxim 20 casos; utilitza next_offset per sol·licitar una altra 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": "Encaminament del cas de prova", "description": "Requereix `read:cases` per a l'aplicació sol·licitada. Avalua les regles actuals o un esborrany proporcionat en funció de l'accés, la disponibilitat, les habilitats i la capacitat actuals dels revisors. No desa l'esborrany ni reserva capacitat de revisor.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "responses": { "200": { "description": "Èxit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingPreview" } } } }, "400": { "description": "Entrada no vàlida." }, "403": { "description": "Permís insuficient." } }, "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": "Llista els revisors de casos elegibles", "description": "Requereix `list:cases` per a l'aplicació sol·licitada.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "responses": { "200": { "description": "Èxit", "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": "Permís insuficient." }, "503": { "description": "No s'ha pogut verificar l'accés del revisor. Torna-ho a provar més tard." } }, "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": "Quin camp s'ha d'utilitzar per ordenar els resultats.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Nombre de resultats que cal retornar per pàgina.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "L'índex inicial a partir del qual es retornen els resultats.", "schema": { "type": "integer" } } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationPaginatedPolicyRevisionList" } } }, "description": "" }, "403": { "description": "Manca el permís de cas requerit." } }, "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": "Descarrega un document signat", "description": "Descarrega el PDF signat d'un document d'un pas de Signatura electrònica. Utilitza la ruta `signed_file` de `signatures[].documents[]` a la decisió. El PDF conté el document que es va mostrar al signatari amb els valors dels seus camps estampats i la pàgina de proves (tret que `signature_evidence_page` estigui desactivat). Un PDF avançat (AES) també inclou la signatura PAdES amb la seva marca de temps; un PDF simple no té signatura digital, segell ni marca de temps. Didit comprova el fitxer amb `sha256_signed` abans de retornar-lo.\n\nFunciona per a sessions de Verificació d'usuaris (KYC) i de Verificació d'empreses (KYB). Requereix `read:sessions`; la teva clau d'API funciona. Consulta l'[Informe de Signatura electrònica](/ca/core-technology/electronic-signature/report-electronic-signature#descarregar-els-documents-signats).", "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 sessió de Verificació d'usuaris (KYC) o Verificació d'empreses (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "El pas de Signatura electrònica: `node_id` de l'element a `signatures[]`.", "schema": { "type": "string", "example": "feature_signature" } }, { "name": "documentId", "in": "path", "required": true, "description": "`id` del document a `signatures[].documents[]`.", "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "El PDF signat.", "headers": { "Content-Disposition": { "description": "Fitxer adjunt amb el nom del fitxer.", "schema": { "type": "string", "example": "attachment; filename=\"agreement-signed.pdf\"" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Falten les credencials, o la credencial no pot llegir aquesta sessió. Si falta la clau, es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "You do not have permission to perform this action." } } } }, "404": { "description": "Cap document signat no coincideix: la sessió, el pas o el document no existeixen, s'han suprimit o encara no s'han signat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Not signed yet": { "summary": "El signant no ha signat", "value": { "code": "signature_not_signed", "detail": "signature_not_signed" } }, "Unknown document": { "summary": "No existeix aquest document en aquest pas", "value": { "code": "signature_not_found", "detail": "signature_not_found" } } } } } }, "409": { "description": "El fitxer emmagatzemat ja no coincideix amb el seu SHA-256 registrat. No es retorna res.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Changed file": { "summary": "El fitxer emmagatzemat no coincideix amb el seu 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": "Descarrega les proves de la signatura", "description": "Descarrega el PDF de proves d'un signatari: el nivell i el format, el signatari, l'adreça IP, cada document amb el seu SHA-256 original i els valors dels camps, i el SHA-256 de cada fitxer signat; a més, per a una signatura avançada (AES), la sessió d'identitat verificada, la confirmació del codi, el certificat i la marca de temps. Utilitza la ruta `evidence_file` de l'element del signatari a `signatures[]`.\n\nPassa sempre `signature_id` quan un pas de Verificació d'empreses (KYB) tingui diversos signataris: sense aquest paràmetre, la ruta tria un dels signataris del pas. Requereix `read:sessions`; la teva clau d'API funciona.", "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 sessió de Verificació d'usuaris (KYC) o Verificació d'empreses (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "El pas de Signatura electrònica: `node_id` de l'element a `signatures[]`.", "schema": { "type": "string", "example": "feature_signature" } }, { "name": "signature_id", "in": "query", "required": false, "description": "`id` de l'element del signatari a `signatures[]`.", "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "El PDF d'evidència.", "headers": { "Content-Disposition": { "description": "Fitxer adjunt amb el nom del fitxer.", "schema": { "type": "string", "example": "attachment; filename=\"signature-evidence.pdf\"" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Falten les credencials, o la credencial no pot llegir aquesta sessió. Si falta la clau, es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "You do not have permission to perform this action." } } } }, "404": { "description": "Cap evidència coincideix: la sessió, el pas o el signant no existeix, s'ha suprimit o no ha signat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Not signed yet": { "summary": "El signant no ha signat", "value": { "code": "signature_not_signed", "detail": "signature_not_signed" } }, "Unknown signer": { "summary": "No existeix aquesta signatura en aquest pas", "value": { "code": "signature_not_found", "detail": "signature_not_found" } } } } } }, "409": { "description": "El fitxer emmagatzemat ja no coincideix amb el seu SHA-256 registrat. No es retorna res.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Changed file": { "summary": "El fitxer emmagatzemat no coincideix amb el seu 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": "Descarrega una imatge de signatura", "description": "Descarrega la signatura o les inicials que un signatari ha aplicat a un camp, com a PNG. Utilitza la `image_url` del camp a `signatures[].documents[].fields[]`. Requereix `read:sessions`; la teva clau d'API funciona.", "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 sessió de Verificació d'usuaris (KYC) o Verificació d'empreses (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "El pas de Signatura electrònica: `node_id` de l'element a `signatures[]`.", "schema": { "type": "string", "example": "feature_signature" } }, { "name": "fieldId", "in": "path", "required": true, "description": "El camp a la còpia d'aquest signant, com ara a l'`image_url` del camp.", "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "La imatge.", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "La imatge emmagatzemada ja no coincideix amb el seu SHA-256 registrat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "example": { "code": "signature_document_changed", "detail": "signature_document_changed" } } } }, "403": { "description": "Falten les credencials, o la credencial no pot llegir aquesta sessió. Si falta la clau, es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "You do not have permission to perform this action." } } } }, "404": { "description": "Cap imatge coincideix: la sessió, el pas o el camp no existeix, s'ha suprimit o no té signatura ni inicials aplicades.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Unknown field": { "summary": "No existeix aquest camp", "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": "Torna a validar les signatures", "description": "Torna a comprovar els documents signats d'un pas de Signatura electrònica. Didit torna a llegir cada PDF signat, en comprova el SHA-256 i, en el cas d'una signatura avançada (AES), valida la signatura PAdES, el certificat, les dades de revocació i la marca de temps (una signatura simple no té signatura digital, de manera que només es comprova la integritat del fitxer), després desa el resultat a la `validation` de cada signant i retorna els elements actualitzats. No es torna a signar res. Envia `signature_id` per comprovar un sol signant; sense aquest paràmetre, es comproven tots els signants del pas i la crida falla si algun d'ells encara no ha signat.\n\nRequereix `write:sessions`; la teva clau d'API funciona. A la consola és el botó **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 sessió de Verificació d'usuaris (KYC) o Verificació d'empreses (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "El pas de Signatura electrònica: `node_id` de l'element a `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` de l'element d'un signatari a `signatures[]`." } } }, "example": { "signature_id": "0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10" } } } }, "responses": { "200": { "description": "Els signataris comprovats, amb la seva `validation` actualitzada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "signatures": { "type": "array", "items": { "$ref": "#/components/schemas/SignatureResult" } } } } } } }, "400": { "description": "Un PDF signat emmagatzemat ja no coincideix amb el SHA-256 registrat quan es va signar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Document changed": { "summary": "Un fitxer signat ja no coincideix amb el seu hash", "value": { "code": "signature_document_changed", "detail": "signature_document_changed" } } } } } }, "403": { "description": "Falten les credencials, o la credencial no pot llegir aquesta sessió. Si falta la clau, es retorna `403`; una clau incorrecta, revocada o caducada retorna `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "You do not have permission to perform this action." } } } }, "404": { "description": "Cap signatura no coincideix: la sessió, el pas o el signatari no existeixen o s'han suprimit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Unknown signer": { "summary": "No existeix aquesta signatura en aquest pas", "value": { "code": "signature_not_found", "detail": "signature_not_found" } } } } } }, "409": { "description": "Un signant del pas encara no ha signat, de manera que no hi ha res a validar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Not signed": { "summary": "Un signant encara no ha signat", "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": "Actualitzar un document de Document AI", "description": "Corregeix els camps que Document AI ha extret d'un document pujat, defineix el seu estat de revisió, o ambdues coses, en una sessió de KYC o KYB. `extracted_data` ha de ser un objecte JSON i es fusiona clau per clau: una clau que enviïs substitueix el valor emmagatzemat (una clau enviada com a `null` s'emmagatzema com a `null`) i les claus que ometis mantenen els seus valors. L'estat del document alimenta el resultat de Document AI del seu node de flux de treball en la decisió de la sessió; l'estat de la sessió en si no es recalcula. Cada crida satisfactòria, inclosa una que no canviï res, envia un [webhook](https://docs.didit.me/ca/integration/webhooks) `data.updated` amb l'activador `manual_review`. Una clau d'API amb àmbit necessita `decisions: write`; consulta [Document AI](https://docs.didit.me/ca/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 sessió de verificació (el `session_id` retornat per `POST /v3/session/`). Accepta tant IDs de sessió de Verificació d'usuaris (KYC) com de Verificació d'empreses (KYB): el servidor resol l'ID entre tots dos tipus de sessió. Ha de ser un UUID ben format; un valor mal format no coincideix amb la ruta i retorna un `404` en HTML.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "documentUuid", "in": "path", "required": true, "description": "UUID del document de Document AI (`document_ai_documents[].items[].uuid` a `GET /v3/session/{sessionId}/decision/`). Ha de pertànyer a la sessió de 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": "Claus de camp (les claus que has configurat per al document) i els seus valors corregits. Ha de ser un objecte JSON; es fusiona clau per clau amb les dades emmagatzemades. Omet-lo en comptes d'enviar `null`, que retorna `400`.", "example": { "invoice_number": "INV-2026-0042" } }, "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Not Finished" ], "description": "Nou estat de revisió del document.", "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": "Document actualitzat. Retorna el document després de la fusió.", "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 document." }, "document_key": { "type": "string", "description": "El document configurat al qual correspon aquesta càrrega." }, "original_filename": { "type": "string", "nullable": true, "description": "Nom de fitxer amb el qual s'ha penjat el document." }, "file_url": { "type": "string", "nullable": true, "description": "Ruta d'emmagatzematge del fitxer carregat. No és un enllaç de descàrrega: llegeix el camp presignat `file_url` de la decisió de la sessió per descarregar el fitxer." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estat de revisió del document." }, "extracted_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Tots els camps extrets després de la fusió, indexats per clau de camp." } } }, "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ó, comprovat abans de cercar el document: `status` no és un dels valors permesos, o s'ha enviat `extracted_data` com a `null`.", "content": { "application/json": { "examples": { "Invalid status": { "summary": "status no és a l'enumeració", "value": { "status": [ "\"Rejected\" is not a valid choice." ] } }, "Null extracted_data": { "summary": "extracted_data és null", "value": { "extracted_data": [ "This field may not be null." ] } } } } } }, "401": { "description": "La clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna `401`: una clau absent, no vàlida o revocada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "summary": "La data de caducitat de la clau ha passat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallada d'autenticació o d'autorització. Si falta la clau es retorna `403`, igual que amb una clau d'una altra aplicació, una clau amb àmbit sense el permís que necessita aquest endpoint o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau; una clau incorrecta, revocada o caducada retorna `401`. Distingeix-les pel camp `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta la capçalera x-api-key, o la clau ha fallat la validació", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clau vàlida que pertany a una aplicació diferent de la de la sessió", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clau amb abast li manca el permís d'escriptura de decisions", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Sol·licitud des de fora de la llista d'adreces IP permeses de la clau", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sessió no existeix, s'ha suprimit o queda fora dels límits d'una clau amb abast limitat, o cap document actual amb aquest UUID li pertany. La cerca de la sessió s'executa abans de comprovar les credencials, de manera que un `sessionId` desconegut retorna `404` fins i tot sense una clau vàlida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Unknown session": { "summary": "No existeix cap sessió amb aquest ID, o s'ha suprimit", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "La sessió queda fora dels límits d'una clau amb abast limitat (també es retorna per a una sessió suprimida fa uns moments)", "value": { "detail": "Session not found." } }, "Unknown document": { "summary": "documentUuid no pertany a la sessió", "value": { "detail": "Document AI document not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència: 300 sol·licituds d'escriptura (POST, PATCH, DELETE) per minut per clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar; les capçaleres `X-RateLimit-*` mostren el pressupost restant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Rate limited": { "summary": "Pressupost per al minut actual esgotat", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/aml/dataset-freshness/": { "get": { "summary": "Obtenir l'actualitat del conjunt de dades AML", "description": "Informa de com estan d'actualitzats els conjunts de dades que hi ha darrere del cribratge AML, per família de fonts (`sanctions`, `pep`, `warnings`, `adverse_media`), com a prova d'auditoria per al [monitoratge AML continu](https://docs.didit.me/ca/core-technology/aml-screening/continuous-monitoring-aml-screening#demostrar-que-el-monitoratge-s’ha-executat). La resposta és d'àmbit de plataforma: sense sessió a la ruta, sense dades de clients al cos, la mateixa resposta per a cada aplicació.\n\nSempre `200` per a una clau acceptada. Comprova primer `availability`: quan no és `available`, `dataset_freshness` és `null`. Les dates mai no s'estimen: una família els conjunts de dades de la qual no hagin informat de cap data no apareix a `sources`, i una família on només alguns conjunts de dades n'hagin informat té `oldest_updated_at: null`. Les lectures es prenen mentre s'executa el monitoratge continu, no a cada crida; `captured_at` n'indica el moment.\n\nUna clau d'API amb abast limitat necessita `sessions: read`; una clau limitada a determinats fluxos de treball o a sessions aprovades no pot cridar aquest endpoint. No es factura res.", "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": "L'última lectura de l'actualitat del conjunt de dades, o `null` amb el motiu.", "content": { "application/json": { "schema": { "type": "object", "required": [ "dataset_freshness", "availability" ], "properties": { "dataset_freshness": { "allOf": [ { "$ref": "#/components/schemas/AMLDatasetFreshness" } ], "nullable": true, "description": "L'última lectura, o `null` quan `availability` no és `available`." }, "availability": { "type": "string", "enum": [ "available", "not_configured", "not_yet_collected" ], "description": "`available` quan existeix una lectura; `not_configured` quan les dates del conjunt de dades no es recullen en aquest entorn; `not_yet_collected` quan la recollida està configurada però encara no existeix cap 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 clau d'API ha caducat. Només pot caducar una clau creada amb data de caducitat; després d'aquesta data, cada sol·licitud que s'hi faci rep una resposta `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Si falta la clau, es rep el missatge genèric; una clau incorrecta, revocada o caducada rep un `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 sol·licituds GET per minut amb aquesta clau d'API. Espera el nombre de segons indicat a `Retry-After` i torna-ho a provar.", "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": "Segons fins que es restableixi la finestra actual d'un minut.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses per minut en aquest pressupost.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Temps Unix en què es reinicia la finestra.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/lists/": { "get": { "summary": "Llista les llistes", "description": "Retorna les llistes de l'aplicació, les més recents primer: les llistes del sistema que Didit proporciona (una llista de bloqueig per tipus d'entrada, la llista personalitzada de **High Risk Countries** i qualsevol llista d'autorització del sistema) i les llistes d'autorització i personalitzades que hagis creat. Filtra amb `list_type` i `entry_type`; les llistes suprimides no apareixen mai. Els resultats estan paginats amb `limit` i `offset`. Una clau d'API amb àmbit requereix `workflows: read`. Consulta [Llistes](https://docs.didit.me/ca/management-api/lists/overview) per saber què fa cada tipus de llista.", "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": "Només llistes d'aquest tipus.", "schema": { "type": "string", "enum": [ "blocklist", "allowlist", "custom" ] } }, { "name": "entry_type", "in": "query", "required": false, "description": "Només llistes d'aquest tipus d'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": "Criteri d'ordenació: `-created_at` (del més recent al més antic, per defecte) o `created_at` (del més antic al més recent).", "schema": { "type": "string", "enum": [ "-created_at", "created_at" ], "default": "-created_at" } }, { "name": "limit", "in": "query", "required": false, "description": "Mida de la pàgina. Per defecte és 50. Un valor superior a 1000000 retorna `400`; un zero, un valor negatiu o un valor no numèric torna al valor per defecte de 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 } }, { "name": "offset", "in": "query", "required": false, "description": "Índex basat en zero del primer element a retornar. És preferible seguir `next`. Un valor superior a 1000000 retorna `400`; un valor negatiu o no numèric torna a 0 per defecte.", "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 llistes.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Nombre total de llistes que coincideixen amb els filtres." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la pàgina següent, o `null` a l'última pàgina." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la pàgina anterior, o `null` a 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àmetre de consulta no és vàlid.", "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 clau d'API amb abast ha caducat. Altres fallades d'autenticació retornen `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), o una clau d'API amb àmbit no té `workflows: read` o s'utilitza des d'una adreça fora de la seva llista d'admesos.", "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": "S'ha superat el límit compartit de lectura de 600 sol·licituds per minut per clau d'API. Respecta `Retry-After` abans 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": "Crea una llista", "description": "Crea una llista d'admesos o una llista personalitzada a l'aplicació a la qual pertany la clau d'API. Les llistes de bloqueig no es poden crear: Didit proveeix una llista de bloqueig del sistema per tipus d'entrada, i s'hi afegeixen elements amb [Crea una entrada de llista](https://docs.didit.me/ca/management-api/lists/create-entry). `entry_type` no pot canviar després de la creació i determina com es validen i coincideixen els valors de les entrades. Les entrades de la llista d'admesos marquen els elements coincidents com de confiança (per exemple, una llista d'admesos de cares omet l'acció de duplicació facial) i mai no anul·len una coincidència amb la llista de bloqueig; fes referència a qualsevol llista des d'una condició de regla de flux de treball o de transacció amb `value_type: \"list\"`. Una clau d'API amb àmbit necessita `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": "Nom de la llista. Ha de ser diferent del nom de qualsevol altra llista de l'aplicació, incloses les llistes del sistema." }, "description": { "type": "string", "default": "", "description": "Descripció opcional en text lliure." }, "list_type": { "type": "string", "enum": [ "allowlist", "custom" ], "description": "`allowlist` o `custom`. `blocklist` es rebutja amb `400`." }, "entry_type": { "type": "string", "enum": [ "face", "document", "phone", "email", "ip_address", "device_fingerprint", "wallet_address", "bank_account", "country", "user", "business", "key" ], "description": "Què conté la llista: `face`, `document` (número de document), `phone`, `email`, `ip_address` (adreça o rang CIDR), `device_fingerprint`, `wallet_address`, `bank_account`, `country` (ISO 3166-1 alpha-3), `user` o `business` (el teu `vendor_data`), o `key` (qualsevol cadena). Decideix com es validen i es comparen els valors de les entrades. No es pot modificar posteriorment." } } }, "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": "S'ha creat la llista.", "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 cos no és vàlid.", "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 clau d'API amb abast ha caducat. Altres fallades d'autenticació retornen `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), o una clau d'API amb àmbit no té `workflows: write` o s'utilitza des d'una adreça IP fora de la seva llista d'admesos.", "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": "Obtenir una llista", "description": "Retorna una llista de l'aplicació amb el seu recompte d'entrades i quan es va afegir la seva entrada més recent. Una llista d'una altra aplicació, o una que s'hagi eliminat, retorna `404`. Això només retorna la llista: llegeix els seus valors amb [Llistar entrades de la llista](https://docs.didit.me/ca/management-api/lists/list-entries). Una clau d'API amb àmbit restringit requereix `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 llista, tal com el retorna Llistar llistes o Crear una llista.", "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 llista.", "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 clau d'API amb abast ha caducat. Altres fallades d'autenticació retornen `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), o una clau d'API amb àmbit no té `workflows: read` o s'utilitza des d'una adreça fora de la seva llista d'admesos.", "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 existeix cap llista amb aquest UUID a l'aplicació de la clau d'API, o s'ha suprimit.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No List matches the given query." } } } } } }, "429": { "description": "S'ha superat el límit compartit de lectura de 600 sol·licituds per minut per clau d'API. Respecta `Retry-After` abans 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": "Actualitzar una llista", "description": "Reanomena una llista o en modifica la descripció. Només es llegeixen `name` i `description`; qualsevol altre camp s'ignora, de manera que `list_type` i `entry_type` mantenen els valors amb què es van crear. Les llistes de sistema no es poden modificar i retornen `400`. La resposta conté només `name` i `description`: crida [Obtenir una llista](https://docs.didit.me/ca/management-api/lists/get) per obtenir la llista completa. Una clau d'API amb abast limitat necessita `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 llista, tal com el retorna Llistar llistes o Crear una llista.", "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": "Nou nom. Ha de ser diferent del nom de qualsevol altra llista de l'aplicació." }, "description": { "type": "string", "description": "Nova descripció. Envia una cadena buida per esborrar-la." } } }, "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": "S'ha actualitzat la llista. Només es retornen els camps editables.", "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string", "description": "El nom de la llista després de l'actualització." }, "description": { "type": "string", "description": "La descripció de la llista després de l'actualització." } } }, "examples": { "Renamed": { "value": { "name": "Trusted office and VPN IPs", "description": "Office egress ranges" } } } } } }, "400": { "description": "La llista és una llista de sistema, o el cos no és vàlid.", "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 clau d'API amb abast ha caducat. Altres fallades d'autenticació retornen `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), o una clau d'API amb àmbit no té `workflows: write` o s'utilitza des d'una adreça IP fora de la seva llista d'admesos.", "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 existeix cap llista amb aquest UUID a l'aplicació de la clau d'API, o s'ha suprimit.", "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 llista", "description": "Elimina una llista permesa o personalitzada juntament amb les seves entrades. L'eliminació és irreversible: la llista i les seves entrades ja no apareixen en cap lectura, i les condicions de regles de transaccions i de fluxos de treball que facin referència a la llista l'avaluaran a partir d'aleshores com una llista buida. Les sessions i transaccions ja avaluades mantenen els seus resultats, i el nom es pot reutilitzar per a una nova llista. Les llistes del sistema no es poden eliminar i retornen `400`; per buidar-ne una, [elimina les seves entrades](https://docs.didit.me/ca/management-api/lists/delete-entry). Una clau d'API amb àmbit requereix `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 llista, tal com el retorna Llistar llistes o Crear una llista.", "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": "S'han suprimit la llista i les seves entrades. Sense cos." }, "400": { "description": "La llista és una llista de sistema.", "content": { "application/json": { "examples": { "System list": { "value": { "detail": "System lists cannot be deleted." } } } } } }, "401": { "description": "La clau d'API amb abast ha caducat. Altres fallades d'autenticació retornen `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), o una clau d'API amb àmbit no té `workflows: write` o s'utilitza des d'una adreça IP fora de la seva llista d'admesos.", "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 existeix cap llista amb aquest UUID a l'aplicació de la clau d'API, o ja s'havia suprimit.", "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": "Llista les entrades de la llista", "description": "Retorna les entrades actuals d'una llista, les més recents primer. `search` cerca coincidències amb part del `value` o `display_label` d'una entrada sense distingir majúscules de minúscules, i `reference_session_id` limita els resultats a les entrades preses d'una sessió de verificació de persona. Les URL d'imatge a `metadata` són URL signades de curta durada que s'emeten de nou a cada crida; una clau d'API amb àmbit sense `media: read` rep `null` al seu lloc. Una clau d'API amb àmbit requereix `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 llista, tal com el retorna Llistar llistes o Crear una llista.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "search", "in": "query", "required": false, "description": "Text que no distingeix majúscules de minúscules que ha de contenir el `value` o el `display_label` de l'entrada.", "schema": { "type": "string" } }, { "name": "reference_session_id", "in": "query", "required": false, "description": "Només les entrades extretes d'aquesta sessió de verificació de persona, per exemple per veure quines de les seves cares ja estan llistades.", "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "description": "Mida de la pàgina. Per defecte és 50. Un valor superior a 1000000 retorna `400`; un zero, un valor negatiu o un valor no numèric torna al valor per defecte de 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 } }, { "name": "offset", "in": "query", "required": false, "description": "Índex basat en zero del primer element a retornar. És preferible seguir `next`. Un valor superior a 1000000 retorna `400`; un valor negatiu o no numèric torna a 0 per defecte.", "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 d'entrades, les més recents primer.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Nombre total d'entrades que coincideixen amb els filtres." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la pàgina següent, o `null` a l'última pàgina." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la pàgina anterior, o `null` a 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àmetre de consulta no és vàlid.", "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 clau d'API amb abast ha caducat. Altres fallades d'autenticació retornen `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), o una clau d'API amb àmbit no té `workflows: read` o s'utilitza des d'una adreça fora de la seva llista d'admesos.", "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 existeix cap llista amb aquest UUID a l'aplicació de la clau d'API, o s'ha suprimit.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "List not found." } } } } } }, "429": { "description": "S'ha superat el límit compartit de lectura de 600 sol·licituds per minut per clau d'API. Respecta `Retry-After` abans 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": "Crea una entrada de llista", "description": "Afegeix una entrada a una llista, d'una de tres maneres: per `value`; des d'una sessió de verificació amb `reference_session_id`, on Didit llegeix el valor del registre més recent de la sessió del tipus d'entrada de la llista i hi enllaça l'entrada; o per `value` amb un `reference_object_uuid` i `metadata.reference_type` que apunten a una transacció, usuari o empresa. A les llistes de bloqueig del sistema de cares, documents, telèfons i correus electrònics, el registre llegit de la sessió també es marca com a bloquejat a la llista de bloqueig, de manera que les noves sessions coincidents es rebutgen; a les llistes de bloqueig del sistema d'usuaris i empreses, els usuaris o empreses coincidents s'estableixen a `BLOCKED`. Les sessions i transaccions que ja han finalitzat no es modifiquen. Una clau d'API amb abast necessita `workflows: write`. Consulta [Crea una entrada de llista](https://docs.didit.me/ca/management-api/lists/create-entry) per a cada mode.", "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 llista a la qual cal afegir. Per a una cara que només tinguis com a imatge, fes servir Pujar una cara a una llista.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Envia `value`, `reference_session_id`, o tots dos. Els camps aplicables depenen del valor de `entry_type` de la llista.", "properties": { "value": { "type": "string", "description": "El valor que s'ha d'incloure a la llista, validat contra l'`entry_type` de la llista: `email` una adreça de correu electrònic vàlida; `phone` un número internacional vàlid, emmagatzemat en E.164; `ip_address` una adreça IP o rang CIDR (per exemple `10.0.0.0/8`); `device_fingerprint` almenys 8 caràcters entre lletres, dígits, `-`, `_`, `:` i `.` (una llista de bloqueig rebutja una empremta que diversos dispositius diferents hagin reportat); `country` un codi ISO 3166-1 alpha-2 o alpha-3, emmagatzemat com a alpha-3; `user` i `business` el `vendor_data`; qualsevol altre tipus una cadena no buida. S'emmagatzema en minúscules excepte els números de telèfon i els codis de país, i una llista conté cada valor una sola vegada (sense distingir majúscules de minúscules). Obligatori tret que s'enviï `reference_session_id`; s'ha de deixar buit amb un `face_image_source` de captura de documents." }, "reference_session_id": { "type": "string", "format": "uuid", "description": "Una sessió de verificació de persona o empresa de la teva aplicació d'on extreure el valor. Didit llegeix el registre més recent de la sessió del tipus d'entrada de la llista (`face`, `document`, `phone`, `email`, `ip_address` o `device_fingerprint`), enllaça l'entrada a la sessió i a aquest registre, i emplena `display_label` i `metadata` per als documents. Per a una llista de bloqueig de `device_fingerprint`, es rebutja una sessió que només té una empremta digital de classe de dispositiu o que s'ha completat en més d'un dispositiu: envia l'empremta digital exacta com a `value`. Per a altres tipus d'entrada, o quan la sessió no té cap registre d'aquest tipus, envia també `value`; el teu `value` s'emmagatzema i l'entrada continua enllaçada a la sessió." }, "reference_object_uuid": { "type": "string", "format": "uuid", "description": "UUID del registre que representa l'entrada quan no prové d'una sessió: un UUID de transacció, o el `didit_internal_id` d'un usuari o empresa. Emparella'l amb `metadata.reference_type`. Se substitueix pel registre de la sessió quan `reference_session_id` en proporciona un." }, "face_image_source": { "type": "string", "enum": [ "liveness", "front_image_camera_front", "back_image_camera_front" ], "default": "liveness", "description": "Llistes facials amb `reference_session_id`: de quina de les imatges de la sessió s'extreu la cara. `liveness` (per defecte) és la selfie de prova de vida. `front_image_camera_front` i `back_image_camera_front` són les selfies que la càmera frontal va fer mentre l'usuari fotografiava l'anvers o el revers del seu document: acceptades només a la llista de bloqueig facial del sistema, amb `reference_session_id` i un `value` buit. Cada selfie es pot afegir un cop i ha de mostrar una única cara clara." }, "reference_node_id": { "type": "string", "nullable": true, "maxLength": 100, "description": "Amb un `face_image_source` de captura de documents: el node de verificació d'identitat la selfie del qual s'ha d'utilitzar, per a fluxos de treball amb més d'un node. Per defecte, la verificació d'identitat més recent que conté aquesta imatge. Es rebutja amb `liveness`." }, "display_label": { "type": "string", "maxLength": 512, "description": "Etiqueta fàcil de llegir. Quan està buida, Didit en dedueix una a partir de la sessió quan és possible (per exemple, el nom del titular i el número de document)." }, "comment": { "type": "string", "description": "Nota de text lliure, com ara el motiu de la inclusió a la llista." }, "metadata": { "type": "object", "additionalProperties": true, "description": "JSON de format lliure emmagatzemat amb l'entrada i retornat tal com s'ha desat. Fes servir `reference_type` i `reference_id` perquè el tauler enllaci amb l'origen. `reference_image_url` i `front_image_url` només els estableix Didit i s'ometen si els envies. Per a una entrada llegida des d'una sessió, les claus de Didit es fusionen amb les teves.", "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 registre d'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": "S'ha creat l'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 cos no és vàlid, el valor ja és a la llista o la sessió no pot 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 clau d'API amb abast ha caducat. Altres fallades d'autenticació retornen `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), o una clau d'API amb àmbit no té `workflows: write` o s'utilitza des d'una adreça IP fora de la seva llista d'admesos.", "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 existeix cap llista amb aquest UUID a l'aplicació de la clau d'API, o s'ha suprimit.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "List not found." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" }, "503": { "description": "L'anàlisi facial d'una selfie de captura de documents no està disponible temporalment. No s'ha afegit res; torna-ho a provar més tard.", "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 la llista", "description": "Elimina una entrada d'una llista, incloses les llistes del sistema. L'entrada deixa de coincidir immediatament i l'eliminació és irreversible: per tornar a incloure el valor a la llista, crea una entrada nova. En una llista de bloqueig de cares, documents, telèfons o correus electrònics del sistema, el registre que representa l'entrada deixa d'estar marcat com a inclòs a la llista de bloqueig; a la llista de bloqueig d'usuaris o empreses del sistema, els usuaris o empreses de l'aplicació el `vendor_data` dels quals coincideixi amb el valor de l'entrada (o el `didit_internal_id` dels quals coincideixi amb el seu `reference_object_uuid`) i que estiguin `BLOCKED` tornen a `ACTIVE`. Les sessions i transaccions que ja hagin finalitzat mantenen el seu estat. Una clau d'API amb àmbit requereix `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 llista que conté l'entrada.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "entry_uuid", "in": "path", "required": true, "description": "UUID de l'entrada, tal com el retorna Llistar les entrades d'una llista o Crear una entrada de llista.", "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": "S'ha eliminat l'entrada. Sense cos de resposta." }, "401": { "description": "La clau d'API amb abast ha caducat. Altres fallades d'autenticació retornen `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), o una clau d'API amb àmbit no té `workflows: write` o s'utilitza des d'una adreça IP fora de la seva llista d'admesos.", "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 existeix cap entrada amb aquest UUID en aquesta llista, la llista no pertany a l'aplicació de la clau d'API o s'ha suprimit, o l'entrada ja s'havia suprimit.", "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": "Puja una cara a una llista", "description": "Afegeix una cara a una llista de bloqueig de cares o a una llista de cares admeses a partir d'una imatge JPEG o PNG codificada en base64, per a casos en què no tinguis cap sessió de verificació a la qual fer referència. Didit detecta les cares de la imatge, utilitza la més gran i crea una entrada el `value` i el `reference_object_uuid` de la qual són l'UUID de la cara nova. Una cara en una llista de bloqueig fa que es rebutgin noves sessions la cara de les quals coincideixi; una cara en una llista de cares admeses omet l'acció de cara duplicada i mai preval sobre una coincidència amb la llista de bloqueig. En una aplicació de sandbox la imatge no s'analitza i l'entrada no coincideix amb res. Una clau d'API amb àmbit necessita `workflows: write`. Per afegir a la llista una cara procedent d'una sessió existent, fes servir [Crear una entrada de llista](https://docs.didit.me/ca/management-api/lists/create-entry) amb `reference_session_id` en el seu lloc.", "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 d'una llista amb `entry_type: face` i `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": "JPEG o PNG codificat en base64, de 2 MB com a màxim un cop descodificat, que mostri una cara clarament visible. Envia la cadena base64 sola, sense el prefix `data:image/...;base64,`." }, "comment": { "type": "string", "default": "", "description": "Nota opcional en text lliure, com ara el motiu de la inclusió a la llista." } } }, "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": "L'entrada de cara s'ha creat.", "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 llista no admet càrregues d'imatges facials, o la imatge no hi és, no és vàlida, és massa gran o no mostra cap cara utilitzable. No s'ha creat cap 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 clau d'API amb abast ha caducat. Altres fallades d'autenticació retornen `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), o una clau d'API amb àmbit no té `workflows: write` o s'utilitza des d'una adreça IP fora de la seva llista d'admesos.", "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 existeix cap llista amb aquest UUID a l'aplicació de la clau d'API, o s'ha suprimit.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "List not found." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" }, "503": { "description": "L'anàlisi facial no està disponible temporalment. No s'ha creat cap entrada; torna-ho a provar més tard.", "content": { "application/json": { "examples": { "Unavailable": { "value": { "detail": "Service temporarily unavailable. Please try again later." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/blocklist/": { "get": { "summary": "Llista els elements de la llista de bloqueig", "description": "Retorna un canal paginat de les cares, documents d'identitat, números de telèfon i adreces de correu electrònic de les sessions de verificació de l'aplicació que estan actualment a la llista de bloqueig, ordenats pel `blocklisted_at` més recent primer; filtra amb `item_type`. Els elements de sessions suprimides no s'inclouen. El canal cobreix els registres afegits a la llista de bloqueig des d'una sessió (amb [Afegir elements de la sessió a la llista de bloqueig](https://docs.didit.me/ca/management-api/blocklist/add), des de la consola o mitjançant una entrada de llista creada a partir d'una sessió); els valors afegits a una llista manualment, les cares pujades, les cares d'una selfie de captura de document i els altres tipus d'entrada es consulten amb [Llistar entrades de llista](https://docs.didit.me/ca/management-api/lists/list-entries). `face_image` i `front_image` són URL signades de curta durada, i una clau d'API amb àmbit sense `media: read` rep `null`. Una clau d'API amb àmbit requereix `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": "Només elements d'aquest tipus. Quan s'omet, es retornen tots els tipus.", "schema": { "type": "string", "enum": [ "face", "document", "phone", "email" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Mida de la pàgina. Per defecte és 50. Un valor superior a 1000000 retorna `400`; un zero, un valor negatiu o un valor no numèric torna al valor per defecte de 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 } }, { "name": "offset", "in": "query", "required": false, "description": "Índex basat en zero del primer element a retornar. És preferible seguir `next`. Un valor superior a 1000000 retorna `400`; un valor negatiu o no numèric torna a 0 per defecte.", "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 d'elements a la llista de bloqueig, els més recents primer.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Nombre total d'elements a la llista de bloqueig que coincideixen amb els filtres." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la pàgina següent, o `null` a l'última pàgina." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la pàgina anterior, o `null` a 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àmetre de consulta no és vàlid.", "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 clau d'API amb abast ha caducat. Altres fallades d'autenticació retornen `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), o una clau d'API amb àmbit no té `workflows: read` o s'utilitza des d'una adreça fora de la seva llista d'admesos.", "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": "S'ha superat el límit compartit de lectura de 600 sol·licituds per minut per clau d'API. Respecta `Retry-After` abans 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": "Afegeix elements de la sessió a la llista de bloqueig", "description": "Afegeix a la llista de bloqueig la cara, el document d'identitat, el número de telèfon o l'adreça de correu electrònic d'una sessió de verificació d'una persona de l'aplicació. Per a cada tipus seleccionat, Didit pren el registre més recent de la sessió, el marca com a inclòs a la llista de bloqueig i afegeix una entrada enllaçada a la sessió a la llista de bloqueig del sistema corresponent (`added_by: \"api\"`), de manera que les noves sessions amb una cara, número de document, número de telèfon o adreça de correu electrònic coincidents es rebutgen. Primer es comprova cada element seleccionat, de manera que si en falta un, no s'afegeix res a la llista de bloqueig; repetir la crida per a un element que ja hi figura en manté l'entrada única i actualitza `blocklisted_at`. La sessió en si i les sessions que ja hagin finalitzat no es modifiquen. Una clau d'API amb abast requereix `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": "Com a mínim un indicador `blocklist_*` ha de ser `true`.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Una sessió de verificació de persona de la teva aplicació. Es rebutgen les sessions suprimides." }, "blocklist_face": { "type": "boolean", "default": false, "description": "Afegir a la llista de bloqueig la cara de la sessió." }, "blocklist_document": { "type": "boolean", "default": false, "description": "Afegir a la llista de bloqueig el document d'identitat de la sessió. El document necessita el seu estat emissor, tipus de document, número de document i nom complet." }, "blocklist_phone": { "type": "boolean", "default": false, "description": "Afegir a la llista de bloqueig el número de telèfon de la sessió." }, "blocklist_email": { "type": "boolean", "default": false, "description": "Afegir a la llista de bloqueig l'adreça de correu electrònic de la sessió." } } }, "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": "Els elements seleccionats s'han afegit a la llista de bloqueig.", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string", "description": "Sempre `Successfully updated blocklist.`" } } }, "examples": { "Blocklisted": { "value": { "message": "Successfully updated blocklist." } } } } } }, "400": { "description": "El cos no és vàlid, la sessió no és una sessió de verificació d'aquesta aplicació o no té cap registre d'un tipus seleccionat. No s'ha afegit res a la llista de bloqueig.", "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 clau d'API amb abast ha caducat. Altres fallades d'autenticació retornen `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), o una clau d'API amb àmbit no té `workflows: write` o s'utilitza des d'una adreça IP fora de la seva llista d'admesos.", "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 elements de la sessió de la llista de bloqueig", "description": "Aixeca el bloqueig sobre la cara, el document d'identitat, el número de telèfon o l'adreça de correu electrònic d'una sessió de verificació de persona de l'aplicació. Per a cada tipus seleccionat, Didit pren el registre més recent de la sessió, neteja l'indicador de llista de bloqueig i suprimeix les entrades de la llista de bloqueig del sistema creades a partir d'aquest registre, de manera que ja no rebutja sessions noves. Les entrades afegides a una llista per valor no es toquen: troba-les amb [List list entries](https://docs.didit.me/ca/management-api/lists/list-entries) i suprimeix-les amb [Delete a list entry](https://docs.didit.me/ca/management-api/lists/delete-entry). Desbloquejar un registre que no està a la llista de bloqueig és satisfactori i no canvia res, i les sessions que ja han finalitzat no es modifiquen. Una clau d'API amb àmbit necessita `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": "Com a mínim un indicador `unblock_*` ha de ser `true`.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Una sessió de verificació de persona de la teva aplicació. Es rebutgen les sessions suprimides." }, "unblock_face": { "type": "boolean", "default": false, "description": "Aixeca el bloqueig sobre la cara de la sessió." }, "unblock_document": { "type": "boolean", "default": false, "description": "Aixeca el bloqueig sobre el document d'identitat de la sessió." }, "unblock_phone": { "type": "boolean", "default": false, "description": "Aixeca el bloqueig sobre el número de telèfon de la sessió." }, "unblock_email": { "type": "boolean", "default": false, "description": "Aixeca el bloqueig sobre l'adreça de correu electrònic de la sessió." } } }, "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": "S'ha aixecat el bloqueig sobre els elements seleccionats.", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string", "description": "Sempre `Successfully removed from blocklist.`" } } }, "examples": { "Unblocked": { "value": { "message": "Successfully removed from blocklist." } } } } } }, "400": { "description": "El cos no és vàlid, la sessió no és una sessió de verificació d'aquesta aplicació o no té cap registre d'un tipus seleccionat. No s'ha modificat res.", "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 clau d'API amb abast ha caducat. Altres fallades d'autenticació retornen `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), o una clau d'API amb àmbit no té `workflows: write` o s'utilitza des d'una adreça IP fora de la seva llista d'admesos.", "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": "Obtenir la configuració del webhook", "description": "Retorna la configuració de webhooks de l'aplicació en una sola crida: cada [destinació del webhook](https://docs.didit.me/ca/management-api/webhook/list-destinations) amb el seu secret de signatura, els tipus d'esdeveniment als quals es pot subscriure una destinació, l'URL, la versió i el secret de webhook a nivell d'aplicació (antics), la política de conservació de dades i plantilles biomètriques, i els amfitrions de retorn de la cartera de Digital ID. Didit lliura webhooks a les destinacions, cadascun signat amb el seu propi `secret_shared_key`; els paràmetres de nivell superior `webhook_url`, `webhook_version` i `secret_shared_key` només s'utilitzen mentre no hi hagi cap destinació habilitada, i només per a `status.updated` i `data.updated`. La resposta conté secrets de signatura, així que mantén-la fora dels registres i del codi del client. Una clau d'API amb àmbit restringit necessita `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ó 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 clau d'API ha caducat: es va crear amb una data de caducitat que ja ha passat. Una clau incorrecta o revocada també rep `401`; si falta la clau, es rep `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Si falta la `x-api-key`, o bé és invàlida o revocada, es rep `You do not have permission to perform this action.` Una clau amb àmbit que no tingui l'accés que aquest endpoint necessita rep un missatge indicant l'accés que falta, i una clau utilitzada des de fora de la seva llista d'adreces IP permeses rep `This API key can't be used from this IP address.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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": "S'ha superat el límit de freqüència: més de 600 sol·licituds GET en la finestra d'un minut actual per a aquesta clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses a la finestra d'un minut (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Temps Unix (segons) en què es reinicia la finestra actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nom del pressupost que s'ha superat.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Actualitza la configuració del webhook", "description": "Actualitza parcialment la configuració a nivell d'aplicació: l'URL, la versió i el secret del webhook heretat, la política de conservació de dades i plantilles biomètriques, i els amfitrions de retorn de la cartera de Digital ID. Envia només els camps que calgui canviar; la resposta és la configuració completa, amb la mateixa estructura que `GET /v3/webhook/`. Les destinacions no es gestionen aquí: crea-les, actualitza-les i suprimeix-les amb els endpoints de `/v3/webhook/destinations/`, i no enviïs un camp `endpoints` a aquest endpoint. Un canvi a `data_retention_months` també s'aplica a les sessions existents, i les sessions que elimini no es podran restaurar; llegeix primer [Conservació de dades](https://docs.didit.me/ca/console/data-retention). Una clau d'API amb àmbit restringit necessita `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": "Envia només els camps que vulguis canviar. Les destinacions no es gestionen aquí.", "properties": { "webhook_url": { "type": "string", "format": "uri", "nullable": true, "maxLength": 2000, "description": "URL de webhook antiga a nivell d'aplicació. Didit només la utilitza mentre l'aplicació no tingui cap destinació activada, i aleshores només per a `status.updated` i `data.updated`. No crea cap destinació, i la propera creació, actualització o eliminació d'una destinació la substituirà. Per rebre webhooks, crea una destinació amb `POST /v3/webhook/destinations/`." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Versió del payload de la `webhook_url` heretada." }, "rotate_secret_key": { "type": "boolean", "default": false, "description": "`true` substitueix immediatament la `secret_shared_key` a nivell d'aplicació per un valor nou aleatori; el valor nou es troba a la resposta. Els secrets de les destinacions no es modifiquen. Cada crida amb `true` genera un secret nou, de manera que no és idempotent." }, "capture_method": { "type": "string", "enum": [ "MOBILE", "MOBILE_AND_DESKTOP" ], "description": "Configuració antiga de l'aplicació. El flux de verificació no la llegeix." }, "data_retention_months": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 120, "description": "Finestra d'eliminació automàtica en mesos (un mes compta com a 30 dies), o `null` per no aplicar eliminació automàtica. Un canvi també s'aplica a les sessions existents: cada sessió de verificació d'usuaris més antiga que la nova finestra s'elimina automàticament, i aquesta eliminació és irreversible." }, "face_retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "Què passa amb l'embedding facial d'una sessió quan se suprimeix la sessió. `retain_until_user_deleted` requereix `face_retention_days` a la mateixa sol·licitud o ja establert prèviament. Un canvi s'aplica a les supressions de sessions a partir d'aquell moment; no crea ni purga cap plantilla biomètrica existent." }, "face_retention_days": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 3650, "description": "Període de conservació de dades, en dies, de les plantilles biomètriques sota `retain_until_user_deleted`." }, "biometric_consent_mode": { "type": "string", "enum": [ "auto", "always", "never" ], "description": "Quan el flux allotjat i els SDK natius demanen a la persona el consentiment biomètric explícit abans d'una captura facial. `auto` (per defecte) només el demana quan s'aplica un activador: un estat declarat, la IP de la persona o l'emissor del document d'identitat es troba a Illinois, Texas o Colorado, o la persona sembla ser als EUA sense un estat conegut. `always` el demana a cada persona el flux de treball de la qual captura una cara. `never` no mostra mai el pas, i recopiles el consentiment pel teu compte abans de la selfie. Cada canvi es registra al registre d'auditoria. Consulta [Consentiment biomètric](https://docs.didit.me/ca/getting-started/biometric-consent)." }, "allowed_return_hosts": { "type": "array", "maxItems": 20, "description": "Substitueix tota la llista de noms d'amfitrió de retorn de carteres de Digital ID. Només noms d'amfitrió simples, com ara `shop.example.com`: sense esquema, port, ruta ni caràcters comodí. Els valors es converteixen a minúscules i s'eliminen els duplicats. Envia `[]` per buidar la llista.", "items": { "type": "string", "maxLength": 253 } }, "allowed_domains": { "type": "array", "maxItems": 50, "items": { "type": "string", "maxLength": 300 }, "description": "Substitueix tota la llista d'orígens permesos. Orígens (per exemple `https://app.example.com`; `http` només per a `localhost`) en què es pot incrustar el flux de verificació allotjat i als quals es pot redirigir l'usuari amb un callback de sessió. Les crides de servidor a servidor no es veuen afectades. Una llista buida significa que no hi ha cap restricció. Didit emmagatzema cada origen en minúscules sense un port per defecte. Una entrada no vàlida falla amb `400` a `allowed_domains`. Envia `[]` per eliminar la restricció.", "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ó completa després de l'actualització, amb la mateixa estructura que `GET /v3/webhook/`. Si has rotat el secret, desa el nou `secret_shared_key` abans de descartar la resposta.", "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": "La validació ha fallat: cada camp no vàlid s'associa a una llista de missatges i no es modifica res. Un cos que no sigui JSON vàlid retorna `{\"detail\": \"JSON parse error - ...\"}`.", "content": { "application/json": { "schema": { "type": "object", "description": "Cada camp no vàlid associat a una llista de missatges.", "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 clau d'API ha caducat: es va crear amb una data de caducitat que ja ha passat. Una clau incorrecta o revocada també rep `401`; si falta la clau, es rep `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Si falta la `x-api-key`, o bé és invàlida o revocada, es rep `You do not have permission to perform this action.` Una clau amb àmbit que no tingui l'accés que aquest endpoint necessita rep un missatge indicant l'accés que falta, i una clau utilitzada des de fora de la seva llista d'adreces IP permeses rep `This API key can't be used from this IP address.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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": "S'ha superat el límit de freqüència: més de 300 sol·licituds d'escriptura (POST, PATCH, PUT, DELETE) en la finestra d'un minut actual per a aquesta clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses a la finestra d'un minut (300).", "schema": { "type": "integer", "example": 300 } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Temps Unix (segons) en què es reinicia la finestra actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nom del pressupost que s'ha superat.", "schema": { "type": "string", "example": "generic-write" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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": "Obtenir les analítiques de la destinació del webhook", "description": "Totals de lliuraments, taxa d'errors i temps de resposta per a una destinació del webhook, al llarg de tot el rang (`summary`) i per dia UTC (`points`). Cada intent compta com a lliurament: el primer enviament d'un esdeveniment, cada [reintent](https://docs.didit.me/ca/integration/webhooks#política-de-reintents) automàtic i cada reenviament. Un lliurament es considera fallit quan el seu estat HTTP registrat és 400 o superior, de manera que els temps d'espera esgotats (registrats com a `504`) i els errors de connexió (`503`) compten com a fallits; un lliurament que encara està a la cua només compta en `total_deliveries`. Els registres de lliurament estan disponibles durant uns 30 dies. Una clau d'API amb àmbit necessita `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 de la destinació (el `uuid` retornat per `GET /v3/webhook/destinations/`).", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "date_from", "in": "query", "required": false, "description": "Primer dia UTC a incloure, en format `YYYY-MM-DD` (inclusiu). Omet-ho per començar des del lliurament més antic disponible. S'accepta `dateFrom` com a àlies.", "schema": { "type": "string", "format": "date" }, "example": "2026-10-01" }, { "name": "date_to", "in": "query", "required": false, "description": "Últim dia UTC a incloure, com a `YYYY-MM-DD` (inclusiu). No pot ser anterior a `date_from`. S'accepta `dateTo` com a àlies.", "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ístiques de lliurament per a la destinació.", "content": { "application/json": { "schema": { "type": "object", "required": [ "summary", "points" ], "properties": { "summary": { "type": "object", "description": "Totals durant l'interval sol·licitat.", "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": "Intents de lliurament, inclosos els que estan a la cua." }, "failed_deliveries": { "type": "integer", "minimum": 0, "description": "Intents amb un codi d'estat HTTP registrat de 400 o superior." }, "min_response_time_ms": { "type": "integer", "nullable": true, "description": "Intent més ràpid en mil·lisegons, o `null` si cap intent té un temps registrat." }, "avg_response_time_ms": { "type": "integer", "nullable": true, "description": "Temps mitjà per intent en mil·lisegons, arrodonit, o `null` quan cap intent té un temps registrat." }, "max_response_time_ms": { "type": "integer", "nullable": true, "description": "L'intent més lent en mil·lisegons, o `null` quan cap intent té un temps registrat." }, "error_rate_percentage": { "type": "integer", "minimum": 0, "maximum": 100, "description": "`failed_deliveries` / `total_deliveries` x 100, arrodonit a un nombre enter. `0` quan no hi ha lliuraments." } } }, "points": { "type": "array", "description": "Una entrada per dia UTC que hagi tingut lliuraments, el més antic primer. Els dies sense lliuraments s'ometen, així que omple els buits amb zeros quan els representis gràficament.", "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": "Dia UTC, `YYYY-MM-DD`." }, "total_deliveries": { "type": "integer", "minimum": 0, "description": "Intents de lliurament, inclosos els que estan a la cua." }, "failed_deliveries": { "type": "integer", "minimum": 0, "description": "Intents amb un codi d'estat HTTP registrat de 400 o superior." }, "min_response_time_ms": { "type": "integer", "nullable": true, "description": "Intent més ràpid en mil·lisegons, o `null` si cap intent té un temps registrat." }, "avg_response_time_ms": { "type": "integer", "nullable": true, "description": "Temps mitjà per intent en mil·lisegons, arrodonit, o `null` quan cap intent té un temps registrat." }, "max_response_time_ms": { "type": "integer", "nullable": true, "description": "L'intent més lent en mil·lisegons, o `null` quan cap intent té un temps registrat." } } } } } }, "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 és una data `YYYY-MM-DD`, o `date_to` és anterior a `date_from`.", "content": { "application/json": { "schema": { "type": "object", "description": "Cada camp no vàlid associat a una llista de missatges.", "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 clau d'API ha caducat: es va crear amb una data de caducitat que ja ha passat. Una clau incorrecta o revocada també rep `401`; si falta la clau, es rep `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Si falta la `x-api-key`, o bé és invàlida o revocada, es rep `You do not have permission to perform this action.` Una clau amb àmbit que no tingui l'accés que aquest endpoint necessita rep un missatge indicant l'accés que falta, i una clau utilitzada des de fora de la seva llista d'adreces IP permeses rep `This API key can't be used from this IP address.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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 existeix cap destinació amb aquest UUID per a l'aplicació, o s'ha suprimit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència: més de 600 sol·licituds GET en la finestra d'un minut actual per a aquesta clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses a la finestra d'un minut (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Temps Unix (segons) en què es reinicia la finestra actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nom del pressupost que s'ha superat.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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": "Llista els lliuraments de la destinació del webhook", "description": "Pagina tots els intents de lliurament a una destinació del webhook, els més recents primer. El primer enviament de cada esdeveniment, cada [reintent](https://docs.didit.me/ca/integration/webhooks#política-de-reintents) automàtic i cada reenviament són entrades independents. Les entrades inclouen l'estat HTTP i el temps de resposta, però no el payload: obtén un lliurament individual per llegir-ne les capçaleres i el cos. `count` és exacte fins a 100 i mostra 100 per sobre d'aquest valor, així que segueix `next` fins que sigui `null`. Els registres de lliurament estan disponibles durant uns 30 dies. Una clau d'API amb abast restringit necessita `webhooks: read` i `decisions: read`; una clau limitada a determinats fluxos de treball o a sessions aprovades no pot utilitzar aquest 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 de la destinació (el `uuid` retornat per `GET /v3/webhook/destinations/`).", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "limit", "in": "query", "required": false, "description": "Nombre màxim de lliuraments per pàgina. Per defecte és 50. Un valor que no sigui un enter positiu torna al valor predeterminat de 50; un valor superior a 1000000 retorna `400`.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 50 }, { "name": "offset", "in": "query", "required": false, "description": "Nombre de lliuraments que cal ometre. Per defecte és 0. És preferible seguir els URL `next` i `previous` de la resposta.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 0 }, { "name": "date_from", "in": "query", "required": false, "description": "Primer dia UTC a incloure, en format `YYYY-MM-DD` (inclusiu). Omet-ho per començar des del lliurament més antic disponible. S'accepta `dateFrom` com a àlies.", "schema": { "type": "string", "format": "date" }, "example": "2026-10-01" }, { "name": "date_to", "in": "query", "required": false, "description": "Últim dia UTC a incloure, com a `YYYY-MM-DD` (inclusiu). No pot ser anterior a `date_from`. S'accepta `dateTo` com a àlies.", "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 lliuraments, els més recents primer.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Nombre de lliuraments coincidents, exacte fins a 100 i limitat a 100 per sobre d'aquest valor. Utilitza `next` per saber si hi ha més pàgines." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la pàgina següent, o `null` a l'última pàgina." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la pàgina anterior, o `null` a 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 és una data `YYYY-MM-DD`, `date_to` és anterior a `date_from`, o bé `limit` o `offset` és superior a 1000000 (aquest error és un array JSON de missatges).", "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 clau d'API ha caducat: es va crear amb una data de caducitat que ja ha passat. Una clau incorrecta o revocada també rep `401`; si falta la clau, es rep `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Si falta la `x-api-key`, o bé és invàlida o revocada, es rep `You do not have permission to perform this action.` Una clau amb àmbit que no tingui l'accés que aquest endpoint necessita rep un missatge indicant l'accés que falta, i una clau utilitzada des de fora de la seva llista d'adreces IP permeses rep `This API key can't be used from this IP address.` Una clau limitada a determinats fluxos de treball o a sessions aprovades rep `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": "Missatge d'error fàcil de llegir." } } }, "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 existeix cap destinació amb aquest UUID per a l'aplicació, o s'ha suprimit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència: més de 600 sol·licituds GET en la finestra d'un minut actual per a aquesta clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses a la finestra d'un minut (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Temps Unix (segons) en què es reinicia la finestra actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nom del pressupost que s'ha superat.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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": "Obtenir el lliurament de la destinació del webhook", "description": "Recupera un intent de lliurament a una destinació de webhook amb les capçaleres de sol·licitud exactes i el cos JSON que va enviar Didit, l'estat HTTP que va retornar el teu endpoint i el temps de resposta. `request_header` i `request_body` són text JSON: analitza'ls per llegir les capçaleres de signatura i el payload, per exemple per comprovar la teva [verificació de la signatura](https://docs.didit.me/ca/integration/webhooks#verificació-de-la-signatura) amb el `secret_shared_key` de la destinació. Un lliurament mai no conté el secret de signatura, i Didit no registra el cos de resposta del teu endpoint. Una clau d'API amb abast limitat necessita `webhooks: read` i `decisions: read`; una clau limitada a determinats fluxos de treball o a sessions aprovades no pot utilitzar aquest 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 de la destinació a la qual s'ha enviat el lliurament.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "delivery_uuid", "in": "path", "required": true, "description": "UUID del lliurament: el `uuid` d'una entrada retornada per `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": "El lliurament, amb les seves capçaleres de sol·licitud i el cos.", "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 clau d'API ha caducat: es va crear amb una data de caducitat que ja ha passat. Una clau incorrecta o revocada també rep `401`; si falta la clau, es rep `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Si falta la `x-api-key`, o bé és invàlida o revocada, es rep `You do not have permission to perform this action.` Una clau amb àmbit que no tingui l'accés que aquest endpoint necessita rep un missatge indicant l'accés que falta, i una clau utilitzada des de fora de la seva llista d'adreces IP permeses rep `This API key can't be used from this IP address.` Una clau limitada a determinats fluxos de treball o a sessions aprovades rep `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": "Missatge d'error fàcil de llegir." } } }, "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": "La destinació no existeix per a l'aplicació o s'ha eliminat, o el lliurament no existeix, pertany a una altra destinació o ja no està disponible.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } }, "Delivery not found": { "value": { "detail": "Webhook delivery not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència: més de 600 sol·licituds GET en la finestra d'un minut actual per a aquesta clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses a la finestra d'un minut (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Temps Unix (segons) en què es reinicia la finestra actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nom del pressupost que s'ha superat.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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 el lliurament a la destinació del webhook", "description": "Torna a enviar un lliurament anterior, per exemple després que el teu endpoint no estigués disponible. Didit agafa el payload emmagatzemat, estableix un nou `timestamp`, el torna a signar amb la `secret_shared_key` actual de la destinació (`X-Signature`, `X-Signature-V2`, `X-Signature-Simple` i `X-Timestamp`) i l'envia mitjançant POST a la `request_url` del lliurament, fins i tot si la URL de la destinació ha canviat des d'aleshores o la destinació està inhabilitada. `event_id` i la resta del payload no canvien, de manera que pots deduplicar per `event_id`. La crida espera el teu endpoint durant un màxim de 5 segons i retorna el nou lliurament amb `200` independentment del que hagi respost el teu endpoint: consulta `response_status`. Un reenviament no es reintenta automàticament, cada crida torna a enviar i crea un nou lliurament, i la sol·licitud no té cos. Una clau d'API amb abast necessita `webhooks: write` i `decisions: read`; una clau limitada a determinats fluxos de treball o a sessions aprovades no pot utilitzar aquest 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 de la destinació a la qual s'ha enviat el lliurament.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "delivery_uuid", "in": "path", "required": true, "description": "UUID del lliurament que cal reenviar: el `uuid` d'una entrada retornada per `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": "El nou lliurament, ja intentat. `response_status` és el que el teu endpoint ha respost aquesta vegada (`504` temps d'espera excedit, `503` fallada de connexió). El lliurament original no canvia.", "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": "El lliurament emmagatzemat no s'ha pogut signar de nou. No s'envia res.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." }, "code": { "type": "string", "description": "Codi d'error llegible per màquina estable. Bifurca segons aquest codi, no pas segons `detail`." } } }, "examples": { "Unsignable delivery": { "value": { "detail": "Invalid webhook data format", "code": "invalid_webhook_payload" } } } } } }, "401": { "description": "La clau d'API ha caducat: es va crear amb una data de caducitat que ja ha passat. Una clau incorrecta o revocada també rep `401`; si falta la clau, es rep `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Si falta la `x-api-key`, o bé és invàlida o revocada, es rep `You do not have permission to perform this action.` Una clau amb àmbit que no tingui l'accés que aquest endpoint necessita rep un missatge indicant l'accés que falta, i una clau utilitzada des de fora de la seva llista d'adreces IP permeses rep `This API key can't be used from this IP address.` Una clau limitada a determinats fluxos de treball o a sessions aprovades rep `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": "Missatge d'error fàcil de llegir." } } }, "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": "La destinació no existeix per a l'aplicació o s'ha eliminat, o el lliurament no existeix, pertany a una altra destinació o ja no està disponible.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } }, "Delivery not found": { "value": { "detail": "Webhook delivery not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència: més de 300 sol·licituds d'escriptura (POST, PATCH, PUT, DELETE) en la finestra d'un minut actual per a aquesta clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses a la finestra d'un minut (300).", "schema": { "type": "integer", "example": 300 } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Temps Unix (segons) en què es reinicia la finestra actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nom del pressupost que s'ha superat.", "schema": { "type": "string", "example": "generic-write" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/": { "get": { "summary": "Llista els esdeveniments de monitoratge", "description": "Llista els esdeveniments de monitoratge emmagatzemats per a la teva aplicació, ordenats per `occurred_at`, del més recent al més antic, amb filtres opcionals que es combinen amb AND. Els filtres multivalor (`event_category`, `action_type`, `status`, `retention_class`) repeteixen el paràmetre i coincideixen amb qualsevol dels valors; els altres filtres són coincidències exactes, i els valors desconeguts simplement no retornen cap esdeveniment. Cada resultat és un resum: crida `GET /v3/events/{event_uuid}/` per obtenir el payload, el context del dispositiu, l'enriquiment d'IP i les proves de la regla, i prioritza `GET /v3/events/subjects/{vendor_data}/` per a l'historial d'un sol subjecte. Les lectures funcionen tant si la ingesta d'esdeveniments està activada com si no. Una clau d'API amb abast restringit necessita `transactions: read`. Consulta [Ingesta d'esdeveniments](https://docs.didit.me/ca/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": "Nombre màxim d'esdeveniments per pàgina. Per defecte és 50. Els valors superiors a 1000000 retornen `400`; un valor no numèric, zero o negatiu torna al valor predeterminat de 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 50 }, { "name": "offset", "in": "query", "required": false, "description": "Nombre d'esdeveniments que cal ometre. Per defecte és 0. És preferible seguir l'URL `next` de la resposta.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 0 }, { "name": "event_category", "in": "query", "required": false, "description": "Només esdeveniments en aquestes categories. Repeteix el paràmetre per a diversos valors (`?event_category=payment&event_category=dispute`); es retorna un esdeveniment que coincideixi amb qualsevol d'ells.", "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": "Només esdeveniments amb aquests tipus d'acció (exactes i que distingeixen entre majúscules i minúscules). Repeteix per a diversos valors.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "deposit_completed", "chargeback_opened" ] }, { "name": "status", "in": "query", "required": false, "description": "Només esdeveniments amb aquests estats. Repeteix per a diversos valors.", "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": "Només esdeveniments en aquestes classes de conservació. Repeteix per a diversos valors.", "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": "Coincidència exacta amb el `vendor_data` del subjecte. El mateix id pot anomenar una persona física i una empresa; afegeix `subject_entity_type` per triar-ne una, o utilitza `GET /v3/events/subjects/{vendor_data}/`.", "schema": { "type": "string" }, "example": "user-42" }, { "name": "subject_entity_type", "in": "query", "required": false, "description": "`company` només retorna esdeveniments de subjectes d'empresa; qualsevol altre valor no buit (per exemple `individual`) només retorna esdeveniments de particulars. Omet-lo per retornar tots dos.", "schema": { "type": "string", "enum": [ "individual", "company" ] }, "example": "individual" }, { "name": "business_vendor_data", "in": "query", "required": false, "description": "Coincidència exacta amb el `business.vendor_data` enviat amb l'esdeveniment.", "schema": { "type": "string" }, "example": "merchant-7" }, { "name": "session_id", "in": "query", "required": false, "description": "Coincidència exacta amb `session.session_id`.", "schema": { "type": "string" }, "example": "web-session-abc" }, { "name": "device_fingerprint", "in": "query", "required": false, "description": "Coincidència exacta amb `device_context.fingerprint`.", "schema": { "type": "string" }, "example": "fp-a8c1" }, { "name": "ip_address", "in": "query", "required": false, "description": "Coincidència exacta amb l'adreça IP de l'esdeveniment.", "schema": { "type": "string" }, "example": "203.0.113.42" }, { "name": "game_id", "in": "query", "required": false, "description": "Coincidència exacta amb el `game_id` promocionat.", "schema": { "type": "string" }, "example": "poker-holdem-01" }, { "name": "round_id", "in": "query", "required": false, "description": "Coincidència exacta amb el `round_id` promocionat.", "schema": { "type": "string" }, "example": "round-88231" }, { "name": "affiliate_code", "in": "query", "required": false, "description": "Coincidència exacta amb l'`affiliate_code` promocionat.", "schema": { "type": "string" }, "example": "aff-summer" }, { "name": "payment_reference_id", "in": "query", "required": false, "description": "Coincidència exacta amb la referència de pagament (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": "Coincidència exacta amb el `counterparty_vendor_data` promocionat.", "schema": { "type": "string" }, "example": "user-77" }, { "name": "matched_only", "in": "query", "required": false, "description": "`true` (també `1` o `yes`, no distingeix majúscules de minúscules) només retorna esdeveniments en què ha coincidit almenys una regla (`rules_matched_count` superior a 0). Qualsevol altre valor s'ignora.", "schema": { "type": "boolean", "default": false }, "example": true }, { "name": "occurred_from", "in": "query", "required": false, "description": "Només esdeveniments amb `occurred_at` en aquest instant o després (inclusiu). Envia un valor ISO 8601: `2026-10-01T00:00:00Z`, un desplaçament explícit amb el `+` codificat en percentatge (`2026-10-01T02:00:00%2B02:00`; un `+` sense codificar es descodifica com un espai i el valor deixa de processar-se correctament), o només una data (`2026-10-01`), que significa les 00:00:00 UTC d'aquell dia. Un valor sense desplaçament s'interpreta com a UTC. No s'accepten valors en cap altre format.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-01T00:00:00Z" }, { "name": "occurred_to", "in": "query", "required": false, "description": "Només esdeveniments amb `occurred_at` en aquest instant o abans (inclusiu). Només una data significa l'inici d'aquell dia, de manera que `occurred_to=2026-10-15` exclou la resta del 15 d'octubre; envia `2026-10-15T23:59:59Z` per incloure-ho. Envia un valor ISO 8601: `2026-10-01T00:00:00Z`, un desplaçament explícit amb el `+` codificat en percentatge (`2026-10-01T02:00:00%2B02:00`; un `+` sense codificar es descodifica com un espai i el valor deixa de processar-se correctament), o només una data (`2026-10-01`), que significa les 00:00:00 UTC d'aquell dia. Un valor sense desplaçament s'interpreta com a UTC. No s'accepten valors en cap altre format.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-17T23:59:59Z" }, { "name": "search", "in": "query", "required": false, "description": "Coincidència de subcadena que no distingeix majúscules de minúscules a `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 resums d'esdeveniments.", "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` o `offset` és superior a 1000000. El cos és una matriu JSON amb un missatge. Un `limit` no numèric o no positiu torna al valor per defecte de 50 en lloc de fallar.", "content": { "application/json": { "examples": { "limit too large": { "summary": "limit per sobre de 1000000", "value": [ "limit must not exceed 1000000." ] }, "offset too large": { "summary": "offset per sobre de 1000000", "value": [ "offset must not exceed 1000000." ] } } } } }, "401": { "description": "La clau d'API amb abast ha caducat. Només una clau caducada rep `401`; una clau absent o no vàlida rep `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), una clau amb àmbit sense `transactions: read`, una clau limitada a determinats fluxos de treball o a sessions aprovades (aquesta clau mai no accedeix a dades de monitoratge de transaccions), o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau.", "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": "S'ha superat el límit de freqüència: les sol·licituds `GET` comparteixen un pressupost de 600 sol·licituds per minut per clau d'API. Espera els segons indicats a `Retry-After` i reintenta-ho.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans 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": "Crea un esdeveniment de monitoratge", "description": "Envia un esdeveniment no monetari (inici de sessió, sessió, joc, bonificació, afiliat, pagament, disputa, seguretat, joc responsable o personalitzat) des del teu backend. L'esdeveniment es valida contra el contracte de la seva categoria, s'emmagatzema, s'enriqueix per IP un cop per cada adreça pública única i s'avalua mitjançant les teves regles d'esdeveniments en temps real abans de retornar la resposta; les regles que creuen subjectes o amb finestres temporals llargues s'executen de manera asíncrona (`correlation_pending: true`), i en una aplicació de sandbox no s'executa cap regla. `event_id` és la clau d'idempotència: el mateix `event_id` amb els mateixos valors de `event_category`, `action_type`, `occurred_at`, `subject.vendor_data` i `payload` retorna `200` amb `idempotent_replay: true` i el resultat emmagatzemat (els altres camps de l'embolcall no es comparen), mentre que si els valors són diferents es retorna `409`. La ingesta d'esdeveniments és opcional per aplicació: fins que no s'activa, aquest endpoint retorna `403` amb `code: event_monitoring_disabled` i no emmagatzema res. Una clau d'API amb àmbit necessita `transactions: write`. Consulta [Ingesta d'esdeveniments](https://docs.didit.me/ca/transaction-monitoring/events) i [Regles sobre esdeveniments](https://docs.didit.me/ca/transaction-monitoring/event-rules); per enviar esdeveniments des d'un navegador o una aplicació, utilitza [Enviament d'esdeveniments amb l'SDK](https://docs.didit.me/ca/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": "L'esdeveniment s'ha emmagatzemat i avaluat.", "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": "Repetició idempotent: ja hi ha emmagatzemat un esdeveniment amb aquest `event_id` i el mateix contingut. No s'ha emmagatzemat ni avaluat res de nou; el cos descriu l'esdeveniment emmagatzemat.", "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ó ha fallat. El cos està indexat per camp; els camps niats són objectes niats. No s'emmagatzema res.", "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 clau d'API amb abast ha caducat. Només una clau caducada rep `401`; una clau absent o no vàlida rep `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), una clau amb àmbit sense `transactions: write`, una clau limitada a determinats fluxos de treball o a sessions aprovades (aquesta clau mai no accedeix a dades de monitoratge de transaccions), o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau. També es retorna amb `code: event_monitoring_disabled` mentre la ingesta d'esdeveniments estigui desactivada per a l'aplicació; en aquest cas no s'emmagatzema res, i la comprovació s'executa abans de validar el cos.", "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` ja s'ha utilitzat per a un esdeveniment amb contingut diferent (categoria, tipus d'acció, `occurred_at`, `vendor_data` del subjecte o payload). Envia l'esdeveniment sota un `event_id` nou.", "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": "S'ha superat el límit de freqüència: les creacions de transaccions i la ingesta d'esdeveniments (`POST /v3/transactions/`, `POST /v3/events/`, `POST /v3/events/batch/`) comparteixen un pressupost de 600 sol·licituds per minut per clau d'API, independent de les 300 que comparteixen la resta de sol·licituds d'escriptura. Espera els segons indicats a `Retry-After` i reintenta-ho.", "headers": { "Retry-After": { "description": "Segons d'espera abans de reintentar, arrodonits a l'alça perquè el reintent caigui a la finestra següent.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Ingestion rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/batch/": { "post": { "summary": "Crea esdeveniments de monitoratge per lots", "description": "Envia d'1 a 500 esdeveniments en una sola sol·licitud, cadascun en el mateix sobre que `POST /v3/events/`. Cada element es valida, s'emmagatzema i s'avalua de manera independent i rep el seu propi resultat (`accepted`, `replayed` o `rejected`), de manera que un esdeveniment mal format mai reverteix els altres: la resposta és `201` quan no s'ha rebutjat cap element i `207` quan se n'ha rebutjat almenys un, i tots dos indiquen que la sol·licitud s'ha processat. Envia `{\"events\": [...]}`; també s'accepta un array JSON simple d'esdeveniments. La ingesta d'esdeveniments ha d'estar activada per a l'aplicació; en cas contrari, tota la sol·licitud retorna `403` amb `code: event_monitoring_disabled` i no s'emmagatzema res. Una clau d'API amb àmbit necessita `transactions: write`. Consulta [Lots](https://docs.didit.me/ca/transaction-monitoring/events#lots).", "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": "D'1 a 500 esdeveniments. Cada element segueix `MonitoringEventCreateRequest`, inclosa la finestra de 7 dies en el passat i 5 minuts en el futur a `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 s'ha rebutjat cap element: cada element és `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": "Elements emmagatzemats i avaluats." }, "replayed_count": { "type": "integer", "minimum": 0, "description": "Elements ja emmagatzemats amb el mateix contingut." }, "rejected_count": { "type": "integer", "minimum": 0, "description": "Elements no emmagatzemats." }, "results": { "type": "array", "description": "Una entrada per element, en l'ordre de la sol·licitud.", "items": { "type": "object", "description": "Resultat d'un element. Els elements acceptats i repetits també inclouen tots els camps de `MonitoringEventIngestResult`; els elements rebutjats inclouen `event_id` i `errors` en el seu lloc.", "required": [ "index", "outcome" ], "properties": { "index": { "type": "integer", "minimum": 0, "description": "Posició de l'element al teu array `events`." }, "outcome": { "type": "string", "enum": [ "accepted", "replayed", "rejected" ], "description": "`accepted`: emmagatzemat i avaluat. `replayed`: ja emmagatzemat amb el mateix contingut. `rejected`: no emmagatzemat; consulta `errors`." }, "event_id": { "type": "string", "nullable": true, "description": "El teu `event_id`. En els elements rebutjats per validació es llegeix des de la clau `event_id` en snake_case de l'element, de manera que és null si l'element l'ha omès o ha enviat l'àlies `eventId`." }, "errors": { "type": "object", "additionalProperties": true, "description": "Només elements rebutjats. Errors de validació indexats per camp, amb el mateix format que el `400` de `POST /v3/events/`; un `event_id` reutilitzat amb contingut diferent es notifica com a cadena sota `errors.event_id`." }, "event_uuid": { "type": "string", "format": "uuid", "description": "Només elements acceptats i reproduïts." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "Només elements acceptats i reproduïts." }, "score": { "type": "integer", "description": "Només elements acceptats i reproduïts." }, "rules_evaluated_count": { "type": "integer", "description": "Només elements acceptats i reproduïts." }, "rules_matched_count": { "type": "integer", "description": "Només elements acceptats i reproduïts." }, "correlation_pending": { "type": "boolean", "description": "Només elements acceptats i reproduïts." }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Només elements acceptats i reproduïts." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Només elements acceptats i reproduïts." }, "idempotent_replay": { "type": "boolean", "description": "Només elements acceptats i reproduïts." }, "rule_matches": { "type": "array", "description": "Només elements acceptats i reproduïts.", "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": "Clau de la biblioteca quan la regla es va instal·lar des de la biblioteca de regles; en cas contrari, null." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Les regles `TEST` registren la coincidència però no apliquen cap acció." }, "is_async": { "type": "boolean", "description": "`true` quan la coincidència prové de la passada 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": "Com a mínim un element ha estat rebutjat. Els altres elements s'han emmagatzemat; corregeix i torna a enviar només els rebutjats (tornar a enviar un element acceptat és segur, es retorna com a `replayed`).", "content": { "application/json": { "schema": { "type": "object", "required": [ "accepted_count", "replayed_count", "rejected_count", "results" ], "properties": { "accepted_count": { "type": "integer", "minimum": 0, "description": "Elements emmagatzemats i avaluats." }, "replayed_count": { "type": "integer", "minimum": 0, "description": "Elements ja emmagatzemats amb el mateix contingut." }, "rejected_count": { "type": "integer", "minimum": 0, "description": "Elements no emmagatzemats." }, "results": { "type": "array", "description": "Una entrada per element, en l'ordre de la sol·licitud.", "items": { "type": "object", "description": "Resultat d'un element. Els elements acceptats i repetits també inclouen tots els camps de `MonitoringEventIngestResult`; els elements rebutjats inclouen `event_id` i `errors` en el seu lloc.", "required": [ "index", "outcome" ], "properties": { "index": { "type": "integer", "minimum": 0, "description": "Posició de l'element al teu array `events`." }, "outcome": { "type": "string", "enum": [ "accepted", "replayed", "rejected" ], "description": "`accepted`: emmagatzemat i avaluat. `replayed`: ja emmagatzemat amb el mateix contingut. `rejected`: no emmagatzemat; consulta `errors`." }, "event_id": { "type": "string", "nullable": true, "description": "El teu `event_id`. En els elements rebutjats per validació es llegeix des de la clau `event_id` en snake_case de l'element, de manera que és null si l'element l'ha omès o ha enviat l'àlies `eventId`." }, "errors": { "type": "object", "additionalProperties": true, "description": "Només elements rebutjats. Errors de validació indexats per camp, amb el mateix format que el `400` de `POST /v3/events/`; un `event_id` reutilitzat amb contingut diferent es notifica com a cadena sota `errors.event_id`." }, "event_uuid": { "type": "string", "format": "uuid", "description": "Només elements acceptats i reproduïts." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "Només elements acceptats i reproduïts." }, "score": { "type": "integer", "description": "Només elements acceptats i reproduïts." }, "rules_evaluated_count": { "type": "integer", "description": "Només elements acceptats i reproduïts." }, "rules_matched_count": { "type": "integer", "description": "Només elements acceptats i reproduïts." }, "correlation_pending": { "type": "boolean", "description": "Només elements acceptats i reproduïts." }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Només elements acceptats i reproduïts." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Només elements acceptats i reproduïts." }, "idempotent_replay": { "type": "boolean", "description": "Només elements acceptats i reproduïts." }, "rule_matches": { "type": "array", "description": "Només elements acceptats i reproduïts.", "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": "Clau de la biblioteca quan la regla es va instal·lar des de la biblioteca de regles; en cas contrari, null." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Les regles `TEST` registren la coincidència però no apliquen cap acció." }, "is_async": { "type": "boolean", "description": "`true` quan la coincidència prové de la passada 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 lot està mal format: `events` falta o no és una matriu, està buit o té més de 500 elements. No s'emmagatzema res; divideix els lots grans.", "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 clau d'API amb abast ha caducat. Només una clau caducada rep `401`; una clau absent o no vàlida rep `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), una clau amb àmbit sense `transactions: write`, una clau limitada a determinats fluxos de treball o a sessions aprovades (aquesta clau mai no accedeix a dades de monitoratge de transaccions), o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau. També es retorna amb `code: event_monitoring_disabled` mentre la ingesta d'esdeveniments estigui desactivada per a l'aplicació; en aquest cas no s'emmagatzema res, i la comprovació s'executa abans de validar el cos.", "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": "S'ha superat el límit de freqüència: les creacions de transaccions i la ingesta d'esdeveniments (`POST /v3/transactions/`, `POST /v3/events/`, `POST /v3/events/batch/`) comparteixen un pressupost de 600 sol·licituds per minut per clau d'API, independent de les 300 que comparteixen la resta de sol·licituds d'escriptura. Espera els segons indicats a `Retry-After` i reintenta-ho.", "headers": { "Retry-After": { "description": "Segons d'espera abans de reintentar, arrodonits a l'alça perquè el reintent caigui a la finestra següent.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Ingestion rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/sdk-token/": { "post": { "summary": "Genera un token de l'SDK de monitoratge", "description": "Genera una credencial de dispositiu de curta durada vinculada a un subjecte, de manera que la teva aplicació web o mòbil pugui enviar els esdeveniments d'aquest usuari directament a Didit sense una clau d'API. L'aplicació envia el `monitoring_token` retornat a la capçalera `X-Monitoring-Token` al canal del dispositiu (`POST /v1/events/` i `POST /v1/events/batch/`), on el subjecte sempre se sobreescriu amb aquest `vendor_data`, els esdeveniments fora de `allowed_event_categories` es rebutgen, cada esdeveniment enviat consumeix un ús i es rebutja qualsevol sol·licitud l'`Origin` de la qual no sigui igual a `bind_to_origin`. Crida'l només des del teu backend; la generació només crea la credencial (no es crea cap usuari). La ingesta d'esdeveniments ha d'estar activada per a l'aplicació; en cas contrari, aquest endpoint retorna `403` amb `code: event_monitoring_disabled` en lloc de generar una credencial que no podria escriure mai. Una clau d'API amb abast limitat necessita `transactions: write`. Consulta [Enviament d'esdeveniments de l'SDK](https://docs.didit.me/ca/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": "S'accepten àlies en camelCase: `vendorData`, `entityType`, `allowedEventCategories`, `ttlSeconds`, `maxUses`, `bindToOrigin`.", "required": [ "vendor_data" ], "properties": { "vendor_data": { "type": "string", "minLength": 1, "maxLength": 255, "description": "El teu id per al subjecte al qual pertany cada esdeveniment enviat amb aquesta credencial." }, "entity_type": { "type": "string", "maxLength": 32, "default": "individual", "description": "`company` vincula un subjecte d'empresa; qualsevol altre valor (per defecte `individual`) vincula un particular." }, "allowed_event_categories": { "type": "array", "items": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ] }, "description": "Categories que la credencial pot enviar. Omet-ho o envia `[]` per permetre totes les categories." }, "ttl_seconds": { "type": "integer", "minimum": 60, "maximum": 86400, "default": 900, "description": "Temps de vida de la credencial en segons." }, "max_uses": { "type": "integer", "minimum": 1, "nullable": true, "default": 1000, "description": "Nombre d'esdeveniments que la credencial pot enviar (un lot consumeix un ús per esdeveniment). Envia `null` per no establir cap límit durant el període de validesa." }, "bind_to_origin": { "type": "string", "maxLength": 255, "nullable": true, "description": "Quan s'estableix, la capçalera `Origin` del navegador de cada sol·licitud del dispositiu ha de coincidir exactament amb aquest valor; una sol·licitud sense `Origin` es rebutja." } } }, "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": "S'ha emès la credencial. Lliura `monitoring_token` a l'aplicació i tracta'l com a secret fins a `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 de dispositiu (un token segur per a URL de 43 caràcters). Envia-la a la capçalera `X-Monitoring-Token`." }, "expires_at": { "type": "string", "format": "date-time", "description": "Quan la credencial deixa de ser acceptada." }, "allowed_event_categories": { "type": "array", "items": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ] }, "description": "Categories que la credencial pot enviar; `[]` significa totes les categories." }, "max_uses": { "type": "integer", "nullable": true, "description": "Pressupost d'esdeveniments de la credencial; null significa sense límit." }, "bind_to_origin": { "type": "string", "nullable": true, "description": "Origen al qual 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": "La validació ha fallat: falta `vendor_data`, `ttl_seconds` fora del rang de 60 a 86400, `max_uses` inferior a 1 o una categoria desconeguda (indexada per la seva posició a l'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 clau d'API amb abast ha caducat. Només una clau caducada rep `401`; una clau absent o no vàlida rep `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), una clau amb àmbit sense `transactions: write`, una clau limitada a determinats fluxos de treball o a sessions aprovades (aquesta clau mai no accedeix a dades de monitoratge de transaccions), o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau. També es retorna amb `code: event_monitoring_disabled` mentre la ingesta d'esdeveniments estigui desactivada per a l'aplicació; en aquest cas no s'emmagatzema res, i la comprovació s'executa abans de validar el cos.", "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": "S'ha superat el límit de freqüència: les sol·licituds d'escriptura (`POST`, `PATCH`, `DELETE`) comparteixen un pressupost de 300 sol·licituds per minut per clau d'API. Espera els segons indicats a `Retry-After` i reintenta-ho.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans 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": "Obtenir l'esdeveniment de monitoratge", "description": "Recupera un esdeveniment de monitoratge amb tot el que retorna la llista més el payload, els valors personalitzats, el context del dispositiu, la procedència dels camps (`field_sources`), els camps de domini promocionats, `expires_at`, cada execució de regla coincident amb les seves evidències, l'enriquiment d'IP i les etiquetes que han afegit les regles. Mentre `correlation_pending` sigui `true`, encara s'ha d'executar una regla asíncrona; torna a llegir l'esdeveniment al cap d'uns minuts per obtenir els valors finals de `status`, `score` i `rule_runs`. Les lectures funcionen tant si la ingesta d'esdeveniments està activada com si no. Una clau d'API amb abast limitat necessita `transactions: read`. Consulta [Evidència](https://docs.didit.me/ca/transaction-monitoring/event-rules#evidència) i [Enriquiment d'IP](https://docs.didit.me/ca/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 de l'esdeveniment (`event_uuid` de la resposta de creació, lot, llistat o línia temporal), no el teu propi `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": "L'esdeveniment amb les seves evidències.", "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 clau d'API amb abast ha caducat. Només una clau caducada rep `401`; una clau absent o no vàlida rep `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), una clau amb àmbit sense `transactions: read`, una clau limitada a determinats fluxos de treball o a sessions aprovades (aquesta clau mai no accedeix a dades de monitoratge de transaccions), o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau.", "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 existeix cap esdeveniment amb aquest `event_uuid` a l'aplicació: mai no s'ha emmagatzemat, s'ha suprimit o pertany a una altra aplicació. Un segment de ruta que no sigui un UUID no coincideix amb la ruta i també retorna `404`.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No MonitoringEvent matches the given query." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència: les sol·licituds `GET` comparteixen un pressupost de 600 sol·licituds per minut per clau d'API. Espera els segons indicats a `Retry-After` i reintenta-ho.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans 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": "Obtenir la cronologia d'esdeveniments del subjecte", "description": "Llista cada esdeveniment de monitoratge d'un subjecte, el més recent segons `occurred_at` primer. Un `vendor_data` només és únic dins d'un tipus d'entitat, de manera que el mateix identificador pot designar una persona física i una empresa: `entity_type` tria quina cronologia obtens, i per defecte és `individual`, de manera que els esdeveniments d'una empresa requereixen `entity_type=company`. Els filtres de `GET /v3/events/` també s'apliquen, i un `vendor_data` sense esdeveniments retorna una pàgina buida en comptes d'un `404`. Una clau d'API amb àmbit necessita `transactions: read`. Consulta [Lectura d'esdeveniments](https://docs.didit.me/ca/transaction-monitoring/events#consultar-els-esdeveniments).", "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": "El teu id per al subjecte (`subject.vendor_data` dels seus esdeveniments). Codifica'l com a URL; aquest endpoint no pot adreçar un valor que contingui `/`.", "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "example": "user-42" }, { "name": "entity_type", "in": "query", "required": false, "description": "`company` retorna l'empresa amb aquest `vendor_data`; qualsevol altre valor, o cap, retorna l'individu. S'accepta `subject_entity_type` com a àlies quan `entity_type` no hi és present.", "schema": { "type": "string", "enum": [ "individual", "company" ], "default": "individual" }, "example": "individual" }, { "name": "limit", "in": "query", "required": false, "description": "Nombre màxim d'esdeveniments per pàgina. Per defecte és 50. Els valors superiors a 1000000 retornen `400`; un valor no numèric, zero o negatiu torna al valor predeterminat de 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 50 }, { "name": "offset", "in": "query", "required": false, "description": "Nombre d'esdeveniments que cal ometre. Per defecte és 0. És preferible seguir l'URL `next` de la resposta.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 0 }, { "name": "event_category", "in": "query", "required": false, "description": "Només esdeveniments en aquestes categories. Repeteix el paràmetre per a diversos valors (`?event_category=payment&event_category=dispute`); es retorna un esdeveniment que coincideixi amb qualsevol d'ells.", "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": "Només esdeveniments amb aquests tipus d'acció (exactes i que distingeixen entre majúscules i minúscules). Repeteix per a diversos valors.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "deposit_completed", "chargeback_opened" ] }, { "name": "status", "in": "query", "required": false, "description": "Només esdeveniments amb aquests estats. Repeteix per a diversos valors.", "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": "Només esdeveniments en aquestes classes de conservació. Repeteix per a diversos valors.", "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": "Coincidència exacta amb el `business.vendor_data` enviat amb l'esdeveniment.", "schema": { "type": "string" }, "example": "merchant-7" }, { "name": "session_id", "in": "query", "required": false, "description": "Coincidència exacta amb `session.session_id`.", "schema": { "type": "string" }, "example": "web-session-abc" }, { "name": "device_fingerprint", "in": "query", "required": false, "description": "Coincidència exacta amb `device_context.fingerprint`.", "schema": { "type": "string" }, "example": "fp-a8c1" }, { "name": "ip_address", "in": "query", "required": false, "description": "Coincidència exacta amb l'adreça IP de l'esdeveniment.", "schema": { "type": "string" }, "example": "203.0.113.42" }, { "name": "game_id", "in": "query", "required": false, "description": "Coincidència exacta amb el `game_id` promocionat.", "schema": { "type": "string" }, "example": "poker-holdem-01" }, { "name": "round_id", "in": "query", "required": false, "description": "Coincidència exacta amb el `round_id` promocionat.", "schema": { "type": "string" }, "example": "round-88231" }, { "name": "affiliate_code", "in": "query", "required": false, "description": "Coincidència exacta amb l'`affiliate_code` promocionat.", "schema": { "type": "string" }, "example": "aff-summer" }, { "name": "payment_reference_id", "in": "query", "required": false, "description": "Coincidència exacta amb la referència de pagament (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": "Coincidència exacta amb el `counterparty_vendor_data` promocionat.", "schema": { "type": "string" }, "example": "user-77" }, { "name": "matched_only", "in": "query", "required": false, "description": "`true` (també `1` o `yes`, no distingeix majúscules de minúscules) només retorna esdeveniments en què ha coincidit almenys una regla (`rules_matched_count` superior a 0). Qualsevol altre valor s'ignora.", "schema": { "type": "boolean", "default": false }, "example": true }, { "name": "occurred_from", "in": "query", "required": false, "description": "Només esdeveniments amb `occurred_at` en aquest instant o després (inclusiu). Envia un valor ISO 8601: `2026-10-01T00:00:00Z`, un desplaçament explícit amb el `+` codificat en percentatge (`2026-10-01T02:00:00%2B02:00`; un `+` sense codificar es descodifica com un espai i el valor deixa de processar-se correctament), o només una data (`2026-10-01`), que significa les 00:00:00 UTC d'aquell dia. Un valor sense desplaçament s'interpreta com a UTC. No s'accepten valors en cap altre format.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-01T00:00:00Z" }, { "name": "occurred_to", "in": "query", "required": false, "description": "Només esdeveniments amb `occurred_at` en aquest instant o abans (inclusiu). Només una data significa l'inici d'aquell dia, de manera que `occurred_to=2026-10-15` exclou la resta del 15 d'octubre; envia `2026-10-15T23:59:59Z` per incloure-ho. Envia un valor ISO 8601: `2026-10-01T00:00:00Z`, un desplaçament explícit amb el `+` codificat en percentatge (`2026-10-01T02:00:00%2B02:00`; un `+` sense codificar es descodifica com un espai i el valor deixa de processar-se correctament), o només una data (`2026-10-01`), que significa les 00:00:00 UTC d'aquell dia. Un valor sense desplaçament s'interpreta com a UTC. No s'accepten valors en cap altre format.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-17T23:59:59Z" }, { "name": "search", "in": "query", "required": false, "description": "Coincidència de subcadena que no distingeix majúscules de minúscules a `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 dels esdeveniments del subjecte.", "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` o `offset` és superior a 1000000. El cos és una matriu JSON amb un missatge. Un `limit` no numèric o no positiu torna al valor per defecte de 50 en lloc de fallar.", "content": { "application/json": { "examples": { "limit too large": { "summary": "limit per sobre de 1000000", "value": [ "limit must not exceed 1000000." ] }, "offset too large": { "summary": "offset per sobre de 1000000", "value": [ "offset must not exceed 1000000." ] } } } } }, "401": { "description": "La clau d'API amb abast ha caducat. Només una clau caducada rep `401`; una clau absent o no vàlida rep `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), una clau amb àmbit sense `transactions: read`, una clau limitada a determinats fluxos de treball o a sessions aprovades (aquesta clau mai no accedeix a dades de monitoratge de transaccions), o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau.", "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": "S'ha superat el límit de freqüència: les sol·licituds `GET` comparteixen un pressupost de 600 sol·licituds per minut per clau d'API. Espera els segons indicats a `Retry-After` i reintenta-ho.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans 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": "Obtenir les mètriques d'enriquiment d'esdeveniments", "description": "Retorna els comptadors d'ingesta d'esdeveniments i d'enriquiment d'IP de la teva aplicació per a un període, sumats a través de totes les vies (servidor, lot i dispositiu), perquè puguis supervisar el volum d'esdeveniments i confirmar que l'enriquiment es resol un cop per adreça única en comptes d'un cop per esdeveniment. El període cobreix el dia d'avui més els `days` dies anteriors, comptats per data de calendari UTC. Les tres ràtios són nul·les quan el seu denominador és zero. Una clau d'API amb àmbit necessita `transactions: read`. Consulta [Enriquiment d'IP](https://docs.didit.me/ca/transaction-monitoring/events#enriquiment-d’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": "Durada del període en dies. El valor per defecte és 30; els valors s'ajusten entre 1 i 365, i un valor no enter torna a 30. El valor aplicat es retorna com a `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": "Comptadors i ràtios per al període.", "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": "Nous esdeveniments emmagatzemats. Les repeticions idempotents no es comptabilitzen." }, "events_rejected": { "type": "integer", "description": "Elements rebutjats dins de sol·licituds per lots (carrils de servidor i de dispositiu). No es compta una sol·licitud d'un sol esdeveniment rebutjada." }, "enrichment_lookups": { "type": "integer", "description": "Esdeveniments l'adreça IP pública dels quals s'ha resolt, des de la memòria cau o directament." }, "enrichment_cache_hits": { "type": "integer", "description": "Consultes resoltes des de la memòria cau." }, "enrichment_provider_calls": { "type": "integer", "description": "Consultes que han requerit una nova resolució de l'adreça." }, "enrichment_skipped_low_value": { "type": "integer", "description": "Esdeveniments de telemetria de baix valor l'adreça dels quals no es coneixia prèviament. Mai desencadenen una nova resolució per si mateixos." }, "unique_ips_seen": { "type": "integer", "description": "Adreces que requerien una nova resolució." }, "period_days": { "type": "integer", "description": "El valor `days` aplicat després de l'ajust als límits." }, "cache_hit_rate": { "type": "number", "nullable": true, "description": "`enrichment_cache_hits / enrichment_lookups`, arrodonit a 4 decimals. Null quan no hi ha hagut consultes." }, "unique_ip_ratio": { "type": "number", "nullable": true, "description": "`unique_ips_seen / events_ingested`, arrodonit a 4 decimals. Nul quan no s'ha ingerit cap esdeveniment." }, "provider_calls_per_1k_events": { "type": "number", "nullable": true, "description": "Resolucions recents per cada 1000 esdeveniments ingerits, arrodonit a 2 decimals. Null si no s'ha ingerit cap esdeveniment." } } }, "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 clau d'API amb abast ha caducat. Només una clau caducada rep `401`; una clau absent o no vàlida rep `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), una clau amb àmbit sense `transactions: read`, una clau limitada a determinats fluxos de treball o a sessions aprovades (aquesta clau mai no accedeix a dades de monitoratge de transaccions), o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau.", "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": "S'ha superat el límit de freqüència: les sol·licituds `GET` comparteixen un pressupost de 600 sol·licituds per minut per clau d'API. Espera els segons indicats a `Retry-After` i reintenta-ho.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans 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": "Elimina l'esdeveniment de monitoratge", "description": "Elimina permanentment un esdeveniment de monitoratge juntament amb les seves execucions de regles, notes i enllaços d'etiquetes, per exemple un esdeveniment enviat per error. Després del `204`, l'esdeveniment desapareix de qualsevol lectura (la recuperació retorna `404`, i ja no apareix a la llista ni a la cronologia del subjecte), l'eliminació és irreversible i el seu `event_id` es pot utilitzar per a un nou esdeveniment. No es veuen afectats: l'usuari o l'empresa als quals s'ha resolt l'esdeveniment, els casos que ha obert una regla, les entrades de llista que ha afegit una regla i les puntuacions i estats que ja s'han aplicat a altres esdeveniments. Per esborrar-ho tot sobre una persona o una empresa, elimina l'usuari o l'empresa directament, la qual cosa també elimina els seus esdeveniments. Una clau d'API amb abast limitat necessita `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 de l'esdeveniment (`event_uuid` de la resposta de creació, lot, llistat o línia temporal), no el teu propi `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": "L'esdeveniment s'ha suprimit. Sense cos." }, "401": { "description": "La clau d'API amb abast ha caducat. Només una clau caducada rep `401`; una clau absent o no vàlida rep `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falta la capçalera `x-api-key` (una clau incorrecta, revocada o caducada rep un `401`), una clau amb àmbit sense `transactions: write`, una clau limitada a determinats fluxos de treball o a sessions aprovades (aquesta clau mai no accedeix a dades de monitoratge de transaccions), o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau.", "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 existeix cap esdeveniment amb aquest `event_uuid` a l'aplicació: mai no s'ha emmagatzemat, s'ha suprimit o pertany a una altra aplicació. Un segment de ruta que no sigui un UUID no coincideix amb la ruta i també retorna `404`.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No MonitoringEvent matches the given query." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència: les sol·licituds d'escriptura (`POST`, `PATCH`, `DELETE`) comparteixen un pressupost de 300 sol·licituds per minut per clau d'API. Espera els segons indicats a `Retry-After` i reintenta-ho.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans 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": "Regenera la sessió de KYC d'una entitat de persones clau", "description": "Assigna a una part de Persones clau d'una sessió de Verificació d'empreses (KYB) una nova sessió de KYC individual després que l'anterior s'hagi suprimit o hagi caducat abans que la persona la comencés, de manera que la comprovació de Persones clau pugui finalitzar de nou; no enviïs cap cos de la sol·licitud. Funciona quan la sessió de KYC de la part s'ha suprimit (`kyc_session_deleted: true`) o ha caducat abans que la persona la comencés (`Expired`, que no s'havia iniciat mai). Una sessió que encara estigui en curs o una que hagi finalitzat en qualsevol altre estat (`Approved`, `Declined`, `In Review`, `Abandoned`, ...) retorna `409` tret que s'hagi suprimit. Una part que mai no n'hagi tingut cap o una part d'empresa sempre retorna `409`. Didit crea una nova sessió de KYC allotjada amb el flux de treball amb el qual es va verificar la part (la seva darrera versió publicada) o, quan aquesta ja no es conegui, el flux de treball que la teva configuració de Persones clau assigna al rol de la part, de manera que l'enllaç tingui una validesa igual al temps de caducitat de la sessió d'aquest flux de treball de KYC; envia l'enllaç per correu electrònic a la part quan hi ha un correu electrònic registrat, neteja `is_skipped` i torna a calcular la comprovació de Persones clau i l'estat de la sessió de l'empresa. Després envia un [webhook](https://docs.didit.me/ca/integration/webhooks) `data.updated` per a la sessió de l'empresa amb l'activador `console_key_people_regenerate`; per eximir la part en el seu lloc, fes servir `PATCH /v3/session/{sessionId}/kyb/parties/{partyUuid}/`. Una clau d'API amb abast necessita `decisions: write`, i sense `sessions: write` rep `kyc_session_url` com a `null`. Les sessions suprimides compleixen els requisits fins i tot si la persona ja havia començat o finalitzat la verificació. Les sessions importades no compleixen els requisits per caducitat; s'han d'haver suprimit.", "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 sessió pare de Verificació d'empreses (KYB).", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "partyUuid", "in": "path", "required": true, "description": "UUID de la part de Persones clau (`key_people_checks[].submitted.parties[].uuid` a la decisió de la sessió d'empresa). Ha de pertànyer a la sessió a la qual fa referència `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": "S'ha creat una nova sessió de KYC. Retorna l'entitat actualitzada amb la seva nova sessió filla, que caduca després del temps de caducitat de la sessió del seu flux de treball de 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 clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna `401`: una clau absent, no vàlida o revocada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "summary": "La data de caducitat de la clau ha passat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallada d'autenticació o d'autorització. Si falta la clau es retorna `403`, igual que amb una clau d'una altra aplicació, una clau amb àmbit sense el permís que necessita aquest endpoint o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau; una clau incorrecta, revocada o caducada retorna `401`. Distingeix-les pel camp `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta la capçalera x-api-key, o la clau ha fallat la validació", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clau vàlida que pertany a una aplicació diferent de la de la sessió", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clau amb abast li manca el permís d'escriptura de decisions", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Sol·licitud des de fora de la llista d'adreces IP permeses de la clau", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sessió no existeix, s'ha suprimit o queda fora dels límits d'una clau amb abast limitat; no existeix cap part amb aquest UUID a la teva aplicació; o la part pertany a una altra sessió. Cada cas té el seu propi `detail`. La cerca de la sessió s'executa abans de comprovar les credencials, de manera que un `sessionId` desconegut retorna `404` fins i tot sense una clau vàlida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Unknown session": { "summary": "No existeix cap sessió amb aquest ID, o s'ha suprimit", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "La sessió queda fora dels límits del flux de treball o dels límits que només permeten sessions aprovades d'una clau amb abast limitat", "value": { "detail": "Session not found." } }, "Unknown party": { "summary": "No hi ha cap part amb aquest UUID a la teva aplicació", "value": { "detail": "No BusinessParty matches the given query." } }, "Party of another session": { "summary": "partyUuid existeix però pertany a una sessió diferent", "value": { "detail": "Party does not belong to the given session." } } } } } }, "409": { "description": "La part no té cap sessió de KYC apta per substituir. Tret que s'elimini, una sessió que encara estigui en curs o una que hagi finalitzat en un altre estat (`Approved`, `Declined`, `In Review`, `Abandoned`, ...) no es pot regenerar. Una part que mai no n'hagi tingut o una part d'empresa també retorna `409`. Una sessió apta s'ha eliminat o ha caducat abans que la persona l'iniciés. Les sessions eliminades són aptes fins i tot si la persona ja havia iniciat o finalitzat la verificació. Les sessions importades no són aptes per caducitat; s'han d'haver eliminat. Bifurca segons `code`.", "content": { "application/json": { "schema": { "type": "object", "required": [ "detail", "code" ], "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." }, "code": { "type": "string", "enum": [ "kyb_party_kyc_session_not_deleted" ], "description": "Codi d'error llegible per màquina estable." } } }, "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": "S'ha superat el límit de freqüència: 300 sol·licituds d'escriptura (POST, PATCH, DELETE) per minut per clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar; les capçaleres `X-RateLimit-*` mostren el pressupost restant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Rate limited": { "summary": "Pressupost per al minut actual esgotat", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/transactions/{transaction_id}/notes/": { "get": { "summary": "Llista les notes de la transacció", "description": "Llista les notes d'una transacció monitorada, començant per la més recent (`created_at` descendent): notes que afegeixes a través de l'API, notes i canvis d'estat que fan els revisors a la consola, i notes que Didit afegeix automàticament (l'acció `add_note` d'una regla, o un problema en crear la sessió de verificació d'acció de l'usuari), que porten l'`actor_name` `Rule Engine`. `metadata` distingeix els tipus de nota.\n\nPaginat amb `limit` i `offset`. `count` és exacte fins a 100 i es limita a 100 per sobre d'aquest valor, així que segueix `next` fins que sigui `null` en lloc de calcular les pàgines a partir de `count`. Aquesta és una lectura sense efectes secundaris.\n\nUna clau d'API amb abast restringit necessita `transactions: read`; una clau limitada a alguns fluxos de treball o a sessions aprovades no pot cridar aquest endpoint. Els revisors veuen la mateixa llista a **Notes** al [detall de la transacció](https://docs.didit.me/ca/transaction-monitoring/console#detall-de-la-transacció).", "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ó de Didit: el `uuid` retornat per `POST /v3/transactions/` i `GET /v3/transactions/`. No s'accepta el teu propi `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": "Nombre de notes per pàgina. Per defecte és 50. Un valor que no sigui un enter positiu torna a 50; un valor superior a 1000000 retorna `400`." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Posició basada en zero de la primera nota a retornar. És preferible seguir `next`. Un valor que no sigui un nombre enter torna a 0 per defecte; un valor superior a 1000000 retorna `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 notes, les més recents primer.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Nombre de notes a la transacció: exacte fins a 100, limitat a 100 per sobre d'aquest valor. Segueix `next` en comptes de calcular pàgines a partir d'aquest valor." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la pàgina següent, o `null` a l'última pàgina." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la pàgina anterior, o `null` a 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` o `offset` supera 1000000. El cos és una matriu JSON de missatges, no un objecte.", "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 clau d'API ha caducat. Només pot caducar una clau creada amb data de caducitat; després d'aquesta data, cada sol·licitud que s'hi faci rep una resposta `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Si falta la clau, es rep el missatge genèric; una clau incorrecta, revocada o caducada rep un `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 existeix cap transacció amb aquest UUID a l'aplicació (no s'ha creat mai, s'ha suprimit o pertany a una altra aplicació). Un `transaction_id` que no sigui un UUID no arriba a l'API: retorna una pàgina HTML `404` en lloc d'aquest cos 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 sol·licituds GET per minut amb aquesta clau d'API. Espera el nombre de segons indicat a `Retry-After` i torna-ho a provar.", "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": "Segons fins que es restableixi la finestra actual d'un minut.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses per minut en aquest pressupost.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Temps Unix en què es reinicia la finestra.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Crea una nota de transacció", "description": "Afegeix una nota en text pla a la cronologia de revisió d'una transacció monitorada, on els revisors de la Console la poden veure. Una nota proporciona context, no és una decisió: el `status`, el `score` i les alertes de la transacció no canvien, no s'envia cap webhook i no es factura res. Les `activities` de la transacció afegeixen una entrada `TRANSACTION_NOTE_ADDED`.\n\nLes notes creades amb una clau d'API no tenen autor: `actor_email` i `actor_name` són `null`, de manera que afegeix l'autor al text si el necessites. Cada adreça de `mentioned_emails` ha de pertànyer a un membre de la teva organització; en cas contrari, tota la sol·licitud falla amb `400`; les mencions s'emmagatzemen en minúscules i deduplicades, i aquest endpoint no notifica els membres mencionats.\n\nCada crida crea una nova nota, per la qual cosa reintentar una sol·licitud que ha esgotat el temps d'espera pot afegir-la dues vegades: llista les notes abans de reintentar. No hi ha cap endpoint de l'API per editar o eliminar una nota. Una clau d'API amb àmbit restringit necessita `transactions: write`; una clau limitada a determinats fluxos de treball o a sessions aprovades no pot cridar aquest 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ó de Didit: el `uuid` retornat per `POST /v3/transactions/` i `GET /v3/transactions/`. No s'accepta el teu propi `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 text pla. Els espais en blanc inicials i finals s'eliminen i es rebutja una nota en blanc. Sense límit de longitud." }, "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email" }, "default": [], "description": "Correus electrònics dels membres de la teva organització que cal esmentar. Cadascun ha de ser un correu electrònic vàlid d'un membre de l'organització." } } }, "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": "La nota s'ha creat.", "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 cos no és vàlid: falta `note`, és nul o està en blanc, hi ha una adreça no vàlida a `mentioned_emails` (errors indexats per posició a la llista) o una adreça esmentada que no és membre de la teva organització. No s'ha creat res.", "content": { "application/json": { "schema": { "type": "object", "description": "Errors de camp indexats pel nom del camp.", "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 clau d'API ha caducat. Només pot caducar una clau creada amb data de caducitat; després d'aquesta data, cada sol·licitud que s'hi faci rep una resposta `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Si falta la clau, es rep el missatge genèric; una clau incorrecta, revocada o caducada rep un `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 existeix cap transacció amb aquest UUID a l'aplicació (no s'ha creat mai, s'ha suprimit o pertany a una altra aplicació). Un `transaction_id` que no sigui un UUID no arriba a l'API: retorna una pàgina HTML `404` en lloc d'aquest cos 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 sol·licituds d'escriptura per minut amb aquesta clau d'API. Espera el nombre de segons indicat a `Retry-After` i torna-ho a provar.", "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": "Segons fins que es restableixi la finestra actual d'un minut.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses per minut en aquest pressupost.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Temps Unix en què es reinicia la finestra.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/transactions/{transaction_id}/related/": { "get": { "summary": "Llista les transaccions relacionades", "description": "Llista les altres transaccions de la teva aplicació que involucren les mateixes persones o empreses que aquesta. Una transacció està relacionada quan alguna de les seves parts, en qualsevol rol, té el mateix `vendor_data` que una de les parts d'aquesta transacció. La transacció en si no es retorna mai, i s'ignoren les parts sense `vendor_data`: si cap de les parts d'aquesta transacció en té un, el resultat sempre és buit.\n\nEls resultats utilitzen el format de resum de `GET /v3/transactions/`, ordenats de més nous a més antics (`txn_date` i després `created_at`). Paginats amb `limit` i `offset`; `count` és exacte fins a 100 i limitat a 100 per sobre d'aquest valor, de manera que has de seguir `next` fins que sigui `null`.\n\nUna clau d'API amb abast necessita `transactions: read`; una clau limitada a determinats fluxos de treball o a sessions aprovades no pot cridar aquest endpoint. Envia el mateix `vendor_data` per a la mateixa persona o empresa a cada [transacció](https://docs.didit.me/ca/transaction-monitoring/transactions#subjecte-i-contrapart) perquè aquesta llista estigui 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ó de Didit: el `uuid` retornat per `POST /v3/transactions/` i `GET /v3/transactions/`. No s'accepta el teu propi `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": "Nombre de transaccions per pàgina. Per defecte és 50. Un valor que no sigui un enter positiu torna a 50; un valor superior a 1000000 retorna `400`." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Posició basada en zero de la primera transacció a retornar. És preferible seguir `next`. Un valor que no sigui un nombre enter torna a 0 per defecte; un valor superior a 1000000 retorna `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 transaccions relacionades, les més recents primer.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Nombre de transaccions relacionades: exacte fins a 100, limitat a 100 per sobre d'aquest valor. Segueix `next` en comptes de calcular pàgines a partir d'aquest valor." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la pàgina següent, o `null` a l'última pàgina." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta de la pàgina anterior, o `null` a 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` o `offset` supera 1000000. El cos és una matriu JSON de missatges, no un objecte.", "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 clau d'API ha caducat. Només pot caducar una clau creada amb data de caducitat; després d'aquesta data, cada sol·licitud que s'hi faci rep una resposta `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Si falta la clau, es rep el missatge genèric; una clau incorrecta, revocada o caducada rep un `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 existeix cap transacció amb aquest UUID a l'aplicació (no s'ha creat mai, s'ha suprimit o pertany a una altra aplicació). Un `transaction_id` que no sigui un UUID no arriba a l'API: retorna una pàgina HTML `404` en lloc d'aquest cos 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 sol·licituds GET per minut amb aquesta clau d'API. Espera el nombre de segons indicat a `Retry-After` i torna-ho a provar.", "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": "Segons fins que es restableixi la finestra actual d'un minut.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses per minut en aquest pressupost.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Temps Unix en què es reinicia la finestra.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/businesses/{business_session_id}/pdf/": { "get": { "summary": "Descarrega un informe en PDF d'una sessió d'empresa", "description": "Genera l'informe en PDF d'una sessió de Verificació d'empreses (KYB): dades del registre mercantil, persones clau i titulars reals, documents, resultats d'AML i la resta de funcionalitats del flux de treball, a més de les etiquetes i l'activitat de revisió de la sessió. Amb la personalització de marca blanca activada, l'informe inclou el teu logotip i la URL de la teva política de privacitat. El cos és el mateix PDF (`application/pdf`), no pas JSON.\n\nLa sessió ha d'estar en estat `Approved`, `Declined` o `In Review`; qualsevol altre estat retorna `403`, de manera que primer cal esperar el [webhook](https://docs.didit.me/ca/integration/webhooks) `status.updated`. L'informe es genera a cada crida i no es factura res, per la qual cosa és millor desar el fitxer en lloc de sol·licitar-lo repetidament. `GET /v3/session/{sessionId}/generate-pdf/` genera el mateix tipus d'informe utilitzant només l'ID de sessió.\n\nUn informe en PDF es considera un element multimèdia: una clau d'API amb àmbit restringit necessita `businesses: read` i `media: read`, i una clau limitada a determinats fluxos de treball o a sessions aprovades no pot cridar-lo.", "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 l'organització.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació. Ha de ser l'aplicació a la qual pertany la clau d'API: una clau utilitzada en qualsevol altra aplicació rep un `403`.", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, { "name": "business_session_id", "in": "path", "required": true, "description": "`session_id` de la sessió de Verificació d'empreses (KYB), tal com es va retornar quan es va crear la sessió. Una sessió d'una altra aplicació retorna `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 renderitzat, retornat directament com a binari `application/pdf`.", "headers": { "Content-Disposition": { "description": "Sempre `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 clau d'API ha caducat. Només pot caducar una clau creada amb data de caducitat; després d'aquesta data, cada sol·licitud que s'hi faci rep una resposta `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa o la sessió no ha finalitzat. Revisa `detail`: una sessió que no estigui en `Approved`, `Declined` o `In Review`, una clau d'API absent (una clau incorrecta, revocada o caducada rep un `401`), un `application_id` que no pertany a l'aplicació de la clau, una clau amb àmbit sense `media: read` o `businesses: read`, una clau limitada a fluxos de treball o sessions aprovades, o una sol·licitud des de fora de la llista d'adreces IP de la clau.", "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 existeix cap sessió d'empresa amb aquest ID a l'aplicació (no es va crear mai, s'ha suprimit o pertany a una altra aplicació). Un valor que no sigui un UUID retorna una pàgina HTML `404` en lloc d'aquest cos 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 sol·licituds GET per minut amb aquesta clau d'API. Espera el nombre de segons indicat a `Retry-After` i torna-ho a provar.", "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": "Segons fins que es restableixi la finestra actual d'un minut.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses per minut en aquest pressupost.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Temps Unix en què es reinicia la finestra.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/pdf/": { "get": { "summary": "Descarrega un informe en PDF d'una transacció", "description": "Renderitza una transacció monitorada com a informe en PDF: visió general i veredicte, parts i mètodes de pagament, propietats personalitzades, alertes i execucions de regles, resultats de cribratge i de Travel Rule, el resum de la xarxa, el desglossament de costos, fins a 50 transaccions relacionades i les 20 entrades d'activitat més recents. El cos és el PDF mateix (`application/pdf`), no pas JSON.\n\nL'informe es renderitza a partir de les dades actuals de la transacció en cada crida, de manera que torna a sol·licitar-lo després d'un canvi d'estat. No s'emmagatzema res ni es factura res. La renderització pot trigar uns quants segons, de manera que fes servir un temps d'espera de client generós.\n\nAquest endpoint es troba en una ruta amb abast d'aplicació: posa el teu ID d'organització i l'ID de l'aplicació a la qual pertany la teva clau d'API a l'URL ([troba el teu ID d'organització](https://docs.didit.me/ca/getting-started/api-authentication#trobar-el-teu-id-d’organització)). Un informe en PDF compta com a contingut multimèdia: una clau d'API amb abast necessita `media: read` i `transactions: read`, i una clau limitada a alguns fluxos de treball o a sessions aprovades no el pot cridar.", "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 l'organització.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació. Ha de ser l'aplicació a la qual pertany la clau d'API: una clau utilitzada en qualsevol altra aplicació rep un `403`.", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, { "name": "transaction_uuid", "in": "path", "required": true, "description": "UUID de transacció de Didit: el `uuid` retornat per `POST /v3/transactions/` i `GET /v3/transactions/`. No s'accepta el teu propi `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 renderitzat, retornat directament com a binari `application/pdf`.", "headers": { "Content-Disposition": { "description": "Sempre `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 clau d'API ha caducat. Només pot caducar una clau creada amb data de caducitat; després d'aquesta data, cada sol·licitud que s'hi faci rep una resposta `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Consulta `detail`: una clau d'API absent (una clau incorrecta, revocada o caducada rep `401`), un `application_id` que no pertany a l'aplicació de la clau, una clau amb àmbit sense `media: read` o `transactions: read`, una clau limitada a fluxos de treball o sessions aprovades, o una sol·licitud des de fora de la llista d'adreces IP de la clau.", "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 existeix cap transacció amb aquest UUID a l'aplicació (no s'ha creat mai, s'ha suprimit o pertany a una altra aplicació). Un `transaction_uuid` que no sigui un UUID no arriba a l'API: retorna una pàgina HTML `404` en lloc d'aquest cos 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 sol·licituds GET per minut amb aquesta clau d'API. Espera el nombre de segons indicat a `Retry-After` i torna-ho a provar.", "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": "Segons fins que es restableixi la finestra actual d'un minut.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses per minut en aquest pressupost.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Temps Unix en què es reinicia la finestra.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/analytics/": { "get": { "summary": "Obtenir les analítiques de l'aplicació", "description": "Llegeix les xifres del [tauler d'analítica](https://docs.didit.me/ca/console/analytics) de la Business Console per a un interval de dates. Sense `scope` ni `widget_keys`, la resposta és el resum de verificació d'usuaris (KYC) (`ApplicationAnalyticsSummary`): recomptes diaris de sessions, totals per estat, taxa de conversió, les mateixes xifres per al període anterior d'igual durada, ubicacions, dades demogràfiques, dispositius, embuts del flux de treball, temps actiu de verificació, reenviaments, advertències i sèries temporals. Amb `scope` o `widget_keys` retorna els ginys d'una pestanya del tauler (`ApplicationAnalyticsWidgetResponse`): `kyc`, `kyb`, `transactions` o `home`.\n\nEls recomptes de sessions es basen en la data de creació de la sessió (UTC) i reflecteixen l'estat actual de cadascuna. Provenen d'agregacions diàries actualitzades en segon pla, per la qual cosa l'activitat més recent pot trigar una mica a aparèixer. Els ID i versions de flux de treball no vàlids s'ignoren en lloc de rebutjar-se. No es factura res.\n\nNomés una clau d'API d'accés complet pot cridar aquest endpoint: qualsevol clau d'API amb àmbit obté `403`, tingui els permisos que tingui, igual que la clau d'una altra aplicació. Consulta [Claus d'API](https://docs.didit.me/ca/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 l'organització.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació. Ha de ser l'aplicació a la qual pertany la clau d'API: una clau utilitzada en qualsevol altra aplicació rep un `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 dia de l'interval, `YYYY-MM-DD`, inclusiu (UTC). Envia'l juntament amb `end_date`: quan en falta algun, s'ignoren tots dos i l'interval abasta des de 30 dies abans d'avui fins a avui." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2026-10-15" }, "description": "Últim dia de l'interval, `YYYY-MM-DD`, inclusiu (UTC). Una data futura compta com avui. L'interval no pot superar els 730 dies." }, { "name": "scope", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "home", "kyc", "kyb", "transactions" ] }, "description": "Pestanya del tauler de la qual es retornaran els ginys (no distingeix entre majúscules i minúscules). Omet-la, juntament amb `widget_keys`, per obtenir el resum de KYC. Enviar només `widget_keys` implica `kyc`. `home` accepta qualsevol giny de KYC, KYB o de transaccions i s'estableix per defecte en el disseny d'inici desat de l'aplicació." }, { "name": "widget_keys", "in": "query", "required": false, "schema": { "type": "string", "example": "tx_count_total,tx_count_daily" }, "description": "Claus de widgets separades per comes, retornades en aquest ordre. S'ometen les claus que l'abast no admet; si no en queda cap, obtens els valors per defecte de l'abast. 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`. Transaccions: `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": "ID de flux de treball separats per comes. Limita el resum de KYC i els widgets de KYC i KYB a aquests fluxos de treball. Els valors que no siguin UUID s'ignoren; si cap no és vàlid, es descarta el filtre. El resum també accepta `workflow_id`." }, { "name": "versions", "in": "query", "required": false, "schema": { "type": "string", "example": "3,4" }, "description": "Números de versió del flux de treball separats per comes. Només s'aplica juntament amb `workflow_ids`; els valors que no siguin números enters s'ignoren. S'accepta `version` com a àlies." }, { "name": "branch_path_ids", "in": "query", "required": false, "schema": { "type": "string", "example": "default" }, "description": "Identificadors de camí de branca separats per comes. S'aplica només juntament amb `workflow_ids`, i només a les xifres de KYC. Actualment, les xifres només es registren per a `default` (tots els camins combinats), de manera que qualsevol altre valor retorna xifres buides. S'accepta `branch_path_id` com a àlies." }, { "name": "tag", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Només ginys de transaccions: UUIDs d'etiquetes o noms d'etiquetes separats per comes." }, { "name": "transaction_type", "in": "query", "required": false, "schema": { "type": "string", "example": "finance" }, "description": "Només ginys de transaccions: categories de transacció separades per comes." }, { "name": "action_type", "in": "query", "required": false, "schema": { "type": "string", "example": "withdrawal" }, "description": "Només ginys de transaccions: tipus d'acció separats per comes (sense distinció entre majúscules i minúscules)." } ], "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 resum de KYC, o els ginys sol·licitats quan s'envia `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": "Interval de dates o abast no vàlid. El cos és un objecte indexat pel paràmetre causant, amb un missatge de text.", "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 clau d'API ha caducat. Només pot caducar una clau creada amb data de caducitat; després d'aquesta data, cada sol·licitud que s'hi faci rep una resposta `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Consulta `detail`: una clau d'API absent (una clau incorrecta, revocada o caducada rep `401`), una clau d'una altra aplicació, qualsevol clau amb àmbit o una sol·licitud des de fora de la llista d'adreces IP de la clau.", "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 sol·licituds GET per minut amb aquesta clau d'API. Espera el nombre de segons indicat a `Retry-After` i torna-ho a provar.", "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": "Segons fins que es restableixi la finestra actual d'un minut.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses per minut en aquest pressupost.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Temps Unix en què es reinicia la finestra.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/analytics/today/": { "get": { "summary": "Obtenir les verificacions d'avui per hora", "operationId": "get_application_analytics_today", "x-didit-sdk": { "resource": "analytics", "method": "retrieve_today", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Analytics" ], "description": "Sessions de verificació d'usuaris (KYC) d'avui, des de la mitjanit local a `tz`, comptades per hora local en què es van crear, al costat de les mateixes hores del mateix dia de la setmana d'una setmana abans, i desglossades pel resultat que té cadascuna ara mateix: aprovada, en revisió o rebutjada. Aquesta és la targeta de volum de la pàgina d'inici de la Business Console.\n\n`total` és el total d'avui fins ara. `previous_total_so_far` compta el dia de comparació només fins a la mateixa hora local, de manera que un canvi entre ells compara la mateixa part d'ambdós dies. Les hores que encara falten avui tenen valor `0`. Un dia en què canvia l'hora té 23 o 25 hores: l'hora que falta es manté a `0` i l'hora repetida les inclou totes dues.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'organització.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació. Ha de ser l'aplicació a la qual pertany la clau d'API: una clau utilitzada en qualsevol altra aplicació rep un `403`.", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "default": "UTC", "example": "Europe/Madrid" }, "description": "Zona horària IANA la mitjanit de la qual comença avui, per exemple `Europe/Madrid` o `America/Mexico_City`. Omet-la per utilitzar UTC." } ], "responses": { "200": { "description": "Verificacions d'avui per hora local, les del dia de comparació i els resultats d'avui.", "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 horària desconeguda. El cos té com a claus els paràmetres, amb una llista de missatges.", "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 clau d'API ha caducat. Només pot caducar una clau creada amb data de caducitat; després d'aquesta data, cada sol·licitud que s'hi faci rep una resposta `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Consulta `detail`: una clau d'API absent o invàlida (mai `401`), una clau d'una altra aplicació, qualsevol clau amb àmbit o una sol·licitud des de fora de la llista d'adreces IP de la clau.", "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 sol·licituds GET per minut amb aquesta clau d'API. Espera el nombre de segons indicat a `Retry-After` i torna-ho a provar.", "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": "Segons fins que es restableixi la finestra actual d'un minut.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses per minut en aquest pressupost.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Temps Unix en què es reinicia la finestra.", "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": "Llista els lliuraments de webhook de la sessió", "description": "Llista cada lliurament de webhook que Didit ha registrat per a una sessió de verificació, d'usuari (KYC) o d'empresa (KYB), els més recents primer, com un array JSON simple (no paginat). Cada entrada és un intent cap a una destinació: el primer enviament, cada [reintent](https://docs.didit.me/ca/integration/webhooks#política-de-reintents) automàtic i cada reenviament són entrades separades amb el seu propi `uuid`, i els reintents i reenviats mantenen l'`event_id` del payload. `request_header` i `request_body` són text JSON; analitza'ls per llegir les signatures i el payload. Els registres de lliurament estan disponibles durant uns 30 dies, de manera que un array buit significa que encara no s'ha enviat cap webhook per a la sessió o que tots els lliuraments tenen més de 30 dies. Una clau d'API amb àmbit necessita `sessions: read` i `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 sessió de verificació, d'usuari (KYC) o d'empresa (KYB): el `session_id` retornat per `POST /v3/session/`. El servidor el resol per a tots dos tipus de sessió.\n\n**Ha de ser un UUID vàlid.** La ruta només coincideix amb UUIDs ben formats, de manera que el router d'URLs rebutja un valor mal format abans que s'executi qualsevol codi d'aplicació i la resposta és una pàgina **HTML** `404` en lloc de l'embolcall JSON `{\"detail\": ...}` que es mostra a continuació.", "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": "Tots els lliuraments registrats per a la sessió, del més recent al més antic.", "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 clau d'API ha caducat: es va crear amb una data de caducitat que ja ha passat. Una clau incorrecta o revocada també rep `401`; si falta la clau, es rep `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Si no s'indica `x-api-key`, o si la clau és invàlida o revocada, es rep `Authentication credentials were not provided or are invalid.` Una clau d'una altra aplicació rep `You do not have permission to perform this action.` Una clau amb àmbit que no tingui l'accés que aquest endpoint necessita rep un missatge indicant l'accés que falta, i una clau utilitzada des de fora de la seva llista d'adreces IP permeses rep `This API key can't be used from this IP address.` Un `sessionId` desconegut retorna `404` abans de comprovar les credencials.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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 sessió no existeix o s'ha suprimit (`Not found.`, retornat abans de comprovar les credencials), o queda fora dels límits de flux de treball o d'estat d'una clau amb abast limitat (`Session not found.`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Unknown session": { "value": { "detail": "Not found." } }, "Outside the key's limits": { "value": { "detail": "Session not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència: més de 600 sol·licituds GET en la finestra d'un minut actual per a aquesta clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses a la finestra d'un minut (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Temps Unix (segons) en què es reinicia la finestra actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nom del pressupost que s'ha superat.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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": "Obtenir el lliurament de webhook de la sessió", "description": "Recupera un lliurament de webhook d'una sessió de verificació: l'URL a la qual es va enviar, l'estat HTTP que va retornar el teu endpoint i les capçaleres exactes i el cos JSON que Didit va enviar. `request_header` i `request_body` són text JSON; per comprovar la teva [verificació de la signatura](https://docs.didit.me/ca/integration/webhooks#verificació-de-la-signatura), torna a calcular `X-Signature-V2` a partir del cos analitzat amb el secret de la destinació a la qual es va enviar (o el secret a nivell d'aplicació per a un lliurament a l'URL de webhook heretada). La ruta no té barra final: amb una barra retorna `404`. Una clau d'API amb abast limitat necessita `sessions: read` i `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 sessió de verificació, d'usuari (KYC) o d'empresa (KYB): el `session_id` retornat per `POST /v3/session/`. El servidor el resol per a tots dos tipus de sessió.\n\n**Ha de ser un UUID vàlid.** La ruta només coincideix amb UUIDs ben formats, de manera que el router d'URLs rebutja un valor mal format abans que s'executi qualsevol codi d'aplicació i la resposta és una pàgina **HTML** `404` en lloc de l'embolcall JSON `{\"detail\": ...}` que es mostra a continuació.", "schema": { "type": "string", "format": "uuid" }, "example": "22222222-3333-4444-5555-666666666666" }, { "name": "webhook_uuid", "in": "path", "required": true, "description": "UUID del lliurament: el `uuid` d'una entrada retornada per `GET /v3/session/{sessionId}/webhooks/`. Ha de pertànyer a la sessió de 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": "El lliurament, amb les seves capçaleres de sol·licitud i el cos.", "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 clau d'API ha caducat: es va crear amb una data de caducitat que ja ha passat. Una clau incorrecta o revocada també rep `401`; si falta la clau, es rep `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Si no s'indica `x-api-key`, o si la clau és invàlida o revocada, es rep `Authentication credentials were not provided or are invalid.` Una clau d'una altra aplicació rep `You do not have permission to perform this action.` Una clau amb àmbit que no tingui l'accés que aquest endpoint necessita rep un missatge indicant l'accés que falta, i una clau utilitzada des de fora de la seva llista d'adreces IP permeses rep `This API key can't be used from this IP address.` Un `sessionId` desconegut retorna `404` abans de comprovar les credencials.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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 sessió no existeix o s'ha suprimit (`Not found.`, retornat abans de comprovar les credencials), o queda fora dels límits de flux de treball o d'estat d'una clau amb abast limitat (`Session not found.`). Un lliurament que no existeix, que pertany a una altra sessió o que ja no està disponible retorna `No WebhookLog matches the given query.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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": "S'ha superat el límit de freqüència: més de 600 sol·licituds GET en la finestra d'un minut actual per a aquesta clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses a la finestra d'un minut (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Temps Unix (segons) en què es reinicia la finestra actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nom del pressupost que s'ha superat.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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 el lliurament del webhook de la sessió", "description": "Torna a enviar el webhook d'una sessió enregistrada a la URL on es va enviar originalment, amb el mateix payload i `event_id` i un `timestamp` nou, una capçalera `X-Timestamp` nova i signatures noves. Didit el signa amb el secret actual de la destinació a la qual pertany el lliurament (o el secret a nivell d'aplicació per a un lliurament a la URL del webhook antic), espera fins a 5 segons el teu endpoint, registra l'intent com un nou lliurament i el retorna amb `200` independentment de la resposta del teu endpoint: consulta `response_status`. Un reenviament no es reintenta automàticament i cada crida torna a fer l'enviament, de manera que el teu endpoint ha de ser idempotent per a l'`event_id`. La ruta no té barra final i la sol·licitud no té cos. Una clau d'API amb àmbit necessita `webhooks: write` i `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 sessió de verificació, d'usuari (KYC) o d'empresa (KYB): el `session_id` retornat per `POST /v3/session/`. El servidor el resol per a tots dos tipus de sessió.\n\n**Ha de ser un UUID vàlid.** La ruta només coincideix amb UUIDs ben formats, de manera que el router d'URLs rebutja un valor mal format abans que s'executi qualsevol codi d'aplicació i la resposta és una pàgina **HTML** `404` en lloc de l'embolcall JSON `{\"detail\": ...}` que es mostra a continuació.", "schema": { "type": "string", "format": "uuid" }, "example": "22222222-3333-4444-5555-666666666666" }, { "name": "webhook_uuid", "in": "path", "required": true, "description": "UUID del lliurament que cal reenviar: el `uuid` d'una entrada retornada per `GET /v3/session/{sessionId}/webhooks/`. Ha de pertànyer a la sessió de 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": "El nou lliurament, ja intentat. `response_status` és el que el teu endpoint ha respost aquesta vegada. El lliurament original no canvia.", "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": "El lliurament no s'ha pogut reenviar. Fes una bifurcació segons `code`: `webhook_url_missing` significa que el lliurament no té cap URL registrada i no s'envia res; `webhook_resend_error` significa que el lliurament emmagatzemat no s'ha pogut tornar a signar o que l'intent no s'ha pogut completar. Després de `webhook_resend_error`, `detail` comença amb `Error processing webhook resend:` seguit d'un text de diagnòstic que pot canviar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." }, "code": { "type": "string", "description": "Codi d'error llegible per màquina estable. Bifurca segons aquest codi, no pas segons `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 clau d'API ha caducat: es va crear amb una data de caducitat que ja ha passat. Una clau incorrecta o revocada també rep `401`; si falta la clau, es rep `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "La sol·licitud no està permesa. Si no s'indica `x-api-key`, o si la clau és invàlida o revocada, es rep `Authentication credentials were not provided or are invalid.` Una clau d'una altra aplicació rep `You do not have permission to perform this action.` Una clau amb àmbit que no tingui l'accés que aquest endpoint necessita rep un missatge indicant l'accés que falta, i una clau utilitzada des de fora de la seva llista d'adreces IP permeses rep `This API key can't be used from this IP address.` Un `sessionId` desconegut retorna `404` abans de comprovar les credencials.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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 sessió no existeix o s'ha suprimit (`Not found.`, retornat abans de comprovar les credencials), o queda fora dels límits de flux de treball o d'estat d'una clau amb abast limitat (`Session not found.`). Un lliurament que no existeix, que pertany a una altra sessió o que ja no està disponible retorna `Webhook log not found`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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": "S'ha superat el límit de freqüència: més de 300 sol·licituds d'escriptura (POST, PATCH, PUT, DELETE) en la finestra d'un minut actual per a aquesta clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Sol·licituds permeses a la finestra d'un minut (300).", "schema": { "type": "integer", "example": 300 } }, "X-RateLimit-Remaining": { "description": "Sol·licituds restants a la finestra actual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Temps Unix (segons) en què es reinicia la finestra actual.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nom del pressupost que s'ha superat.", "schema": { "type": "string", "example": "generic-write" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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": "Llista els esdeveniments de la sessió", "description": "Llegeix la cronologia d'esdeveniments d'una sessió de verificació, ordenada del més recent al més antic segons `sent_at`: les pantalles que ha vist l'usuari, botons i pujades, intents fallits, canvis d'estat i de passos de funcionalitats, i el rastre d'encaminament del flux de treball. Funciona per a IDs de sessió de Verificació d'usuaris (KYC) i Verificació d'empreses (KYB). Els esdeveniments s'emmagatzemen de manera asíncrona, de manera que un esdeveniment nou pot trigar uns segons a aparèixer. Els resultats estan paginats amb `limit` i `offset`; segueix `next` fins que sigui `null`. Una clau d'API amb àmbit necessita `sessions: read` i `decisions: read`, i sense `media: read` rep `file_url` com a `null`. Els esdeveniments d'encaminament es descriuen a [Recuperar sessió](https://docs.didit.me/ca/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 sessió de verificació (el `session_id` retornat per `POST /v3/session/`). Accepta tant IDs de sessió de Verificació d'usuaris (KYC) com de Verificació d'empreses (KYB): el servidor resol l'ID entre tots dos tipus de sessió. Ha de ser un UUID ben format; un valor mal format no coincideix amb la ruta i retorna un `404` en HTML.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "limit", "in": "query", "required": false, "description": "Nombre màxim d'esdeveniments per pàgina. Per defecte és 50. Un valor inferior a 1 o un valor no numèric torna al valor predeterminat de 50; un valor superior a 1,000,000 retorna `400`.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000, "example": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Nombre de resultats que cal ometre abans del primer retornat. Per defecte és 0; un valor negatiu o no numèric torna a 0, un valor superior a 1,000,000 retorna `400`. És preferible seguir els URL `next` i `previous`.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000, "example": 0 } }, { "name": "ordering", "in": "query", "required": false, "description": "Anul·lació opcional de l'ordenació. L'ordre predeterminat és `-sent_at`. Passa el nom d'un camp de resultat (per exemple `sent_at`, `created_at`, `event_type`, `feature_step` o `step`) per ordenar de manera ascendent, afegeix-li el prefix `-` per ordenar de manera descendent i separa diversos camps amb comes. Els camps desconeguts s'ignoren.", "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 dels esdeveniments de la sessió, els més recents primer.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Nombre total d'esdeveniments de la sessió." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la pàgina següent, o `null` a l'última pàgina." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la pàgina anterior, o `null` a 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` o `offset` supera 1,000,000. El cos és una matriu JSON amb un missatge.", "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 clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna `401`: una clau absent, no vàlida o revocada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "summary": "La data de caducitat de la clau ha passat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallada d'autenticació o d'autorització. Si falta la clau es retorna `403`, igual que amb una clau d'una altra aplicació, una clau amb àmbit sense el permís que necessita aquest endpoint o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau; una clau incorrecta, revocada o caducada retorna `401`. Distingeix-les pel camp `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta la capçalera x-api-key, o la clau ha fallat la validació", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clau vàlida que pertany a una aplicació diferent de la de la sessió", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without sessions read": { "summary": "A la clau amb abast li manca el permís de lectura de sessions", "value": { "detail": "This API key has no read access to sessions." } }, "Scoped key without decisions read": { "summary": "A la clau amb abast li manca el permís de lectura de decisions", "value": { "detail": "This API key has no read access to decisions." } }, "IP not allowed": { "summary": "Sol·licitud des de fora de la llista d'adreces IP permeses de la clau", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sessió no existeix, s'ha suprimit o queda fora dels límits de flux de treball o de sessions només aprovades d'una clau amb abast limitat. La cerca de la sessió s'executa abans de comprovar les credencials, de manera que un `sessionId` desconegut retorna `404` fins i tot sense una clau vàlida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Unknown session": { "summary": "No existeix cap sessió amb aquest ID, o s'ha suprimit", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "La sessió queda fora dels límits del flux de treball o dels límits que només permeten sessions aprovades d'una clau amb abast limitat", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència: 600 sol·licituds GET per minut per clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar; les capçaleres `X-RateLimit-*` mostren el pressupost.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Rate limited": { "summary": "Pressupost per al minut actual esgotat", "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/aml-screening-history/": { "get": { "summary": "Llistar l'historial de cribratge AML", "description": "Llista cada nou cribratge de monitoratge continu completat de la comprovació AML d'una sessió, els més recents primer per `completed_at`, incloses les execucions en què res no va canviar: les alertes, les entrades d'activitat i els webhooks només es disparen quan un resultat canvia, de manera que aquest historial és la prova que un subjecte net continuava sent sotmès a cribratge. Funciona per a identificadors de sessió de KYC i KYB; passa `node_id` quan la sessió hagi executat més d'un pas d'AML. Només es llisten els nous cribratges de monitoratge continu (el primer cribratge forma part de la decisió de la sessió) i no es reconstrueixen les execucions anteriors a l'existència d'aquest historial, per la qual cosa una sessió sense monitoratge continu retorna una llista buida. `count` és exacte fins a 100 i es limita a 100 per sobre d'aquest valor, de manera que segueix `next` fins que sigui `null`. Passa `month` per llegir un mes natural a la vegada. Una clau d'API amb àmbit necessita `decisions: read`; consulta [Monitoratge AML continu](https://docs.didit.me/ca/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 sessió de verificació (el `session_id` retornat per `POST /v3/session/`). Accepta tant IDs de sessió de Verificació d'usuaris (KYC) com de Verificació d'empreses (KYB): el servidor resol l'ID entre tots dos tipus de sessió. Ha de ser un UUID ben format; un valor mal format no coincideix amb la ruta i retorna 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 node del graf del flux de treball del cribratge AML. Només cal quan la sessió ha executat més d'un pas AML; si no s'especifica, s'utilitza el cribratge AML més recent. Un node desconegut fa que la crida retorni `404`.", "schema": { "type": "string", "example": "feature_aml_1" } }, { "name": "month", "in": "query", "required": false, "description": "Un mes natural UTC en format `YYYY-MM`. Només es retornen els cribratges completats en aquest mes; sense ell, es retornen tots els mesos. Un mes amb un format incorrecte retorna `400`.", "schema": { "type": "string", "pattern": "^\\d{4}-(0[1-9]|1[0-2])$", "example": "2026-09" } }, { "name": "limit", "in": "query", "required": false, "description": "Nombre màxim d'execucions de cribratge per pàgina. Per defecte és 50. Un valor inferior a 1 o un valor no numèric torna al valor predeterminat de 50; un valor superior a 1,000,000 retorna `400`.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000, "example": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Nombre de resultats que cal ometre abans del primer retornat. Per defecte és 0; un valor negatiu o no numèric torna a 0, un valor superior a 1,000,000 retorna `400`. És preferible seguir els URL `next` i `previous`.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000, "example": 0 } }, { "name": "ordering", "in": "query", "required": false, "description": "Anul·lació opcional de l'ordenació. L'ordre predeterminat és `-completed_at`. Passa el nom d'un camp de resultat (per exemple `completed_at`, `started_at`, `outcome` o `score`) per ordenar de manera ascendent, afegeix-li el prefix `-` per ordenar de manera descendent i separa diversos camps amb comes. Els camps desconeguts s'ignoren.", "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 d'execucions de cribratge, les més recents primer.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "maximum": 100, "description": "Nombre d'execucions, exacte fins a 100 i limitat a 100 per sobre d'aquest valor." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la pàgina següent, o `null` a l'última pàgina." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la pàgina anterior, o `null` a 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` o `offset` supera 1,000,000 (una matriu JSON amb un missatge), o `month` no és un mes natural `YYYY-MM` (un objecte amb la clau `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 clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna `401`: una clau absent, no vàlida o revocada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "summary": "La data de caducitat de la clau ha passat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallada d'autenticació o d'autorització. Si falta la clau es retorna `403`, igual que amb una clau d'una altra aplicació, una clau amb àmbit sense el permís que necessita aquest endpoint o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau; una clau incorrecta, revocada o caducada retorna `401`. Distingeix-les pel camp `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta la capçalera x-api-key, o la clau ha fallat la validació", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clau vàlida que pertany a una aplicació diferent de la de la sessió", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions read": { "summary": "A la clau amb abast li manca el permís de lectura de decisions", "value": { "detail": "This API key has no read access to decisions." } }, "IP not allowed": { "summary": "Sol·licitud des de fora de la llista d'adreces IP permeses de la clau", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sessió no existeix, s'ha suprimit o queda fora dels límits d'una clau amb abast limitat, o no té cap comprovació AML (per al `node_id` indicat). La cerca de la sessió s'executa abans de comprovar les credencials, de manera que un `sessionId` desconegut retorna `404` fins i tot sense una clau vàlida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Unknown session": { "summary": "No existeix cap sessió amb aquest ID, o s'ha suprimit", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "La sessió queda fora dels límits d'una clau amb abast limitat (també es retorna per a una sessió suprimida fa uns moments)", "value": { "detail": "Session not found." } }, "No AML check": { "summary": "La sessió no ha executat mai cap pas d'AML", "value": { "detail": "The session does not have an AML check." } }, "No AML check for node": { "summary": "node_id no coincideix amb cap comprovació AML de la sessió", "value": { "detail": "The session does not have an AML check for node 'feature_aml_2'." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència: 600 sol·licituds GET per minut per clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar; les capçaleres `X-RateLimit-*` mostren el pressupost.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Rate limited": { "summary": "Pressupost per al minut actual esgotat", "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/aml-screening-history/export/": { "get": { "summary": "Exportar l'historial de cribratge AML com a CSV", "description": "Descarrega el mateix historial de monitoratge continu que `GET /v3/session/{sessionId}/aml-screening-history/` en format de fitxer CSV, una línia per cada reanàlisi completada, començant per la més recent, a punt per entregar a un auditor. El fitxer es transmet sencer (sense paginació) i comença amb una línia de capçalera; una cel·la buida significa desconegut, les dates del conjunt de dades mai s'estimen i qualsevol valor que iniciï una fórmula de full de càlcul porta un apòstrof al davant. Funciona per a ID de sessió de KYC i KYB; passa `node_id` quan la sessió hagi executat més d'un pas d'AML. Passa `month` per exportar un mes natural. Els errors es retornen com a JSON, no com a CSV. Una clau d'API amb àmbit requereix `decisions: read` i `media: read`: la resposta és un fitxer, de manera que una clau sense `media: read` rep un `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 sessió de verificació (el `session_id` retornat per `POST /v3/session/`). Accepta tant IDs de sessió de Verificació d'usuaris (KYC) com de Verificació d'empreses (KYB): el servidor resol l'ID entre tots dos tipus de sessió. Ha de ser un UUID ben format; un valor mal format no coincideix amb la ruta i retorna 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 node del graf del flux de treball del cribratge AML. Només cal quan la sessió ha executat més d'un pas AML; si no s'especifica, s'utilitza el cribratge AML més recent. Un node desconegut fa que la crida retorni `404`.", "schema": { "type": "string", "example": "feature_aml_1" } }, { "name": "month", "in": "query", "required": false, "description": "Un mes natural UTC en format `YYYY-MM`. Només es retornen els cribratges completats en aquest mes; sense ell, es retornen tots els mesos. Un mes amb un format incorrecte retorna `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 fitxer CSV, transmès com a `text/csv` amb salts de línia CRLF. Columnes, en ordre: `screened_at` (quan ha finalitzat el nou cribratge), `outcome` (`NO_CHANGE`, `CHANGED` o `FAILED`), `provider` (identificador opac de la font de dades AML; no en creïs bifurcacions lògiques), `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` (l'execució del monitoratge), `entities_screened` (`1`, o `0` per a una execució fallida) i `new_hits` (buit quan es desconeix). Les dates són en format ISO 8601 amb un desplaçament UTC. Una sessió sense nous cribratges encara retorna només la línia de capçalera.", "headers": { "Content-Disposition": { "description": "`attachment; filename=\"aml-screening-history-{sessionId}.csv\"`, o `aml-screening-history-{sessionId}-{month}.csv` quan es passa `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 és 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 clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna `401`: una clau absent, no vàlida o revocada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "summary": "La data de caducitat de la clau ha passat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallada d'autenticació o d'autorització. Si falta la clau es retorna `403`, igual que amb una clau d'una altra aplicació, una clau amb àmbit sense el permís que necessita aquest endpoint o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau; una clau incorrecta, revocada o caducada retorna `401`. Distingeix-les pel camp `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta la capçalera x-api-key, o la clau ha fallat la validació", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clau vàlida que pertany a una aplicació diferent de la de la sessió", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions read": { "summary": "A la clau amb abast li manca el permís de lectura de decisions", "value": { "detail": "This API key has no read access to decisions." } }, "Scoped key without media read": { "summary": "A la clau amb abast li manca el permís media: read (la resposta és un fitxer)", "value": { "detail": "This API key has no read access to media." } }, "IP not allowed": { "summary": "Sol·licitud des de fora de la llista d'adreces IP permeses de la clau", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sessió no existeix, s'ha suprimit o queda fora dels límits d'una clau amb abast limitat, o no té cap comprovació AML (per al `node_id` indicat). La cerca de la sessió s'executa abans de comprovar les credencials, de manera que un `sessionId` desconegut retorna `404` fins i tot sense una clau vàlida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Unknown session": { "summary": "No existeix cap sessió amb aquest ID, o s'ha suprimit", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "La sessió queda fora dels límits d'una clau amb abast limitat (també es retorna per a una sessió suprimida fa uns moments)", "value": { "detail": "Session not found." } }, "No AML check": { "summary": "La sessió no ha executat mai cap pas d'AML", "value": { "detail": "The session does not have an AML check." } }, "No AML check for node": { "summary": "node_id no coincideix amb cap comprovació AML de la sessió", "value": { "detail": "The session does not have an AML check for node 'feature_aml_2'." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència: 600 sol·licituds GET per minut per clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar; les capçaleres `X-RateLimit-*` mostren el pressupost.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Rate limited": { "summary": "Pressupost per al minut actual esgotat", "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/add-images/": { "patch": { "summary": "Afegeix una imatge a una sessió", "description": "Adjunta una imatge o un PDF addicional al resultat de Verificació d'identitat (`model_type=kyc`) o de Comprovant de domicili (`model_type=poa`) d'una sessió finalitzada de Verificació d'usuaris (KYC), per exemple proves recollides fora del flux. La sessió ha d'estar en estat `Approved`, `Declined`, `In Review` o `Kyc Expired` i incloure el resultat indicat per `model_type`; les sessions de Verificació d'empreses (KYB) no són compatibles. Cada crida afegeix un fitxer (al resultat més recent quan el pas s'ha executat més d'una vegada), manté els fitxers existents i registra una entrada `FILE_ADDED` al registre d'activitat de la sessió; la pujada no envia cap webhook ni canvia l'estat de la sessió. El fitxer es comprimeix durant la pujada i es retorna a `extra_files` de la decisió de la sessió. Aquest endpoint està limitat a 10 sol·licituds per minut per clau d'API. Una clau d'API amb abast restringit necessita `sessions: write`, i sense `media: read` rep els enllaços d'`extra_files` com a `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 sessió de Verificació d'usuaris (KYC) a la qual s'ha d'afegir el fitxer (el `session_id` retornat per `POST /v3/session/`). Un ID de sessió de Verificació d'empreses (KYB) retorna `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 imatge o PDF. Extensions permeses: `jpg`, `jpeg`, `png`, `webp`, `tiff`, `pdf`. Com a màxim 15 MB en pujar-la; posteriorment el fitxer es comprimeix i es rebutja amb un error `400` si encara supera els 2 MB (2.097.152 bytes). Els fitxers buits es rebutgen." }, "model_type": { "type": "string", "enum": [ "kyc", "poa" ], "description": "`kyc` afegeix el fitxer al resultat de Verificació d'identitat, `poa` al resultat de Comprovant de domicili.", "example": "kyc" }, "file_password": { "type": "string", "description": "Contrasenya d'un PDF xifrat. Sense ella, o amb una d'incorrecta, un PDF xifrat retorna `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": "Fitxer afegit. Retorna tots els fitxers addicionals d'aquest resultat, inclòs el nou.", "content": { "application/json": { "schema": { "type": "object", "required": [ "extra_files" ], "properties": { "extra_files": { "type": "array", "description": "Enllaços presignats de curta durada a tots els fitxers addicionals del resultat anomenat per `model_type`, del més antic al més recent. Cada enllaç és `null` per a una clau d'API d'abast limitat sense `media: read`. Llegeix enllaços actualitzats des de la decisió de la sessió més endavant.", "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ó. Els errors de camp arriben com a `{\"\": [\"\"]}`; els errors de PDF xifrat com a `{\"detail\": \"...\"}`.", "content": { "application/json": { "examples": { "Missing file": { "summary": "No hi ha cap part de fitxer al formulari", "value": { "file": [ "No file was submitted." ] } }, "Missing model_type": { "summary": "model_type omès", "value": { "model_type": [ "This field is required." ] } }, "Invalid model_type": { "summary": "model_type no és kyc o poa", "value": { "model_type": [ "\"passport\" is not a valid choice." ] } }, "File too large": { "summary": "Pujada de més de 15 MB", "value": { "file": [ "File size should not exceed 15 MB" ] } }, "Too large after compression": { "summary": "Encara supera els 2 MB després de la compressió", "value": { "file": [ "File size is too big. Max allowed size is 2097152 bytes." ] } }, "Encrypted PDF": { "summary": "PDF xifrat sense file_password", "value": { "detail": "The PDF is encrypted. Please upload a decrypted PDF or a photo instead." } }, "Wrong PDF password": { "summary": "file_password no obre el PDF", "value": { "detail": "The PDF password is incorrect. Please provide the correct password." } } } } } }, "401": { "description": "La clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna `401`: una clau absent, no vàlida o revocada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "summary": "La data de caducitat de la clau ha passat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallada d'autenticació o d'autorització. Si falta la clau es retorna `403`, igual que amb una clau d'una altra aplicació, una clau amb àmbit sense el permís que necessita aquest endpoint o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau; una clau incorrecta, revocada o caducada retorna `401`. Distingeix-les pel camp `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta la capçalera x-api-key, o la clau ha fallat la validació", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clau vàlida que pertany a una aplicació diferent de la de la sessió", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without sessions write": { "summary": "A la clau amb abast li manca el permís d'escriptura de sessions", "value": { "detail": "This API key has no write access to sessions." } }, "IP not allowed": { "summary": "Sol·licitud des de fora de la llista d'adreces IP permeses de la clau", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sessió no existeix, s'ha suprimit o queda fora dels límits d'una clau amb abast limitat; és una sessió KYB o no està en `Approved`, `Declined`, `In Review` o `Kyc Expired`; o no té cap resultat del `model_type` sol·licitat (comprovat abans de validar el fitxer). La cerca de la sessió s'executa abans de comprovar les credencials, de manera que un `sessionId` desconegut retorna `404` fins i tot sense una clau vàlida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Unknown session": { "summary": "No existeix cap sessió amb aquest ID, o s'ha suprimit", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "La sessió queda fora dels límits del flux de treball o dels límits que només permeten sessions aprovades d'una clau amb abast limitat", "value": { "detail": "Session not found." } }, "Not eligible": { "summary": "La sessió encara no ha finalitzat, o és un ID de sessió de KYB", "value": { "detail": "No Session matches the given query." } }, "No ID verification": { "summary": "model_type=kyc en una sessió sense Verificació d'identitat", "value": { "detail": "The session does not have KYC data." } }, "No Proof of Address": { "summary": "model_type=poa en una sessió sense Comprovant de domicili", "value": { "detail": "The session does not have POA data." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència: 10 sol·licituds per afegir imatges per minut per clau d'API (les sol·licituds rebutjades també compten). El pressupost compartit de 300 sol·licituds d'escriptura per minut també s'aplica. Espera els segons indicats a `Retry-After` abans de reintentar; les capçaleres `X-RateLimit-*` mostren el pressupost restant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Rate limited": { "summary": "Pressupost per al minut actual esgotat", "value": { "detail": "Session add-images rate limit exceeded. You can make up to 10 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } }, "503": { "$ref": "#/components/responses/DocumentProcessingBusy" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/update-aml-status/": { "patch": { "summary": "Actualitzar l'estat d'una comprovació d'AML", "description": "Estableix l'estat de la comprovació de cribratge AML d'una sessió en el seu conjunt (l'`status` d'una entrada `aml_screenings[]` a la decisió de la sessió), per exemple `Approved` després que el teu equip hagi resolt totes les coincidències. Funciona per a ID de sessions de KYC i KYB; passa `node_id` (paràmetre de consulta o camp del cos) si la sessió ha executat més d'un pas d'AML; en cas contrari, s'actualitza la comprovació d'AML més recent. Quan l'estat canvia realment, es registra una entrada d'activitat `AML_STATUS_UPDATED` i s'envia un [webhook](https://docs.didit.me/ca/integration/webhooks) `data.updated`; enviar l'estat actual retorna `200` i no canvia res. L'estat de la sessió no es torna a calcular: utilitza `PATCH /v3/session/{sessionId}/update-status/` per a la decisió de la sessió i `PATCH /v3/session/{sessionId}/update-aml-hit-status/` per a coincidències individuals. Una clau d'API amb abast limitat requereix `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 sessió de verificació (el `session_id` retornat per `POST /v3/session/`). Accepta tant IDs de sessió de Verificació d'usuaris (KYC) com de Verificació d'empreses (KYB): el servidor resol l'ID entre tots dos tipus de sessió. Ha de ser un UUID ben format; un valor mal format no coincideix amb la ruta i retorna 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 node del graf del flux de treball de la comprovació AML que cal actualitzar. Només cal quan la sessió ha executat més d'un pas AML. Té preferència sobre `node_id` al cos.", "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": "Nou estat de la comprovació AML.", "example": "Approved" }, "node_id": { "type": "string", "description": "ID del node del graf del flux de treball de la comprovació AML, com a alternativa al paràmetre 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": "Estat de la comprovació AML establert (o sense canvis si ja tenia aquest valor).", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "status", "previous_status" ], "properties": { "message": { "type": "string", "description": "Sempre `AML status updated successfully`." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estat de la comprovació AML ara." }, "previous_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estat abans de la crida. Igual a `status` quan no hi ha cap canvi." } } }, "example": { "message": "AML status updated successfully", "status": "Approved", "previous_status": "In Review" } } } }, "400": { "description": "Error de validació: falta `status` o no és un dels valors permesos. La cerca de la comprovació AML s'executa primer, de manera que una sessió sense comprovació AML retorna `404` fins i tot amb un cos no vàlid.", "content": { "application/json": { "examples": { "Missing status": { "summary": "Cos buit o sense estat", "value": { "status": [ "This field is required." ] } }, "Invalid status": { "summary": "status no és a l'enumeració", "value": { "status": [ "\"Cleared\" is not a valid choice." ] } } } } } }, "401": { "description": "La clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna `401`: una clau absent, no vàlida o revocada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "summary": "La data de caducitat de la clau ha passat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallada d'autenticació o d'autorització. Si falta la clau es retorna `403`, igual que amb una clau d'una altra aplicació, una clau amb àmbit sense el permís que necessita aquest endpoint o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau; una clau incorrecta, revocada o caducada retorna `401`. Distingeix-les pel camp `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta la capçalera x-api-key, o la clau ha fallat la validació", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clau vàlida que pertany a una aplicació diferent de la de la sessió", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clau amb abast li manca el permís d'escriptura de decisions", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Sol·licitud des de fora de la llista d'adreces IP permeses de la clau", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sessió no existeix, s'ha suprimit o queda fora dels límits d'una clau amb abast limitat, o no té cap comprovació AML (per al `node_id` indicat). La cerca de la sessió s'executa abans de comprovar les credencials, de manera que un `sessionId` desconegut retorna `404` fins i tot sense una clau vàlida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Unknown session": { "summary": "No existeix cap sessió amb aquest ID, o s'ha suprimit", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "La sessió queda fora dels límits d'una clau amb abast limitat (també es retorna per a una sessió suprimida fa uns moments)", "value": { "detail": "Session not found." } }, "No AML check": { "summary": "La sessió no ha executat mai cap pas d'AML", "value": { "detail": "The session does not have an AML check." } }, "No AML check for node": { "summary": "node_id no coincideix amb cap comprovació AML de la sessió", "value": { "detail": "The session does not have an AML check for node 'feature_aml_2'." } } } } } }, "429": { "description": "S'ha superat el límit de freqüència: 300 sol·licituds d'escriptura (POST, PATCH, DELETE) per minut per clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar; les capçaleres `X-RateLimit-*` mostren el pressupost restant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Rate limited": { "summary": "Pressupost per al minut actual esgotat", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/status/": { "get": { "summary": "Obtenir l'estat del servei (públic, sense autenticació)", "description": "Retorna l'estat de cada servei de Didit (`operational`, `degraded` o `down`), l'estat global (el pitjor de tots) i les incidències en curs o que s'han resolt en els darrers 7 dies. Fes-lo servir per alimentar un giny d'estat o per comprovar l'estat de Didit des de la teva integració.\n\nPúblic: no enviïs cap capçalera d'autenticació. La resposta no conté dades de l'organització i és idèntica per a tothom. Les respostes es desen a la memòria cau durant 30 segons, per la qual cosa no facis consultes periòdiques més d'una vegada cada 30 segons.", "operationId": "get_v3_status", "tags": [ "Status" ], "security": [ {} ], "parameters": [], "responses": { "200": { "description": "Estat actual del servei.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceStatusFeed" }, "examples": { "One service degraded": { "summary": "Un incident en curs i un de resolt aquesta setmana", "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": "Cap incident en els darrers 7 dies", "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 sol·licituds GET en un minut des de la mateixa adreça (o la mateixa clau d'API, si n'envies una). Respecta `Retry-After` abans 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": "Obtenir els preus de verificació bancària (públics, no autenticats)", "description": "Retorna el preu de tarifa de cada mètode de Bank Verification a cada país: inici de sessió bancari amb els seus complements de saldo i transaccions, i la comprovació de compte. Un mètode que un país no ofereix actualment es mostra com a no disponible, sense preu. Fes-lo servir per pressupostar un pas bancari abans de crear un flux de treball, o per mostrar preus bancaris al teu propi producte.\n\nPúblic: no enviïs cap capçalera d'autenticació. La resposta no conté dades de l'organització i és idèntica per a tothom. Es desa a la memòria cau pública durant una hora i inclou un `ETag`, de manera que pots enviar `If-None-Match` per rebre un `304 Not Modified` quan res no hagi canviat.\n\nUn mètode només és `available` on Didit el serveix avui dia en producció, i el seu `price_usd` és `null` a la resta de llocs, de manera que el canal mai no mostra un preu que no puguis contractar. `available: false` cobreix un país sense preu aprovat, un mètode que el país no admet i una ruta que encara no està activada.\n\nAquests són preus de tarifa abans del descompte del teu pla. El descompte del teu pla s'aplica al preu bancari total, i un preu negociat o per contracte substitueix el preu de tarifa per a la teva organització.", "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": "Preus de llista de Verificació bancària per país.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankVerificationPricing" }, "examples": { "Two countries": { "summary": "Un país amb tots dos mètodes, un sense cap dels dos", "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": "No modificat: l'`ETag` enviat a `If-None-Match` encara coincideix. Sense cos." } } } }, "/v3/session/{sessionId}/simulate/": { "post": { "summary": "Simular l'estat d'una sessió de sandbox", "description": "Força un estat terminal en una sessió de sandbox a posteriori, des del teu backend, sense executar el flux. Només aplicacions de sandbox: una sessió de producció retorna `404`. Funciona per a sessions de Verificació d'usuaris (KYC) i Verificació d'empreses (KYB).\n\nDefineix `new_status`, o deixa que `scenario` o `risk` el proporcionin. `risk` (o el primer risc que portin els valors màgics de l'escenari) afegeix aquesta advertència a la sessió. El canvi es registra a l'activitat de la sessió.\n\n`send_webhooks` (per defecte `true`) envia exactament els webhooks que enviaria un canvi d'estat real. Amb `false` l'estat continua canviant i el tauler s'actualitza en directe, però no es registra ni s'envia cap webhook, la recuperació de webhooks perduts mai reenvia aquesta decisió i el següent canvi d'estat envia webhooks amb normalitat. La resposta reflecteix el valor aplicat.\n\nRequereix el permís `write:sessions`; una clau d'API amb abast limitat necessita accés d'escriptura a les sessions. Un `session_id` desconegut retorna `404` i la sessió d'una altra aplicació retorna `403`, en ambdós casos abans de llegir el cos; una sessió de producció retorna `404` només després de validar el cos. Per simular des del flux allotjat amb el token propi de la sessió, fes servir `POST /v3/session/{sessionId}/sandbox/simulate/`. Consulta [Sandbox i dades de prova](/ca/integration/sandbox-testing) per veure el catàleg d'escenaris.", "operationId": "post_v3_session_simulate", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sessió de verificació de sandbox. Accepta tant IDs de sessió d'usuari (KYC) com d'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": "Rebutjar mitjançant un escenari sense enviar webhooks", "value": { "scenario": "decline_aml_hit", "send_webhooks": false } }, "Status Only": { "summary": "Aprova i envia els webhooks habituals", "value": { "new_status": "Approved" } } } } } }, "responses": { "200": { "description": "L'estat ha canviat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxSimulateResponse" }, "examples": { "Simulated": { "summary": "Rebutjada mitjançant un escenari, webhooks no enviats", "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ó: un escenari o risc desconegut, no s'ha proporcionat `new_status` quan ni `scenario` ni `risk` en faciliten un, un estat que aquest endpoint no estableix o la sessió ja té l'estat sol·licitat (una matriu JSON simple).", "content": { "application/json": { "examples": { "Unknown Scenario": { "summary": "l'escenari no és al catàleg", "value": { "scenario": [ "Unknown sandbox scenario: 'not-a-scenario'." ] } }, "Unknown Risk": { "summary": "risk no és al catàleg", "value": { "risk": [ "Unknown sandbox risk case: 'NOT_A_RISK'." ] } }, "Missing new_status": { "summary": "No hi ha cap new_status, scenario ni risk", "value": { "new_status": [ "This field is required." ] } }, "Invalid new_status": { "summary": "Un estat que la simulació no estableix", "value": { "new_status": [ "\"Resubmitted\" is not a valid choice." ] } }, "Same Status": { "summary": "La sessió ja té aquest estat", "value": [ "The new status is the same as the current status." ] } } } } }, "401": { "description": "La clau d'API amb abast ha caducat.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Clau d'API amb abast que ha superat la data de caducitat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falten les credencials, qui fa la crida no té el privilegi `write:sessions`, la clau d'API amb abast limitat no té l'accés que necessita aquest endpoint, o el `session_id` pertany a una altra aplicació.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Falta l'x-api-key o no és vàlid", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "L'emissor de la crida no disposa de write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Clau d'API amb abast sense aquest accés", "value": { "detail": "This API key has no write access to sessions." } } } } } }, "404": { "description": "No existeix cap sessió amb aquest `session_id`, o és una sessió de producció (no de sandbox).", "content": { "application/json": { "examples": { "Not Found": { "summary": "Sessió desconeguda o en producció", "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 l'estat d'una sessió de sandbox des del client", "description": "La mateixa simulació que `POST /v3/session/{sessionId}/simulate/`, autenticada amb el `Session-Token` propi de la sessió (retornat a `session_token` per [Create Session](/ca/sessions-api/create-session)) en lloc de la teva clau d'API, de manera que un entorn de proves o el flux allotjat puguin cridar-lo des del client. El cos, la resposta i `send_webhooks` es comporten exactament com en aquest endpoint.\n\nUn `Session-Token` d'una aplicació en entorn de producció (no sandbox), o un que no coincideixi amb el `sessionId` de la ruta, retorna `404`. Consulta [Sandbox & Test Data](/ca/integration/sandbox-testing).", "operationId": "post_v3_session_sandbox_simulate", "tags": [ "Sessions" ], "security": [ { "SessionTokenAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sessió de verificació de sandbox. Ha de coincidir amb la sessió codificada al Session-Token utilitzat per autenticar-se.", "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": "Rebutjar mitjançant un escenari sense enviar webhooks", "value": { "scenario": "decline_aml_hit", "send_webhooks": false } }, "Status Only": { "summary": "Aprova i envia els webhooks habituals", "value": { "new_status": "Approved" } } } } } }, "responses": { "200": { "description": "L'estat ha canviat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxSimulateResponse" }, "examples": { "Simulated": { "summary": "Rebutjada mitjançant un escenari, webhooks no enviats", "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ó: un escenari o risc desconegut, no s'ha proporcionat `new_status` quan ni `scenario` ni `risk` en faciliten un, un estat que aquest endpoint no estableix o la sessió ja té l'estat sol·licitat (una matriu JSON simple).", "content": { "application/json": { "examples": { "Unknown Scenario": { "summary": "l'escenari no és al catàleg", "value": { "scenario": [ "Unknown sandbox scenario: 'not-a-scenario'." ] } }, "Unknown Risk": { "summary": "risk no és al catàleg", "value": { "risk": [ "Unknown sandbox risk case: 'NOT_A_RISK'." ] } }, "Missing new_status": { "summary": "No hi ha cap new_status, scenario ni risk", "value": { "new_status": [ "This field is required." ] } }, "Invalid new_status": { "summary": "Un estat que la simulació no estableix", "value": { "new_status": [ "\"Resubmitted\" is not a valid choice." ] } }, "Same Status": { "summary": "La sessió ja té aquest estat", "value": [ "The new status is the same as the current status." ] } } } } }, "403": { "description": "Falta la capçalera `Session-Token` o no és vàlida.", "content": { "application/json": { "examples": { "Invalid Session Token": { "summary": "Falta el Session-Token o no és vàlid", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "El `Session-Token` pertany a una aplicació de producció (fora de sandbox), o no coincideix amb el `sessionId` de la ruta.", "content": { "application/json": { "examples": { "Not Found": { "summary": "Sessió en viu, o desajust de session_id / token", "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": "Llista les sobreescriptures de comprovacions d'una sessió", "description": "Totes les substitucions de l'estat d'una funcionalitat individual (pas) en una sessió de Verificació d'usuaris (KYC) o Verificació d'empreses (KYB), de la més recent a la més antiga i no paginades: les aplicades, les que esperen que la persona acabi el flux (`pending_until_flow_finishes`) i les cancel·lades, cadascuna amb qui l'ha sol·licitada, el seu motiu i si s'ha aplicat mentre la persona encara estava en el flux (`forced`).\n\n`person_in_flow` t'indica si una nova substitució amb `defer_until_flow_finishes: true` s'esperaria. `flow_finished_at` és el moment en què la persona ha acabat el flux per última vegada; és `null` mentre encara hi és (incloent-hi un reenviament) i quan la sessió s'ha tancat abans que acabés.\n\nRequereix el permís `read:sessions`; una clau d'API amb abast restringit necessita accés de lectura a les decisions.", "operationId": "get_v3_session_feature_overrides", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sessió de verificació. Accepta tant IDs de sessió d'usuari (KYC) com d'empresa (KYB).", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } ], "responses": { "200": { "description": "Les sobreescriptures de les comprovacions de la sessió, les més recents primer.", "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 encara és al flux, de manera que una nova sobreescriptura amb `defer_until_flow_finishes: true` esperaria.", "example": true }, "flow_finished_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan la persona va completar el flux per darrera vegada. `null` mentre encara hi sigui (inclosos els reenviaments) i quan la sessió es va tancar abans que finalitzés (abandonada, caducada o decidida a mig flux).", "example": null }, "overrides": { "type": "array", "description": "Totes les substitucions de la sessió, de la més recent a la més antiga.", "items": { "$ref": "#/components/schemas/FeatureStatusOverride" } } } }, "examples": { "Overrides": { "summary": "Una sobreescriptura pendent, una d'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 clau d'API amb abast ha caducat.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Clau d'API amb abast que ha superat la data de caducitat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falten les credencials, qui fa la crida no té el privilegi `read:sessions`, la clau d'API amb abast limitat no té l'accés que necessita aquest endpoint, o el `session_id` pertany a una altra aplicació.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Falta l'x-api-key o no és vàlid", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "L'emissor de la crida no disposa de read:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Clau d'API amb abast sense aquest accés", "value": { "detail": "This API key has no read access to decisions." } } } } } }, "404": { "description": "No existeix cap sessió de KYC o KYB amb aquest `session_id`.", "content": { "application/json": { "examples": { "Not Found": { "summary": "session_id desconegut", "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": "Cancel·lar una modificació manual de verificació que espera que acabi el flux", "description": "Cancel·la una modificació manual de l'estat d'una funcionalitat (pas) que encara estigui `pending_until_flow_finishes`, de manera que mai no s'apliqui. La verificació manté el seu estat, la cancel·lació es registra a l'activitat de la sessió com a `FEATURE_OVERRIDE_CANCELLED` i no s'envia cap webhook. La resposta és la modificació manual amb `state: cancelled` i `cancel_reason: cancelled_by_reviewer`.\n\nUna modificació manual que ja s'hagi aplicat o s'hagi cancel·lat retorna `409` amb el codi `feature_override_not_pending`. Pots trobar els ID de les modificacions manuals amb `GET /v3/session/{sessionId}/features/overrides/` o a l'objecte `override` que retorna l'actualització d'estat de la funcionalitat.\n\nRequereix el permís `write:sessions`; una clau d'API amb abast limitat necessita accés d'escriptura a les decisions.", "operationId": "post_v3_session_feature_override_cancel", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sessió de verificació. Accepta tant IDs de sessió d'usuari (KYC) com d'empresa (KYB).", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, { "in": "path", "name": "overrideId", "required": true, "description": "L'`id` de l'override que es vol cancel·lar.", "schema": { "type": "string", "format": "uuid", "example": "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3" } } ], "responses": { "200": { "description": "La substitució s'ha cancel·lat i no s'aplicarà mai.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureStatusOverride" }, "examples": { "Cancelled": { "summary": "La sobreescriptura cancel·lada", "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 clau d'API amb abast ha caducat.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Clau d'API amb abast que ha superat la data de caducitat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falten les credencials, qui fa la crida no té el privilegi `write:sessions`, la clau d'API amb abast limitat no té l'accés que necessita aquest endpoint, o el `session_id` pertany a una altra aplicació.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Falta l'x-api-key o no és vàlid", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "L'emissor de la crida no disposa de write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Clau d'API amb abast sense aquest accés", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "No existeix cap sessió de KYC o KYB amb aquest `session_id`, o la sessió no té cap anul·lació amb aquest `overrideId`.", "content": { "application/json": { "examples": { "Not Found": { "summary": "session_id desconegut", "value": { "detail": "Not found." } }, "Override Not Found": { "summary": "No hi ha cap sobreescriptura amb aquest id a la sessió", "value": { "detail": "Override not found." } } } } } }, "409": { "description": "La substitució ja s'ha aplicat o s'ha cancel·lat.", "content": { "application/json": { "examples": { "Not Pending": { "summary": "Només es pot cancel·lar una invalidació 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": "Afegeix una etiqueta a una xarxa", "description": "Afegeix una de les etiquetes de la teva aplicació a la xarxa. Retorna el detall de la xarxa, on `tags` llista les etiquetes de la teva aplicació a la xarxa, amb `201` quan l'etiqueta s'ha afegit i `200` quan ja era a la xarxa. Una etiqueta que pertany a una altra aplicació, o que no existeix, retorna 404 `Tag not found.`. Requereix una clau d'API d'accés complet, o `write:networks` per a un membre 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "description": "UUID de la xarxa." } ], "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": "L'etiqueta s'ha afegit. Retorna el detall de la xarxa.", "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": "L'etiqueta ja era a la xarxa i es deixa tal com està. Retorna el detall de la xarxa.", "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": "Cos no vàlid: `tag_uuid` falta o no és un UUID.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tag_uuid": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Missing tag_uuid": { "summary": "Falta el tag_uuid", "value": { "tag_uuid": [ "This field is required." ] } }, "Invalid tag_uuid": { "summary": "tag_uuid no vàlid", "value": { "tag_uuid": [ "Must be a valid UUID." ] } } } } } }, "401": { "description": "Falten les credencials o no són vàlides.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Present en errors codificats, per exemple `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falten les credencials o no són vàlides", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "La clau d'API pertany a una altra aplicació o és una clau amb accés restringit: els endpoints de Networks necessiten una clau amb accés complet. Un token de membre de la consola necessita `write:networks`. També es retorna amb `code: networks_not_entitled` quan Networks no està habilitat per a l'organització.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Present en errors codificats, per exemple `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Xarxes no habilitades", "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": "Clau d'API restringida", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Sense permís", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No s'ha trobat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Present en errors codificats, per exemple `networks_not_entitled`." } } }, "examples": { "Network not found": { "summary": "No s'ha trobat la xarxa", "value": { "detail": "Network not found." } }, "Tag not found": { "summary": "Etiqueta no trobada", "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": "Eliminar una etiqueta d'una xarxa", "description": "Elimina una de les etiquetes de la teva aplicació de la xarxa. Retorna el detall de la xarxa. Retorna 404 quan l'etiqueta no és a la xarxa o no pertany a la teva aplicació. Requereix una clau d'API amb accés complet, o `write:networks` per a un membre 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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "description": "UUID de la xarxa." } ], "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": "L'etiqueta s'ha suprimit de la xarxa. Retorna el detall de la xarxa.", "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": "Cos no vàlid: `tag_uuid` falta o no és un UUID.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tag_uuid": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Missing tag_uuid": { "summary": "Falta el tag_uuid", "value": { "tag_uuid": [ "This field is required." ] } }, "Invalid tag_uuid": { "summary": "tag_uuid no vàlid", "value": { "tag_uuid": [ "Must be a valid UUID." ] } } } } } }, "401": { "description": "Falten les credencials o no són vàlides.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Present en errors codificats, per exemple `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falten les credencials o no són vàlides", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "La clau d'API pertany a una altra aplicació o és una clau amb accés restringit: els endpoints de Networks necessiten una clau amb accés complet. Un token de membre de la consola necessita `write:networks`. També es retorna amb `code: networks_not_entitled` quan Networks no està habilitat per a l'organització.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Present en errors codificats, per exemple `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Xarxes no habilitades", "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": "Clau d'API restringida", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Sense permís", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "No s'ha trobat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Present en errors codificats, per exemple `networks_not_entitled`." } } }, "examples": { "Network not found": { "summary": "No s'ha trobat la xarxa", "value": { "detail": "Network not found." } }, "Tag not found": { "summary": "Etiqueta no trobada", "value": { "detail": "Tag not found." } }, "Tag not on the network": { "summary": "L'etiqueta no és a la xarxa", "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 client una sol·licitud", "description": "Torna a enviar el correu electrònic d'una sol·licitud de client en espera, al mateix destinatari verificat i amb el mateix contingut. Pots enviar un recordatori per a una sol·licitud com a màxim un cop cada 24 hores. Un recordatori no canvia res més: la sol·licitud manté la seva data límit i el cas manté el seu estat. Cada recordatori es registra al cas com un esdeveniment CUSTOMER_REQUEST amb l'acció `reminded`. El `delivery_status` de la resposta indica com ha acabat el lliurament d'aquest recordatori: SENT, SIMULATED (el correu electrònic no s'ha enviat) o UNKNOWN (és possible que s'hagi acceptat el correu electrònic; no es torna a enviar automàticament). `next_reminder_at` és el moment en què pots tornar a enviar un recordatori per a aquesta sol·licitud. Retorna 409 amb un `reason` quan el client ja no té la sol·licitud per respondre-hi, i 429 amb `retry_at` i una capçalera `Retry-After` quan ja s'ha enviat un recordatori per a la sol·licitud en les últimes 24 hores. Requereix `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 l'organització." }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "UUID de l'aplicació." }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "UUID del cas." }, { "in": "path", "name": "request_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "UUID de la sol·licitud del client, de la llista de sol·licituds del cas." } ], "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": "S'ha registrat el recordatori i s'ha enviat el seu correu electrònic.", "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": "Quan es va registrar aquest recordatori." }, "delivery_status": { "type": "string", "enum": [ "SENT", "SIMULATED", "UNKNOWN" ], "description": "Com ha acabat el lliurament d'aquest recordatori. SIMULATED: el correu electrònic no s'ha enviat. UNKNOWN: és possible que el correu electrònic s'hagi acceptat; no es torna a enviar automàticament." }, "next_reminder_at": { "type": "string", "format": "date-time", "description": "Quan pots tornar a enviar un recordatori per a aquesta sol·licitud: `reminded_at` més 24 hores." } } }, "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 cas té una resolució pendent d'aprovació. El cos és una llista de cadenes.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "Customer messages require an active case without a pending resolution." ] } } }, "403": { "description": "L'emissor de la crida no té el permís de casos requerit." }, "404": { "description": "La sol·licitud o el cas no està disponible per a aquest sol·licitant." }, "409": { "description": "La sol·licitud ja no està pendent del client, de manera que no cal recordar-li res. `reason` n'indica el motiu: `answered` (el client ha respost), `cancelled`, `expired`, `closed` (el cas s'ha resolt després d'enviar la sol·licitud, fins i tot si s'ha reobert posteriorment), `not_actionable` (una actualització de revisió en curs no demana res), `not_delivered` (el primer correu electrònic no s'ha enviat) o `contact_unavailable` (el correu electrònic verificat ja 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": "Ja s'ha enviat un recordatori per a aquesta sol·licitud en les darreres 24 hores. `retry_at` i la capçalera `Retry-After` indiquen quan hi pots tornar a enviar un recordatori.", "headers": { "Retry-After": { "description": "Segons que cal esperar abans de poder recordar aquesta sol·licitud de nou.", "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": "Previsualitza el correu electrònic de decisió d'una sessió", "description": "Genera el correu electrònic que rep la persona quan estableixes una sessió a `Approved` o `Declined` amb `send_email: true`, sense modificar la sessió ni enviar res. La resposta mostra l'assumpte i l'HTML exactament com s'envien, el destinatari, el remitent, l'idioma i si la confirmació del canvi envia el correu electrònic (`will_be_sent`, `not_sent_reason`).\n\nEl destinatari és la pròpia adreça de la persona: la que va verificar en un pas de verificació de correu electrònic del flux, o bé la indicada a `contact_details` en crear la sessió. El remitent és el domini de remitent verificat de la teva aplicació quan s'aplica marca blanca (`sender_kind: customer`), o bé el remitent de Didit (`sender_kind: didit`).\n\nPer enviar exactament el que has previsualitzat, crida [Update Session Status](/ca/sessions-api/update-status) amb el mateix `new_status`, `send_email: true`, `email_address` establert a `recipient`, `email_language` establert a `language` i `email_preview_token` establert a `preview_token`. El justificant caduca al cap de 15 minuts. Si el destinatari, l'idioma, l'estat de la sessió, el remitent o el correu han canviat des de la previsualització, l'actualització retorna `409` abans que canviï res; torna a fer la previsualització i confirma amb el nou justificant.\n\nFunciona per a sessions de Verificació d'usuaris (KYC) i Verificació d'empreses (KYB) en estat `Approved`, `Declined`, `In Review`, `Kyc Expired`, `Abandoned` o `Resubmitted`. La comprovació d'estat s'executa abans de la validació del cos. Requereix el permís `write:sessions`; una clau d'API amb abast limitat necessita accés d'escriptura a les decisions. Les respostes utilitzen `Cache-Control: no-store`: tracta-les com a contingut confidencial de verificació.", "operationId": "post_v3_session_decision_email_preview", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID de la sessió de verificació. Accepta tant IDs de sessió d'usuari (KYC) com d'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ó el correu electrònic de la qual vols previsualitzar.", "example": "Approved" }, "email_language": { "type": "string", "default": "en", "description": "Idioma del correu electrònic, el mateix valor per defecte que a Update Session Status. Un idioma que no s'ofereixi torna a l'anglès; el camp `language` de la resposta indica quin s'utilitza.", "example": "en" } } }, "examples": { "Approved": { "summary": "Previsualitza el correu d'aprovació en anglès", "value": { "new_status": "Approved" } }, "Declined in Spanish": { "summary": "Previsualitza el correu de rebuig en espanyol", "value": { "new_status": "Declined", "email_language": "es" } } } } } }, "responses": { "200": { "description": "Només previsualització. La sessió no canvia i no s'envia cap correu electrònic.", "headers": { "Cache-Control": { "description": "Sempre `no-store`: la previsualització conté contingut de verificació i no s'ha d'emmagatzemar a la memòria cau.", "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": "L'adreça a la qual s'envia el correu electrònic. Una cadena buida quan no es coneix cap adreça per a la persona: en aquest cas no es pot enviar cap correu electrònic i `preview_token` també és buit. Envia-la com a `email_address` en confirmar.", "example": "person@example.com" }, "recipient_source": { "type": "string", "enum": [ "email_verification", "contact_details", "" ], "description": "D'on prové `recipient`. `email_verification`: l'adreça que la persona ha verificat en un pas de verificació de correu electrònic del flux. `contact_details`: l'adreça indicada a `contact_details` en crear la sessió. Una cadena buida quan no hi ha cap adreça.", "example": "email_verification" }, "sender": { "type": "string", "description": "La capçalera `From` amb què s'envia el correu electrònic.", "example": "Example App " }, "sender_name": { "type": "string", "description": "La part del nom visible de `sender`.", "example": "Example App" }, "sender_email": { "type": "string", "format": "email", "description": "La part de l'adreça de `sender`.", "example": "no-reply@mail.example.com" }, "sender_kind": { "type": "string", "enum": [ "customer", "didit" ], "description": "`customer`: el correu electrònic s'envia des del domini de remitent verificat de la teva aplicació (marca blanca). `didit`: s'envia des del remitent propi de Didit.", "example": "customer" }, "subject": { "type": "string", "description": "La línia de l'assumpte exactament tal com s'envia.", "example": "Your verification has been approved in Example App" }, "html": { "type": "string", "description": "L'HTML del correu electrònic exactament com s'envia, amb el seu logotip incrustat com a URL de dades. Renderitza'l en un frame aïllat (sandbox), mai directament al DOM de la teva aplicació.", "example": "..." }, "text": { "type": "string", "description": "El text del correu electrònic com a text pla, tal com el manté el fil de missatges de la persona, per a una previsualització compacta (l'HTML continua sent el correu electrònic que rep 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": "L'idioma en què està escrit el correu electrònic. Anglès (`en`) quan el `email_language` que has demanat no s'ofereix.", "example": "en" }, "will_be_sent": { "type": "boolean", "description": "Indica si confirmar el canvi amb `send_email: true` envia aquest correu electrònic. `false` quan s'ha definit `not_sent_reason`.", "example": true }, "not_sent_reason": { "type": "string", "nullable": true, "enum": [ "status_unchanged", "notification_emails_disabled", "no_recipient", "sandbox", null ], "description": "Per què en confirmar no s'enviaria cap correu electrònic, o `null` quan s'enviarà. `status_unchanged`: la sessió ja té aquest estat, per la qual cosa l'actualització no canvia res ni envia res. `notification_emails_disabled`: la sessió es va crear sense `contact_details.send_notification_emails: true`, per la qual cosa no s'envia cap correu electrònic de decisió a l'adreça indicada a `contact_details`. `no_recipient`: no es coneix cap adreça per a la persona. `sandbox`: una sessió de sandbox el destinatari de la qual no ha acceptat el lliurament de correus electrònics en sandbox, per la qual cosa l'enviament només es simula.", "example": null }, "preview_token": { "type": "string", "description": "Justificant signat per a aquesta adreça electrònica exacta, vàlid durant 15 minuts. Passa'l com a `email_preview_token` a [Actualitzar l'estat de la sessió](/ca/sessions-api/update-status). Una cadena buida quan no hi ha destinatari.", "example": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } } }, "examples": { "Will Be Sent": { "summary": "El correu electrònic d'aprovació s'envia a l'adreça verificada en el flux", "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 es coneix cap adreça per a 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 sessió no es troba en un estat que aquest endpoint accepti (`{\"detail\": ...}`), o el cos no és vàlid (`{\"\": [\"\"]}`).", "content": { "application/json": { "examples": { "Wrong Current Status": { "summary": "La sessió no es troba en un estat que aquest endpoint accepti", "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 és Approved o Declined", "value": { "new_status": [ "\"Resubmitted\" is not a valid choice." ] } }, "Missing new_status": { "summary": "S'ha omès un camp obligatori", "value": { "new_status": [ "This field is required." ] } } } } } }, "401": { "description": "La clau d'API amb abast ha caducat.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Clau d'API amb abast que ha superat la data de caducitat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falten les credencials, qui fa la crida no té el privilegi `write:sessions`, la clau d'API amb abast limitat no té l'accés que necessita aquest endpoint, o el `session_id` pertany a una altra aplicació.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Falta l'x-api-key o no és vàlid", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "L'emissor de la crida no disposa de write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Clau d'API amb abast sense aquest accés", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "No existeix cap sessió de KYC o KYB amb aquest `session_id`.", "content": { "application/json": { "examples": { "Not Found": { "summary": "session_id desconegut", "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": "Obtenir una invitació per unir-se gratuïtament", "description": "Públic, no autenticat. Mostra la invitació a la qual correspon un enllaç per unir-se mentre estigui oberta: qui l'ha demanat, l'adreça a la qual s'ha enviat i els valors del directori que s'emplenaran prèviament. El token és l'autenticació.", "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 d'invitació de l'enllaç per unir-se." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl https://verification.didit.me/v3/travel-rule/join/{token}/" } ], "responses": { "200": { "description": "La invitació.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleJoinInvitation" } } } }, "404": { "description": "Cap invitació té aquest enllaç." }, "410": { "description": "La invitació ja no està disponible: ha caducat, ja s'ha utilitzat o s'ha retirat." } } }, "post": { "summary": "Registra un compte gratuït de Travel Rule", "description": "Públic, no autenticat. Crea un compte gratuït de Travel Rule per a un VASP contrapart que ha rebut una sol·licitud. El correu electrònic ha de ser l'adreça a la qual s'ha enviat la invitació. S'hi envia un codi de 6 caràcters per correu electrònic; envia'l a l'endpoint de verificació per finalitzar. Els intents de registre tenen un límit de freqüència per adreça i per 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 d'invitació de l'enllaç per unir-se." } ], "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": "S'ha creat el compte i s'ha enviat un codi per correu electrònic.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Indica a la contrapart que comprovi el seu correu electrònic per veure el codi de verificació." }, "email": { "type": "string", "format": "email", "description": "L'adreça a la qual s'ha enviat el codi." } } } } } }, "400": { "description": "El correu electrònic no és l'adreça convidada, o bé s'ha rebutjat la contrasenya o l'adreça." }, "404": { "description": "Cap invitació té aquest enllaç." }, "410": { "description": "La invitació ja no està disponible: ha caducat, ja s'ha utilitzat o s'ha retirat." }, "429": { "description": "Massa intents d'unir-s'hi. Les capçaleres `X-RateLimit-*` indiquen el pressupost que s'ha consumit." } } } }, "/v3/travel-rule/join/{token}/verify/": { "post": { "summary": "Verifica un compte gratuït de Travel Rule", "description": "Públic, no autenticat. Consumeix el codi enviat per correu electrònic, crea l'organització gratuïta i respon amb les credencials que la seva aplicació utilitza als endpoints de l'espai de treball. La recepció de dades de Travel Rule és gratuïta.", "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 d'invitació de l'enllaç per unir-se." } ], "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": "Les credencials de l'organització i de l'aplicació.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleJoinCredentials" } } } }, "400": { "description": "El codi o el correu electrònic s'ha rebutjat." }, "404": { "description": "Cap invitació té aquest enllaç." }, "410": { "description": "La invitació ja no està disponible: ha caducat, ja s'ha utilitzat o s'ha retirat." }, "429": { "description": "Massa intents d'unir-s'hi. Les capçaleres `X-RateLimit-*` indiquen el pressupost que s'ha consumit." } } } }, "/v3/travel-rule/workspace/": { "get": { "summary": "Obtenir l'espai de treball gratuït de Travel Rule", "description": "Llegeix l'espai de treball gratuït d'una aplicació que s'ha unit de manera gratuïta: reclamació del directori, prova del domini, facturació i llistat de la xarxa 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": "L'espai de treball.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "404": { "description": "Aquesta aplicació no s'ha registrat gratuïtament, per la qual cosa no té cap espai de treball gratuït." } } } }, "/v3/travel-rule/workspace/claim/": { "post": { "summary": "Reclamar una entrada del directori", "description": "Reclama l'entrada del directori que representa aquest espai de treball. Quan el correu electrònic professional pertany a un domini que figura a l'entrada, la reclamació es verifica i s'aplica immediatament: el perfil de VASP i la configuració de Travel Rule s'emplenen a partir de l'entrada i Travel Rule s'activa, de manera que la transferència següent cap a aquesta s'encamina a través de la xarxa de Didit. En cas contrari, la reclamació queda en espera de revisió (`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": "L'espai de treball amb el seu estat de reclamació.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "Cap entrada del directori té aquest id." }, "404": { "description": "Aquesta aplicació no s'ha registrat gratuïtament, per la qual cosa no té cap espai de treball gratuït." } } } }, "/v3/travel-rule/workspace/domain/code/": { "post": { "summary": "Envia per correu electrònic un codi de verificació de domini", "description": "Envia per correu electrònic un codi d'un sol ús a l'adreça de feina de l'espai de treball per demostrar que controla el domini de correu electrònic. Té límit de freqüència, i s'accepta un nombre limitat d'intents incorrectes per codi. També retorna el registre TXT per a l'alternativa 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 domini, el seu estat i el registre TXT.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspaceDomainCodeResponse" } } } }, "404": { "description": "Aquesta aplicació no s'ha registrat gratuïtament, per la qual cosa no té cap espai de treball gratuït." } } } }, "/v3/travel-rule/workspace/domain/confirm/": { "post": { "summary": "Confirmar el codi de verificació de domini", "description": "Consumeix el codi enviat per correu electrònic i marca el domini de correu electrònic com a verificat.", "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": "L'espai de treball.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "El codi és incorrecte, ha caducat o ja s'ha utilitzat." }, "404": { "description": "Aquesta aplicació no s'ha registrat gratuïtament, per la qual cosa no té cap espai de treball gratuït." } } } }, "/v3/travel-rule/workspace/domain/dns/": { "post": { "summary": "Verifica el domini a partir del seu registre TXT", "description": "Comprova el registre TXT `didit-tr-verify.` retornat per l'endpoint de codi i marca el domini com a verificat quan coincideix. N'hi ha prou amb una de les dues proves: el codi enviat per correu electrònic o el registre 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": "L'espai de treball.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "El registre TXT no s'ha trobat o no coincideix." }, "404": { "description": "Aquesta aplicació no s'ha registrat gratuïtament, per la qual cosa no té cap espai de treball gratuït." } } } }, "/v3/travel-rule/workspace/billing/": { "post": { "summary": "Habilita la facturació de sortida", "description": "Activa la facturació de la Travel Rule sortint per a l'espai de treball. La recepció continua sent gratuïta. Això no es pot tornar a desactivar mitjançant l'API: contacta amb el suport 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": "L'espai de treball amb `billing_enabled` establert a true.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "`enabled` era false." }, "404": { "description": "Aquesta aplicació no s'ha registrat gratuïtament, per la qual cosa no té cap espai de treball gratuït." } } } }, "/v3/investigator/summary/": { "get": { "operationId": "investigator_summary", "summary": "Resum de l'investigador", "description": "Fase, recomptes de cua, informes preparats i decidits avui, concordança de 30 dies, preus i el nivell d'autonomia de cada cua. Les claus restringides necessiten l'abast `decisions` (lectura); les alertes de transaccions també necessiten `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": "Falta la clau d'API o no és vàlida." }, "403": { "description": "A la clau li manca l'abast, el tipus d'element no es pot llegir o el pla no inclou l'Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sessions, i casos no oberts per una regla de transacció) o `transactions` (alertes de transacció, i casos oberts per una regla de transacció)." }, { "in": "query", "name": "timezone", "schema": { "type": "string" }, "description": "Zona horària IANA (per exemple `Europe/Madrid`) a partir de la qual comença a comptar «avui». UTC per defecte." } ], "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": "Llista la cua d'Investigator", "description": "Informes oberts, primer **A punt per acceptar**, després per data límit, risc i espera. `counts` cobreix tots els tipus dins de l'abast. `count` està limitat a 100. Les claus restringides necessiten l'abast `decisions` (lectura); les alertes de transaccions també necessiten `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": "Falta la clau d'API o no és vàlida." }, "403": { "description": "A la clau li manca l'abast, el tipus d'element no es pot llegir o el pla no inclou l'Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sessions, i casos no oberts per una regla de transacció) o `transactions` (alertes de transacció, i casos oberts per una regla de transacció)." }, { "in": "query", "name": "kind", "schema": { "type": "string" }, "description": "`session`, `business_session`, `transaction` o `case`, o diversos separats per comes." }, { "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": "Nom, empresa, títol del cas, número, ID de transacció o ID d'element." }, { "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": "Obtenir un informe d'Investigator", "description": "L'informe complet d'una execució. 404 quan l'execució no té cap informe completat, o el seu element s'ha suprimit. Les claus restringides necessiten l'abast `decisions` (lectura); les alertes de transaccions també necessiten `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorRunDetail" } } } }, "404": { "description": "No s'ha trobat o no hi ha cap informe." }, "401": { "description": "Falta la clau d'API o no és vàlida." }, "403": { "description": "A la clau li manca l'abast, el tipus d'element no es pot llegir o el pla no inclou l'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": "Acceptar una recomanació", "description": "Aplica l'acció recomanada a través del camí habitual de l'element, de manera que es disparin els teus webhooks habituals. Un camp `narrative` fa que quedi editada i acceptada. Les claus restringides necessiten l'abast `decisions` (escriptura); les alertes de transacció també necessiten `transactions` (escriptura). Escalar una verificació o transacció obre un cas.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorDecision" } } } }, "409": { "description": "Ja s'ha decidit, l'informe no està a punt, o una regla de protecció reté l'element." }, "401": { "description": "Falta la clau d'API o no és vàlida." }, "403": { "description": "A la clau li manca l'abast, el tipus d'element no es pot llegir o el pla no inclou l'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": "Sobreescriure una recomanació", "description": "Executa una altra acció amb una categoria i un motiu. També anul·la una decisió que l'Investigator hagi pres pel seu compte mentre encara estigui vigent. Les claus restringides necessiten l'abast `decisions` (escriptura); les alertes de transacció també necessiten `transactions` (escriptura). Escalar una verificació o transacció obre un cas.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorDecision" } } } }, "409": { "description": "Ja s'ha decidit, o una regla de protecció reté l'element." }, "401": { "description": "Falta la clau d'API o no és vàlida." }, "403": { "description": "A la clau li manca l'abast, el tipus d'element no es pot llegir o el pla no inclou l'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": "Acceptar recomanacions en lot", "description": "Accepta fins a 50 informes marcats com a «Preparats per acceptar». Cadascun és la seva pròpia decisió: si un no es pot acceptar, s'omet indicant-ne el motiu. Les claus restringides necessiten l'abast `decisions` (escriptura); les alertes de transaccions també necessiten `transactions` (escriptura). Escalar una verificació o transacció obre un cas.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorBatchAcceptResponse" } } } }, "401": { "description": "Falta la clau d'API o no és vàlida." }, "403": { "description": "A la clau li manca l'abast, el tipus d'element no es pot llegir o el pla no inclou l'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": "Obtenir la revisió d'Investigator d'una transacció", "description": "L'última revisió de la transacció, o `investigator: null` quan mai no n'ha tingut cap. Les claus restringides necessiten els àmbits `decisions` i `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 és la transacció d'aquesta aplicació." }, "401": { "description": "Falta la clau d'API o no és vàlida." }, "403": { "description": "A la clau li manca l'abast, el tipus d'element no es pot llegir o el pla no inclou l'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": "Llista els controls de seguretat bloquejats", "description": "Les cinc baranes de seguretat que s'apliquen a cada cua. No es poden desactivar. Les claus restringides necessiten l'abast `decisions` (lectura); les alertes de transaccions també necessiten `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": "Falta la clau d'API o no és vàlida." }, "403": { "description": "A la clau li manca l'abast, el tipus d'element no es pot llegir o el pla no inclou l'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": "Tauler de l'investigador", "description": "Els darrers 30 dies: revisions, decisions, taxa d'automatització, hores estalviades, despesa, anul·lacions, mostres de qualitat des del llançament, xifres setmanals i per cua. Les claus restringides necessiten l'abast `decisions` (lectura); les alertes de transaccions també necessiten `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": "Falta la clau d'API o no és vàlida." }, "403": { "description": "A la clau li manca l'abast, el tipus d'element no es pot llegir o el pla no inclou l'Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sessions, i casos no oberts per una regla de transacció) o `transactions` (alertes de transacció, i casos oberts per una regla de transacció)." } ], "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": "Rendiment de l'investigador", "description": "Concordança amb el teu equip, volum, temps estalviat, calibratge de confiança, resultats per cua, motius d'anul·lació i discrepàncies durant un període. Les claus restringides necessiten l'abast `decisions` (lectura); les alertes de transaccions també necessiten `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": "Falta la clau d'API o no és vàlida." }, "403": { "description": "A la clau li manca l'abast, el tipus d'element no es pot llegir o el pla no inclou l'Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sessions, i casos no oberts per una regla de transacció) o `transactions` (alertes de transacció, i casos oberts per una regla de transacció)." }, { "in": "query", "name": "period", "schema": { "type": "string", "enum": [ "7", "30", "90" ], "default": "30" }, "description": "Dies, que acaben avui." } ], "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": "Llista l'activitat de l'investigador", "description": "El registre d'auditoria de només addició, el més recent primer. Una acceptació per lots és una entrada. Afegeix `counts` per grup i `actors`. Les claus restringides necessiten l'abast `decisions` (lectura); les alertes de transaccions també necessiten `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": "Falta la clau d'API o no és vàlida." }, "403": { "description": "A la clau li manca l'abast, el tipus d'element no es pot llegir o el pla no inclou l'Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sessions, i casos no oberts per una regla de transacció) o `transactions` (alertes de transacció, i casos oberts per una regla de transacció)." }, { "in": "query", "name": "group", "schema": { "type": "string", "enum": [ "agent", "decisions", "overrides", "autonomy" ] } }, { "in": "query", "name": "actor", "schema": { "type": "string" }, "description": "`agent` per a l'Investigator, o el correu electrònic d'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 l'activitat d'Investigator", "description": "Les mateixes entrades en format CSV, una fila per decisió, de més recent a més antiga, fins a 10.000 entrades. Les claus restringides necessiten l'abast `decisions` (lectura); les alertes de transaccions també necessiten `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "text/csv": { "schema": { "type": "string" } } } }, "401": { "description": "Falta la clau d'API o no és vàlida." }, "403": { "description": "A la clau li manca l'abast, el tipus d'element no es pot llegir o el pla no inclou l'Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sessions, i casos no oberts per una regla de transacció) o `transactions` (alertes de transacció, i casos oberts per una regla de transacció)." }, { "in": "query", "name": "group", "schema": { "type": "string", "enum": [ "agent", "decisions", "overrides", "autonomy" ] } }, { "in": "query", "name": "actor", "schema": { "type": "string" }, "description": "`agent` per a l'Investigator, o el correu electrònic d'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": "Obtenir la configuració d'Investigator", "description": "La fase (`none`, `shadow` o `live`) i el límit de despesa mensual amb la despesa d'aquest mes. Les claus restringides necessiten l'abast `applications` (lectura).", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorSettings" } } } }, "401": { "description": "Falta la clau d'API o no és vàlida." }, "403": { "description": "A la clau li manca l'abast, el tipus d'element no es pot llegir o el pla no inclou l'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": "Actualitzar configuració de l'investigador", "description": "Canvia l'estat, el límit de despesa mensual o ambdós. Passar de `none` requereix un pla que inclogui l'Investigator (Growth o superior); `live` també requereix un contracte que n'estableixi el preu, si en tens un. Les claus restringides necessiten l'abast `applications` (escriptura).", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorSettings" } } } }, "400": { "description": "No s'ha enviat cap camp, o el valor no és vàlid." }, "401": { "description": "Falta la clau d'API o no és vàlida." }, "403": { "description": "A la clau li manca l'abast, el tipus d'element no es pot llegir o el pla no inclou l'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 adreces de cartera de forma massiva", "description": "Afegeix fins a 10,000 carteres a la teva llibreta d'adreces de la Travel Rule en una sola crida, com a JSON o com a fitxer CSV. Es pot enviar una cartera per la seva adreça, pel SHA-256 de la seva adreça en minúscules (`address_hash`) per mantenir l'adreça privada, o per tots dos mètodes. La importació és idempotent: una cartera que ja estigui a la llibreta es reporta com a `existing` i es deixa intacta, de manera que es pot enviar el mateix fitxer un altre cop. Cada fila es valida de manera independent, per la qual cosa una fila incorrecta mai no fa fallar les altres. Una cartera importada només pel seu hash coincideix únicament amb les transferències a aquesta adreça i es pot acreditar amb el giny de titularitat de la cartera com qualsevol altra 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 fitxer CSV en format UTF-8 d'un màxim de 5 MB amb una fila de capçalera que especifica les seves columnes (els camps de les files o els seus àlies). Les cel·les buides es consideren com a no enviades; les columnes que la importació no llegeix s'ignoren." } } } } } }, "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": "Totes les files s'han creat, ja eren al registre o eren una repetició d'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": "Com a mínim una fila ha fallat; les altres s'han importat. Cada fila que ha fallat indica els seus errors.", "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 es pot llegir la sol·licitud: s'han enviat tant `entries` com un `file`, o bé cap dels dos; més de 10.000 files; un fitxer de més de 5 MB, que no és CSV en UTF-8, sense fila de capçalera o sense files.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "file": [ "At most 10000 rows per import." ] } } } } } } }, "/v3/travel-rule/counterparty-contacts/": { "get": { "summary": "Llista els contactes de la contrapart", "description": "Les adreces de compliment a les quals el canal EMAIL pot escriure per a la teva aplicació: els contactes de la plataforma de Didit més els privats de la teva aplicació, inclosos els rebotats, ordenats del més recent al més antic. Paginat amb `limit` (per defecte 50) i `offset`; `count` s'atura a 100, de manera 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": "Només els contactes d'aquesta entrada de directori. Ha de ser un UUID; un valor buit significa cap filtre." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "Mida de la pàgina, per defecte 50." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "Files que cal ometre." } ], "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": "Els contactes.", "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 és un UUID.", "content": { "application/json": { "example": { "counterparty": [ "Must be a valid UUID." ] } } } } } }, "post": { "summary": "Afegeix un contacte de la contrapart", "description": "Afegeix una adreça de compliment privada per a una entrada del directori. Només la teva aplicació la veu i la utilitza, i el canal EMAIL hi escriu abans que a qualsevol contacte de la plataforma. Si afegeixes una adreça que l'entrada ja té entre els teus propis contactes, es retorna aquest contacte.", "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": "S'ha afegit el contacte.", "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 camp o no és vàlid, o cap entrada del directori té aquest id.", "content": { "application/json": { "example": { "counterparty": [ "No directory entry with this id." ] } } } } } } }, "/v3/travel-rule/counterparty-contacts/{contact_uuid}/": { "delete": { "summary": "Eliminar un contacte de la contrapart", "description": "Elimina un dels contactes propis de la teva aplicació. El canal EMAIL deixa d'escriure-hi immediatament. Els contactes de la plataforma no es poden 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": "Eliminat." }, "404": { "description": "Cap contacte de la teva aplicació té aquest id. Un contacte de la plataforma també retorna un 404." } } } }, "/v3/travel-rule/transfers/": { "get": { "summary": "Llista les transferències de Travel Rule", "description": "Les transferències de Travel Rule de la teva aplicació, les més recents primer, paginades amb `limit` (per defecte 50) i `offset`. Les files només contenen noms de VASP, carteres i memos, mai dades de persones. Els valors separats per comes en seleccionen diversos. Un valor desconegut respon 400 indicant el paràmetre, per exemple `{\"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 ambdós separats per comes. Distingeix entre majúscules i minúscules." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Un o més estats de transferència, separats per comes." }, { "name": "rail", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Un o més dels següents: INTERNAL, TRP, GTR, TRUST, VERIFYVASP, SYGNA, EMAIL, TEST_VASP, separats per comes." }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string" }, "description": "withdrawal, deposit o message, separats per comes." }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" }, "description": "La moneda de la transacció, sense distingir majúscules de minúscules." }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Transferències creades a partir d'aquest dia (UTC), YYYY-MM-DD." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Transferències creades fins a aquest dia (UTC), YYYY-MM-DD." }, { "name": "counterparty", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "L'`id` d'una entrada del directori o d'un membre de la xarxa Didit des de GET /v3/travel-rule/vasps/: les teves transferències amb aquesta contrapart. Un valor que no sigui un id vàlid respon 400." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "Mida de la pàgina, per defecte 50." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "Files que cal ometre." } ], "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 transferències.", "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": "El valor d'un filtre no és vàlid.", "content": { "application/json": { "example": { "start_date": [ "Use the YYYY-MM-DD format." ] } } } } } } }, "/v3/session/imports/providers/": { "get": { "summary": "Llista els proveïdors de migració", "description": "Els 15 proveïdors des dels quals pots migrar verificacions: què necessita cadascun per connectar-se, si la seva API pot llistar registres, els permisos que necessita la seva clau i la seva assignació d'estats per defecte.", "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": "Proveïdors de migració.", "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": "Falta la clau d'API, no és vàlida o està revocada, o qui fa la crida no pot importar verificacions per a aquesta aplicació.", "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": "Comprovar una clau de proveïdor", "description": "Consulta el proveïdor amb la teva clau abans de crear una migració. No s'emmagatzema res.", "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ó, de `GET /v3/session/imports/providers/`. Obligatori quan `source` és `provider`." }, "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "La clau de només lectura del proveïdor, amb els noms de camp que enumera `credential_fields`. Xifrada en repòs, mai no es retorna i s'elimina quan finalitza la importació. Envia-la com una cadena JSON a multipart." }, "options": { "type": "object", "properties": { "region": { "type": "string", "description": "La regió del proveïdor, una de les seves `regions` (Onfido: `eu`, `us`, `ca`)." } } }, "record_ids": { "type": "array", "items": { "type": "string" }, "description": "Per a proveïdors de tipus `api_ids`: l'ID del primer registre de la teva exportació." } }, "required": [ "provider", "credentials" ] }, "example": { "provider": "sumsub", "credentials": { "app_token": "YOUR_PROVIDER_APP_TOKEN", "secret_key": "YOUR_PROVIDER_SECRET_KEY" } } } } }, "responses": { "200": { "description": "La clau pot llegir registres.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "provider": { "type": "string" }, "credential_hint": { "type": "string", "nullable": true } } } } } }, "400": { "description": "El proveïdor ha rebutjat la clau: `code`, `detail`, `missing_permissions`, `suggested_region`." }, "403": { "description": "Falta la clau d'API, no és vàlida o està revocada, o qui fa la crida no pot importar verificacions per a aquesta aplicació.", "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": "Inicia una execució de prova", "description": "Inicia una migració l'execució de prova (dry run) de la qual ha finalitzat (`READY`): la mateixa tasca farà la importació real, amb el mapatge d'estats i la selecció de plantilles facials que s'envien ara.", "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": "Modificacions del mapatge d'estats per defecte del proveïdor: de l'estat d'origen a l'estat de Didit. `Not Finished` i `Abandoned` s'ometen i es comptabilitzen, mai s'importen." }, "face_templates": { "type": "boolean", "default": false, "description": "Genera plantilles biomètriques a partir de les selfies importades i cerca-les a les cares i la llista de bloqueig de l'aplicació. Les coincidències només es marquen per a revisió. Requereix `lawful_basis_confirmed`." }, "lawful_basis_confirmed": { "type": "boolean", "default": false, "description": "Confirma que disposes d'una base jurídica per compartir aquestes selfies amb Didit com a encarregat del tractament." } } } } } }, "responses": { "200": { "description": "La tasca d'importació.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "La tasca no es troba en un estat al qual es pugui aplicar aquesta acció." }, "403": { "description": "Falta la clau d'API, no és vàlida o està revocada, o qui fa la crida no pot importar verificacions per a aquesta aplicació.", "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": "Posa en pausa una tasca d'importació", "description": "Posa en pausa una importació a la cua o en execució.", "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": "La tasca d'importació.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "La tasca no es troba en un estat al qual es pugui aplicar aquesta acció." }, "403": { "description": "Falta la clau d'API, no és vàlida o està revocada, o qui fa la crida no pot importar verificacions per a aquesta aplicació.", "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": "Reprendre una tasca d'importació", "description": "Reprèn una importació que hagis pausat. Una tasca pausada pel límit de freqüència del proveïdor es reprèn automàticament.", "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": "La tasca d'importació.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "La tasca no es troba en un estat al qual es pugui aplicar aquesta acció." }, "403": { "description": "Falta la clau d'API, no és vàlida o està revocada, o qui fa la crida no pot importar verificacions per a aquesta aplicació.", "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": "Cancel·lar una tasca d'importació", "description": "Cancel·la una importació. El que ja s'ha importat es manté; el fitxer penjat i la clau s'esborren.", "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": "La tasca d'importació.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "La tasca no es troba en un estat al qual es pugui aplicar aquesta acció." }, "403": { "description": "Falta la clau d'API, no és vàlida o està revocada, o qui fa la crida no pot importar verificacions per a aquesta aplicació.", "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": "Reintenta una migració", "description": "Torna a executar una migració que ha finalitzat com una tasca nova, amb una clau nova (l'antiga s'ha esborrat). Manté el proveïdor, el flux de treball, la regió, el mapatge d'estats i la selecció de plantilles facials; s'omet tot el que ja sigui a Didit.", "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 clau de només lectura del proveïdor, amb els noms de camp que enumera `credential_fields`. Xifrada en repòs, mai no es retorna i s'elimina quan finalitza la importació. Envia-la com una cadena JSON a multipart." }, "file": { "type": "string", "format": "binary", "description": "Els ID de registre o el fitxer d'exportació de nou, per als proveïdors `api_ids` i `export_file`." } } }, "example": { "credentials": { "app_token": "YOUR_PROVIDER_APP_TOKEN", "secret_key": "YOUR_PROVIDER_SECRET_KEY" } } } } }, "responses": { "201": { "description": "La nova tasca d'importació.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "No és una migració, no ha finalitzat o el proveïdor ha rebutjat la clau." }, "403": { "description": "Falta la clau d'API, no és vàlida o està revocada, o qui fa la crida no pot importar verificacions per a aquesta aplicació.", "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": "Llista les tasques d'importació", "description": "Totes les importacions de l'aplicació en un sol format: importacions i migracions de verificacions, persones i empreses.", "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": "Tasques d'importació, les més recents primer.", "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": "Falta la clau d'API, no és vàlida o està revocada, o qui fa la crida no pot importar verificacions per a aquesta aplicació.", "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": "Llista les tasques d'importació actives", "description": "Què s'està executant o esperant, més el que acaba de finalitzar, per a un indicador de progrés.", "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": "Tasques d'importació actives.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJobSummary" } }, "running": { "type": "integer" } } } } } }, "403": { "description": "Falta la clau d'API, no és vàlida o està revocada, o qui fa la crida no pot importar verificacions per a aquesta aplicació.", "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 transaccions en lot", "description": "Elimina una o més transaccions de manera permanent. Selecciona-les amb `transaction_uuids`, o bé elimina totes les transaccions de l'aplicació amb `delete_all: true`.\n\nUna transacció eliminada s'esborra juntament amb els registres que són exclusivament seus: les seves parts, etiquetes, notes, enllaços de mètodes de pagament, documents i totes les versions emmagatzemades dels seus fitxers, execucions de regles, alertes, resultats de proveïdors, instantània de xarxa i dades de la Travel Rule. Els casos, les persones i les empreses es mantenen; el seu enllaç amb la transacció eliminada s'esborra. Els esborranys d'informes regulatoris la deixen d'incloure i es reconstrueixen sense aquesta. L'eliminació és permanent i irreversible; no hi ha cap endpoint per desfer l'acció.\n\nSi alguna transacció seleccionada figura en un informe regulatori finalitzat, es rebutja tota la sol·licitud amb `409` i no s'elimina res. El cos utilitza `code: in_filed_report` i indica cada transacció i els informes que la llisten. Elimina aquests informes i, tot seguit, repeteix la sol·licitud.", "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 l'organització." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID de l'aplicació." } ], "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 transacció de Didit per eliminar. Obligatoris tret que `delete_all` sigui cert.", "minItems": 1 }, "delete_all": { "type": "boolean", "enum": [ false ], "default": false, "description": "Omet-ho o envia `false` quan seleccionis transaccions amb `transaction_uuids`." } } }, { "title": "All transactions", "required": [ "delete_all" ], "properties": { "delete_all": { "type": "boolean", "enum": [ true ], "description": "Elimina totes les transaccions de l'aplicació. `transaction_uuids` s'ignora." }, "transaction_uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "S'ignora quan `delete_all` és cert." } } } ] }, "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": "Transaccions seleccionades suprimides." }, "400": { "description": "No s'ha proporcionat cap selector de transacció.", "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 clau d'API no pot suprimir transaccions. L'endpoint requereix `write:transactions`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "409": { "description": "Com a mínim una transacció seleccionada figura en un informe regulador finalitzat. No s'ha suprimit res.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/travel-rule/networks/": { "get": { "summary": "Obtenir les xarxes de Travel Rule", "description": "Llegeix, per a aquesta aplicació, l'estat real de cada xarxa: si envia a través de la teva pròpia pertinença o de la de Didit, i per quin motiu encara no pot fer-ho. També retorna el qüestionari de diligència deguda i els teus participants. Llegir no crea res.", "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": "Estats de la xarxa, qüestionari i participants.", "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": "Falta la clau d'API o no és vàlida." } } } }, "/v3/travel-rule/networks/questionnaire/": { "get": { "summary": "Obtenir el qüestionari de la xarxa", "description": "Llegeix el qüestionari de diligència deguda de la xarxa de Didit per a aquesta aplicació, el seu estat i la nota de revisió de Didit. Una aplicació que mai no n'hagi desat cap llegeix un esborrany buit.", "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 qüestionari.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" } } } }, "401": { "description": "Falta la clau d'API o no és vàlida." } } }, "put": { "summary": "Desa les respostes del qüestionari de xarxa", "description": "Desa les respostes al qüestionari mentre estigui en estat draft o changes_requested. Les desades són parcials: les respostes que no enviïs es conserven.", "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 qüestionari amb les respostes combinades.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" } } } }, "400": { "description": "Error de validació, indexat per camp." }, "401": { "description": "Falta la clau d'API o no és vàlida." }, "403": { "description": "L'accés a la xarxa mitjançant la pertinença de Didit encara no està obert.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_platform_networks_disabled" ] } } } } } }, "409": { "description": "El qüestionari està amb Didit o ja està decidit: només pot canviar mentre estigui en estat 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": "Envia el qüestionari de xarxa", "description": "Envia el qüestionari desat perquè Didit el revisi. Les respostes desades han d'estar completes: tots els camps excepte lei i data_protection_contact_email, amb les tres atestacions a true. Didit l'aprova, sol·licita canvis (edita'l i torna'l a enviar) o el rebutja. Les xarxes que hagis sol·licitat mentre estava pendent es traslladen al seu procés d'alta un cop s'aprovi.", "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 qüestionari enviat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" } } } }, "400": { "description": "Les respostes desades estan incompletes o no són vàlides, indexades per camp." }, "401": { "description": "Falta la clau d'API o no és vàlida." }, "403": { "description": "L'accés a la xarxa mitjançant la pertinença de Didit encara no està obert.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_platform_networks_disabled" ] } } } } } }, "409": { "description": "El qüestionari està amb Didit o ja està decidit: només pot canviar mentre estigui en estat 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": "Sol·licitar una xarxa de Travel Rule", "description": "Sol·licita el participant propi d'aquesta aplicació en una xarxa que cobreix l'afiliació de Didit (GTR o Sygna). Sense un qüestionari aprovat, el participant l'espera (questionnaire_pending); amb un, passa a l'alta de la xarxa (submitted_to_network) i s'activa un cop la xarxa li assigna un codi. Idempotent: un participant pendent, en procés d'alta o actiu es retorna sense canvis. Si la xarxa ha rebutjat el registre (last_error està establert), sol·licitar-ho de nou reintenta el procés. TRUST i VerifyVASP només són accessibles mitjançant la teva pròpia afiliació: TRUST admet membres per VASP, i un VerifyVASP Enclave dona servei a un únic identificador 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 xarxa a la qual unir-se a través de la pertinença a 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": "El teu participant a la xarxa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkParticipant" } } } }, "400": { "description": "Xarxa desconeguda, una xarxa que Didit no admet (connecta la teva pròpia afiliació) o una aplicació 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": "Falta la clau d'API o no és vàlida." }, "403": { "description": "L'accés a la xarxa mitjançant la pertinença de Didit encara no està obert.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_platform_networks_disabled" ] } } } } } } } } }, "/v3/address-validation/": { "post": { "summary": "Valida una adreça", "description": "Confirma que una adreça existeix i rep-la normalitzada: les seves línies de lliurament, components i coordenades. Només confirma l'adreça; mai vincula l'adreça a una persona.\n\n**Sol·licitud.** Envia l'adreça en una línia (`address`) o com a camps estructurats (`address_line_1` i, opcionalment, `address_line_2`, `city`, `region`, `postal_code`), mai tots dos, i sempre el seu `country` (ISO 3166-1 alfa-2 o alfa-3).\n\n**Resultat.** `address_validation.status` és `verified` (confirmat fins a l'edifici), `partially_verified` (confirmat només fins al carrer o superior), `not_verified` (només han coincidit la regió o ciutat, o no ha coincidit res) o `unavailable` (la validació no s'ha pogut executar). L'estat HTTP és `200` per a cada sol·licitud completada, `unavailable` inclòs; reintenta un resultat `unavailable` més tard.\n\n**Facturació.** Una crida en producció costa $0.10 per adreça validada. Un resultat `unavailable` no es cobra. No s'emmagatzema res a part del registre d'ús: no es crea cap sessió i el resultat es retorna només en aquesta resposta.\n\n**Sandbox.** Les claus de sandbox validen la sol·licitud i sempre retornen un resultat determinista `verified` que reprodueix l'adreça enviada, sense consumir crèdits.\n\n**Autenticació.** Envia la clau d'API de la teva aplicació a `x-api-key`. Les credencials absents o no vàlides retornen `403` - aquesta API mai retorna `401`.\n\n**Límit de freqüència.** Pressupost compartit d'escriptura de 300 sol·licituds per minut per clau d'API entre els endpoints POST/PATCH/DELETE (les creacions de transaccions i la ingesta d'esdeveniments tenen un pressupost separat de 600).", "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": "Camps d'adreça estructurada", "value": { "address_line_1": "1600 Amphitheatre Pkwy", "city": "Mountain View", "region": "CA", "postal_code": "94043", "country": "US" } }, "One line": { "summary": "Tota l'adreça en una sola línia", "value": { "address": "Paseo de la Castellana 259, 28046 Madrid", "country": "ES" } } } } } }, "responses": { "200": { "description": "La validació s'ha completat. Llegeix `address_validation.status`; HTTP és sempre `200` per a una sol·licitud completada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressValidationResponse" }, "examples": { "Verified": { "summary": "Una adreça real, confirmada fins al nivell de l'edifici", "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": "Un carrer inventat: només ha coincidit la ciutat", "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": "La validació no s'ha pogut executar; no s'ha cobrat", "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": "Llista les proves de cartera amb captures de pantalla pendents de revisió", "description": "La teva cua de revisió de captures de pantalla com a comprovants de titularitat de la cartera. Una captura de pantalla és l'únic comprovant que Didit no pot comprovar per si mateix: un cop l'usuari final la puja des del widget, roman en PENDING fins que l'aprovis o la rebutgis amb POST /v3/travel-rule/wallet-proofs/{proof_uuid}/decision/. Primer les més antigues, de manera que la cua es processa començant pel comprovant que fa més temps que espera. Només apareixen les captures de pantalla pujades, mai cap comprovant on l'usuari final encara no hagi pujat cap fitxer, i mai cap en una cartera que hagis eliminat de la teva llibreta d'adreces (Didit les tanca com a 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": "Quines proves s'han de llistar. Per defecte és PENDING, les que encara s'han de 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": "Proves amb captures de pantalla paginades. El recompte és exacte fins a 100 i es limita a 100 per sobre d'aquest valor.", "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": "Estat desconegut." }, "401": { "description": "Falta l'x-api-key o no és vàlid." }, "403": { "description": "L'emissor de la crida no té el permís de transaccions." } } } }, "/v3/travel-rule/wallet-proofs/{proof_uuid}/decision/": { "post": { "summary": "Aprova o rebutja un comprovant de cartera per captura de pantalla", "description": "Pren una decisió sobre una prova de captura de pantalla de la teva cua de revisió. approve verifica la prova i l'entrada de la llibreta d'adreces i aplica la titularitat a la transferència per a la qual es va generar la sessió del widget, exactament igual que fa una signatura verificada. Una captura de pantalla mai confirma una transferència que un altre client de Didit hagi enviat a través del canal INTERNAL: això requereix un missatge signat o un dipòsit de prova. reject tanca la prova com a REJECTED amb failure_reason REVIEW_REJECTED; l'usuari final pot iniciar una nova prova des del widget. La nota es conserva amb la prova.", "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 cua de revisió.", "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": "El comprovant determinat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWalletProofReview" } } } }, "400": { "description": "Decisió no vàlida o una nota de més de 512 caràcters." }, "401": { "description": "Falta l'x-api-key o no és vàlid." }, "403": { "description": "L'emissor de la crida no té el permís de transaccions." }, "404": { "description": "No hi ha cap comprovant de captura de pantalla enviat amb aquest ID a la teva aplicació." }, "409": { "description": "La prova ja està decidida (el cos inclou el seu estat), o codi OWNERSHIP_CHANGED: el titular de la cartera ha canviat o la cartera s'ha eliminat després que es generés la sessió del widget, de manera que la prova està tancada i el titular actual en necessita una de nova.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } } } } }, "/v3/travel-rule/widget/{token}/proofs/": { "post": { "summary": "Inicia una prova de titularitat de cartera", "description": "Endpoint públic identificat pel token de sessió del widget, sense necessitat de cap clau d'API: el widget allotjat el crida quan l'usuari final tria un mètode de comprovació. Una prova només existeix, i compta al teu embut de proves, a partir d'aquesta crida. Tornar a triar el mateix mètode retorna la prova ja oberta (200, mateix repte o import del dipòsit) en lloc d'iniciar-ne una de segona; triar un altre mètode tanca la prova inacabada com a METHOD_SWITCHED, tret d'una captura de pantalla enviada o un dipòsit de prova que encara s'estigui comprovant. MESSAGE_SIGNING retorna el repte que cal signar; SATOSHI_TEST l'adreça de dipòsit, l'import exacte i la finestra temporal; SELF_DECLARATION es verifica a l'instant (estat VERIFIED). Formats de signatura verificats per família de cadenes: les cadenes EVM accepten una signatura personal_sign (EIP-191), codificada en hexadecimal; Bitcoin accepta una signatura signmessage BIP-137 (adreces P2PKH, P2SH-P2WPKH i P2WPKH) o una signatura simple BIP-322 (adreces P2WPKH i P2TR), codificada en base64; Solana accepta una signatura Ed25519 sobre el repte, codificada en base58; Tron accepta una signatura signMessageV2 (TIP-191), codificada en hexadecimal. Una signatura BIP-322 completa o de comprovant de fons, o una adreça multisig, falla amb 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 sessió opac retornat quan s'ha creat la sessió 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 nova prova PENDING (VERIFIED per a SELF_DECLARATION).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofSummary" } } } }, "200": { "description": "La prova que ja estava oberta per a aquest mètode, represa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofSummary" } } } }, "400": { "description": "Cos no vàlid, una cartera que no coincideix amb la transferència, SCREENSHOT no permès o el codi CHAIN_UNSUPPORTED quan el mètode no està disponible a la blockchain.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "403": { "description": "SELF_DECLARATION no està permès per a aquesta aplicació." }, "404": { "description": "Token desconegut." }, "409": { "description": "codi OWNERSHIP_CHANGED: el titular de la cartera ha canviat o la cartera s'ha suprimit després de generar la sessió; genera una nova sessió per al titular actual. També es retorna per a SATOSHI_TEST quan la sessió no té satoshi_deposit_address, i quan a la sessió no li queden intents (sense codi; el cos conté max_attempts, attempts_used i attempts_remaining 0): genera una nova sessió.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "410": { "description": "La sessió ha caducat." } } } }, "/v3/travel-rule/widget/{token}/proofs/{proof_id}/verify/": { "post": { "summary": "Envia la prova de titularitat de la cartera", "description": "Endpoint públic identificat pel token de sessió del widget, sense necessitat de cap clau d'API. Envia les proves que requereix el mètode de comprovació: signatura per a MESSAGE_SIGNING, txid per a SATOSHI_TEST (JSON), o un fitxer per a SCREENSHOT (multipart). Cada enviament compta com un intent. Una signatura que no es verifiqui, o un dipòsit que no coincideixi, respon 400 amb un codi i deixa la prova en PENDING perquè l'usuari final ho pugui tornar a intentar. Un dipòsit detectat però encara no confirmat respon 200 amb l'estat PENDING i es torna a comprovar automàticament fins que es tanca la finestra. Una captura de pantalla respon 200 amb l'estat PENDING i espera a la teva cua de revisió (GET /v3/travel-rule/wallet-proofs/). Una prova en EXPIRED o REJECTED mai no es verifica posteriorment: inicia'n una de nova. Formats de signatura verificats per família de cadenes: les cadenes EVM accepten una signatura personal_sign (EIP-191), codificada en hexadecimal; Bitcoin accepta una signatura signmessage BIP-137 (adreces P2PKH, P2SH-P2WPKH i P2WPKH) o una signatura simple BIP-322 (adreces P2WPKH i P2TR), codificada en base64; Solana accepta una signatura Ed25519 sobre el repte, codificada en base58; Tron accepta una signatura signMessageV2 (TIP-191), codificada en hexadecimal. Una signatura BIP-322 completa o de comprovant de fons, o una adreça multisig, falla amb 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 sessió opac retornat quan s'ha creat la sessió del widget.", "schema": { "type": "string" } }, { "name": "proof_id", "in": "path", "required": true, "description": "proof_id retornat quan s'ha iniciat la prova.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "signature": { "type": "string", "description": "MESSAGE_SIGNING: la signatura de la cartera sobre el repte de la prova." }, "txid": { "type": "string", "description": "SATOSHI_TEST: l'identificador de transacció del dipòsit de prova." } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary", "description": "SCREENSHOT: una imatge que mostra la cartera a l'aplicació de cartera de l'usuari 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 encara PENDING (una captura de pantalla pendent de revisió, un dipòsit no indexat o encara no confirmat, amb el codi DEPOSIT_NOT_FOUND o DEPOSIT_UNCONFIRMED).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofVerifyResult" } } } }, "400": { "description": "Falten proves; un intent fallit que manté la prova en PENDING perquè l'usuari final pugui tornar-ho a provar (codi SIGNATURE_INVALID, SIGNATURE_UNSUPPORTED_SCHEME o DEPOSIT_LOOKUP_FAILED); o un dipòsit de prova que rebutja la prova (codi DEPOSIT_MISMATCH, DEPOSIT_STALE o TXID_REUSED, estat REJECTED, amb el recompte d'intents de la sessió): seleccionar un mètode de nou inicia una nova prova mentre attempts_remaining sigui superior a 0.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "404": { "description": "Token desconegut o no hi ha aquesta prova en aquesta sessió." }, "409": { "description": "codi OWNERSHIP_CHANGED (la prova es tanca amb aquest codi); una prova tancada (REJECTED o EXPIRED), amb el seu estat, el codi amb què s'ha tancat i el recompte d'intents de la sessió: tria un altre cop un mètode per iniciar una nova prova; o una prova SELF_DECLARATION, que es verifica en iniciar-se.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "410": { "description": "La sessió ha caducat, o té el codi WINDOW_EXPIRED quan s'ha tancat la finestra de prova de satoshi.", "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": "Carteres de la Digital Credentials API (Google Wallet): envia el que la cartera ha retornat a la teva pàgina o aplicació per a una verificació on next_action sigui request_digital_credential. Didit ho desxifra, comprova la signatura de l'emissor contra les arrels d'emissors de confiança, cada valor retornat contra el seu resum signat, i la signatura del dispositiu sobre el teu origen i aquesta sol·licitud, i després decideix la verificació: verificada (facturada una vegada) o rebutjada amb el codi d'error. D'un sol ús: un segon enviament retorna la verificació decidida.", "summary": "Envia una resposta de cartera", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "El request_id que ha retornat l'endpoint d'inici.", "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": "Falten les credencials (x-api-key o Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error not_found: cap verificació de cartera d'aquesta aplicació té aquest request_id." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Errors de validació de camp ({field: [messages]})." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error not_a_digital_credentials_wallet: aquesta verificació no admet una resposta de cartera." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot verificar la cartera." } }, "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 sessió amb Google Wallet (Google Wallet (ID pass) i emissors estatals dels EUA (permís de conduir mòbil); USA, GBR, BRA, SGP, TWN) sense cap flux de treball. Es factura un sol cop, només quan es verifica la identitat. La resposta inclou next_action.type=request_digital_credential amb una sol·licitud que Didit ha signat per a la teva aplicació, utilitzable només des de l'origen. Durant un gest de l'usuari en aquest origen, passa next_action.digital_credentials.request a navigator.credentials.get({digital: ...}) (o a Android Credential Manager com a requestJson de GetDigitalCredentialOption), i després fes un POST del que retorni la cartera a /v3/id-verification/wallets/verifications/{request_id}/response/. El navegador ofereix el seu propi codi QR quan la cartera es troba en un altre dispositiu. Les aplicacions de sandbox obtenen una simulació determinista (simulated: true) que mai contacta amb el proveïdor.", "summary": "Inicia la verificació amb Google Wallet", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es reintenta amb la mateixa clau, cartera i cos, es retorna la verificació original sense iniciar un segon inici de sessió; la mateixa clau amb una altra cartera o cos retorna 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": "Errors de validació de camp ({field: [messages]}), o 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": "Falten les credencials ({detail}), o s'ha produït l'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 (amb Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_provider_unavailable: el proveïdor no s'ha pogut iniciar; no s'ha creat res." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "error wallet_not_configured: aquest entorn no pot comunicar-se amb la cartera." } }, "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": "Puja documents de KYB a una sessió", "description": "Puja un o més documents corporatius (escriptures de constitució, registre d'accionistes, certificat de constitució, ...) al pas de Documents de KYB d'una sessió de Verificació d'empreses (KYB), des del teu propi servidor en lloc de la pàgina allotjada. Didit executa el procés allotjat: compressió, OCR, comprovacions de manipulació i creuades entre documents, agrupació de documents, i fa avançar la sessió quan se satisfan els grups de documents requerits. El pas té una tarifa fixa única independentment de quants fitxers enviïs. La sessió ha d'estar oberta i en el pas de Documents de KYB, i l'empresa seleccionada en el pas de registre ha d'existir. Consulta les persones que anomenen els documents amb `GET /v3/session/{sessionId}/kyb/extracted-parties/`. Requereix `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 sessió de Verificació d'empreses (KYB). Ha de pertànyer a l'aplicació de la clau d'API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Node del flux de treball del pas de KYB. Només cal quan el flux de treball té més d'un node de KYB; per defecte, Didit utilitza el node propi de la sessió.", "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": "Fitxers per penjar: JPG, JPEG, PNG, TIFF, WEBP, PDF o arxius ZIP que en continguin. PDF de fins a 50 MB, fotos de fins a 6 MB abans de la compressió." }, "document_passwords": { "type": "array", "items": { "type": "string" }, "description": "Una entrada per fitxer a `documents`, en el mateix ordre: la contrasenya d'un PDF protegit, buit per a qualsevol altre fitxer." }, "document_group": { "type": "string", "enum": [ "LEGAL_PRESENCE", "COMPANY_DETAILS", "OWNERSHIP_STRUCTURE", "REPRESENTATIVES_AUTHORIZATION" ], "description": "Grup de documents obligatori al qual respon aquesta càrrega." }, "locale": { "type": "string", "maxLength": 10, "description": "Configuració regional utilitzada per traduir la resposta del pas següent." } } } } } }, "responses": { "200": { "description": "Documents processats. Quan es compleix cada grup requerit, la sessió avança i `next_step` indica el pas següent; en cas contrari, roman al pas de Documents i `document_groups` i `document_answer` indiquen què falta encara.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "next_step": { "type": "string", "nullable": true, "description": "Pas en què es troba la sessió després de la càrrega." }, "kyb_status": { "type": "string", "description": "Estat de la comprovació de l'empresa." }, "document_answer": { "type": "object", "additionalProperties": true, "description": "Resultat per document pujat i les càrregues restants." } }, "additionalProperties": true }, "example": { "valid": true, "next_step": "KYB_KEY_PEOPLE", "kyb_status": "In Progress" } } } }, "400": { "description": "S'ha rebutjat un document (manipulació, il·legible o no admès) o la sessió encara no té cap empresa de KYB. Reintenta-ho amb un altre fitxer mentre quedin intents.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "example": { "message": "No KYB company found. Submit company data first." } } } }, "402": { "description": "L'organització no té prou crèdit per al pas de documents.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "example": { "detail": "Insufficient credits." } } } }, "401": { "description": "La clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna `401`: una clau absent, no vàlida o revocada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "summary": "La data de caducitat de la clau ha passat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallada d'autenticació o d'autorització. Si falta la clau es retorna `403`, igual que amb una clau d'una altra aplicació, una clau amb àmbit sense el permís que necessita aquest endpoint o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau; una clau incorrecta, revocada o caducada retorna `401`. Distingeix-les pel camp `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta la capçalera x-api-key, o la clau ha fallat la validació", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clau vàlida que pertany a una aplicació diferent de la de la sessió", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clau amb abast li manca el permís d'escriptura de decisions", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Sol·licitud des de fora de la llista d'adreces IP permeses de la clau", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sessió no existeix, s'ha suprimit, pertany a una altra aplicació o queda fora dels límits d'una clau amb abast limitat; cap detall no permet distingir entre aquests casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "La sessió ha finalitzat (`kyb_session_not_writable`) o no es troba al pas KYB Documents (`kyb_step_mismatch`, amb `next_step` indicant el pas en què es troba).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." }, "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": "S'ha superat el límit de freqüència: 300 sol·licituds d'escriptura (POST, PATCH, DELETE) per minut per clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar; les capçaleres `X-RateLimit-*` mostren el pressupost restant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Rate limited": { "summary": "Pressupost per al minut actual esgotat", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segons que cal esperar abans de reintentar.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } }, "503": { "$ref": "#/components/responses/DocumentProcessingBusy" } }, "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": "Llista les parts que figuren als documents pujats", "description": "Retorna els accionistes i administradors que esmenten els documents pujats en aquesta sessió de KYB, fusionats per persona i atribuïts als documents que els esmenten. Mostra'ls al teu sol·licitant perquè els confirmi i, a continuació, declara'ls amb els endpoints d'esborrany de parts. Un interval continua sent un interval: `ownership_percent.text` manté la xifra literal i `min` / `max` els números llegits a partir d'aquesta. Aquí no s'etiqueta ningú com a UBO; això es decideix quan s'envien les parts, a partir de la configuració de rols i els llindars de titularitat del flux de treball. La mateixa llista es troba a la decisió de la sessió com a `document_verifications[].extracted_parties`. Requereix `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 sessió de Verificació d'empreses (KYB). Ha de pertànyer a l'aplicació de la clau d'API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Node del flux de treball del pas de KYB. Només cal quan el flux de treball té més d'un node de KYB; per defecte, Didit utilitza el node propi de la sessió.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Parts designades pels documents actuals.", "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 xifra de titularitat exactament com s'indica al document, com ara `25-50%`, `>50%` o `NO EXHIBE`." }, "min": { "type": "number", "nullable": true, "description": "Número inferior extret de `text`; null quan no n'indica cap." }, "max": { "type": "number", "nullable": true, "description": "Número superior extret de `text`; null quan no n'indica cap." } } } } } }, "documents": { "type": "array", "description": "Els documents pujats que identificaven aquesta part.", "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": "Els accionistes i administradors que s'esmenten als documents pujats, fusionats per persona. Aquí ningú no s'etiqueta com a UBO: això es decideix quan s'envien les parts." }, "document_count": { "type": "integer", "description": "Nombre de documents pujats a partir dels quals s'ha llegit la llista." }, "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 clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna `401`: una clau absent, no vàlida o revocada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "summary": "La data de caducitat de la clau ha passat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallada d'autenticació o d'autorització. Si falta la clau es retorna `403`, igual que amb una clau d'una altra aplicació, una clau amb àmbit sense el permís que necessita aquest endpoint o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau; una clau incorrecta, revocada o caducada retorna `401`. Distingeix-les pel camp `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta la capçalera x-api-key, o la clau ha fallat la validació", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clau vàlida que pertany a una aplicació diferent de la de la sessió", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clau amb abast li manca el permís d'escriptura de decisions", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Sol·licitud des de fora de la llista d'adreces IP permeses de la clau", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sessió no existeix, s'ha suprimit, pertany a una altra aplicació o queda fora dels límits d'una clau amb abast limitat; cap detall no permet distingir entre aquests casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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": "Llista els esborranys de parts de KYB", "description": "Llista les parts que estàs preparant per a aquesta sessió de KYB, de més antigues a més recents. Un esborrany no és una part declarada: no apareix a la decisió ni a la consola i no crea cap sessió de verificació fins que l'enviïs amb `POST /v3/session/{sessionId}/kyb/parties/submit/`. Requereix `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 sessió de Verificació d'empreses (KYB). Ha de pertànyer a l'aplicació de la clau d'API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Node del flux de treball del pas de KYB. Només cal quan el flux de treball té més d'un node de KYB; per defecte, Didit utilitza el node propi de la sessió.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Els esborranys emmagatzemats.", "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 part és una persona física o una empresa." }, "full_name": { "type": "string", "maxLength": 255, "description": "Nom complet d'una persona. Envia aquest camp, o bé `first_name` i `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 té la part. Intercanviable amb `roles`; quan s'envien tots dos, es fusionen." }, "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": "Tots els rols que té la part. Una persona necessita almenys un rol (aquí o a `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Càrrec laboral d'una persona." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Nom d'una part empresarial. Obligatori quan `entity_type` és `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registre d'una part de l'empresa." }, "email": { "type": "string", "format": "email", "description": "On s'envia l'enllaç de verificació. Obligatori quan la part ha de completar la verificació, cosa que depèn de la configuració del rol i dels llindars de titularitat del flux de treball." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Participació de l'empresa que posseeix la part interessada." }, "nationality": { "type": "string", "maxLength": 100, "description": "Nacionalitat d'una persona, o país de constitució d'una empresa. Obligatori per a cada part." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Camps addicionals definits pel flux de treball." }, "skip_verification": { "type": "boolean", "default": false, "description": "Demana ometre la verificació d'aquesta part. Només s'accepta quan el rol de la part permet l'omissió a la configuració de Persones clau del flux de treball." } } } } } }, "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 clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna `401`: una clau absent, no vàlida o revocada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "summary": "La data de caducitat de la clau ha passat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallada d'autenticació o d'autorització. Si falta la clau es retorna `403`, igual que amb una clau d'una altra aplicació, una clau amb àmbit sense el permís que necessita aquest endpoint o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau; una clau incorrecta, revocada o caducada retorna `401`. Distingeix-les pel camp `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta la capçalera x-api-key, o la clau ha fallat la validació", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clau vàlida que pertany a una aplicació diferent de la de la sessió", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clau amb abast li manca el permís d'escriptura de decisions", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Sol·licitud des de fora de la llista d'adreces IP permeses de la clau", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sessió no existeix, s'ha suprimit, pertany a una altra aplicació o queda fora dels límits d'una clau amb abast limitat; cap detall no permet distingir entre aquests casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "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": "Crea un esborrany d'una part del KYB", "description": "Afegeix una part (una persona o una empresa) a la llista que estàs preparant per a aquesta sessió de KYB. S'apliquen els mateixos camps i regles que a la pantalla allotjada de persones clau: una persona necessita `full_name` o `first_name` i `last_name`, com a mínim un rol i una nacionalitat; una empresa necessita `company_name` i el país de constitució a `nationality`. No es declara ni es factura res fins a `POST /v3/session/{sessionId}/kyb/parties/submit/`. Requereix `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 sessió de Verificació d'empreses (KYB). Ha de pertànyer a l'aplicació de la clau d'API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Node del flux de treball del pas de KYB. Només cal quan el flux de treball té més d'un node de KYB; per defecte, Didit utilitza el node propi de la sessió.", "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 part és una persona física o una empresa." }, "full_name": { "type": "string", "maxLength": 255, "description": "Nom complet d'una persona. Envia aquest camp, o bé `first_name` i `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 té la part. Intercanviable amb `roles`; quan s'envien tots dos, es fusionen." }, "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": "Tots els rols que té la part. Una persona necessita almenys un rol (aquí o a `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Càrrec laboral d'una persona." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Nom d'una part empresarial. Obligatori quan `entity_type` és `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registre d'una part de l'empresa." }, "email": { "type": "string", "format": "email", "description": "On s'envia l'enllaç de verificació. Obligatori quan la part ha de completar la verificació, cosa que depèn de la configuració del rol i dels llindars de titularitat del flux de treball." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Participació de l'empresa que posseeix la part interessada." }, "nationality": { "type": "string", "maxLength": 100, "description": "Nacionalitat d'una persona, o país de constitució d'una empresa. Obligatori per a cada part." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Camps addicionals definits pel flux de treball." }, "skip_verification": { "type": "boolean", "default": false, "description": "Demana ometre la verificació d'aquesta part. Només s'accepta quan el rol de la part permet l'omissió a la configuració de Persones clau del flux de treball." } } }, "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": "Esborrany creat.", "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 part és una persona física o una empresa." }, "full_name": { "type": "string", "maxLength": 255, "description": "Nom complet d'una persona. Envia aquest camp, o bé `first_name` i `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 té la part. Intercanviable amb `roles`; quan s'envien tots dos, es fusionen." }, "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": "Tots els rols que té la part. Una persona necessita almenys un rol (aquí o a `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Càrrec laboral d'una persona." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Nom d'una part empresarial. Obligatori quan `entity_type` és `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registre d'una part de l'empresa." }, "email": { "type": "string", "format": "email", "description": "On s'envia l'enllaç de verificació. Obligatori quan la part ha de completar la verificació, cosa que depèn de la configuració del rol i dels llindars de titularitat del flux de treball." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Participació de l'empresa que posseeix la part interessada." }, "nationality": { "type": "string", "maxLength": 100, "description": "Nacionalitat d'una persona, o país de constitució d'una empresa. Obligatori per a cada part." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Camps addicionals definits pel flux de treball." }, "skip_verification": { "type": "boolean", "default": false, "description": "Demana ometre la verificació d'aquesta part. Només s'accepta quan el rol de la part permet l'omissió a la configuració de Persones clau del flux de treball." } } } } }, "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 camp de la part no és vàlid o en falta un d'obligatori.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "example": { "non_field_errors": [ "Person parties require at least one role." ] } } } }, "401": { "description": "La clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna `401`: una clau absent, no vàlida o revocada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "summary": "La data de caducitat de la clau ha passat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallada d'autenticació o d'autorització. Si falta la clau es retorna `403`, igual que amb una clau d'una altra aplicació, una clau amb àmbit sense el permís que necessita aquest endpoint o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau; una clau incorrecta, revocada o caducada retorna `401`. Distingeix-les pel camp `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta la capçalera x-api-key, o la clau ha fallat la validació", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clau vàlida que pertany a una aplicació diferent de la de la sessió", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clau amb abast li manca el permís d'escriptura de decisions", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Sol·licitud des de fora de la llista d'adreces IP permeses de la clau", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sessió no existeix, s'ha suprimit, pertany a una altra aplicació o queda fora dels límits d'una clau amb abast limitat; cap detall no permet distingir entre aquests casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "La sessió ha finalitzat (`kyb_session_not_writable`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." }, "code": { "type": "string" } } }, "example": { "detail": "This verification session is no longer accepting changes.", "code": "kyb_session_not_writable" } } } }, "429": { "description": "S'ha superat el límit de freqüència: 300 sol·licituds d'escriptura (POST, PATCH, DELETE) per minut per clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar; les capçaleres `X-RateLimit-*` mostren el pressupost restant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Rate limited": { "summary": "Pressupost per al minut actual esgotat", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segons que cal esperar abans 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": "Edita un esborrany de part de KYB", "description": "Canvia els camps de l'esborrany d'una part. La modificació es fusiona amb l'esborrany emmagatzemat i la part fusionada es valida en conjunt, de manera que es rebutja qualsevol modificació que deixi la part incompleta. Canviar `first_name` o `last_name` substitueix el nom complet emmagatzemat. Requereix `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 sessió de Verificació d'empreses (KYB). Ha de pertànyer a l'aplicació de la clau d'API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "draftId", "in": "path", "required": true, "description": "UUID de l'esborrany de la part (`draft_id` retornat quan es va crear).", "schema": { "type": "string", "format": "uuid", "example": "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d" } }, { "name": "node_id", "in": "query", "required": false, "description": "Node del flux de treball del pas de KYB. Només cal quan el flux de treball té més d'un node de KYB; per defecte, Didit utilitza el node propi de la sessió.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Qualsevol subconjunt dels camps de la part. L'edició es fusiona amb l'esborrany emmagatzemat i la part fusionada es valida en conjunt, de manera que un esborrany que es podia enviar abans d'una edició encara es pot enviar després d'aquesta.", "properties": { "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Si la part és una persona física o una empresa." }, "full_name": { "type": "string", "maxLength": 255, "description": "Nom complet d'una persona. Envia aquest camp, o bé `first_name` i `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 té la part. Intercanviable amb `roles`; quan s'envien tots dos, es fusionen." }, "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": "Tots els rols que té la part. Una persona necessita almenys un rol (aquí o a `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Càrrec laboral d'una persona." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Nom d'una part empresarial. Obligatori quan `entity_type` és `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registre d'una part de l'empresa." }, "email": { "type": "string", "format": "email", "description": "On s'envia l'enllaç de verificació. Obligatori quan la part ha de completar la verificació, cosa que depèn de la configuració del rol i dels llindars de titularitat del flux de treball." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Participació de l'empresa que posseeix la part interessada." }, "nationality": { "type": "string", "maxLength": 100, "description": "Nacionalitat d'una persona, o país de constitució d'una empresa. Obligatori per a cada part." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Camps addicionals definits pel flux de treball." }, "skip_verification": { "type": "boolean", "default": false, "description": "Demana ometre la verificació d'aquesta part. Només s'accepta quan el rol de la part permet l'omissió a la configuració de Persones clau del flux de treball." } } }, "example": { "ownership_percent": 55 } } } }, "responses": { "200": { "description": "Esborrany actualitzat.", "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 part és una persona física o una empresa." }, "full_name": { "type": "string", "maxLength": 255, "description": "Nom complet d'una persona. Envia aquest camp, o bé `first_name` i `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 té la part. Intercanviable amb `roles`; quan s'envien tots dos, es fusionen." }, "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": "Tots els rols que té la part. Una persona necessita almenys un rol (aquí o a `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Càrrec laboral d'una persona." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Nom d'una part empresarial. Obligatori quan `entity_type` és `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registre d'una part de l'empresa." }, "email": { "type": "string", "format": "email", "description": "On s'envia l'enllaç de verificació. Obligatori quan la part ha de completar la verificació, cosa que depèn de la configuració del rol i dels llindars de titularitat del flux de treball." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Participació de l'empresa que posseeix la part interessada." }, "nationality": { "type": "string", "maxLength": 100, "description": "Nacionalitat d'una persona, o país de constitució d'una empresa. Obligatori per a cada part." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Camps addicionals definits pel flux de treball." }, "skip_verification": { "type": "boolean", "default": false, "description": "Demana ometre la verificació d'aquesta part. Només s'accepta quan el rol de la part permet l'omissió a la configuració de Persones clau del flux de treball." } } } } }, "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 part fusionada no és vàlida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "example": { "non_field_errors": [ "Person parties require at least one role." ] } } } }, "401": { "description": "La clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna `401`: una clau absent, no vàlida o revocada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "summary": "La data de caducitat de la clau ha passat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallada d'autenticació o d'autorització. Si falta la clau es retorna `403`, igual que amb una clau d'una altra aplicació, una clau amb àmbit sense el permís que necessita aquest endpoint o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau; una clau incorrecta, revocada o caducada retorna `401`. Distingeix-les pel camp `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta la capçalera x-api-key, o la clau ha fallat la validació", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clau vàlida que pertany a una aplicació diferent de la de la sessió", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clau amb abast li manca el permís d'escriptura de decisions", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Sol·licitud des de fora de la llista d'adreces IP permeses de la clau", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "No existeix la sessió o l'esborrany, o la sessió queda fora de l'aplicació de la clau o dels límits d'una clau amb abast limitat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "La sessió ha finalitzat (`kyb_session_not_writable`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." }, "code": { "type": "string" } } }, "example": { "detail": "This verification session is no longer accepting changes.", "code": "kyb_session_not_writable" } } } }, "429": { "description": "S'ha superat el límit de freqüència: 300 sol·licituds d'escriptura (POST, PATCH, DELETE) per minut per clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar; les capçaleres `X-RateLimit-*` mostren el pressupost restant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Rate limited": { "summary": "Pressupost per al minut actual esgotat", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segons que cal esperar abans 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 esborrany d'una part de KYB", "description": "Descarta un esborrany de part. Les parts declarades no es veuen afectades. Requereix `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 sessió de Verificació d'empreses (KYB). Ha de pertànyer a l'aplicació de la clau d'API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "draftId", "in": "path", "required": true, "description": "UUID de l'esborrany de la part (`draft_id` retornat quan es va crear).", "schema": { "type": "string", "format": "uuid", "example": "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d" } }, { "name": "node_id", "in": "query", "required": false, "description": "Node del flux de treball del pas de KYB. Només cal quan el flux de treball té més d'un node de KYB; per defecte, Didit utilitza el node propi de la sessió.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Esborrany suprimit. Sense cos." }, "401": { "description": "La clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna `401`: una clau absent, no vàlida o revocada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "summary": "La data de caducitat de la clau ha passat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallada d'autenticació o d'autorització. Si falta la clau es retorna `403`, igual que amb una clau d'una altra aplicació, una clau amb àmbit sense el permís que necessita aquest endpoint o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau; una clau incorrecta, revocada o caducada retorna `401`. Distingeix-les pel camp `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta la capçalera x-api-key, o la clau ha fallat la validació", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clau vàlida que pertany a una aplicació diferent de la de la sessió", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clau amb abast li manca el permís d'escriptura de decisions", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Sol·licitud des de fora de la llista d'adreces IP permeses de la clau", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "No existeix la sessió o l'esborrany, o la sessió queda fora de l'aplicació de la clau o dels límits d'una clau amb abast limitat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "La sessió ha finalitzat (`kyb_session_not_writable`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." }, "code": { "type": "string" } } }, "example": { "detail": "This verification session is no longer accepting changes.", "code": "kyb_session_not_writable" } } } }, "429": { "description": "S'ha superat el límit de freqüència: 300 sol·licituds d'escriptura (POST, PATCH, DELETE) per minut per clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar; les capçaleres `X-RateLimit-*` mostren el pressupost restant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Rate limited": { "summary": "Pressupost per al minut actual esgotat", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segons que cal esperar abans 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": "Envia els esborranys de les parts de KYB", "description": "Declara els esborranys emmagatzemats com a persones clau de l'empresa. Aquest és el pas de Persones clau allotjat sota la teva clau d'API: Didit decideix a partir de la configuració de rols i els llindars de titularitat del flux de treball quines parts s'han de verificar, crea una sessió individual de KYC (o una subsessió de KYB per a un titular corporatiu) per a cadascuna d'elles, envia els correus electrònics que el flux de treball sol·licita i fa avançar la sessió. Cada sessió filla es factura com en el flux allotjat. Els esborranys es consumeixen. Repetir la crida després d'un enviament satisfactori no canvia res i respon `200` amb `already_submitted: true` i les persones que ja existeixen. La sessió ha d'estar al pas de Persones clau. Envia el camp `kyc_session_url` de cada persona directament a ella, o bé incrusta'l. Requereix `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 sessió de Verificació d'empreses (KYB). Ha de pertànyer a l'aplicació de la clau d'API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Node del flux de treball del pas de KYB. Només cal quan el flux de treball té més d'un node de KYB; per defecte, Didit utilitza el node propi de la sessió.", "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "locale": { "type": "string", "maxLength": 10, "description": "Configuració regional utilitzada per traduir la resposta del pas al qual avança la sessió." } } }, "example": { "locale": "es" } } } }, "responses": { "200": { "description": "Parts declarades (o ja declarades).", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "next_step": { "type": "string", "nullable": true, "description": "Pas en què es troba la sessió." }, "status": { "type": "string", "description": "Estat de la sessió d'empresa." }, "advanced": { "type": "boolean", "description": "`true` quan aquesta crida ha declarat les parts i ha fet avançar la sessió." }, "already_submitted": { "type": "boolean", "description": "`true` quan les parts ja s'havien declarat en una crida 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": "L'organització s'ha quedat sense crèdit per a les sessions de verificació filles.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "example": { "detail": "Insufficient credits." } } } }, "401": { "description": "La clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna `401`: una clau absent, no vàlida o revocada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Expired key": { "summary": "La data de caducitat de la clau ha passat", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Fallada d'autenticació o d'autorització. Si falta la clau es retorna `403`, igual que amb una clau d'una altra aplicació, una clau amb àmbit sense el permís que necessita aquest endpoint o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau; una clau incorrecta, revocada o caducada retorna `401`. Distingeix-les pel camp `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Missing or invalid credentials": { "summary": "Falta la capçalera x-api-key, o la clau ha fallat la validació", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Una clau vàlida que pertany a una aplicació diferent de la de la sessió", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "A la clau amb abast li manca el permís d'escriptura de decisions", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Sol·licitud des de fora de la llista d'adreces IP permeses de la clau", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "La sessió no existeix, s'ha suprimit, pertany a una altra aplicació o queda fora dels límits d'una clau amb abast limitat; cap detall no permet distingir entre aquests casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "`kyb_no_party_drafts`: no hi ha res a enviar. `kyb_parties_already_submitted`: s'han afegit esborranys després de declarar les parts. `kyb_step_mismatch`: la sessió no es troba al pas Persones clau (`next_step` n'indica el pas). `kyb_session_not_writable`: la sessió ha finalitzat.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." }, "code": { "type": "string" }, "next_step": { "type": "string" } } }, "example": { "detail": "There are no draft parties to submit.", "code": "kyb_no_party_drafts" } } } }, "429": { "description": "S'ha superat el límit de freqüència: 300 sol·licituds d'escriptura (POST, PATCH, DELETE) per minut per clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar; les capçaleres `X-RateLimit-*` mostren el pressupost restant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge d'error fàcil de llegir." } } }, "examples": { "Rate limited": { "summary": "Pressupost per al minut actual esgotat", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segons que cal esperar abans 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 tots els fitxers d'una sessió", "description": "Inicia la preparació d'un ZIP amb totes les imatges, vídeos i documents d'una sessió de Verificació d'usuaris (KYC) o Verificació d'empreses (KYB), en qualitat original: els fitxers s'emmagatzemen al ZIP tal com es van capturar, sense recomprimir mai. Respon `202` amb l'exportació; consulta-la amb `GET /v3/session/{sessionId}/files-export/{exportId}/` fins que `status` sigui `READY`, i després descarrega `download_url`. Mentre s'estigui preparant una exportació de la mateixa sessió, es retornarà aquesta exportació en lloc d'una de nova.\n\nEl ZIP s'elimina 24 hores després d'estar a punt, i immediatament quan s'elimina la sessió. Una sessió eliminada no es pot exportar. Cada exportació i cada enllaç de descàrrega lliurat es registra al registre d'auditoria de la sessió. Una clau d'API amb abast restringit necessita `media: read` i `decisions: read`; un usuari de la consola necessita el privilegi per llegir sessions.", "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 sessió de verificació (el `session_id` retornat per `POST /v3/session/`). Accepta tant IDs de sessió de Verificació d'usuaris (KYC) com de Verificació d'empreses (KYB). Una sessió eliminada retorna `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": "L'exportació, en preparació.", "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": "Obtenir una exportació de fitxers de sessió", "description": "Progrés d'una exportació iniciada amb `POST /v3/session/{sessionId}/files-export/`. Un cop `status` sigui `READY`, `download_url` és un URL signat del fitxer ZIP que continua sent vàlid durant un breu període; torna a consultar l'exportació per obtenir-ne un de nou fins a `expires_at`. Cada lectura que lliura un enllaç de descàrrega s'escriu al registre d'auditoria de la sessió. Una exportació d'una sessió eliminada retorna `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 sessió de verificació (el `session_id` retornat per `POST /v3/session/`). Accepta tant IDs de sessió de Verificació d'usuaris (KYC) com de Verificació d'empreses (KYB). Una sessió eliminada retorna `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "exportId", "in": "path", "required": true, "description": "L'`export_id` retornat per `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": "L'exportació.", "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": "Llista els dipòsits de Travel Rule no emparellats", "description": "Dipòsits entrants que encara estan esperant les dades de Travel Rule del VASP ordenant: la seva transferència està en estat `AWAITING_COUNTERPARTY`, `NOT_ENOUGH_COUNTERPARTY_DATA` o `COUNTERPARTY_VASP_NOT_FOUND`, no hi ha cap missatge rebut emparellat amb ells i ningú els ha emparellat manualment. Les files i els filtres són els mateixos que a `GET /v3/travel-rule/transfers/`, ordenats del més recent al més antic, paginats amb `limit` (per defecte 50) i `offset`. Emparella un dipòsit amb el missatge enviat pel VASP ordenant mitjançant `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 ambdós separats per comes. Distingeix entre majúscules i minúscules." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Un o més estats de transferència, separats per comes." }, { "name": "rail", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Un o més dels següents: INTERNAL, TRP, GTR, TRUST, VERIFYVASP, SYGNA, EMAIL, TEST_VASP, separats per comes." }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string" }, "description": "withdrawal, deposit o message, separats per comes." }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" }, "description": "La moneda de la transacció, sense distingir majúscules de minúscules." }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Transferències creades a partir d'aquest dia (UTC), YYYY-MM-DD." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Transferències creades fins a aquest dia (UTC), YYYY-MM-DD." }, { "name": "counterparty", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "L'`id` d'una entrada del directori o d'un membre de la xarxa Didit des de GET /v3/travel-rule/vasps/: les teves transferències amb aquesta contrapart. Un valor que no sigui un id vàlid respon 400." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000000 }, "description": "Mida de la pàgina, per defecte 50." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000000 }, "description": "Files que cal ometre." } ], "responses": { "200": { "description": "Una pàgina de dipòsits no coincidents.", "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": "El valor d'un filtre no és vàlid.", "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": "Emparella un dipòsit de Travel Rule amb un missatge rebut", "operationId": "matchUnmatchedTravelRuleDeposit", "x-didit-sdk": { "resource": "travel_rule.unmatched_deposits", "method": "match", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Aparella un dipòsit entrant que encara està esperant les dades de l'ordenant amb el missatge de Travel Rule que el VASP ordenant va enviar per a aquest. El dipòsit adopta les dades de l'ordenant, el VASP contrapart i el rail del missatge, i ambdues transferències registren la coincidència a la seva cronologia. `transaction_uuid` és el `transaction_id` del dipòsit de `GET /v3/travel-rule/unmatched/`. El camp `transaction_id` del cos és el `transaction_id` del missatge rebut, obtingut d'una fila de `GET /v3/travel-rule/transfers/?kind=message`; el camp `id` propi de la transferència no es troba. El missatge ha de ser per al mateix actiu que el dipòsit. Si s'elimina un dipòsit o un missatge des de la Consola, es respon amb `404`; un que ja hagi canviat d'estat (aparellat o que ja no estigui en espera) respon amb `409`.", "parameters": [ { "name": "transaction_uuid", "in": "path", "required": true, "description": "El `transaction_id` del dipòsit no emparellat.", "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": "Totes dues transferències després de la coincidència.", "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ó: falta `transaction_id`, és el mateix dipòsit, no és un missatge de Travel Rule rebut o és per a un actiu diferent del dipòsit; o la transacció a la ruta no és un dipòsit entrant.", "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": "Dipòsit o missatge desconegut, o un d'ells s'ha suprimit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No TravelRuleTransfer matches the given query." } } } }, "409": { "description": "El dipòsit ja no està esperant dades de l'ordenant, o el missatge ja està associat a un dipòsit.", "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": "Simbologia detectada, per exemple `QR_CODE`, `CODE_128`, `EAN_13`, `DATA_MATRIX` o `PDF_417`." }, "page_number": { "type": "integer", "minimum": 1, "description": "Número de pàgina, començant per 1." }, "position": { "type": "array", "nullable": true, "description": "Polígon detectat en coordenades de píxels de la pàgina renderitzada. `null` quan no hi ha cap ubicació fiable disponible.", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "integer" } } }, "x": { "type": "integer", "nullable": true, "description": "Vora esquerra del quadre delimitador en píxels de la pàgina renderitzada." }, "y": { "type": "integer", "nullable": true, "description": "Vora superior del quadre delimitador en píxels de la pàgina renderitzada." }, "width": { "type": "integer", "nullable": true, "description": "Amplària del quadre delimitador en píxels de la pàgina renderitzada." }, "height": { "type": "integer", "nullable": true, "description": "Alçària del quadre delimitador en píxels de la pàgina renderitzada." }, "page_width": { "type": "integer", "description": "Amplària de la pàgina renderitzada en píxels." }, "page_height": { "type": "integer", "description": "Alçària de la pàgina renderitzada en píxels." }, "raw_payload": { "type": "string", "description": "Payload del descodificador en brut com a cadena en base64 quan estigui disponible; en cas contrari, una cadena buida." }, "parsed_payload": { "nullable": true, "description": "Cadena descodificada o valor estructurat. `null` quan el codi s'ha localitzat però no s'ha pogut descodificar." } } }, "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 de la tasca d'importació. Utilitza aquest valor per fer el seguiment del progrés i obtenir els errors de les files." }, "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": "L'estat de la tasca tal com es mostra a la consola; `errors` és una tasca completada amb files rebutjades." }, "source": { "type": "string", "enum": [ "file", "api", "provider" ] }, "provider": { "type": "string", "description": "Origen de la migració; buit per a una importació per fitxer o API." }, "provider_options": { "type": "object" }, "credential_hint": { "type": "string", "description": "Els primers caràcters de la clau que manté la migració. La clau en si no es retorna mai." }, "credentials_expires_at": { "type": "string", "format": "date-time", "nullable": true }, "resumes_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan una tasca posada en pausa pel límit de freqüència del proveïdor es reprèn per si mateixa." }, "status_mapping": { "type": "object", "additionalProperties": { "type": "string" } }, "is_dry_run": { "type": "boolean" }, "dry_run_summary": { "type": "object", "description": "El que ha trobat una execució en sec: `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": "Cos d'actualització parcial de la marca. Proporciona només els camps que vulguis canviar. Els colors hexadecimals accepten `#RRGGBB` o `#RRGGBBAA`. El domini personalitzat i el correu de marca blanca no s'accepten aquí.", "properties": { "color_primary": { "type": "string", "description": "Color de les capçaleres / del text principal." }, "color_secondary": { "type": "string", "description": "Color del paràgraf / text secundari." }, "color_background": { "type": "string", "description": "Color de fons de la pàgina." }, "color_panel": { "type": "string", "description": "Color del panell / d'accent." }, "color_panel_10": { "type": "string", "description": "Color del panell al 10% d'opacitat." }, "color_on_panel_1": { "type": "string", "description": "Color del text de suport als panells." }, "color_on_panel_2": { "type": "string", "description": "Color de la píndola / distintiu als panells." }, "color_on_background": { "type": "string", "description": "Color del text sobre el fons." }, "color_button_1": { "type": "string", "description": "Color del botó principal." }, "color_button_2": { "type": "string", "description": "Color del botó secundari." }, "color_button_text_1": { "type": "string", "description": "Color del text del botó principal." }, "color_button_text_2": { "type": "string", "description": "Color del text del botó secundari." }, "color_pill_text": { "type": "string", "description": "Color del text per a pastilles, camps d'entrada i selectors." }, "border_radius_panel": { "type": "integer", "minimum": 0, "description": "Radi de les cantonades del panell en píxels." }, "border_radius_buttons": { "type": "integer", "minimum": 0, "description": "Radi de cantonada del botó en píxels." }, "font_family": { "type": "string", "description": "Nom de la família de fonts de Google (p. ex. `Inter`, `AR One Sans`)." }, "font_weight": { "type": "string", "description": "Pes de la font disponible per a la família seleccionada (p. ex., `regular`, `500`, `700`)." }, "app_public_name": { "type": "string", "nullable": true, "description": "Nom públic que es mostra al flux de verificació." }, "privacy_policy_url": { "type": "string", "nullable": true, "description": "URL de la política de privadesa que es mostra a l'usuari final." }, "skip_welcome_screen": { "type": "boolean", "description": "Omet la pantalla inicial de benvinguda." }, "disable_login_with_didit": { "type": "boolean", "description": "Continua com a convidat en lloc de mostrar la pantalla d'inici de sessió amb Didit. No es pot tornar a establir a `false` mentre hi hagi un domini personalitzat configurat (400)." }, "hide_progress_bar": { "type": "boolean", "description": "Amaga la barra de progrés durant el flux." }, "callback_seconds": { "type": "integer", "minimum": 0, "description": "Retard (segons) abans de redirigir a l'URL de callback." }, "delete_logo_square": { "type": "boolean", "description": "Quan és `true`, elimina el logotip quadrat actual." }, "delete_logo_rectangular": { "type": "boolean", "description": "Quan és `true`, elimina el logotip rectangular actual." }, "delete_logo_rectangular_dark": { "type": "boolean", "description": "Quan és `true`, elimina el logotip actual del mode fosc, i `logo_rectangular_dark` passa a ser `null`. Si la mateixa sol·licitud multipart també puja `image_rectangular_dark`, preval la pujada." }, "delete_favicon": { "type": "boolean", "description": "Quan és `true`, elimina la icona de favorits (favicon) actual." } } }, "BrandingCustomization": { "type": "object", "description": "Personalització de marca blanca per a una aplicació: colors, tipografies, radis, URL de logotips i opcions d'UI/UX. Les URL de logotips són de només lectura (s'estableixen pujant imatges). El domini personalitzat i el correu electrònic de marca blanca no s'inclouen.", "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": "Només de lectura. URL resolta del full d'estils de Google Fonts per a la família seleccionada." }, "logo_square": { "type": "string", "nullable": true, "description": "URL de només lectura del logotip quadrat. Puja'l mitjançant `image_square`." }, "logo_rectangular": { "type": "string", "nullable": true, "description": "URL de només lectura del logotip rectangular. Puja'l mitjançant `image_rectangular`." }, "logo_rectangular_dark": { "type": "string", "format": "uri", "nullable": true, "description": "Només de lectura. URL temporal signada del logotip rectangular per al mode fosc, que es mostra sobre un fons fosc. `null` quan no s'ha configurat cap logotip fosc o no es mostren logotips rectangulars per al teu compte. Puja'l amb `image_rectangular_dark`." }, "favicon": { "type": "string", "nullable": true, "description": "URL de només lectura del favicon. Puja'l mitjançant `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": "Nom d'esdeveniment de webhook admès. Utilitza aquestes cadenes exactes a `subscribed_events`; els valors no admesos es rebutgen.", "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": "Filtre d'esdeveniments per a aquesta destinació del webhook. Didit només lliura webhooks el tipus d'esdeveniment dels quals coincideix exactament amb un d'aquests valors; no hi ha subscripció amb caràcters comodí. Quan s'envia, la llista ha de contenir almenys un esdeveniment vàlid (un `[]` explícit es rebutja amb 400); una destinació amb la llista buida (camp omès en crear-se) no rep res. En actualitzar, la llista es reemplaça completament, mai es fusiona.", "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 sessió de la verificació. Un enviament `Retry` retorna el mateix `request_id` que l'enviament original. Aquest id apareix a la Business Console, el torna a retornar un `POST /v3/phone/check/` finalitzat i es pot transmetre a `GET /v3/session/{sessionId}/decision/`." }, "status": { "type": "string", "enum": [ "Success", "Retry", "Blocked" ], "description": "`Success` — OTP enviat a una nova verificació. `Retry` — OTP reenviat per a la verificació pendent creada per un enviament anterior. `Blocked` — la capa antifrau ha rebutjat l'enviament; la verificació es finalitza immediatament com a `Declined` i no es factura res." }, "reason": { "type": "string", "nullable": true, "description": "Per què un enviament ha estat `Blocked` (p. ex., `repeated_attempts`, `suspicious`, `spam`). `null` a `Success` i `Retry`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò de les `vendor_data` emmagatzemades a la sessió (des del primer enviament)." }, "metadata": { "type": "object", "nullable": true, "description": "Ressò de les `metadata` emmagatzemades a la sessió (des del primer enviament)." } } }, "PhoneVerificationCheckResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "A `Approved`/`Declined`: l'identificador de sessió de la verificació coincident — idèntic al `request_id` retornat per `POST /v3/phone/send/`. A `Failed` i `Expired or Not Found`: un UUID aleatori d'un sol ús que no es podrà consultar posteriorment." }, "status": { "type": "string", "enum": [ "Approved", "Declined", "Failed", "Expired or Not Found" ], "description": "`Approved` — codi correcte, sense risc que provoqui rebuig. `Declined` — terminal: ha coincidit un risc que provoca rebuig o s'ha esgotat el pressupost d'intents (3). `Failed` — codi incorrecte, queden intents. `Expired or Not Found` — cap verificació pendent per a aquest número en els darrers 5 minuts." }, "message": { "type": "string", "description": "Explicació fàcil de llegir del resultat, inclòs el nombre d'intents restants després d'un codi incorrecte." }, "phone": { "type": "object", "nullable": true, "description": "Informe telefònic complet. Present (no nul) només en resultats finalitzats (`Approved`/`Declined`); `null` a `Failed` i absent en `Expired or Not Found`.", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Not Finished", "Expired" ], "description": "Estat final de la verificació de telèfon. Coincideix amb el `status` de nivell superior per a les comprovacions finalitzades." }, "phone_number_prefix": { "type": "string", "description": "Codi telefònic de país que comença amb `+` (p. ex., `+1`).", "example": "+1" }, "phone_number": { "type": "string", "description": "Número nacional sense el prefix telefònic del país.", "example": "4155552671" }, "full_number": { "type": "string", "description": "Número complet en format 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": "Nom complet del país derivat de `country_code`.", "example": "United States" }, "carrier": { "type": "object", "description": "Xarxa actual que dona servei al número, a partir de la cerca d'operador executada en finalitzar.", "properties": { "name": { "type": "string", "description": "Nom de l'operador. Cadena buida quan la cerca no l'ha pogut identificar." }, "type": { "type": "string", "description": "Tipus de línia indicat per la cerca: `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` quan el número pertany a un servei de números temporals/d'un sol ús." }, "is_virtual": { "type": "boolean", "description": "`true` quan el tipus de línia és virtual (`voip`, `isp` o `vpn`)." }, "verification_method": { "type": "string", "description": "Canal que realment ha lliurat l'OTP un cop confirmat el lliurament (p. ex., `whatsapp`, `sms`); fins aleshores, el canal sol·licitat." }, "verification_attempts": { "type": "integer", "description": "Nombre d'enviaments d'OTP per a aquesta verificació (1, o 2 després d'un reintent)." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va introduir el codi correcte. `null` si la verificació mai no es va aprovar." }, "warnings": { "type": "array", "description": "Advertències de risc registrades durant la verificació (duplicate, disposable, VoIP, attempts exceeded, blocklist, etc.). Matriu buida si no n'hi ha cap.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Funcionalitat que ha generat l'advertència. Sempre `PHONE` aquí." }, "risk": { "type": "string", "description": "Codi de risc llegible per màquina." }, "additional_data": { "type": "object", "nullable": true, "description": "Context específic del risc (p. ex., l'id de la sessió duplicada per a riscos de duplicats). `null` quan el risc no inclou dades addicionals." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravetat. Els riscos `error` fan que es rebutgi la verificació, `warning` la marca per a revisió i `information` es registra sense afectar l'estat." }, "short_description": { "type": "string", "description": "Resum d'una sola línia del risc, llegible per a humans." }, "long_description": { "type": "string", "description": "Explicació fàcil de llegir del risc." } } } }, "lifecycle": { "type": "array", "description": "Pista d'auditoria cronològica de la verificació. El `type` de l'esdeveniment és un dels següents: `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": "Tipus d'esdeveniment." }, "timestamp": { "type": "string", "format": "date-time", "description": "Quan va ocórrer l'esdeveniment." }, "details": { "type": "object", "nullable": true, "description": "Payload específic de l'esdeveniment. Esdeveniments d'enviament: `{status, reason, channel, actual_channel}` (`actual_channel` s'omple un cop confirmat el lliurament). Esdeveniments de lliurament: `{channel, status}`. Esdeveniments d'introducció de codi: `{code_tried, status}`. Esdeveniments d'estat final: `null`, o `{reason}` si s'ha rebutjat o està en revisió." }, "fee": { "type": "number", "description": "Import en USD facturat per aquest esdeveniment. Diferent de zero només en els esdeveniments d'enviament (el preu de lliurament); 0 per a entrades de codi, confirmacions de lliurament i esdeveniments d'estat." } } } }, "matches": { "type": "array", "description": "Altres sessions de la teva aplicació (KYC, KYB o API) on un usuari diferent (amb un `vendor_data` diferent) ha utilitzat el mateix número de telèfon. Fins a 5 entrades, primer una coincidència sintètica d'una entrada de la llista de bloqueig quan n'hi hagi (les coincidències derivades de sessions mantenen l'ordre de la consulta). Matriu buida quan no hi ha coincidències.", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID de sessió de l'altra verificació que ha utilitzat aquest número de telèfon." }, "session_number": { "type": "integer", "description": "Número seqüencial fàcil de llegir d'aquesta sessió." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` d'aquella sessió." }, "verification_date": { "type": "string", "description": "Quan es va crear aquesta sessió (`YYYY-MM-DDTHH:MM:SSZ`)." }, "phone_number": { "type": "string", "description": "El número de telèfon coincident." }, "status": { "type": "string", "description": "Estat d'aquesta sessió (p. ex., `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Si el número de telèfon és a la llista de bloqueig de la teva aplicació." }, "api_service": { "type": "string", "nullable": true, "description": "Per a sessions de tipus API, l'API independent que la va crear (p. ex., `PHONE_VERIFICATION`); `null` per a sessions de verificació habituals." }, "source": { "type": "string", "description": "On s'ha trobat la coincidència. Normalment `session`; una coincidència amb la llista de bloqueig mitjançant una entrada de llista de l'organització anteposa una coincidència sintètica amb `source: \"list_entry\"` i `session_id`/`session_number` nuls." } } } }, "phone_social": { "$ref": "#/components/schemas/PhoneSocialFootprint" }, "phone_intelligence": { "allOf": [ { "$ref": "#/components/schemas/PhoneIntelligence" } ], "description": "Senyals d'intel·ligència telefònica. Present només quan `enable_enrichment` era `true` a la comprovació." } } }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` de la sessió de la verificació coincident. `null` a `Expired or Not Found`." }, "metadata": { "type": "object", "nullable": true, "description": "`metadata` de la sessió de la verificació coincident. `null` a `Expired or Not Found`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de temps de la resposta d'aquesta comprovació." } } }, "EmailVerificationSendResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID de sessió de la verificació. Un enviament `Retry` retorna el mateix `request_id` que l'enviament original. Aquest id apareix a la Business Console, el torna a retornar un `POST /v3/email/check/` finalitzat i es pot transmetre a `GET /v3/session/{sessionId}/decision/`." }, "status": { "type": "string", "enum": [ "Success", "Retry", "Undeliverable" ], "description": "`Success` — OTP enviat per correu electrònic a una nova verificació (facturat). `Retry` — nou OTP enviat per correu electrònic per a la verificació pendent creada per un enviament anterior (gratuït). `Undeliverable` — l'adreça no ha superat la validació de lliurabilitat o no s'ha pogut enviar el missatge; la verificació es finalitza immediatament com a `Declined` i no es factura res." }, "reason": { "type": "string", "nullable": true, "enum": [ "email_can_not_be_delivered", null ], "description": "`email_can_not_be_delivered` quan `status` és `Undeliverable`; `null` en cas contrari." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò de les `vendor_data` emmagatzemades a la sessió (des del primer enviament)." }, "metadata": { "type": "object", "nullable": true, "description": "Ressò de les `metadata` emmagatzemades a la sessió (des del primer enviament)." } } }, "EmailVerificationCheckResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "A `Approved`/`Declined`: l'identificador de sessió de la verificació coincident — idèntic al `request_id` retornat per `POST /v3/email/send/`. A `Failed` i `Expired or Not Found`: un UUID aleatori d'un sol ús que no es podrà consultar posteriorment." }, "status": { "type": "string", "enum": [ "Approved", "Declined", "Failed", "Expired or Not Found" ], "description": "`Approved` — codi correcte, sense risc que provoqui rebuig. `Declined` — terminal: ha coincidit un risc que provoca rebuig o s'ha esgotat el pressupost d'intents (3). `Failed` — codi incorrecte, queden intents. `Expired or Not Found` — cap verificació pendent per a aquesta adreça en els darrers 5 minuts." }, "message": { "type": "string", "description": "Explicació fàcil de llegir del resultat, inclòs el nombre d'intents restants després d'un codi incorrecte." }, "email": { "type": "object", "nullable": true, "description": "Informe complet de correu electrònic. Present (no nul) només en resultats finalitzats (`Approved`/`Declined`); `null` a `Failed` i absent a `Expired or Not Found`.", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Not Finished", "Expired" ], "description": "Estat final de la verificació de correu electrònic. Coincideix amb el `status` de nivell superior per a les comprovacions finalitzades." }, "email": { "type": "string", "format": "email", "description": "L'adreça de correu electrònic verificada.", "example": "alice@example.com" }, "is_breached": { "type": "boolean", "description": "`true` quan l'adreça apareix en filtracions de dades conegudes (cerca d'intel·ligència sobre filtracions executada en finalitzar)." }, "breaches": { "type": "array", "description": "Fins a les 5 filtracions conegudes més recents que contenen aquesta adreça. Matriu buida (o omesa) quan `is_breached` és `false`.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Identificador de la filtració." }, "domain": { "type": "string", "description": "Domini del servei afectat per la filtració." }, "breach_date": { "type": "string", "format": "date", "description": "Data en què es va produir l'incompliment." }, "breach_emails_count": { "type": "integer", "description": "Nombre total de comptes exposats a la filtració." }, "description": { "type": "string", "description": "Descripció fàcil de llegir de la vulneració (pot contenir marcatge HTML)." }, "logo_path": { "type": "string", "description": "URL del logotip del servei afectat per la filtració." }, "data_classes": { "type": "array", "items": { "type": "string" }, "description": "Categories de dades exposades, en snake_case (p. ex., `email_addresses`, `passwords`)." }, "is_verified": { "type": "boolean", "description": "Indica si s'ha verificat que la filtració és legítima." } } } }, "is_disposable": { "type": "boolean", "description": "`true` quan el domini pertany a un proveïdor conegut de correu d'un sol ús o temporal." }, "is_undeliverable": { "type": "boolean", "description": "`true` quan l'adreça no pot rebre correu (ha fallat la validació de sintaxi o DNS/MX, o el missatge ha rebotat)." }, "verification_attempts": { "type": "integer", "description": "Nombre d'enviaments d'OTP per a aquesta verificació (1, o 2 després d'un reintent)." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va introduir el codi correcte. `null` si la verificació mai no es va aprovar." }, "warnings": { "type": "array", "description": "Advertències de risc registrades durant la verificació (duplicate, breached, disposable, undeliverable, attempts exceeded, blocklist, etc.). Matriu buida si no n'hi ha cap.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Funcionalitat que ha generat l'advertència. Sempre `EMAIL` aquí." }, "risk": { "type": "string", "description": "Codi de risc llegible per màquina." }, "additional_data": { "type": "object", "nullable": true, "description": "Context específic del risc (p. ex., l'id de la sessió duplicada per a riscos de duplicats). `null` quan el risc no inclou dades addicionals." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravetat. Els riscos `error` fan que es rebutgi la verificació, `warning` la marca per a revisió i `information` es registra sense afectar l'estat." }, "short_description": { "type": "string", "description": "Resum d'una sola línia del risc, llegible per a humans." }, "long_description": { "type": "string", "description": "Explicació fàcil de llegir del risc." } } } }, "lifecycle": { "type": "array", "description": "Pista d'auditoria cronològica de la verificació. El `type` de l'esdeveniment és un dels següents: `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": "Tipus d'esdeveniment." }, "timestamp": { "type": "string", "format": "date-time", "description": "Quan va ocórrer l'esdeveniment." }, "details": { "type": "object", "nullable": true, "description": "Payload específic de l'esdeveniment. Esdeveniments d'enviament: `{status, reason}`. Esdeveniments d'introducció de codi: `{code_tried, status}`. Esdeveniments d'estat final: `null`, o `{reason}` si s'ha rebutjat o està en revisió." }, "fee": { "type": "number", "description": "Import en USD facturat per aquest esdeveniment. Diferent de zero només en el primer enviament satisfactori; 0 per a reintents, entrades de codi i esdeveniments d'estat." } } } }, "matches": { "type": "array", "description": "Altres sessions de la teva aplicació (KYC, KYB o API) on un usuari diferent (`vendor_data` diferent) ha utilitzat la mateixa adreça de correu electrònic. Fins a 5 entrades; s'afegeix al principi una coincidència sintètica de llista de bloqueig d'una entrada de llista quan n'hi ha una (i només quan no existeix cap correu electrònic a la llista de bloqueig derivat de la sessió) — les coincidències derivades de sessions mantenen l'ordre de created_at. Matriu buida quan no hi ha coincidències.", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID de sessió de l'altra verificació que ha utilitzat aquesta adreça de correu electrònic." }, "session_number": { "type": "integer", "description": "Número seqüencial fàcil de llegir d'aquesta sessió." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` d'aquella sessió." }, "verification_date": { "type": "string", "description": "Quan es va crear aquesta sessió (`YYYY-MM-DDTHH:MM:SSZ`)." }, "email": { "type": "string", "description": "L'adreça de correu electrònic coincident." }, "status": { "type": "string", "description": "Estat d'aquesta sessió (p. ex., `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Indica si l'adreça de correu electrònic és a la llista de bloqueig de la teva aplicació." }, "api_service": { "type": "string", "nullable": true, "description": "Per a sessions de tipus API, l'API independent que la va crear (p. ex., `PHONE_VERIFICATION`); `null` per a sessions de verificació habituals." }, "source": { "type": "string", "description": "On s'ha trobat la coincidència. Normalment `session`; una coincidència amb la llista de bloqueig mitjançant una entrada de llista de l'organització anteposa una coincidència sintètica amb `source: \"list_entry\"` i `session_id`/`session_number` nuls." } } } }, "email_social": { "$ref": "#/components/schemas/EmailSocialFootprint" }, "email_intelligence": { "allOf": [ { "$ref": "#/components/schemas/EmailIntelligence" } ], "description": "Senyals d'intel·ligència de correu electrònic. Només estan presents quan `enable_enrichment` era `true` a la comprovació." } } }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` de la sessió de la verificació coincident. `null` a `Expired or Not Found`." }, "metadata": { "type": "object", "nullable": true, "description": "`metadata` de la sessió de la verificació coincident. `null` a `Expired or Not Found`." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de temps de la resposta d'aquesta comprovació." } } }, "WorkflowListItem": { "type": "object", "description": "Una versió del flux de treball a la vista de llista.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID per versió. Fes-lo servir com a `{settings_uuid}` per a get/update/delete, i com a `workflow_id` en crear sessions." }, "workflow_id": { "type": "string", "format": "uuid", "description": "ID de grup estable compartit per totes les versions del mateix flux de treball. És igual a `uuid` per a la versió 1." }, "workflow_label": { "type": "string", "description": "Nom visible per al flux de treball." }, "workflow_type": { "type": "string", "nullable": true, "description": "Tipus base per a fluxos de treball simples: `kyc`, `kyb`, `adaptive_age_verification`, `biometric_authentication`, etc. `null` per a fluxos de treball basats en grafs sense funcionalitat de KYB." }, "is_default": { "type": "boolean", "description": "Si aquest és el flux de treball per defecte per a les noves sessions." }, "is_archived": { "type": "boolean" }, "is_white_label_enabled": { "type": "boolean", "description": "Indica si la personalització de marca blanca s'aplica a les sessions creades amb aquest flux de treball." }, "total_price": { "type": "number", "description": "Preu fix per verificació en USD (número JSON, exclou funcionalitats amb preu variable com ara DATABASE_VALIDATION i PHONE_VERIFICATION)." }, "min_price": { "type": "number", "description": "Preu fix més econòmic entre les rutes del graf del flux de treball, en USD." }, "max_price": { "type": "number", "description": "Preu fix més car entre les rutes del graf del flux de treball, en USD." }, "features": { "type": "string", "description": "Funcionalitats habilitades en una única cadena unida amb `\" + \"`, p. ex. `\"OCR + LIVENESS + FACE_MATCH\"`. Divideix per `\" + \"` per obtenir una llista." }, "is_simple_workflow": { "type": "boolean", "description": "Cert quan el flux de treball no té cap graf de flux de treball personalitzat." }, "is_editable": { "type": "boolean", "description": "Cert quan aquesta versió és un `draft` (els esborranys es poden editar directament; les versions publicades són immutables a la Console)." }, "workflow_url": { "type": "string", "format": "uri", "description": "URL de verificació pública compartible per a aquest flux de treball (`https://verify.didit.me/u/`)." }, "max_retry_attempts": { "type": "integer", "description": "Nombre màxim d'intents de reintent permesos després d'una verificació rebutjada (0-10)." }, "retry_window_days": { "type": "integer", "nullable": true, "description": "Finestra mòbil en dies utilitzada per comptar els reintents (1-365). `null` = límit per a tot l'historial." }, "session_expiration_time": { "type": "integer", "description": "Segons abans que caduqui una sessió no finalitzada (3600-2419200)." }, "version": { "type": "integer", "description": "Número de versió dins del grup `workflow_id`, començant per 1." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Estat de la versió. Les sessions noves utilitzen l'última versió `published` d'un grup." }, "has_draft": { "type": "boolean", "description": "Cert quan qualsevol versió d'aquest grup de `workflow_id` és actualment un esborrany." }, "created_by": { "type": "object", "nullable": true, "description": "Qui ha creat aquesta versió: `{name, email, type}` on `type` és `user` (usuari de la consola, `email` definit) o `api_key` (`name` és l'identificador del client, `email` és null). `null` quan no s'ha registrat cap 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 flux de treball lineal simple. L'API converteix internament aquesta llista de funcionalitats en un graf de flux basat en nodes. Llista blanca de camps ESTRICTA: qualsevol clau no indicada aquí (incloent-hi `workflow_type`) es rebutja amb un 400.", "required": [ "features" ], "properties": { "workflow_label": { "type": "string", "maxLength": 50, "default": "ID Verification", "description": "Nom visible per al flux de treball (màxim 50 caràcters). El valor per defecte és `\"ID Verification\"` quan s'omet — defineix-lo sempre perquè els fluxos de treball es puguin distingir.", "example": "Standard KYC" }, "is_default": { "type": "boolean", "description": "Estableix aquest flux de treball com a predeterminat per a les noves sessions." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Omet aquest camp per crear un flux de treball publicat a punt per a sessions. Utilitza `draft` només quan vulguis desar sense publicar." }, "features": { "type": "array", "minItems": 1, "description": "Funcionalitats de verificació en ordre d'execució. L'API enllaça cada element amb el següent i afegeix un node d'estat final automàticament.", "items": { "$ref": "#/components/schemas/SimpleWorkflowFeature" } }, "is_white_label_enabled": { "type": "boolean", "description": "Habilita la personalització de marca blanca per a les sessions creades amb aquest flux de treball.", "default": false }, "is_desktop_allowed": { "type": "boolean", "description": "Permet que el flux de verificació s'executi en navegadors d'escriptori.", "default": false }, "max_retry_attempts": { "type": "integer", "minimum": 0, "maximum": 10, "default": 3, "description": "Nombre màxim d'intents de reintent permesos després d'una verificació rebutjada. `0` bloqueja l'usuari després del primer rebuig." }, "retry_window_days": { "type": "integer", "minimum": 1, "maximum": 365, "nullable": true, "default": 7, "description": "Finestra mòbil en dies utilitzada per comptar els reintents. `null` aplica un límit per a tot l'historial." }, "face_liveness_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "default": 3, "description": "Nombre màxim d'enviaments de prova de vida per sessió. Per defecte 3: un intent inicial més dos reintents. Aquest valor també es copia als nodes generats del flux de treball de prova de vida i estimació d'edat tret que la configuració a nivell de funcionalitat el sobreescrigui." }, "face_match_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "default": 3, "description": "Nombre màxim d'enviaments de coincidència facial per sessió. Per defecte 3: un intent inicial més dos reintents. Aquest valor també es copia als nodes generats del flux de treball de coincidència facial tret que la configuració a nivell de funcionalitat el sobreescrigui." }, "session_expiration_time": { "type": "integer", "minimum": 3600, "maximum": 2419200, "default": 604800, "description": "Segons abans que caduqui una sessió no finalitzada. Mínim 1 hora (3600), màxim 4 setmanes (2419200)." } } }, "SimpleWorkflowUpdateRequest": { "type": "object", "description": "Actualitza les metadades del flux de treball o substitueix la llista lineal completa de funcionalitats. Llista blanca de camps ESTRICTA: qualsevol clau no indicada aquí es rebutja amb un 400.", "properties": { "workflow_label": { "type": "string", "maxLength": 50, "description": "Nom visible per al flux de treball (màxim 50 caràcters)." }, "is_default": { "type": "boolean", "description": "Estableix aquest flux de treball com a predeterminat per a les noves sessions." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Controla el versionat. Omet-ho per actualitzar la versió actual directament (els esborranys es publiquen automàticament). `published` en una versió ja publicada crea i retorna una NOVA versió. `draft` només és vàlid mentre la versió encara sigui un esborrany." }, "features": { "type": "array", "minItems": 1, "description": "Si es proporciona, això substitueix l'ordre i la configuració completes de les funcionalitats.", "items": { "$ref": "#/components/schemas/SimpleWorkflowFeature" } }, "is_white_label_enabled": { "type": "boolean", "description": "Habilita la personalització de marca blanca per a les sessions creades amb aquest flux de treball." }, "is_desktop_allowed": { "type": "boolean", "description": "Permet que el flux de verificació s'executi en navegadors d'escriptori." }, "max_retry_attempts": { "type": "integer", "minimum": 0, "maximum": 10, "description": "Nombre màxim d'intents de reintent permesos després d'una verificació rebutjada. `0` bloqueja l'usuari després del primer rebuig." }, "retry_window_days": { "type": "integer", "minimum": 1, "maximum": 365, "nullable": true, "description": "Finestra mòbil en dies utilitzada per comptar els reintents. `null` aplica un límit per a tot l'historial." }, "face_liveness_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "description": "Nombre màxim d'enviaments de prova de vida per sessió. Aquest valor també es copia als nodes generats del flux de treball de prova de vida i estimació d'edat tret que la configuració a nivell de funcionalitat el sobreescrigui." }, "face_match_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "description": "Nombre màxim d'enviaments de coincidència facial per sessió. Aquest valor també es copia als nodes generats del flux de treball de coincidència facial tret que la configuració a nivell de funcionalitat el sobreescrigui." }, "session_expiration_time": { "type": "integer", "minimum": 3600, "maximum": 2419200, "description": "Segons abans que caduqui una sessió no finalitzada. Mínim 1 hora (3600), màxim 4 setmanes (2419200)." } } }, "SimpleWorkflowFeature": { "type": "object", "required": [ "feature" ], "properties": { "feature": { "type": "string", "description": "Funcionalitat a executar. Utilitza els valors en majúscules que es mostren 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ó específica de la funcionalitat. Per a `QUESTIONNAIRE`, inclou `questionnaire_uuid` amb el `questionnaire_id` retornat per l'endpoint de creació de qüestionaris. Per a `SIGNATURE`, un flux de treball que passi a producció necessita un document per signar: defineix `signature_documents_source` com a `session` o `both` perquè cada sessió pugui aportar el seu propi, o envia `status: \"draft\"` i afegeix els documents abans de publicar. `signature_level: \"aes\"` es rebutja amb `aes_not_available` mentre `signature_availability.aes` sigui `false` al flux de treball. Per a `OCR`, `methods` selecciona quins mètodes de Verificació d'identitat pot utilitzar cada país (captura de documents, consulta sense document en una font governamental o una altra font oficial, i carteres d'identitat digital); omet-lo i, per a tots els països, només s'utilitzarà la captura de documents. Per a `SIGNATURE`, consulta [Configuració de signatura electrònica](/ca/management-api/workflows/feature-configs#e-signature): de moment `signature_level` accepta `simple` (el valor per defecte, sense necessitat de verificació d'identitat, correu electrònic o telèfon) i `aes`, i els documents del flux de treball i els seus camps es gestionen a la consola, de manera que a través de l'API s'envien documents i camps per sessió amb `signature_documents_source: \"session\"`.", "additionalProperties": true }, "label": { "type": "string", "description": "Etiqueta interna opcional per a aquest node del flux de treball." } } }, "ReviewItem": { "type": "object", "description": "Una entrada al fil de revisió / activitat d'una sessió. Els canvis d'estat inclouen `previous_status`, `new_status`, `previous_value`, `new_value` i `changed_fields`; els comentaris inclouen `comment` i (per a comentaris de la consola) `mentioned_emails`; els camps restants són `null` o buits quan no s'apliquen al tipus d'activitat.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador únic d'aquesta entrada del canal.", "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": "Quin tipus d'activitat registra aquesta entrada. Les files `STATUS_UPDATED` provenen de decisions manuals (`PATCH /v3/session/{session_id}/update-status/`) i d'entrades afegides mitjançant `POST …/reviews/` (que prenen aquest tipus per defecte fins i tot quan no es registra cap estat). Les files `COMMENT` provenen de revisors de la Console; les visualitzacions de la pàgina de detall de la Console també s'emmagatzemen com a files `COMMENT` marcades amb `metadata.system_event = \"DETAIL_VIEWED\"`. Els tipus restants fan el seguiment d'edicions de dades, canvis de fitxers, etiquetes i activitat de monitoratge AML. Les files STATUS_UPDATED també s'escriuen per actors del sistema (per exemple, el monitoratge AML continu amb actor_type SYSTEM i actualitzacions automàtiques de l'estat de les funcionalitats), no només mitjançant l'endpoint update-status i publicacions de revisió manual. `FEATURE_OVERRIDE_PENDING`, `FEATURE_OVERRIDE_APPLIED` i `FEATURE_OVERRIDE_CANCELLED` registren una substitució de l'estat d'una comprovació (`PATCH /v3/session/{session_id}/features/{node_id}/update-status/`): sol·licitada per esperar que acabi el flux, aplicada o cancel·lada. Porten l'estat de la comprovació a `previous_value` / `new_value` (`{\"status\": ...}`), deixen `previous_status` i `new_status` com a `null`, i identifiquen la substitució a `metadata` (`feature_override_id`, `node_id`, `feature_model`, `forced`, `state`, `cancel_reason`). L'entrada de la sol·licitud porta el `comment` del revisor; una substitució aplicada quan acaba el flux es registra amb `actor_type` `SYSTEM`.", "example": "STATUS_UPDATED" }, "actor_display": { "type": "string", "description": "Etiqueta d'autor fàcil de llegir, resolta en aquest ordre: nom complet de l'actor → identificador de compte de la Console → part local d'`actor_email` → `\"API Client\"` (per a actors `API_KEY`) → `\"System\"` (per a actors `SYSTEM`) → `\"Unknown\"`. Les entrades creades mitjançant `POST …/reviews/` sempre mostren `\"Unknown\"` perquè aquest endpoint no registra cap atribució d'actor.", "example": "API Client" }, "actor_email": { "type": "string", "nullable": true, "description": "Correu electrònic de l'usuari de la Console que ha realitzat l'acció. `null` per als actors de claus d'API i del sistema.", "example": null }, "actor_type": { "type": "string", "enum": [ "API_KEY", "CONSOLE_USER", "SYSTEM" ], "description": "Qui ha dut a terme l'acció: una clau d'API, un usuari de la consola o el mateix Didit (`SYSTEM`, p. ex., monitoratge AML continu). Les entrades creades mitjançant `POST …/reviews/` porten el valor per defecte `CONSOLE_USER` independentment de qui fa la crida.", "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": "Estat de la sessió registrat per aquesta entrada (per a actualitzacions d'estat). `null` per a comentaris i entrades de canvi de dades.", "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": "Estat que tenia la sessió abans del canvi. S'omple a les entrades `STATUS_UPDATED` escrites per l'endpoint d'actualització d'estat; `null` a les entrades afegides mitjançant `POST …/reviews/`. També s'omple a les files STATUS_UPDATED generades pel sistema.", "example": "In Review" }, "comment": { "type": "string", "nullable": true, "description": "Nota de text lliure adjunta a l'entrada, o `null`.", "example": "Document re-checked manually; address matches." }, "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Usuaris de la consola mencionats amb `@email` al comentari. Sempre buit per a les entrades creades mitjançant aquesta API — el processament de mencions és una funcionalitat exclusiva de la consola.", "example": [] }, "previous_value": { "type": "object", "nullable": true, "description": "Instantània de les dades modificades abans de l'acció, p. ex. `{\"status\": \"In Review\"}` en un canvi d'estat. `null` si no s'ha modificat res.", "example": { "status": "In Review" } }, "new_value": { "type": "object", "nullable": true, "description": "Instantània de les dades modificades després de l'acció, p. ex. `{\"status\": \"Approved\"}`. `null` si no s'ha modificat res.", "example": { "status": "Approved" } }, "changed_fields": { "type": "array", "items": { "type": "string" }, "description": "Noms dels camps modificats per aquesta activitat (p. ex. `[\"status\"]`). Buit per a comentaris i per a entrades afegides mitjançant `POST …/reviews/`.", "example": [ "status" ] }, "metadata": { "type": "object", "nullable": true, "description": "Context addicional per a entrades generades pel sistema. Les visualitzacions de la pàgina de detall a la Console inclouen `{\"system_event\": \"DETAIL_VIEWED\", \"detail_type\": \"verification\"}` perquè es puguin excloure de la lògica de notificacions. Un `COMMENT` editat pel seu autor a la Console conté `edited_at`, l'hora ISO 8601 de l'última edició (`comment` i `mentioned_emails` contenen aleshores el text editat i les seves mencions). `null` per a entrades ordinàries.", "example": null }, "created_at": { "type": "string", "format": "date-time", "description": "Quan es va escriure l'entrada, ISO 8601 UTC.", "example": "2026-06-12T00:19:31.918735Z" } } }, "QuestionnaireListItem": { "type": "object", "description": "Una versió del qüestionari a la vista de llista.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID per versió. Fes-lo servir com a `{questionnaire_uuid}` per a get/update/delete i com a `questionnaire_uuid` a la configuració de la funcionalitat QUESTIONNAIRE d'un flux de treball." }, "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": "Cert per a qüestionaris lineals creats mitjançant aquesta API; fals per a qüestionaris basats en grafs creats a la consola." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "question_types": { "type": "array", "items": { "type": "string" }, "description": "Tipus d'element en majúscules de les preguntes que es poden respondre, en ordre de creació (p. ex., `SHORT_TEXT`, `MULTIPLE_CHOICE`, `FILE_UPLOAD`). Els elements estructurals `SECTION_HEADER` i `SEPARATOR` n'estan exclosos. Una entrada per pregunta, de manera que els valors es poden repetir." }, "workflow_names": { "type": "array", "items": { "type": "string" }, "description": "Noms dels fluxos de treball que utilitzen aquest qüestionari. Actualment sempre `[]` en aquest endpoint (només s'emplena al llistat de la consola)." }, "questionnaire_group_id": { "type": "string", "format": "uuid", "description": "Identificador estable que agrupa totes les versions del mateix qüestionari." }, "version": { "type": "integer", "description": "Número de versió dins del grup, començant per 1." }, "status": { "type": "string", "enum": [ "draft", "published" ] }, "published_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va publicar aquesta versió. `null` per a esborranys." }, "is_editable": { "type": "boolean", "description": "Cert quan aquesta versió és un `draft`." } } }, "SimpleQuestionnaireRequest": { "type": "object", "description": "Crea un qüestionari lineal simple. L'API converteix `form_elements` en el graf intern del qüestionari.", "required": [ "title", "languages", "form_elements" ], "properties": { "title": { "type": "string", "description": "Nom intern del qüestionari." }, "description": { "type": "string", "nullable": true }, "languages": { "type": "array", "description": "Idiomes inclosos a cada etiqueta. Ha d'incloure `en`.", "items": { "type": "string" }, "example": [ "en" ] }, "default_language": { "type": "string", "description": "Idioma predeterminat. S'ha d'incloure a `languages`.", "example": "en" }, "is_active": { "type": "boolean", "default": true }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Omet aquest camp per crear un qüestionari publicat a punt per a fluxos de treball." }, "form_elements": { "type": "array", "minItems": 1, "description": "Preguntes en l'ordre exacte en què els usuaris les haurien de veure. Les branques i els camps condicionals no són compatibles.", "items": { "$ref": "#/components/schemas/SimpleQuestionnaireElement" } } } }, "SimpleQuestionnaireUpdateRequest": { "type": "object", "description": "Actualitza les metadades del qüestionari o substitueix la llista 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 es proporciona, això substitueix la llista lineal completa de preguntes.", "items": { "$ref": "#/components/schemas/SimpleQuestionnaireElement" } } } }, "SimpleQuestionnaireElement": { "type": "object", "required": [ "element_type", "label" ], "properties": { "id": { "type": "string", "description": "ID opcional i estable de la pregunta. Si s'omet, l'API genera `q1`, `q2`, etc. Fes servir lletres minúscules, números i guions baixos per millorar la llegibilitat.", "example": "source_of_funds" }, "element_type": { "type": "string", "description": "Tipus de pregunta. L'API accepta aquests valors en minúscules i els seus equivalents en majúscules.", "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 per codi d'idioma, per exemple `{ \"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": "Utilitza per a `dropdown`, `single_choice` i `multiple_choice`. Si s'omet `value`, l'API en genera un a partir de l'etiqueta de l'opció.", "items": { "type": "object", "required": [ "label" ], "properties": { "value": { "type": "string" }, "label": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "max_files": { "type": "integer", "minimum": 1, "maximum": 5, "description": "Utilitza amb `file_upload` o `image`." }, "validation": { "type": "object", "nullable": true, "description": "Validació de format opcional per a `short_text`, `long_text` o `number`. S'aplica mentre l'usuari emplena el camp (no pot continuar fins que sigui vàlid) i l'API la torna a comprovar en enviar-lo.", "properties": { "pattern": { "type": "string", "description": "Expressió regular (subconjunt ECMA-262) amb la qual el valor ha de coincidir completament. Per a `short_text` i `long_text`. No afegeixis àncores ^/$; es fa coincidir el valor sencer." }, "min_length": { "type": "integer", "minimum": 0, "description": "Nombre mínim de caràcters. Per a `short_text` i `long_text`." }, "max_length": { "type": "integer", "minimum": 0, "description": "Nombre màxim de caràcters. Per a `short_text` i `long_text`." }, "min": { "type": "number", "description": "Valor numèric mínim. Per a `number`." }, "max": { "type": "number", "description": "Valor numèric màxim. Per a `number`." }, "error_message": { "type": "object", "description": "Missatge traduït que es mostra quan la validació falla, indexat pel codi d'idioma.", "additionalProperties": { "type": "string" } } } } } }, "QuestionnaireDetail": { "type": "object", "description": "Detall complet del qüestionari retornat des dels endpoints GET, POST (creació) i PATCH (actualització).", "properties": { "questionnaire_id": { "type": "string", "format": "uuid", "description": "Identificador únic del qüestionari. Utilitza aquest id en fer referència al qüestionari des d'un flux de treball o en sol·licituds posteriors d'actualització o supressió." }, "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 del graf amb start_node i mapa de nodes." }, "sections": { "type": "array", "description": "Contingut del qüestionari agrupat en seccions (derivat del graf).", "items": { "type": "object" } }, "questionnaire_group_id": { "type": "string", "format": "uuid", "description": "Identificador estable que agrupa totes les versions del mateix qüestionari." }, "version": { "type": "integer" }, "status": { "type": "string", "enum": [ "draft", "published" ] }, "published_at": { "type": "string", "format": "date-time", "nullable": true }, "is_editable": { "type": "boolean", "description": "Cert quan el qüestionari encara es pot editar in situ (versions en esborrany)." } } }, "UserListItem": { "type": "object", "description": "Un usuari verificat.", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "UUID intern estable de Didit per a aquest usuari." }, "vendor_data": { "type": "string", "nullable": true, "description": "El teu identificador únic per a aquest usuari (passat en crear sessions). Pot ser nul quan no s'ha proporcionat cap identificador de proveïdor." }, "display_name": { "type": "string", "nullable": true, "description": "Nom visible personalitzat definit per tu" }, "full_name": { "type": "string", "nullable": true, "description": "Nom complet extret dels documents verificats" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "effective_name": { "type": "string", "nullable": true, "description": "Millor nom disponible: display_name si està definit, en cas contrari full_name" }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Estat del cicle de vida del registre d'usuari (NO és un estat de la sessió). `ACTIVE` és el valor per defecte, `FLAGGED` marca l'usuari per a atenció manual, `BLOCKED` impedeix noves sessions per a aquest `vendor_data`." }, "portrait_image_url": { "type": "string", "nullable": true, "description": "URL presignada de la foto de retrat de l'usuari (caduca al cap d'unes hores)" }, "session_count": { "type": "integer", "description": "Nombre total de sessions de verificació per a aquest usuari" }, "approved_count": { "type": "integer", "description": "Nombre de sessions aprovades" }, "declined_count": { "type": "integer", "description": "Nombre de sessions rebutjades" }, "in_review_count": { "type": "integer", "description": "Nombre de sessions en revisió" }, "issuing_states": { "type": "array", "items": { "type": "string" }, "description": "Codis ISO 3166-1 alpha-3 dels països emissors que consten als documents d'identitat aprovats d'aquest usuari, p. ex. `[\"USA\", \"ESP\"]`. Matriu buida si no n'hi ha cap." }, "approved_emails": { "type": "array", "items": { "type": "string" }, "description": "Adreces de correu electrònic verificades recollides de les sessions aprovades d'aquest usuari, p. ex. `[\"john@example.com\"]`." }, "approved_phones": { "type": "array", "items": { "type": "string" }, "description": "Números de telèfon verificats recollits de les sessions aprovades d'aquest usuari, p. ex. `[\"+14155551234\"]`." }, "features": { "type": "object", "description": "Estat agregat per funcionalitat a totes les sessions d'aquest usuari. Claus possibles: `ID_VERIFICATION`, `NFC`, `LIVENESS`, `FACE_MATCH`, `POA`, `QUESTIONNAIRE`, `EMAIL_VERIFICATION`, `PHONE`, `AML`, `IP_ANALYSIS`, `AGE_ESTIMATION`, `DATABASE_VALIDATION`. Valors possibles: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub Requested`." }, "features_list": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string" }, "status": { "type": "string" } } }, "description": "Les mateixes dades que `features`, com una llista ordenada d'objectes `{feature, status}`." }, "last_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de temps de la sessió més recent" }, "first_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de temps de la primera sessió" }, "last_activity_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de temps de l'activitat més recent d'aquest usuari (sessió, transacció, canvi d'estat, edició de dades, etc.)." }, "tags": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string" } } }, "description": "Etiquetes assignades a aquest usuari" }, "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": "Detall complet de l'usuari. Amplia UserListItem amb metadades, comentaris i updated_at.", "allOf": [ { "$ref": "#/components/schemas/UserListItem" }, { "type": "object", "properties": { "metadata": { "type": "object", "description": "JSON de metadades personalitzades que has adjuntat a aquest usuari. Per defecte és `{}`." }, "tags": { "type": "array", "description": "Assignacions d'etiquetes. NOTA: a les respostes de detall cada entrada és un objecte d'*enllaç* d'etiqueta (`{uuid, tag: {...}, added_by_email, added_by_name, created_at}`), a diferència de l'estructura plana `{uuid, name, color}` utilitzada a les respostes de llista.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID de l'assignació de l'etiqueta (no l'etiqueta en si)." }, "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": "Valors de camp anteriors per a entrades PROFILE_UPDATED." }, "new_value": { "type": "object", "nullable": true, "description": "Nous valors de camp per a les entrades PROFILE_UPDATED." }, "changed_fields": { "type": "array", "items": { "type": "string" }, "description": "Noms dels camps modificats per una entrada PROFILE_UPDATED." }, "metadata": { "type": "object", "nullable": true }, "mentioned_emails": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" } } }, "description": "Registre d'activitat i comentaris per a aquest usuari (canvis d'estat, edicions de perfil, notes manuals)." }, "updated_at": { "type": "string", "format": "date-time" } } } ] }, "BusinessListItem": { "type": "object", "description": "Una empresa verificada.", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "UUID intern estable de Didit per a aquesta empresa." }, "vendor_data": { "type": "string", "nullable": true, "description": "El teu identificador únic per a aquesta empresa (passat en crear sessions). Pot ser nul quan no s'ha proporcionat cap identificador de proveïdor." }, "display_name": { "type": "string", "nullable": true, "description": "Nom visible personalitzat definit per tu" }, "legal_name": { "type": "string", "nullable": true, "description": "Nom legal oficial obtingut del registre mercantil o introduït manualment" }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registre o de constitució de l'empresa" }, "country_code": { "type": "string", "nullable": true, "description": "País de constitució (ISO 3166-1 alpha-2, p. ex. `GB`, `US`)." }, "effective_name": { "type": "string", "nullable": true, "description": "Millor nom disponible: display_name si està definit, en cas contrari legal_name" }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Estat del cicle de vida del registre d'empresa (NO és un estat de la sessió). `ACTIVE` és el valor per defecte, `FLAGGED` el marca per a atenció manual, `BLOCKED` impedeix noves sessions per a aquest `vendor_data`." }, "session_count": { "type": "integer", "description": "Nombre total de sessions de verificació per a aquesta empresa" }, "approved_count": { "type": "integer", "description": "Nombre de sessions aprovades" }, "declined_count": { "type": "integer", "description": "Nombre de sessions rebutjades" }, "in_review_count": { "type": "integer", "description": "Nombre de sessions en revisió" }, "features": { "type": "object", "description": "Estat agregat per funcionalitat a totes les sessions de KYB d'aquesta empresa. Actualment l'única clau és `KYB` (l'estat de la comprovació de l'empresa al registre). Valors possibles: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub Requested`." }, "features_list": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string" }, "status": { "type": "string" } } }, "description": "Les mateixes dades que `features`, com una llista ordenada d'objectes `{feature, status}`." }, "last_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de temps de la sessió més recent" }, "first_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de temps de la primera sessió" }, "last_activity_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de temps de l'activitat més recent (canvi d'estat, actualització de la sessió, etc.)" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string" } } }, "description": "Etiquetes assignades a aquesta empresa" }, "created_at": { "type": "string", "format": "date-time" } } }, "BusinessDetailItem": { "type": "object", "description": "Detall complet de l'empresa. Amplia BusinessListItem amb metadades i updated_at.", "allOf": [ { "$ref": "#/components/schemas/BusinessListItem" }, { "type": "object", "properties": { "metadata": { "type": "object", "description": "JSON de metadades personalitzades que has adjuntat a aquesta empresa. Per defecte és `{}`." }, "updated_at": { "type": "string", "format": "date-time" } } } ] }, "TransactionDetail": { "type": "object", "description": "Registre complet de monitoratge per a una transacció, tal com el retornen `GET /v3/transactions/{transaction_id}/` i `POST /v3/transactions/`.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador de transacció estable de Didit. Fes-lo servir com a `{transaction_id}` per a les crides de seguiment." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Entorn de l'aplicació propietària de la transacció. Una transacció `sandbox` s'emmagatzema però mai s'avalua, se sotmet a cribratge, es notifica ni es factura, de manera que el seu `rule_runs` buit significa \"no avaluada\"." }, "transaction_number": { "type": "integer", "description": "Número seqüencial de transacció en l'àmbit de l'aplicació que es mostra a la consola (p. ex. `4123`)." }, "txn_id": { "type": "string", "description": "El `transaction_id` que has proporcionat en el moment de la creació (màx. 128 caràcters). Únic per aplicació." }, "txn_date": { "type": "string", "format": "date-time", "description": "Quan va tenir lloc la transacció (a partir de `transaction_at`; per defecte pren l'hora d'enviament)." }, "zone_id": { "type": "string", "nullable": true, "description": "Identificador de zona horària IANA proporcionat en el moment de la creació." }, "transaction_type": { "type": "string", "description": "Categoria de primer nivell tal com s'emmagatzema: `finance`, `kyc`, `travelRule`, `userPlatformEvent`, `gamblingBet`, `gamblingLimitChange`, `gamblingBonusChange`, `auditTrailEvent`. Tingues en compte que els valors de diverses paraules es retornen en camelCase fins i tot quan s'envien en snake_case." }, "action_type": { "type": "string", "description": "Subtipus dins de la categoria (p. ex. `deposit`, `withdrawal`, `transfer`). Per defecte pren la categoria quan no s'especifica." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Direcció relativa al subjecte. S'emmagatzema en majúscules independentment de les majúscules o minúscules enviades (s'accepten `in`/`out`/`inbound`/`outbound` a l'entrada)." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Veredicte de monitoratge actual. Les transaccions es creen com a `APPROVED`; les regles poden canviar-les a `IN_REVIEW`/`DECLINED` de manera sincrònica." }, "source": { "type": "string", "enum": [ "LIVE", "IMPORTED" ], "description": "Com s'ha originat el registre: `LIVE` per a transaccions enviades a través de l'API o l'SDK, `IMPORTED` per a transaccions carregades mitjançant la importació des de la consola." }, "amount": { "type": "string", "description": "Import de la transacció com a cadena decimal sense els zeros finals (p. ex., `\"1500\"`, `\"0.5\"`, `\"0.123456789012345678\"`). Fins a 18 decimals." }, "currency": { "type": "string", "description": "Codi de moneda de `amount`. S'accepta qualsevol codi alfabètic ISO 4217 (p. ex. `EUR`, `USD`, `NGN`), així com un símbol d'actiu cripto (p. ex. `BTC`). És preferible utilitzar un codi actualment en circulació. No tots els codis acceptats tenen tipus de canvi: quan no n'hi ha cap de disponible per al codi (per exemple, la unitat de compte ISO `XSU`, o un símbol cripto que Didit no cotitza), la conversió automàtica falla i `preferred_currency_amount` es retorna null tret que la sol·licitud hagi proporcionat un `amount_in_default_currency` preconvertit." }, "currency_type": { "type": "string", "nullable": true, "description": "`fiat` o `crypto`, tal com s'ha indicat a `currency_kind`." }, "amount_in_default_currency": { "type": "string", "nullable": true, "description": "Import preconvertit que has proporcionat, com a cadena decimal sense zeros finals." }, "default_currency_code": { "type": "string", "nullable": true }, "preferred_currency_amount": { "type": "string", "nullable": true, "description": "`amount` convertit a la moneda preferida de l'aplicació, quan estigui disponible." }, "preferred_currency_code": { "type": "string", "nullable": true }, "payment_details": { "type": "string", "nullable": true, "description": "Referència de pagament o concepte de text lliure de l'enviament." }, "payment_txn_id": { "type": "string", "nullable": true, "description": "Referència del sistema de pagament extern (p. ex. hash de la transacció a la blockchain) de `payment_reference_id`." }, "score": { "type": "integer", "description": "Puntuació de risc acumulada per les regles (normalment 0–100). Com més alta, més risc." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "description": "Gravetat de risc categòrica establerta per regles/proveïdors (`UNKNOWN`, `LOW`, `MEDIUM`, `HIGH`, `CRITICAL`). `null` fins que algun element l'estableixi." }, "decision_reason_code": { "type": "string", "nullable": true, "description": "Motiu llegible per màquina per a l'`status` actual." }, "decision_reason_label": { "type": "string", "nullable": true, "description": "Etiqueta fàcil de llegir per a `decision_reason_code`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Còpia de conveniència del `vendor_data` del sol·licitant." }, "metadata": { "type": "object", "description": "Instantània dels payloads de `subject` i `counterparty` tal com es van enviar en el moment de la creació." }, "props": { "type": "object", "description": "Les `custom_properties` que has proporcionat en crear. Cada clau es pot referenciar en les condicions de les regles com a `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 l'etiqueta és un valor predefinit de Didit o una etiqueta personalitzada." } } }, "description": "Etiquetes adjuntades a la transacció (manualment o per regles)." }, "parties": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "role": { "type": "string", "enum": [ "APPLICANT", "REMITTER", "BENEFICIARY", "COUNTERPARTY" ], "description": "Rol de la part. L'endpoint de creació assigna `APPLICANT` (el subjecte) i `COUNTERPARTY`." }, "entity_type": { "type": "string", "enum": [ "individual", "company", "external", "unhostedWallet" ] }, "kind": { "type": "string", "enum": [ "USER", "BUSINESS", "EXTERNAL" ], "description": "Les parts `USER`/`BUSINESS` s'enllacen amb una entitat propietat de Didit mitjançant `vendor_data`. Les parts `EXTERNAL` no tenen cap entitat de Didit al darrere." }, "vendor_data": { "type": "string", "nullable": true, "description": "El teu identificador intern d'usuari/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": "Codi de país de l'`address.country` enviat (normalment ISO 3166-1 alpha-3)." }, "dob": { "type": "string", "format": "date", "nullable": true, "description": "Data de naixement a partir de la `date_of_birth` enviada." }, "address": { "type": "object", "description": "Objecte d'adreça tal com s'ha enviat. `{}` quan s'omet." }, "institution_info": { "type": "object", "description": "Detalls de la institució tal com s'han enviat. `{}` si s'ometen." }, "device": { "type": "object", "description": "Context del dispositiu normalitzat, inclòs l'enriquiment d'IP del costat del servidor sota network_context (geolocalització, indicadors de VPN/centre de dades) quan s'ha proporcionat una IP.", "properties": { "fingerprint": { "type": "string", "description": "Petjada digital única del dispositiu." }, "persistent_device_id": { "type": "string", "description": "Identificador de dispositiu estable entre sessions (esquema d'empremta digital v2)." }, "user_agent": { "type": "string", "description": "Cadena de l'agent d'usuari del navegador o de l'aplicació." }, "browser_family": { "type": "string", "description": "Família del navegador (p. ex., Chrome, Firefox, Safari)." }, "browser_version": { "type": "string", "description": "Cadena de la versió del navegador." }, "platform": { "type": "string", "description": "Identificador de plataforma (web, ios, android, macos, windows, linux)." }, "os_family": { "type": "string", "description": "Família del sistema operatiu (p. ex., iOS, Android, Windows)." }, "os_version": { "type": "string", "description": "Cadena de la versió del sistema operatiu." }, "accept_language": { "type": "string", "description": "Valor de la capçalera Accept-Language." }, "session_id": { "type": "string", "description": "Identificador de sessió (emmagatzemat a les metadades)." }, "session_age_ms": { "type": "number", "description": "Antiguitat de la sessió en mil·lisegons." }, "network_context": { "type": "object", "description": "Context de xarxa amb adreça IP i geolocalització.", "properties": { "ip_address": { "type": "string", "description": "Adreça IP del client." }, "ip_country_code": { "type": "string", "description": "País geolocalitzat de la IP (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": "Còpia congelada de les dades de les parts de tipus `EXTERNAL`. `null` mentre la part estigui vinculada a un usuari o una empresa de Didit." } } }, "description": "Parts de la transacció (sol·licitant, contrapart)." }, "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 per correlacionar la reutilització del mateix instrument." }, "account_id": { "type": "string", "nullable": true, "description": "Identificador de compte (IBAN, adreça de cartera, token de targeta, …)." }, "issuing_country": { "type": "string", "nullable": true }, "owner_kind": { "type": "string", "enum": [ "USER", "BUSINESS", "EXTERNAL" ] }, "vendor_data": { "type": "string", "nullable": true, "description": "El teu identificador per a l'usuari o l'empresa propietaris." }, "owner_name": { "type": "string", "nullable": true }, "institution_info": { "type": "object" }, "details": { "type": "object", "description": "Objecte `payment_method` en brut tal com s'ha enviat." }, "external_owner_snapshot": { "type": "object", "nullable": true }, "role": { "type": "string", "enum": [ "SOURCE", "DESTINATION", "FUNDING", "BENEFICIARY" ], "description": "Com es va utilitzar aquest mètode a la transacció. L'endpoint de creació assigna `SOURCE`/`DESTINATION` a partir de la direcció (sortint: subject = SOURCE; entrant: subject = DESTINATION)." } } }, "description": "Mètodes de pagament vinculats a la transacció." }, "documents": { "type": "array", "description": "Fitxers adjunts a la transacció des de la consola. `[]` quan no n'hi ha cap.", "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 descàrrega signada de curta durada; obtén-la quan sigui necessari en lloc d'emmagatzemar-la." }, "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": "P. ex. `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": "Entrades del registre d'activitat (creació, notes, revisions manuals, canvis d'estat)." }, "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": "Sempre buit actualment. Una alerta oberta és una transacció amb estat `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 s'ha executat." }, "rule_title": { "type": "string" }, "rule_description": { "type": "string", "nullable": true }, "rule_category": { "type": "string" }, "matched": { "type": "boolean", "description": "Si les condicions de la regla han coincidit amb aquesta transacció. Només s'enregistra una execució per a les regles coincidents, de manera que les avaluacions en producció sempre porten `true`." }, "is_test": { "type": "boolean", "description": "Cert quan la regla s'ha executat en mode TEST (sense cap efecte en l'estat o la puntuació)." }, "mode": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "TEST" ] }, "severity": { "type": "string", "nullable": true }, "score_delta": { "type": "integer", "description": "Puntuació afegida per les accions `add_score` d'aquesta regla." }, "status_target": { "type": "string", "nullable": true, "description": "Estat establert per una acció `change_status`, si n'hi ha." }, "action_summary": { "type": "string", "nullable": true, "description": "Resum de les accions que ha executat la regla, unides amb `; ` (p. ex., `score +30; change_status:IN_REVIEW; add_tag:high_risk_country`). Parts: `score +N`, `change_status:`, `add_tag:`, `add_note`, `add_to_list`, `open_case`. `null` quan la regla no ha executat cap acció." }, "metadata": { "type": "object", "description": "Detall de l'avaluació: `scope_match`, `conditions[]` i `aggregations[]`. Cada entrada de condició conté `field`, `operator`, `expected_value`, el `current_value` llegit de la transacció, `matched`, `group_index` i `group_logic`. Cada entrada d'agregació (velocitat / recompte / suma) conté `metric`, `field`, `operator`, `expected_value`, el `computed_value` resultant de l'avaluació de l'agregat, `window`, `filters`, `matched` i `sample_references`; les agregacions asíncrones ajornades tenen `computed_value: null` i `deferred: true`. Un grup de condicions niat és una entrada de `conditions[]` amb l'`operator` `any_of` o `all_of`, `field` null, i els resultats dels seus membres sota el seu propi `conditions`." }, "created_at": { "type": "string", "format": "date-time" } } }, "description": "Resultats d'execució per regla: quina regla s'ha activat, amb quin impacte en la puntuació." }, "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 resposta del proveïdor en brut." }, "created_at": { "type": "string", "format": "date-time" } } }, "description": "Payloads en brut dels proveïdors (Cribratge AML, anàlisi de blockchain, etc.)." }, "travel_rule": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TransactionTravelRule" } ], "description": "Transferència o comprovació de Travel Rule. S'emplena quan s'ha enviat `travel_rule_details`, i també quan Travel Rule està activat i la transacció s'ha creat amb `transaction_category: travelRule` (Didit inicia l'intercanvi directament, fins i tot sense `travel_rule_details`). `null` quan no existeix cap transferència o comprovació. En una transferència entrant, els camps `originator_data` i `beneficiary_data` de la contrapart romanen emmascarats (`data_masked: true`) fins que es confirma la titularitat de la cartera." }, "network_snapshot": { "type": "object", "nullable": true, "description": "Instantània del graf de transaccions/parts relacionades utilitzada pel motor de regles. O bé el `network_snapshot` enviat amb la transacció o bé el graf que Didit construeix a partir d'un cribratge AML de carteres satisfactori (que substitueix el que s'hagi enviat). `null` quan cap dels dos existeix.", "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": "Sessió de correcció oferta a l'usuari quan es requereix una reverificació. Substituïda per `action_required`, que és el bloc canònic; es manté per compatibilitat amb versions anteriors.", "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ó pendent de l'usuari final necessària per completar aquesta transacció, o null si no n'hi ha cap. Els SDK de Didit inicien automàticament l'acció per defecte i actualitzen la transacció quan finalitza. Dues variants, discriminades per `type`: `verification_session` (una sessió de verificació allotjada creada per una acció de regla) i `wallet_ownership` (una sessió de widget de titularitat de la cartera generada automàticament per a una transferència de Travel Rule que necessita un comprovant de control de la cartera, regulada per la configuració de Travel Rule `auto_wallet_verification`). Quan totes dues es podrien aplicar, `wallet_ownership` té prioritat perquè bloqueja l'intercanvi de 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": "Cost d'aquesta transacció: `total_price` i `items`, un per càrrec, cadascun amb `usage_type`, `price`, `details` i `created_at`. Un nou cribratge de la mateixa transacció és un element nou." } } }, "TravelRuleSettingsDetail": { "type": "object", "properties": { "is_enabled": { "type": "boolean", "description": "Indica si el flux gestionat de negociació de Travel Rule està actiu per a transaccions `travelRule` sortints en aquesta aplicació." }, "jurisdiction": { "type": "string", "maxLength": 8, "description": "El codi de jurisdicció operativa del teu VASP. Per defecte `\"EU\"`. Didit l'assigna al règim que estampa a les teves transaccions de Travel Rule com a `travel_rule_regime` (per exemple, `EU` o el codi d'un estat membre de la UE es converteix en `eu`), sobre el qual es poden basar les regles de transacció. Altres clients de Didit el veuen com la teva jurisdicció al directori de VASP un cop la xarxa de Didit llista el teu perfil." }, "name_matching_strictness": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Amb quin grau d'estrictesa han de coincidir els noms dels beneficiaris abans que una transferència pugui arribar a l'estat COMPLETED. `CONTAINS` accepta un nom les paraules del qual apareguin totes en l'altre." }, "confirmation_timeout_hours": { "type": "integer", "minimum": 1, "description": "Hores que una transferència AWAITING_COUNTERPARTY pot romandre sense confirmar abans que el procés de neteja periòdic la faci caducar. Per defecte, 48." }, "timeout_outcome": { "type": "string", "enum": [ "HOLD", "REJECT", "PROCEED" ], "description": "Què passa amb la transacció subjacent quan caduca una transferència. Per defecte HOLD. sunrise_policy i non_responsive_policy tenen prioritat quan s'apliquen i estan configurades." }, "threshold_amount": { "type": "string", "description": "Cadena decimal, en la moneda predeterminada de la teva aplicació. Import mínim de transferència que activa un intercanvi gestionat; les transferències per sota d'aquest es resolen directament com a NOT_APPLICABLE. Didit compara l'import de la transacció convertit a la teva moneda predeterminada, o el camp `amount_in_default_currency` que enviïs; quan no hi ha cap import convertit disponible, el llindar no s'aplica. El valor per defecte és \"0.00\" (el TFR de la UE no aplica cap import mínim)." }, "ownership_validation_mode": { "type": "string", "enum": [ "FULL", "SIMPLIFIED", "AUTOMATED" ], "description": "Quanta prova requereix la titularitat d'una cartera. `FULL` requereix sempre una prova (missatge signat, dipòsit de prova o captura de pantalla revisada), mai la paraula de l'usuari final. `SIMPLIFIED` accepta una autodeclaració per sota de `simplified_validation_threshold` i una prova per sobre d'aquest llindar. `AUTOMATED` permet que la llibreta d'adreces i les proves anteriors responguin per si soles, incloses les autodeclaracions mentre `allow_self_declaration` sigui cert. Per defecte `AUTOMATED`." }, "simplified_validation_threshold": { "type": "string", "description": "Cadena decimal, per defecte \"0.00\". En mode `SIMPLIFIED`, una transferència per sota d'aquest import (en la moneda del llindar) accepta una autodeclaració. Una transferència sense cap import en aquesta moneda es compta com a superior." }, "data_sharing_fields": { "$ref": "#/components/schemas/TravelRuleDataSharingFields" }, "matching_rules": { "$ref": "#/components/schemas/TravelRuleMatchingRules" }, "legal_name": { "type": "string", "description": "La raó social del teu VASP. Obligatòria (no pot estar en blanc) per establir is_enabled a true." }, "lei": { "type": "string", "description": "El teu identificador d'entitat jurídica, mostrat al directori de VASP." }, "compliance_email": { "type": "string", "format": "email", "description": "Correu electrònic de contacte de compliment per al teu perfil de VASP. La xarxa de Didit només llista el teu perfil un cop confirmada aquesta adreça mitjançant un enllaç enviat per correu electrònic (POST /v3/travel-rule/settings/compliance-email/confirmation/); modificar-la requereix una nova confirmació." }, "is_discoverable": { "type": "boolean", "description": "Indica si el teu perfil de VASP es pot llistar a la xarxa de Didit: que altres clients de Didit poden trobar mitjançant GET /v3/travel-rule/vasps/ i accessible pel canal INTERNAL. Per a poder-lo llistar també cal una aplicació en producció, Travel Rule activat, una raó social i un correu electrònic de compliment confirmat; didit_network indica quins falten. Per defecte és true." }, "inbound_auto_accept": { "type": "boolean", "description": "Quan és cert, una consulta TRP d'entrada la cartera beneficiària de la qual és una entrada verificada de la llibreta d'adreces amb un nom coincident s'aprova automàticament. Quan és fals, aquesta consulta s'espera en ON_HOLD que l'aprovis o la deneguis amb l'endpoint de titularitat. Les transferències de rail INTERNAL i posteriors al dipòsit no es veuen afectades. Per defecte cert." }, "allow_self_declaration": { "type": "boolean", "description": "Quan és cert, el widget de titularitat de la cartera ofereix l'autodeclaració com a mètode de prova alternatiu. Per defecte cert." }, "allow_screenshot_proof": { "type": "boolean", "description": "Quan és cert, el widget de titularitat de la cartera ofereix la càrrega de captures de pantalla com a mètode de prova de titularitat. Per defecte cert." }, "auto_wallet_verification": { "type": "boolean", "description": "Quan és cert, enviar una transferència de sortida de la Travel Rule que requereix una prova de control de la cartera per part de l'usuari final crea automàticament una sessió del widget de titularitat de la cartera vinculada a la transacció i l'exposa al bloc action_required de la transacció. Per defecte cert." }, "vasp_attribution_enabled": { "type": "boolean", "description": "Quan és cert, una transferència de sortida de la Travel Rule que cap rail pot encaminar s'atribueix mitjançant analítica de blockchain: la cartera de destinació es resol al seu VASP propietari, l'entitat es registra a la transferència i al directori de VASP, i els rails es tornen a executar una vegada amb el nom atribuït. Per defecte cert." }, "counterparty_screening_enabled": { "type": "boolean", "description": "Cribratge opcional de sancions i mitjans adversos de VASP de les contraparts, facturat per cribratge al preu de Cribratge AML d'empreses. Quan està activat, Didit fa el cribratge de la contrapart a la qual arriba un intercanvi de sortida (reutilitzant un cribratge de menys de 30 dies) i pots fer-ne el cribratge d'una amb POST /v3/travel-rule/vasps/{vasp_id}/screening/. Per defecte false: no es fa cap cribratge ni es factura res." }, "sunrise_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "Què fa una transferència caducada sobre la seva transacció quan la contrapart és una entrada del directori en una jurisdicció de sunrise_jurisdictions, que encara no aplica la Travel Rule: HOLD la passa a revisió, REJECT la rebutja, PROCEED deixa el seu estat intacte. En blanc (per defecte) segueix timeout_outcome. S'aplica abans de non_responsive_policy." }, "sunrise_jurisdictions": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Només de lectura. Els països (ISO 3166 alpha-2) que Didit considera en període d'entrada en vigor de la Travel Rule, on s'aplica sunrise_policy. Actualment CO, KH i VN. Qualsevol altra jurisdicció, així com una de buida o desconeguda, segueix timeout_outcome." }, "non_responsive_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "Què fa una transferència caducada sobre la seva transacció quan la contrapart és una entrada del directori la capacitat de resposta de la qual és UNRESPONSIVE: HOLD, REJECT o PROCEED, igual que per a timeout_outcome. En blanc (per defecte) segueix timeout_outcome. sunrise_policy s'aplica primer quan es compleixen totes dues condicions." }, "travel_address": { "type": "string", "description": "Només de lectura. La Travel Address pròpia del teu VASP: l'endpoint de consultes TRP entrants codificat que altres VASP utilitzen per contactar amb tu. Buit mentre `is_enabled` sigui false." }, "disabled_networks": { "type": "array", "items": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA" ] }, "description": "Xarxes que han desactivat la pertinença a la plataforma. No inhabilita les teves pertinences pròpies connectades ni aprovisiona xarxes no disponibles.", "default": [] }, "networks": { "type": "object", "readOnly": true, "description": "Per xarxa, com enviaria aquesta aplicació i per què no pot fer-ho. Cap xarxa, inclosa GTR, s'inclou per defecte: es pot accedir a una xarxa mitjançant la teva pròpia pertinença connectada, o mitjançant la pertinença de Didit un cop la pertinença de Didit a aquesta xarxa estigui activa i el teu propi participant hi estigui actiu. No és una comprovació d'estat o de lliurament en directe.", "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": "Indica si la xarxa de Didit llista el teu perfil de VASP, de manera que altres clients de Didit el trobin al directori i hi puguin contactar a través de la via INTERNAL, així com cadascuna de les condicions que encara no compleix.", "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": "Buit quan apareix a la llista. compliance_email_unconfirmed: envia la confirmació amb POST /v3/travel-rule/settings/compliance-email/confirmation/ i obre l'enllaç rebut per correu electrònic. excluded_by_staff: Didit ha marcat l'aplicació com a prova, demo o interna." }, "compliance_email_confirmed": { "type": "boolean", "description": "Indica si l'actual compliance_email s'ha confirmat a través de l'enllaç enviat per correu electrònic." } } } } }, "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` accepta un nom les paraules del qual apareixen totes en l'altre." }, "confirmation_timeout_hours": { "type": "integer", "minimum": 1 }, "timeout_outcome": { "type": "string", "enum": [ "HOLD", "REJECT", "PROCEED" ] }, "compliance_email": { "type": "string", "format": "email", "description": "Correu electrònic de contacte de compliment per al teu perfil de VASP. La xarxa de Didit només llista el teu perfil un cop confirmada aquesta adreça mitjançant un enllaç enviat per correu electrònic (POST /v3/travel-rule/settings/compliance-email/confirmation/); modificar-la requereix una nova confirmació." }, "is_discoverable": { "type": "boolean", "description": "Indica si el teu perfil de VASP es pot llistar a la xarxa de Didit: que altres clients de Didit poden trobar mitjançant GET /v3/travel-rule/vasps/ i accessible pel canal INTERNAL. Per a poder-lo llistar també cal una aplicació en producció, Travel Rule activat, una raó social i un correu electrònic de compliment confirmat; didit_network indica quins falten. Per defecte és true." }, "threshold_amount": { "type": "string", "description": "Cadena decimal, zero o superior, en la moneda predeterminada de la teva aplicació. Import mínim de la transferència que activa un intercanvi gestionat." }, "ownership_validation_mode": { "type": "string", "enum": [ "FULL", "SIMPLIFIED", "AUTOMATED" ], "description": "Consulta el camp de la resposta amb el mateix nom." }, "simplified_validation_threshold": { "type": "string", "description": "Cadena decimal, 0 o més." }, "data_sharing_fields": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleDataSharingFields" } ], "description": "Es fusiona per tipus d'entitat: un tipus d'entitat que ometis manté la seva opció actual. Una opció que no pugui complir les obligacions de l'ordenant del teu règim de `jurisdiction` (EU TFR o FATF Recommendation 16), una llista buida inclosa, es rebutja amb `400`." }, "matching_rules": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleMatchingRules" } ], "description": "Es fusiona per tipus d'entitat i per camp dins d'aquest. Un camp que aquest tipus d'entitat no compara (per exemple, `date_of_birth` per a `company`) es rebutja amb `400`." }, "inbound_auto_accept": { "type": "boolean" }, "allow_self_declaration": { "type": "boolean" }, "allow_screenshot_proof": { "type": "boolean", "description": "Quan és cert, el widget de titularitat de la cartera ofereix la càrrega de captures de pantalla com a mètode de prova de titularitat. Per defecte cert." }, "auto_wallet_verification": { "type": "boolean" }, "vasp_attribution_enabled": { "type": "boolean" }, "counterparty_screening_enabled": { "type": "boolean", "description": "Cribratge opcional de sancions i mitjans adversos de VASP de les contraparts, facturat per cribratge al preu de Cribratge AML d'empreses. Quan està activat, Didit fa el cribratge de la contrapart a la qual arriba un intercanvi de sortida (reutilitzant un cribratge de menys de 30 dies) i pots fer-ne el cribratge d'una amb POST /v3/travel-rule/vasps/{vasp_id}/screening/. Per defecte false: no es fa cap cribratge ni es factura res." }, "sunrise_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "HOLD, REJECT, PROCEED, o buit per seguir timeout_outcome. Consulta el camp de resposta amb el mateix nom." }, "non_responsive_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "HOLD, REJECT, PROCEED, o buit per seguir timeout_outcome. Consulta el camp de resposta amb el mateix nom." }, "disabled_networks": { "type": "array", "items": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA" ] }, "description": "Xarxes que han desactivat la pertinença a la plataforma. No inhabilita les teves pertinences pròpies connectades ni aprovisiona xarxes no disponibles.", "default": [] } }, "description": "Tots els camps són opcionals; PUT aplica una actualització parcial." }, "WalletAddressEntry": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "address": { "type": "string", "description": "L'adreça de la cartera; `\"\"` per a una entrada importada només pel seu resum criptogràfic. Única per aplicació, cadena i memo, comparant l'adreça sense distingir majúscules de minúscules. Després de suprimir una entrada, pots tornar a registrar la mateixa adreça." }, "chain": { "type": "string", "description": "Token de cadena per a l'adreça, per exemple `ETH` o `BTC`. Quan Didit encamina o registra una transferència, fa coincidir les entrades de la llibreta d'adreces amb l'adreça de la cartera i, quan la transferència inclou una cadena, també amb aquest valor, ignorant majúscules i minúscules. La cadena d'una transferència és `beneficiary_data.chain`, que s'omple a partir de la cadena cripto de la transacció o del símbol de la moneda (per exemple, `ETH`) quan no l'envies, o del camp `chain` d'un registre posterior al dipòsit, de manera que has de fer servir el mateix token a tot arreu. Una entrada amb una cadena buida coincideix amb qualsevol cadena. Un beneficiari de Lightning (un id de node o una Lightning Address) registrat a bitcoin s'emmagatzema en minúscules a `LIGHTNING`, on es fan coincidir les transferències de Lightning. Les cadenes conegudes s'emmagatzemen sota un únic identificador canònic, independentment de com s'escriguin: \"ethereum\", \"Ethereum\" i \"ERC20\" s'emmagatzemen com a ETH; \"BNB Smart Chain\" i \"BEP20\" com a BNB; \"tron\" com a TRX. Els noms de cadena desconeguts es mantenen tal com s'han indicat." }, "holder_vendor_data": { "type": "string", "description": "El teu identificador intern per al titular." }, "holder_name": { "type": "string", "description": "Nom del titular de la cartera, utilitzat per a la coincidència del nom del beneficiari." }, "entity_type": { "type": "string", "description": "Text lliure, per defecte \"individual\"." }, "is_ownership_verified": { "type": "boolean", "description": "Només de lectura. Indica si s'ha demostrat la titularitat d'aquesta adreça." }, "created_at": { "type": "string", "format": "date-time" }, "travel_address": { "type": "string", "description": "La Travel Address del VASP contrapart per a aquesta cartera, si es coneix. Permet a Didit encaminar les transferències d'aquest beneficiari a través del canal TRP, per als actius que admet TRP (BTC, ETH i USDC en una xarxa designada)." }, "address_hash": { "type": "string", "description": "Només de lectura. SHA-256 de l'adreça en minúscules, en format hexadecimal en minúscules. Una entrada importada només pel seu hash s'hi emparella mitjançant aquest valor." }, "memo": { "type": "string", "description": "L'etiqueta de destinació o nota que forma part de la cartera en una xarxa de notes (XRP, XLM, EOS, ATOM, HBAR); `\"\"` per a tota l'adreça. Una entrada amb una nota només coincideix amb transferències que indiquin aquesta nota; una sense coincideix amb tota l'adreça." }, "receiving_travel_address": { "type": "string", "readOnly": true, "description": "La teva Travel Address específica per a aquesta cartera: proporciona-la al VASP remitent perquè la seva consulta TRP designi aquesta cartera. Està buida per a una cartera registrada com a pertanyent a un altre VASP, mentre Travel Rule estigui desactivada i abans que es desi el teu perfil de VASP." } } }, "WalletAddressEntryCreate": { "type": "object", "required": [ "address" ], "properties": { "address": { "type": "string", "maxLength": 128, "description": "L'adreça de la cartera. Una X-address de XRP s'emmagatzema com la seva adreça clàssica i la seva etiqueta, de manera que coincideix amb les transferències que mencionin qualsevol de les dues formes." }, "chain": { "type": "string", "maxLength": 32, "description": "Token de la blockchain per a l'adreça, per exemple `ETH` o `BTC`. Quan Didit enruta o registra una transferència, fa coincidir les entrades de la llibreta d'adreces amb l'adreça de la cartera i, si la transferència inclou una blockchain, també amb aquest valor, sense distingir majúscules de minúscules. La blockchain d'una transferència és `beneficiary_data.chain`, emplenada a partir de la blockchain de criptomonedes o el símbol de la moneda de la transacció (per exemple `ETH`) si no l'envies, o el `chain` d'un registre posterior al dipòsit, per la qual cosa cal utilitzar el mateix token arreu. Una entrada amb una blockchain buida coincideix amb qualsevol blockchain. Les blockchains conegudes s'emmagatzemen sota un identificador canònic, independentment de com s'escriguin: \"ethereum\", \"Ethereum\" i \"ERC20\" s'emmagatzemen com a ETH, \"BNB Smart Chain\" i \"BEP20\" com a BNB, i \"tron\" com a TRX. Un nom de blockchain desconegut es manté tal com s'ha proporcionat." }, "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": "Només escriptura. Quan és cert, l'entrada es crea ja amb la titularitat verificada mitjançant una prova de tipus SELF_DECLARATION. Retorna 400 quan `allow_self_declaration` està desactivat a la teva configuració de Travel Rule." }, "travel_address": { "type": "string", "description": "Opcional. La Travel Address del VASP de la contrapart per a aquesta cartera, que habilita l'encaminament TRP per als actius que transporta TRP (BTC, ETH i USDC en una xarxa designada). Una Travel Address no vàlida retorna 400.", "maxLength": 512 }, "memo": { "type": "string", "maxLength": 256, "description": "Opcional. L'etiqueta de destinació o memo que forma part de la cartera. XRP: una etiqueta de destinació, un nombre enter de 0 a 4294967295 (s'accepta un nombre JSON). XLM: un memo de text de fins a 28 bytes, un id de 64 bits o un hash de 32 bytes en hexadecimal. EOS: fins a 256 bytes. ATOM: fins a 256 caràcters. HBAR: fins a 100 bytes. Les carteres de Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin i Lightning no admeten memo: si se n'inclou un, es retorna un `400`. Àlies: `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": "El PATCH és una actualització parcial; la resposta només reprodueix holder_name, holder_vendor_data, entity_type, travel_address, receiving_travel_address, label i owner_type." }, "TravelRuleTransferDetail": { "type": "object", "description": "Objecte de transferència complet retornat pels endpoints de confirmació de titularitat i de finalització/cancel·lació. Mentre la titularitat de la cartera d'una transferència entrant no estigui confirmada, els camps `originator_data` i `beneficiary_data` de la contrapart es retornen emmascarats (es manté la primera lletra de cada paraula; la cartera, la cadena i l'encaminament del VASP continuen sent llegibles) i `data_masked` és 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": "El rail pel qual s'ha encaminat la transferència, o null quan no se n'ha seleccionat cap (per exemple, per sota del llindar, una cartera autoallotjada de la contrapart, un registre posterior al dipòsit o cap contrapart accessible). INTERNAL significa que ambdues parts són aplicacions de Didit; EMAIL significa que s'ha contactat amb la contrapart mitjançant un enllaç de recollida enviat per correu electrònic. TEST_VASP significa que el Didit Test VASP ha respost a la transferència de sandbox. A través de GTR, VERIFYVASP i SYGNA, Didit llegeix la resposta de la contrapart a partir de la resposta de la xarxa o fent-ne un sondeig cada 5 minuts. TRUST només envia, de manera que una transferència TRUST roman en AWAITING_COUNTERPARTY fins que caduca. Un rail de xarxa només s'utilitza quan has connectat la teva pròpia afiliació a aquesta xarxa. Es tria després que la creació de la transacció retorni, de manera que és null en aquesta resposta." }, "protocol": { "type": "string", "nullable": true }, "ivms_version": { "type": "string", "example": "ivms101.2023" }, "required": { "type": "boolean" }, "ownership_confirmed": { "type": "boolean", "nullable": true }, "deadline_at": { "type": "string", "format": "date-time", "nullable": true }, "timeline": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "at": { "type": "string", "format": "date-time" }, "detail": { "type": "string" }, "name_match": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleNameMatch" } ], "nullable": true, "description": "La comparació de noms que aquesta entrada ha decidit, al costat de `detail`. Absent en les entrades que no han comparat cap nom." }, "reason": { "type": "string", "description": "Present només a l'entrada d'una transició causada per un lliurament fallit: `email_undeliverable` o `delivery_failed`, el valor que informa el camp `reason` de la transferència." } } } }, "counterparty_vasp": { "type": "object", "nullable": true, "properties": { "name": { "type": "string" }, "lei": { "type": "string" }, "dd_score": { "type": "integer", "description": "Puntuació de diligència deguda de 0 a 100, on un valor més alt és millor. La mateixa escala que al directori de VASP." }, "dd_score_breakdown": { "type": "object", "description": "Contribucions per component a dd_score, un objecte per component tal com apareix al directori de VASP (jurisdiction, verification, protocol, lei, history, essentials, responsiveness), cadascun amb {points, max, reason, detail}. {} fins que s'hagi avaluat la contrapart.", "additionalProperties": { "type": "object", "properties": { "points": { "type": "number", "description": "Punts atorgats per a aquest component." }, "max": { "type": "integer", "description": "Nombre màxim de punts que pot atorgar aquest component." }, "reason": { "type": "string", "description": "Codi llegible per màquina del veredicte del component." }, "detail": { "type": "string", "description": "Motiu dels punts atorgats, llegible per a humans." } } } }, "dd_assessed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va executar per darrera vegada l'avaluació de diligència deguda. Null fins que s'hagi avaluat la contrapart." } } }, "originator_data": { "type": "object", "description": "Part ordenant. Per a una transferència entrant, els valors de la contrapart s'emmascaren fins que se'n confirmi la titularitat." }, "beneficiary_data": { "type": "object", "description": "Part beneficiària. Per a una transferència entrant, els valors de la contrapart s'emmascaren fins que es confirmi la titularitat." }, "name_match": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleNameMatch" } ], "nullable": true, "description": "La comparació de noms que ha decidit la transferència, o null fins que se n'hagi executat una. Mentre les parts estan emmascarades, i a la còpia de l'altre client d'un intercanvi INTERNAL, `transfer_name`, `compared_name`, `matched_names` i `mismatched_names` s'oculten. `score` i `matched` poden discrepar: `matched` segueix l'estrictesa, `score` és la similitud dels dos noms complets." }, "data_match": { "$ref": "#/components/schemas/TravelRuleDataMatch" }, "mismatched_fields": { "type": "array", "items": { "type": "string" }, "description": "Drecera per a `data_match.mismatched_fields`. Buit quan no hi ha cap diferència." }, "data_unmasked": { "$ref": "#/components/schemas/TravelRuleDataUnmasked" }, "data_masked": { "type": "boolean", "description": "Cert mentre les dades personals de la contrapart estiguin emmascarades en aquesta resposta." }, "created_at": { "type": "string", "format": "date-time" }, "delivery": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TravelRuleDelivery" } ], "description": "Estat en què es troba l'últim missatge que aquesta transferència deu a l'altra part. És nul quan la transferència mai no n'ha degut cap (per exemple, per sota de `threshold_amount`, una cartera autoallotjada declarada o un registre de sunrise)." }, "discovery": { "type": "array", "description": "Com Didit ha cercat la contrapart, una entrada per cada pas que s'ha executat. Buit quan no s'ha executat cap descobriment, per exemple en una transferència entrant.", "items": { "$ref": "#/components/schemas/TravelRuleDiscoveryStep" } }, "reason": { "type": "string", "description": "Per què una transferència `COUNTERPARTY_VASP_NOT_FOUND` o `COUNTERPARTY_VASP_NOT_REACHABLE` està encallada; `\"\"` per a qualsevol altre estat. Un lliurament fallit ho determina primer, només a `COUNTERPARTY_VASP_NOT_REACHABLE`: `email_undeliverable` (el proveïdor de correu ha refusat el correu electrònic de compliment i no queda cap adreça per provar: quan s'ha enviat, en un recordatori o com un rebot permanent notificat més tard) o `delivery_failed` (el canal que l'estava lliurant ha fallat definitivament: un canal de xarxa ha refusat el missatge o s'ha quedat sense reintents, un host d'identitat `TRP` no ha respost o l'host `TRP` de la contrapart no ha acceptat la consulta). En cas contrari, el rastreig de `discovery` ho determina: `awaiting_end_user` (cap pas ha indicat una contrapart a la qual Didit pugui arribar), `directory_match_no_route` (un pas ha indicat un VASP del directori que no té ruta), `picked_member_without_proven_wallet` (l'usuari final ha triat un client de Didit que no ha demostrat el control de la cartera) o `no_directory_match` quan el rastreig no dóna cap altre motiu. Un reenviament fa avançar la transferència, de manera que el motiu s'esborra. Consulta [Per què una transferència està encallada](/ca/transaction-monitoring/travel-rule#per-què-una-transferència-està-bloquejada)." }, "next_actions": { "type": "array", "description": "Què fa avançar la transferència; `[]` per a qualsevol estat excepte `COUNTERPARTY_VASP_NOT_FOUND` o `COUNTERPARTY_VASP_NOT_REACHABLE`. `email_undeliverable` ofereix `update_compliance_email` i després `resend`. `delivery_failed` ofereix `resend`. Un motiu de descobriment ofereix `select_counterparty_vasp`, `declare_self_hosted`, `add_vasp_hint` i `resend`.", "items": { "$ref": "#/components/schemas/TravelRuleNextAction" } }, "chain_details": { "$ref": "#/components/schemas/TravelRuleChainDetails" } } }, "TravelRuleOwnershipConfirmRequest": { "type": "object", "required": [ "confirmed" ], "properties": { "confirmed": { "type": "boolean", "description": "true per confirmar la titularitat, false per denegar-la." }, "wallet_address": { "type": "string", "default": "", "description": "Transferències TRP entrants: l'adreça de pagament que Didit retorna al VASP ordenant quan aproves. Per defecte és l'adreça de l'entrada coincident de la llibreta d'adreces, i després beneficiary_data.wallet_address. En una transferència declarada amb cartera autoallotjada que no especifica cap cartera de la contrapart, la cartera de la qual has verificat la titularitat; sense aquesta, la sol·licitud es rebutja amb un 400. S'ignora per a altres transferències." } } }, "TravelRuleTransferPatchRequest": { "type": "object", "description": "Proporciona exactament un d'aquests valors: payment_txn_id (finalitzar), action=cancel, action=resend, action=update_compliance_email amb compliance_email, action=update_originator_wallet amb wallet_address, o action=beneficiary_vasp amb beneficiary_vasp.", "properties": { "payment_txn_id": { "type": "string", "description": "El hash de la transacció on-chain. Requereix que la transferència sigui una transferència sortint en estat COMPLETED." }, "action": { "type": "string", "enum": [ "cancel", "resend", "update_compliance_email", "update_originator_wallet", "beneficiary_vasp" ], "description": "\"cancel\" cancel·la una transferència que no es troba en un estat terminal. \"resend\" torna a executar l'encaminament d'una transferència de sortida bloquejada en l'estat COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE o NOT_ENOUGH_COUNTERPARTY_DATA. \"update_compliance_email\" substitueix el correu electrònic de compliment al qual s'envia la sol·licitud, en una transferència de sortida en un d'aquests tres estats; envia \"resend\" després. \"update_originator_wallet\" registra la cartera des d'on han sortit realment els fons (`wallet_address`, `memo`). \"beneficiary_vasp\" designa el VASP contrapart tu mateix (requereix `beneficiary_vasp`) per a una transferència de sortida en un d'aquests estats: s'encamina a aquest VASP i es torna a enviar." }, "compliance_email": { "type": "string", "format": "email", "maxLength": 254, "description": "Obligatori amb `action: update_compliance_email`. Es desa com el `beneficiary_data.counterparty_vasp_email` d'aquesta transferència: pertany únicament a aquesta transferència i no s'afegeix a cap entrada de directori ni a cap llista de contactes." }, "wallet_address": { "type": "string", "maxLength": 128, "description": "Amb `action: update_originator_wallet`: la cartera des d'on han sortit els fons. Quan es coneixen les entrades UTXO de la transferència, ha de ser una d'elles." }, "memo": { "type": "string", "maxLength": 256, "description": "Amb `action: update_originator_wallet`: el memo o l'etiqueta de la cartera en una xarxa amb memo. Opcional." }, "beneficiary_vasp": { "type": "string", "format": "uuid", "description": "Obligatori amb action=beneficiary_vasp: l'`id` d'un VASP del directori, obtingut de `GET /v3/travel-rule/vasps/`. La teva selecció té prioritat sobre qualsevol pas de descobriment automàtic, que mai la sobreescriurà." } } }, "VaspDirectoryEntry": { "type": "object", "description": "Un VASP del directori o un membre de la xarxa Didit, amb les rutes que la teva aplicació hi té. Un client només és membre de la xarxa Didit mentre la seva aplicació està en producció, té la Travel Rule activada, el seu perfil es pot trobar, té un nom legal i un correu electrònic de compliment confirmat, i Didit no ha marcat l'aplicació com de prova, demo o interna. Cada fila també inclou l'avaluació de diligència deguda compartida (dd_score, risk_level, responsiveness, essential_checks) i la decisió, el cribratge d'entitats i els qüestionaris propis de la teva aplicació, que cap altre client pot veure.", "properties": { "id": { "type": "string", "format": "uuid", "description": "L'identificador de l'entrada, per a GET /v3/travel-rule/vasps/{vasp_id}/." }, "kind": { "type": "string", "enum": [ "directory", "didit" ], "description": "directory per a una entrada del directori compartit; didit per a un membre de la xarxa Didit." }, "name": { "type": "string" }, "lei": { "type": "string" }, "jurisdiction": { "type": "string", "description": "Codi de país ISO 3166, tal com el proporciona la font." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Els dominis web del VASP. Sempre buits per als membres de la xarxa de Didit." }, "reachable": { "type": "boolean", "description": "Indica si la teva aplicació té una ruta disponible cap a aquest VASP, o cap a una de les seves entitats per a una marca. Sempre true per a un membre de la xarxa de Didit, excepte en una aplicació de sandbox, on cada fila és 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 registre global de LEI), network_name (el nom en una xarxa de Travel Rule), attribution (el nom de l'entitat que l'anàlisi de blockchain assigna a les carteres del VASP), merged (el nom d'una entrada duplicada fusionada en aquesta) o staff." } } }, "description": "Altres noms amb els quals es pot trobar el VASP." }, "networks": { "type": "array", "items": { "type": "object", "description": "Un registre actual d'aquest VASP al directori de membres d'una xarxa de Travel Rule. Un registre de TRISA indica qui és el VASP a TRISA; Didit no té cap rail de TRISA, de manera que mai és una ruta.", "properties": { "network": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA", "TRISA" ] }, "code": { "type": "string", "description": "L'identificador del VASP en aquesta xarxa." }, "listed_name": { "type": "string", "description": "El nom sota el qual la xarxa llista el VASP." }, "country": { "type": "string", "description": "El país que indica la xarxa, quan en proporciona un." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan el personal de Didit ha verificat el registre. Nul per als registres llegits d'un directori públic." }, "last_seen_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan la font va mostrar el registre per darrera vegada. Un registre que la font no hagi mostrat durant tres setmanes s'elimina." }, "source": { "type": "string", "enum": [ "trisa_directory", "staff" ], "description": "D'on prové l'entrada: el directori públic de TRISA o el personal de Didit." } } } }, "routes": { "type": "array", "items": { "type": "object", "description": "Una via per la qual la teva aplicació pot lliurar dades de Travel Rule a aquest VASP, en l'ordre en què l'enviament les prova. Una ruta de xarxa necessita ser membre d'aquesta xarxa: la teva pròpia (connectada al Marketplace) o la de Didit un cop Didit en tingui una. Sense ella, la ruta apareix com a no disponible amb el motiu, mai com una via per arribar 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": "Per què no es pot utilitzar una ruta no disponible: no_membership (ni tu ni Didit sou membres d'aquesta xarxa), network_switched_off (has desactivat aquesta xarxa a la teva configuració) o sandbox_application (una aplicació de sandbox només envia al VASP de prova de Didit, per la qual cosa no té cap ruta disponible). Buit quan la ruta està disponible." }, "via": { "type": "string", "enum": [ "", "own_membership", "didit_membership", "directory", "contact", "didit_network" ], "description": "Com s'arriba a una ruta disponible: own_membership o didit_membership per a una via de xarxa, directory per a un endpoint TRP que el directori ha verificat, contact per a la via EMAIL, didit_network per a un membre de la xarxa de Didit. Buit quan la ruta no està disponible." } } } }, "umbrella": { "type": "object", "nullable": true, "description": "La marca de la qual aquesta entrada és una entitat regulada. Null quan no forma part de cap.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "entities": { "type": "array", "items": { "type": "object", "description": "Una entitat regulada d'una marca: l'entitat jurídica que rep una transferència.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "lei": { "type": "string" }, "jurisdiction": { "type": "string" }, "reachable": { "type": "boolean", "description": "Indica si la teva aplicació té una ruta disponible cap a aquesta aplicació." } } }, "description": "Per a una marca, les entitats regulades que reben les seves transferències. Una transferència que anomena la marca va a l'entitat accessible a la jurisdicció que indica (beneficiary_data.counterparty_vasp_jurisdiction); si no, a l'entitat que l'atribució analítica de blockchain ha vinculat a la cartera de destinació; si no, a l'única entitat accessible quan no s'indica cap jurisdicció. Si dues entitats són igualment adequades, mai no se'n tria una per conjectura." }, "contacts": { "type": "array", "items": { "type": "object", "description": "Un contacte de compliment on el rail EMAIL pot escriure.", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" }, "source": { "type": "string", "enum": [ "staff", "application", "learned" ], "description": "staff: seleccionat per Didit; application: afegit per la teva aplicació; learned: una adreça que ha respost a una sol·licitud de Travel Rule a través del seu enllaç de resposta." }, "scope": { "type": "string", "enum": [ "platform", "application" ], "description": "els contactes de plataforma s'utilitzen per a les transferències de tots els clients de Didit; els contactes d'aplicació són privats per a la teva aplicació, que només veu els seus propis." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan algú en aquesta adreça va respondre a una sol·licitud. Null quan encara no ho ha fet." } } }, "description": "Els contactes de la plataforma per a aquest VASP i els propis de la teva aplicació." }, "dd_status": { "type": "string", "enum": [ "NOT_STARTED", "IN_PROGRESS", "COMPLETED", "REJECTED" ], "description": "Estat de verificació de Didit de l'entrada, puntuat pel component de verificació de dd_score. Sempre COMPLETED per a un membre de la xarxa de Didit." }, "dd_score": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 100, "description": "La puntuació compartida de diligència deguda d'una entrada del directori, de 0 a 100, on un valor més alt és més segur (consulta dd_score_semantic): la suma dels punts a dd_score_breakdown. Null per a un membre de la xarxa Didit, que no es puntua. Una entrada que encara no s'ha avaluat (dd_assessed_at null) mostra 0 amb un risk_level buit, així que consulta risk_level en lloc de la puntuació en brut." }, "reachable_rails": { "type": "array", "items": { "type": "string", "enum": [ "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL" ] }, "description": "Canals registrats a l'entrada. Consulta les rutes per veure què pot utilitzar la teva aplicació avui." }, "is_didit_customer": { "type": "boolean", "description": "true per a un membre de la xarxa Didit (dd_status sempre és COMPLETED, dd_score null i risk_level buit en aquests casos) i per a una entrada del directori vinculada a un client de Didit." }, "dd_score_breakdown": { "type": "object", "description": "Un objecte per component de dd_score. Components, el seu pes (màx.) i els seus codis de motiu: 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). Buit per a un membre de la xarxa de Didit.", "additionalProperties": { "type": "object", "properties": { "points": { "type": "number", "description": "Punts que aporta el component, arrodonits a una xifra decimal." }, "max": { "type": "integer", "description": "El pes del component: els punts que aporta com a màxim." }, "reason": { "type": "string", "description": "Codi llegible per màquina del veredicte del component." }, "detail": { "type": "string", "description": "Explicació d'una línia en anglès." } } } }, "dd_assessed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es van calcular per darrera vegada dd_score, risk_level i responsiveness: després que un intercanvi amb l'entrada es completi, finalitzi, caduqui, no coincideixi o es rebutgi, quan Didit actualitza o gestiona l'entrada, i en l'actualització setmanal del directori. Null per a un membre de la xarxa Didit." }, "dd_score_semantic": { "type": "string", "enum": [ "higher_is_safer" ], "description": "En quin sentit apunta dd_score: sempre higher_is_safer." }, "risk_level": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH", "" ], "description": "La franja en què cau dd_score: LOW (70 o més), MEDIUM (de 40 a 69) o HIGH (per sota de 40). Buit per a un membre de la xarxa de Didit i per a una entrada encara no avaluada. Filtra per aquest valor amb risk. El cribratge que has marcat mai no canvia aquest valor compartit: en comptes d'això, fa que counterparty_risk_level sigui HIGH a les teves regles." }, "responsiveness": { "type": "object", "description": "Indica si el VASP respon a les sol·licituds de Travel Rule: la proporció de sol·licituds iniciades pels clients de Didit cap a ell en els darrers 90 dies a les quals ha respost. Només compten les sol·licituds enviades a través d'una xarxa o via de protocol, o per correu electrònic a una adreça compartida (l'adreça de compliment de l'entrada o un contacte de la plataforma); una sol·licitud enviada a una adreça que hagi escrit un client, o al contacte privat d'un client, no compta mai. Una sol·licitud caducada es considera no contestada; un intercanvi completat, un rebuig o una discrepància de dades és una resposta; una sol·licitud cancel·lada o una via inaccessible no és cap de les dues coses. Sempre és UNKNOWN amb recomptes a zero per a un membre de la xarxa de Didit.", "properties": { "status": { "type": "string", "enum": [ "RESPONSIVE", "UNRESPONSIVE", "UNKNOWN" ], "description": "UNKNOWN amb menys de 5 sol·licituds decidides a la finestra temporal; UNRESPONSIVE quan se n'han respost menys del 10 per cent; altrament, RESPONSIVE." }, "answered": { "type": "integer", "description": "Sol·licituds decidides a la finestra que el VASP ha respost." }, "total": { "type": "integer", "description": "Sol·licituds decidides a la finestra: respostes més les caducades." }, "computed_at": { "type": "string", "format": "date-time", "nullable": true } } }, "essential_checks": { "type": "object", "description": "L'informe de comprovacions essencials d'una entrada de directori, elaborat exclusivament a partir de les fonts verificades de la plataforma: registre (un registre oficial llista el VASP: el registre provisional de MiCA de la UE, el directori públic de TRISA o el registre global de LEI), llicència (hi ha una autorització MiCA registrada i vigent), domini (el domini de l'entrada coincideix amb el seu endpoint de TRP o amb el lloc web que indica el seu registre) i lei (el seu registre LEI està actiu, emès i és coherent amb els noms i el país de l'entrada). El component essentials de dd_score és la proporció de comprovacions resoltes que resulten favorables. Està buit fins que l'actualització setmanal del directori comprova l'entrada per primera vegada, i sempre està buit per a un membre de la xarxa 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 quan cap font registrada pot determinar la comprovació." }, "reason": { "type": "string", "description": "Codi llegible per màquina del veredicte." }, "detail": { "type": "string", "description": "Explicació d'una línia en anglès." } } } }, "passed": { "type": "integer" }, "failed": { "type": "integer" }, "unknown": { "type": "integer" }, "total": { "type": "integer" } } }, "decision": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyDecision" } ], "nullable": true, "description": "La decisió de la teva aplicació sobre aquest VASP, o per a una entitat sense decisió pròpia, la de la seva marca (inherited_from indica la marca). Null quan no n'hi ha cap. Privada per a la teva aplicació." }, "entity_screening": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyScreening" } ], "nullable": true, "description": "L'últim cribratge de sancions i mitjans adversos de la teva aplicació sobre aquest VASP. Null si mai no n'has fet el cribratge. Privat per a la teva aplicació." }, "questionnaires": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleCounterpartyQuestionnaire" }, "description": "Els qüestionaris de diligència deguda de la teva aplicació amb aquest VASP, els més recents primer. Privats per a la teva aplicació." } }, "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ó de la teva aplicació sobre un VASP de contrapart. Privada per a la teva aplicació: mai canvia l'entrada compartida del directori i cap altre client no la veu. Només actua mitjançant les teves regles de transacció (el camp de regla counterparty_dd_status i els valors predefinits travel-rule-counterparty-blocked i travel-rule-counterparty-restricted); mai canvia com s'enruta una transferència.", "properties": { "decision": { "type": "string", "enum": [ "APPROVED", "RESTRICTED", "BLOCKED" ], "description": "APPROVED: el teu equip ha autoritzat la contrapart. RESTRICTED: les transferències cap a ella poden tirar endavant després de la revisió. BLOCKED: el teu equip l'ha rebutjat." }, "reason": { "type": "string", "maxLength": 255, "description": "Motiu de text lliure que has indicat; buit si no n'hi ha cap." }, "decided_by": { "type": "string", "description": "L'usuari de la consola que ha pres o ha modificat per darrera vegada la decisió. Buit quan l'ha pres una clau d'API." }, "updated_at": { "type": "string", "format": "date-time" }, "inherited_from": { "type": "object", "nullable": true, "description": "La marca la decisió de la qual segueix aquesta entitat perquè no n'has pres cap sobre la pròpia entitat. Null quan la decisió és pròpia de la contrapart.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } } } }, "TravelRuleCounterpartyDecisionResponse": { "type": "object", "properties": { "decision": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyDecision" } ], "nullable": true, "description": "La decisió que s'aplica a la contrapart per a la teva aplicació: la seva pròpia o, altrament (per a una entitat d'una marca), la de la marca. Null quan no n'hi ha cap." } } }, "TravelRuleCounterpartyDecisionRequest": { "type": "object", "required": [ "decision" ], "properties": { "decision": { "type": "string", "enum": [ "APPROVED", "RESTRICTED", "BLOCKED" ] }, "reason": { "type": "string", "maxLength": 255, "description": "Opcional. Substitueix el motiu anterior; omet-lo per esborrar-lo." } } }, "TravelRuleCounterpartyScreening": { "type": "object", "description": "Un cribratge de sancions i mitjans adversos de l'entitat contrapart, executat per a la teva aplicació i facturat a aquesta. Privat per a la teva aplicació: un altre client mai no el veu.", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Aprovada: cap coincidència possible requereix atenció. En revisió o Rebutjada: possible coincidència amb sancions o mitjans adversos." }, "total_hits": { "type": "integer", "description": "Quantes possibles coincidències ha retornat el cribratge." }, "score": { "type": "number", "nullable": true, "description": "La puntuació de risc més alta d'entre les possibles coincidències. Null quan no hi ha hagut cap coincidència." }, "screened_at": { "type": "string", "format": "date-time" }, "fresh": { "type": "boolean", "description": "Si el cribratge és més recent que fresh_days (30 dies). Un cribratge recent es reutilitza en lloc de facturar-se de nou." }, "flagged": { "type": "boolean", "description": "true mentre el cribratge sigui recent i el seu estat sigui In Review o Declined. Mentre el teu últim cribratge estigui marcat i el cribratge de contraparts es mantingui actiu, counterparty_risk_level serà HIGH a les teves regles." } } }, "TravelRuleCounterpartyScreeningStatus": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "La teva configuració counterparty_screening_enabled de Travel Rule. Desactivada per defecte; no es fa cap cribratge ni es factura res mentre estigui desactivada." }, "price": { "type": "string", "description": "Cadena decimal, en USD: el que costa un cribratge a la teva organització, el preu del Cribratge AML d'empreses." }, "fresh_days": { "type": "integer", "description": "Quants dies es manté vigent un cribratge i es reutilitza." }, "screening": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyScreening" } ], "nullable": true, "description": "El teu darrer cribratge de la contrapart. Null si no n'has fet mai cap cribratge." } } }, "TravelRuleCounterpartyScreeningRequest": { "type": "object", "properties": { "refresh": { "type": "boolean", "default": false, "description": "true torna a cribrar (i torna a facturar) fins i tot quan existeix un cribratge recent." } } }, "TravelRuleCounterpartyScreeningResult": { "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "screened", "reused" ], "description": "screened: s'ha executat un nou cribratge i s'ha facturat (201). reused: s'ha retornat un cribratge recent i no s'ha facturat res (200)." }, "screening": { "$ref": "#/components/schemas/TravelRuleCounterpartyScreening" } } }, "TravelRuleCounterpartyQuestionnaire": { "type": "object", "description": "Un qüestionari de diligència deguda que la teva aplicació ha enviat a la contrapart: el qüestionari estàndard de Didit, enviat per correu electrònic a una adreça de compliment registrada amb un enllaç de resposta d'un sol ús. Privat per a la teva aplicació.", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "SENT", "ANSWERED", "EXPIRED" ], "description": "SENT: esperant respostes. ANSWERED: la contrapart ha respost a totes les preguntes. EXPIRED: l'enllaç de resposta s'ha tancat sense respondre (ha vençut el termini o l'ha substituït un qüestionari més recent), o les respostes han superat valid_until." }, "form_version": { "type": "string", "description": "Versió del qüestionari estàndard de Didit al qual pertanyen les respostes. Actualment 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 data límit per respondre, 30 dies després de l'enviament. L'enllaç deixa de funcionar a partir d'aquesta data." }, "answered_at": { "type": "string", "format": "date-time", "nullable": true }, "valid_until": { "type": "string", "format": "date-time", "nullable": true, "description": "Quant de temps es mantenen vigents les respostes: 365 dies després de respondre. Null fins que es respon." }, "current": { "type": "boolean", "description": "true mentre el qüestionari estigui en estat ANSWERED i no hagi superat valid_until." }, "answers": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Les respostes indexades per id de pregunta: legal_name, licensing, jurisdictions, aml_program, compliance_officer, sanctions_screening, transaction_monitoring, travel_rule, custody, ownership, record_keeping, data_protection. Cada resposta té fins a 2.000 caràcters. Buit fins que es respongui." } } }, "TravelRuleCounterpartyQuestionnaireRequest": { "type": "object", "properties": { "sent_to": { "type": "string", "format": "email", "description": "Opcional. Una adreça de compliment registrada per a la contrapart: per a una entrada del directori, la seva adreça de compliment o un contacte que la teva aplicació vegi; per a un membre de la xarxa de Didit, el seu correu electrònic de compliment confirmat. Predeterminat: l'adreça a la qual s'envia un correu electrònic de Travel Rule a la contrapart (primer el teu propi contacte, després un contacte de la plataforma i, finalment, l'adreça de compliment de l'entrada)." } } }, "TravelRuleCounterpartyQuestionnaireList": { "type": "object", "properties": { "questionnaires": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleCounterpartyQuestionnaire" }, "description": "Els més recents primer." } } }, "TravelRulePickupInfo": { "type": "object", "description": "L'intercanvi pendent darrere d'un enllaç de recollida enviat per correu electrònic, tal com el mostra la pàgina de resposta de la contrapart.", "properties": { "reference": { "type": "string", "format": "uuid", "description": "L'uuid de la transferència, tal com el mostra la consola del VASP emissor." }, "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 contrapart al qual s'adreça la sol·licitud." }, "language": { "type": "string", "description": "L'idioma del correu electrònic de sol·licitud i de la pàgina de resposta, a partir de la jurisdicció de la contrapart." }, "amount": { "type": "string" }, "currency": { "type": "string" }, "fiat_amount": { "type": "string", "description": "El valor convertit que ha indicat el remitent, o buit." }, "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": "Quan l'enllaç deixa de respondre." }, "reminders_sent": { "type": "integer" }, "contact": { "type": "string", "description": "El valor `?contact=` de l'enllaç, retornat; buit si l'enllaç no en té cap." }, "decline_reasons": { "type": "array", "items": { "type": "string", "enum": [ "data_mismatch", "not_our_customer", "wallet_not_hosted", "sanctions", "risk_appetite", "jurisdiction", "insufficient_data", "other" ] }, "description": "Els valors que accepta `decline_reason`." }, "join_invitation": { "type": "object", "description": "Indica si la contrapart té una invitació activa per unir-se a Didit de franc. L'enllaç d'invitació només viatja en el correu electrònic a l'adreça convidada, de manera que `url` és buit aquí.", "properties": { "eligible": { "type": "boolean" }, "url": { "type": "string" } } }, "originator_data": { "type": "object", "description": "Els camps de l'ordenant que el VASP emissor comparteix (`data_sharing_fields`). El nom i la cartera s'inclouen sempre." }, "beneficiary_data": { "type": "object" }, "ivms_request": { "type": "object", "description": "La mateixa sol·licitud com a objecte IVMS 101. S'omet mentre `data_masked` sigui true." }, "data_masked": { "type": "boolean", "description": "Sempre false en aquest endpoint: una sol·licitud per correu electrònic és sortint, i el propi usuari del remitent mai s'emmascara." } } }, "TravelRulePickupRespondRequest": { "type": "object", "required": [ "decision" ], "properties": { "decision": { "type": "string", "enum": [ "accept", "decline" ] }, "beneficiary_name": { "type": "string", "description": "El nom del beneficiari tal com figura als teus registres, passat per la regla de noms del VASP emissor. `ivms_response` té prioritat quan indica el beneficiari.", "maxLength": 255 }, "decline_reason": { "type": "string", "enum": [ "", "data_mismatch", "not_our_customer", "wallet_not_hosted", "sanctions", "risk_appetite", "jurisdiction", "insufficient_data", "other" ], "description": "Per què rebutges. Es registra a la cronologia de transferències del VASP emissor. Buit (per defecte) quan no indiques cap motiu." }, "decline_detail": { "type": "string", "maxLength": 512, "description": "Text lliure; obligatori quan `decision` és `decline` i `decline_reason` és `other`." }, "ivms_response": { "type": "object", "description": "La teva resposta IVMS 101 completa. El seu nom de beneficiari té prioritat sobre `beneficiary_name`." }, "contact": { "type": "string", "format": "uuid", "description": "El contacte al qual s'ha enviat l'enllaç, a partir del valor `?contact=` de l'enllaç. Quan el cos l'omet, s'utilitza el paràmetre de consulta `contact`." } } }, "TravelRuleInboundRequest": { "type": "object", "required": [ "chain", "txid", "wallet_address", "amount", "currency" ], "properties": { "chain": { "type": "string", "description": "Cadena en què s'ha liquidat el dipòsit, per exemple `ETH`. S'emmagatzema en minúscules i es compara sense distingir majúscules de minúscules amb les entrades de la llibreta d'adreces de carteres, així que fes servir el mateix token de cadena allà.", "maxLength": 32 }, "txid": { "type": "string", "description": "Hash de la transacció on-chain. Desduplicat juntament amb wallet_address.", "maxLength": 128 }, "wallet_address": { "type": "string", "description": "La cartera de destinació on has rebut el dipòsit. Una X-address d'XRP es divideix en la seva adreça clàssica i l'etiqueta.", "maxLength": 128 }, "amount": { "type": "string", "description": "Import del dipòsit com a cadena decimal, zero o superior, amb fins a 18 xifres decimals." }, "currency": { "type": "string", "description": "Actiu del dipòsit, p. ex. \"USDC\".", "maxLength": 16 }, "originator_data": { "type": "object", "description": "Detalls de l'ordenant proporcionats pel VASP emissor, si es coneixen, com a objecte pla com ara `{\"name\": \"...\"}`. Didit en llegeix name (o full_name), first_name, last_name i vendor_data.", "additionalProperties": true }, "beneficiary_data": { "type": "object", "description": "Detalls del beneficiari (el teu client), com a objecte pla com ara `{\"name\": \"...\"}`. Didit compara el nom amb el holder_name de l'entrada coincident de la llibreta d'adreces, i estableix wallet_address i chain a partir de la sol·licitud.", "additionalProperties": true }, "originating_vasp": { "type": "object", "description": "Descripció opcional del VASP emissor. Es manté només en aquesta transferència (`metadata.originating_vasp`, i el VASP ordenant de la transferència a GET /v3/travel-rule/transfers/); mai crea, edita ni enllaça una entrada compartida del directori de VASP.", "properties": { "name": { "type": "string", "maxLength": 255 }, "lei": { "type": "string", "maxLength": 20, "description": "Opcional. Un LEI ISO 17442 vàlid de 20 caràcters, o buit." }, "travel_address": { "type": "string", "description": "La Travel Address del remitent, registrada en aquesta transferència.", "maxLength": 512 } } }, "memo": { "type": "string", "maxLength": 256, "description": "Opcional. L'etiqueta de destinació o memo del dipòsit en una xarxa basada en memos: en una adreça de dipòsit compartida és el que permet distingir els teus clients, i es fa coincidir l'entrada de la llibreta d'adreces corresponent a aquest memo. XRP: una etiqueta de destinació, un nombre enter de 0 a 4294967295 (s'accepta un número JSON). XLM: un memo de text de fins a 28 bytes, un ID de 64 bits o un hash de 32 bytes en hex. EOS: fins a 256 bytes. ATOM: fins a 256 caràcters. HBAR: fins a 100 bytes. Les carteres de Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin i Lightning no admeten memo: incloure'n un retorna un `400`. Àlies: `destinationTag` o `destination_tag`." }, "utxo": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleUtxo" } ], "description": "Opcional, només per a cadenes UTXO. Les entrades i sortides de la transacció de dipòsit: la cartera del remitent és la declarada a `originator_data.wallet_address`; en cas contrari, l'entrada més gran." } } }, "TravelRuleInboundResponse": { "type": "object", "properties": { "transaction_id": { "type": "string", "format": "uuid", "description": "UUID de transacció de Didit per al dipòsit entrant." }, "txn_id": { "type": "string", "description": "txn_id de la transacció entrant: generat per Didit quan Didit ha creat la transacció, o el teu propi quan s'ha reutilitzat un dipòsit no reclamat." }, "created": { "type": "boolean", "description": "true quan aquesta crida ha registrat la transferència (HTTP 201); false quan ja existia una transferència per al mateix txid i wallet_address (HTTP 200)." }, "travel_rule": { "$ref": "#/components/schemas/TravelRuleTransferDetail" } } }, "TravelRuleTestVaspInboundRequest": { "type": "object", "required": [ "beneficiary_wallet_address" ], "properties": { "beneficiary_wallet_address": { "type": "string", "description": "L'adreça de destinació. El Didit Test VASP hi fa l'enviament, contrastada amb la teva llibreta d'adreces a la blockchain de l'actiu. Una cartera sense cap entrada coincident s'accepta i la transacció entrant es registra com a ON_HOLD." }, "scenario": { "type": "string", "enum": [ "accept", "name_mismatch" ], "default": "accept", "description": "Què declara el Didit Test VASP que és el beneficiari. `accept` declara el nom del mateix titular; `name_mismatch` declara un nom amb el qual cap titular està d'acord. La decisió en si sempre és teva." }, "chain": { "type": "string", "default": "ETH", "description": "Cadena de l'actiu." }, "amount": { "type": "string", "default": "1", "description": "Import com a cadena decimal." }, "currency": { "type": "string", "default": "ETH", "description": "Codi de l'actiu." }, "reference": { "type": "string", "description": "Clau d'idempotència opcional. Si es repeteix amb el mateix valor, retorna la transferència que la primera crida va registrar." } } }, "TravelRuleTestVaspInboundResponse": { "type": "object", "properties": { "transaction_id": { "type": "string", "format": "uuid", "description": "UUID de transacció de Didit de la transferència entrant." }, "txn_id": { "type": "string", "description": "txn_id generat per Didit." }, "scenario": { "type": "string", "description": "L'escenari que s'ha executat." }, "travel_rule_status": { "type": "string", "description": "L'estat en què s'ha resolt la decisió de la teva aplicació." }, "detail": { "type": "string", "description": "Per què la transferència s'ha resolt amb aquest estat." }, "test_vasp": { "type": "boolean", "description": "Sempre true: el remitent ha estat el VASP de proves de Didit." }, "travel_rule": { "$ref": "#/components/schemas/TravelRuleTransferDetail" } } }, "TravelRuleWidgetSessionCreate": { "type": "object", "properties": { "wallet_address": { "type": "string", "description": "L'adreça de la cartera que s'ha de verificar. Opcional; quan està buida, s'ha de proporcionar l'adreça quan s'inicia una prova.", "maxLength": 128 }, "chain": { "type": "string", "description": "Token de la blockchain per a l'adreça, per exemple `ETH`, `BTC` o `SOL`. Utilitza el mateix token que a la teva llibreta d'adreces de carteres. La signatura de missatges i la prova de Satoshi només s'ofereixen per a blockchains compatibles. L'entrada de la llibreta d'adreces que la prova verifica l'emmagatzema sota el seu identificador canònic (ETH, BTC, SOL, TRX).", "maxLength": 32 }, "holder_name": { "type": "string", "description": "Nom del titular de la cartera, utilitzat per a la coincidència del nom del beneficiari.", "maxLength": 255 }, "vendor_data": { "type": "string", "description": "El teu identificador intern per al titular, traslladat a l'entrada de la llibreta d'adreces creada.", "maxLength": 255 }, "transaction_id": { "type": "string", "format": "uuid", "description": "Opcional. UUID de transacció de Didit d'una transferència de Travel Rule que s'ha de fer avançar quan la prova es verifiqui.", "nullable": true }, "satoshi_deposit_address": { "type": "string", "description": "Opcional. Una adreça de dipòsit que controles; proporcionar-la habilita el mètode de prova SATOSHI_TEST.", "maxLength": 128 }, "callback_url": { "type": "string", "description": "Opcional. URL http(s) absoluta a la qual el giny redirigeix el client després de completar el procés.", "maxLength": 512 }, "expires_in_minutes": { "type": "integer", "description": "Opcional. Temps de vida de l'enllaç generat, en minuts. S'amplia automàticament per cobrir la finestra de la prova de Satoshi quan s'ofereix 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 sessió opac inserit a la URL del widget." }, "url": { "type": "string", "description": "L'URL del giny allotjat de titularitat de la cartera. Obre'l literalment al navegador del sistema (mai dins d'un webview de l'SDK mòbil)." }, "expires_at": { "type": "string", "format": "date-time" } } }, "TravelRuleWidgetContext": { "type": "object", "properties": { "vasp_name": { "type": "string", "description": "Nom legal del teu perfil de VASP, mostrat al client al widget. Buit quan no hi ha cap perfil." }, "wallet_address": { "type": "string" }, "chain": { "type": "string", "description": "La cadena amb què es va encunyar la sessió, tal com la vas enviar." }, "chain_family": { "type": "string", "nullable": true, "enum": [ "EVM", "BTC", "SOL", "TRON", null ], "description": "La família de claus de la cadena: EVM (Ethereum, BNB Chain, Polygon, Arbitrum, Base, Optimism, Avalanche, Linea i les altres cadenes EVM), BTC, SOL o TRON. Una clau EVM controla la mateixa adreça a totes les cadenes EVM. Null quan no es pot verificar cap signatura a la cadena." }, "holder_name": { "type": "string" }, "allowed_methods": { "type": "array", "items": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SCREENSHOT", "SATOSHI_TEST", "SELF_DECLARATION" ] }, "description": "Mètodes de prova disponibles per a aquesta sessió. MESSAGE_SIGNING requereix una cadena amb un chain_family, SATOSHI_TEST requereix un satoshi_deposit_address a la sessió i una cadena en què Didit pugui llegir els dipòsits, SCREENSHOT requereix la configuració allow_screenshot_proof i SELF_DECLARATION requereix la configuració allow_self_declaration." }, "transfer_status": { "type": "string", "nullable": true, "description": "Estat de la transferència vinculada de Travel Rule. Null quan la sessió es va crear sense un transaction_id." }, "callback_url": { "type": "string", "description": "On el widget retorna el client després de completar-se. Buit si no s'ha establert." }, "expires_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "No nul un cop s'ha verificat una prova." }, "proofs": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleWidgetProofSummary" } }, "max_attempts": { "type": "integer", "description": "Comprovants de cartera rebutjats que permet aquesta sessió." }, "attempts_used": { "type": "integer", "description": "Comprovants rebutjats fins ara." }, "attempts_remaining": { "type": "integer", "description": "Quan és 0, iniciar una altra prova respon 409 i crees una nova sessió del widget." }, "customization": { "type": "object", "nullable": true, "description": "La personalització de marca blanca de l'aplicació (colors, logotip, família tipogràfica) quan la marca blanca està habilitada: el widget es renderitza amb la mateixa identitat visual que el flux de verificació. Null en cas contrari." } } }, "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: l'usuari final ha triat aquest mètode i la prova encara no s'ha decidit. Una signatura fallida o un dipòsit de prova que encara no es pot llegir o confirmar manté la prova com a PENDING amb un failure_reason, de manera que l'usuari final pot tornar-ho a provar; un dipòsit SATOSHI_TEST enviat es torna a comprovar automàticament fins que es tanca la seva finestra temporal, i un SCREENSHOT enviat queda a l'espera de la teva revisió. VERIFIED: la titularitat està demostrada. REJECTED: el dipòsit de prova és realment incorrecte (un altre remitent, un import diferent de l'esperat a l'adreça de dipòsit, anterior al repte o una transacció que ja ha demostrat una altra cartera) o el teu revisor ha rebutjat la captura de pantalla; failure_reason indica quin ha estat el motiu. Una prova rebutjada és definitiva i consumeix un dels intents de la sessió. EXPIRED: la prova ja no es pot decidir (la finestra s'ha tancat, l'usuari final ha canviat de mètode, la sessió del widget ha caducat o el titular de la cartera ha canviat); failure_reason indica quin ha estat el motiu." }, "wallet_address": { "type": "string" }, "chain": { "type": "string", "description": "Identificador canònic de la cadena de l'entrada de la llibreta d'adreces a la qual correspon el comprovant, p. ex. ETH, BTC, SOL, TRX." }, "deposit_address": { "type": "string", "nullable": true, "description": "Adreça de dipòsit a la qual el client ha d'enviar l'import de la prova Satoshi. Només present en una prova SATOSHI_TEST." }, "expected_amount": { "type": "string", "nullable": true, "description": "Quantitat on-chain exacta, en la moneda nativa del dipòsit, amb la qual ha de coincidir el dipòsit de prova de Satoshi. Present només en una prova SATOSHI_TEST." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data límit per a la finestra pròpia de la prova de Satoshi d'aquest comprovant. Present només en un comprovant SATOSHI_TEST; el camp expires_at de la sessió del widget s'amplia per cobrir-lo quan s'ofereix SATOSHI_TEST." }, "challenge": { "type": "string", "nullable": true, "description": "Missatge emès per Didit que el client signa amb la seva cartera. Present només en una prova de MESSAGE_SIGNING." }, "rejection_reason": { "type": "string", "description": "Per què s'ha rebutjat la prova, com a frase en anglès per a l'usuari final. Només present quan `status` és REJECTED; buit quan el teu revisor ha rebutjat una captura de pantalla (la teva nota es queda amb tu)." }, "created_at": { "type": "string", "format": "date-time" }, "attempts": { "type": "integer", "description": "Quants cops s'han enviat proves per a aquest comprovant (signatures, identificadors de transacció, fitxers pujats)." }, "failure_reason": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "Per què l'últim intent no va reeixir, o per què es va tancar la prova. Buit quan res no ha fallat." } } }, "CaseSubject": { "type": "object", "nullable": true, "description": "L'únic usuari o empresa al qual està vinculat el cas.", "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 subjecte." }, "country": { "type": "string", "nullable": true, "description": "Codi de país de tres lletres del subjecte (ISO 3166-1 alfa-3), o null quan no es coneix. Per a una empresa, el seu país de constitució. Per a una persona, el país emissor d'un document d'identitat de les seves verificacions; una persona amb documents de diversos països en mostra un d'ells, i poden aparèixer codis de document de l'OACI com ara `XXA`.", "example": "ESP" }, "portrait": { "type": "string", "format": "uri", "nullable": true, "description": "URL signada de curta durada de la imatge de retrat de la persona. Sempre null per a una empresa, i null per a una persona sense retrat. La URL caduca, així que descarrega la imatge quan llegeixis el cas en lloc d'emmagatzemar 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": "Les sis seccions que es poden activar o desactivar i que determinen quines pestanyes i quins camps apareixen a la pàgina del cas. Es rebutgen les seccions o claus desconegudes.", "properties": { "checklist": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "optional": { "type": "boolean", "description": "Quan és cert, es pot resoldre un cas amb elements de la llista de verificació incomplets." }, "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 per a enllaços de sessió i business_session; uuid/txn_id/status per a enllaços de transacció." }, "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": "Les sis seccions que es poden activar o desactivar i que determinen quines pestanyes i quins camps apareixen a la pàgina del cas. Es rebutgen les seccions o claus desconegudes.", "properties": { "checklist": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "optional": { "type": "boolean", "description": "Quan és cert, es pot resoldre un cas amb elements de la llista de verificació incomplets." }, "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": "Connectors que actualment estan encaminant casos nous cap a aquest esquema.", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aml", "rule", "workflow" ] }, "id": { "type": "string" }, "name": { "type": "string" } } } }, "receives_escalation_from": { "type": "array", "description": "Altres esquemes l'objectiu d'escalat dels quals apunta a aquest.", "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": "Assignat automàticament, p. ex. 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": "S'estableix només mentre una resolució de 4 ulls està preparada a l'esquema del verificador, esperant l'aprovació o el rebuig de l'aprovació.", "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": "Correu electrònic del responsable que ha enviat la resolució. Null quan l'ha enviat una clau d'API: aquesta resolució no té cap autor registrat, de manera que approve i reject-approval retornen 403 per a qualsevol persona que els cridi." }, "maker_name": { "type": "string", "nullable": true }, "maker_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID d'usuari membre del responsable que ha enviat la resolució. Null quan l'ha enviada una clau d'API. Aquest membre no es pot indicar com a `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": "S'estableix només mentre una resolució de 4 ulls està preparada a l'esquema del verificador, esperant l'aprovació o el rebuig de l'aprovació.", "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": "Correu electrònic del responsable que ha enviat la resolució. Null quan l'ha enviat una clau d'API: aquesta resolució no té cap autor registrat, de manera que approve i reject-approval retornen 403 per a qualsevol persona que els cridi." }, "maker_name": { "type": "string", "nullable": true }, "maker_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID d'usuari membre del responsable que ha enviat la resolució. Null quan l'ha enviada una clau d'API. Aquest membre no es pot indicar com a `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": "Les 50 notes més recents." }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/CaseEvent" }, "description": "Els 100 esdeveniments més recents." }, "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": "Codi 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": "Valors per defecte reutilitzables de capçalera de goAML. Camps obligatoris a nivell de plantilla: rentity_id, submission_code i currency_code_local (de 3 lletres). Opcionals: enabled_fields (quins blocs d'informe opcionals cal incloure) a més dels valors per defecte de reporting_person, location, reason i action. Els camps de capçalera per declaració (action, submission_date, transactions, jurisdiction) s'exigeixen quan l'informe es valida o es finalitza, no a 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": "Codi d'informe goAML derivat de report_type, p. ex. 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 l'entitat informant emès per la FIU." }, "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": "Seccions narratives de les cinc 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": "Resultat de la validació més recent; cada entrada és un objecte {field, 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 camp de la transacció que s'ha d'avaluar. Camps principals: amount, currency, direction, action_type, score, severity, transaction_type, payment_details, preferred_currency_amount (recorre a amount_in_default_currency si no està definit), 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 (i els equivalents counterparty_payment_method_*), travel_rule_status, travel_rule_required, travel_rule_obligations_count, counterparty_dd_status (la teva decisió sobre la contrapart de Travel Rule: APPROVED, RESTRICTED o BLOCKED, una entitat que segueix la decisió de la seva marca), counterparty_risk_level (LOW, MEDIUM o HIGH; HIGH mentre el teu propi cribratge de contraparts estigui marcat), counterparty_jurisdiction (el país del VASP de la contrapart), counterparty_responsiveness (RESPONSIVE, UNRESPONSIVE o UNKNOWN), subject_days_since_previous_transaction, tags i custom_values. per a qualsevol clau enviada a custom_properties en crear la transacció. Els camps de codi de país accepten ISO-2 o ISO-3; ambdues parts es normalitzen a ISO-3 abans de la comparació." }, "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ó. in/not_in comproven la pertinença (el valor pot ser una llista o un únic escalar). contains/not_contains són comprovacions de subcadenes que no distingeixen majúscules de minúscules respecte a un valor de tipus cadena. contains_any rep una llista de cadenes i coincideix quan qualsevol d'elles és una subcadena (sense distingir majúscules de minúscules) del valor del camp. regex compara el patró del valor amb el camp. fuzzy_match compara amb la cadena del valor mitjançant el llindar `score` requerit (0-100). gt/gte/lt/lte mai no coincideixen quan falta algun dels dos costats. exists/is_not_empty/is_not_null (àlies) i not_exists/is_empty/is_null (àlies) són comprovacions de presència que ignoren `value`." }, "value": { "description": "Valor de comparació. La seva estructura depèn de l'operador i de value_type; omet-lo per als operadors de comprovació de presència. Qualsevol altre operador necessita un valor que no sigui `null` ni una llista buida; en cas contrari, la regla es rebutja amb `400`. `contains_any` necessita una llista de cadenes, i `contains`, `not_contains` i `regex` necessiten una sola cadena." }, "value_type": { "type": "string", "enum": [ "list", "field", "relative_date" ], "description": "Interpretació opcional del valor. `list`: el valor és un UUID de llista i les entrades de la llista esdevenen el valor de comparació. `field`: el valor és una altra ruta de camp, comparada camp a camp. `relative_date`: el valor és un objecte de data relativa, p. ex. {\"direction\": \"past\", \"unit\": \"days\", \"amount\": 30}." }, "score": { "type": "number", "minimum": 0, "maximum": 100, "description": "Obligatori quan operator és fuzzy_match: el llindar de similitud de 0-100." }, "group_index": { "type": "integer", "description": "Lògica agrupada opcional. Quan qualsevol condició té group_index, les condicions que comparteixen un índex formen un grup i l'avaluació agrupada substitueix evaluation_mode." }, "group_logic": { "type": "string", "enum": [ "AND", "OR" ], "default": "AND", "description": "Com es combinen les condicions DINS d'un grup." }, "groups_logic": { "type": "string", "enum": [ "AND", "OR" ], "default": "OR", "description": "Com es combinen els resultats dels grups ENTRE grups. Es llegeix a partir de la primera condició." } }, "description": "Una condició només llegeix la transacció que s'està avaluant; mai filtra la finestra d'agregació." }, "TransactionRuleAggregation": { "type": "object", "required": [ "value" ], "properties": { "metric": { "type": "string", "enum": [ "count", "sum", "max", "min", "avg", "distinct_count" ], "default": "count", "description": "Com s'agreguen les transaccions històriques coincidents. S'accepta unique_count com a àlies de distinct_count." }, "field": { "type": "string", "default": "amount", "description": "Camp agregat per sum/max/min/avg/distinct_count. S'ignora per a count." }, "operator": { "type": "string", "enum": [ "eq", "ne", "gt", "gte", "lt", "lte" ], "default": "eq", "description": "Comparació aplicada a la mètrica calculada." }, "value": { "type": "number", "description": "Llindar amb el qual es compara la mètrica calculada." }, "window": { "type": "string", "pattern": "^\\d+(m|h|d)$", "default": "1d", "description": "Finestra retrospectiva que finalitza al camp txn_date de la transacció: m (MINUTS, no mesos), h (hores) o d (dies), p. ex. 30m, 24h, 7d, 30d." }, "filters": { "type": "object", "additionalProperties": true, "description": "Restringeix quines transaccions històriques s'agreguen. Les claus són rutes de camps del catàleg de camps de condicions; un valor de \"__current__\" es resol al valor del mateix camp a la transacció que s'està avaluant (p. ex., {\"subject_vendor_data\": \"__current__\"} limita la finestra al mateix subjecte), i un valor de llista indica pertinença. Els registres sense el valor agrupat mai no s'agrupen junts: quan la transacció que s'està avaluant no té cap valor per a un camp \"__current__\" (sense contrapart, sense empremta digital del dispositiu), l'agregació no coincideix, sigui quin sigui el seu operador. Els filtres comparen NOMÉS per igualtat o pertinença; no hi ha cap filtre lt/gte, de manera que un interval com ara \"transaccions històriques inferiors a 10.000\" no es pot expressar aquí. En comptes d'això, posa l'interval a la mètrica (la mètrica max amb l'operador lt manté totes les transaccions de la finestra per sota del llindar)." } }, "description": "Comprovació de velocitat sobre les transaccions històriques de l'aplicació dins de la finestra temporal. Cada entrada d'agregació ha de coincidir perquè la regla coincideixi, independentment de evaluation_mode. Una agregació limita només la finestra temporal; la transacció que s'està avaluant està limitada per scope i conditions, per la qual cosa cal repetir direction, currency o transaction_type a totes dues meitats quan la regla els requereixi." }, "TransactionRuleScope": { "type": "object", "properties": { "transaction_types": { "type": "array", "items": { "type": "string" }, "description": "Restringeix als tipus de transacció, p. ex. finance, kyc, travel_rule, user_event. Buit o absent = sense restricció." }, "directions": { "type": "array", "items": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "description": "Restringeix a direccions de transacció (no distingeix majúscules de minúscules en escriure)." }, "action_types": { "type": "array", "items": { "type": "string" }, "description": "Restringeix als teus valors de action_type, p. ex. withdrawal, deposit." } }, "description": "A quines transaccions s'aplica la regla. Només s'accepten aquestes tres claus." }, "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ó de regla. Una regla en pot incloure diverses; totes s'apliquen conjuntament quan coincideix. Les regles en mode TEST registren el que haurien fet sense aplicar cap acció." }, "TransactionRuleCreateRequest": { "type": "object", "required": [ "title", "category", "mode" ], "properties": { "title": { "type": "string", "description": "Nom de la regla. Únic per aplicació entre les regles no eliminades; els duplicats retornen 400." }, "description": { "type": "string", "nullable": true }, "category": { "type": "string", "description": "Tema de risc utilitzat per agrupar i generar informes, p. ex., 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 avalua en temps real. TEST avalua i registra les execucions de regles però mai no modifica la puntuació ni l'estat: el mode inicial recomanat. DISABLED s'omet." }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ], "default": "ALL", "description": "Indica si s'han de complir totes les condicions (ALL) o com a mínim una (ANY). S'ignora quan les condicions utilitzen 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": "Metadades de format lliure emmagatzemades a la regla." } }, "description": "Crea una regla CUSTOM. Les regles en mode ACTIVE tenen efecte immediatament per a les noves transaccions; crea-la en mode TEST i fes un backtest primer." }, "TransactionRuleUpdateRequest": { "type": "object", "properties": { "title": { "type": "string", "description": "Nom de la regla. Únic per aplicació entre les regles no eliminades; els duplicats retornen 400." }, "description": { "type": "string", "nullable": true }, "category": { "type": "string", "description": "Tema de risc utilitzat per agrupar i generar informes, p. ex., 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 avalua en temps real. TEST avalua i registra les execucions de regles però mai no modifica la puntuació ni l'estat: el mode inicial recomanat. DISABLED s'omet." }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ], "default": "ALL", "description": "Indica si s'han de complir totes les condicions (ALL) o com a mínim una (ANY). S'ignora quan les condicions utilitzen 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": "Metadades de format lliure emmagatzemades a la regla." } }, "description": "Actualització parcial. Les regles personalitzades accepten tots els camps; les regles de la biblioteca (PRESET) només accepten mode; qualsevol altra opció retorna 400." }, "TransactionRuleDetail": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "title": { "type": "string", "description": "Nom de la regla. Únic per aplicació entre les regles no eliminades; els duplicats retornen 400." }, "description": { "type": "string", "nullable": true }, "category": { "type": "string", "description": "Tema de risc utilitzat per agrupar i generar informes, p. ex., 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 avalua en temps real. TEST avalua i registra les execucions de regles però mai no modifica la puntuació ni l'estat: el mode inicial recomanat. DISABLED s'omet." }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ], "default": "ALL", "description": "Indica si s'han de complir totes les condicions (ALL) o com a mínim una (ANY). S'ignora quan les condicions utilitzen 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": "Metadades de format lliure emmagatzemades a la regla." }, "severity": { "type": "string", "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "nullable": true, "description": "Gravetat informativa transmesa per les regles de la biblioteca; no es pot configurar en regles personalitzades." }, "source": { "type": "string", "enum": [ "PRESET", "CUSTOM" ], "description": "Les regles PRESET provenen de la biblioteca (instal·lació/desinstal·lació, modificacions només de mode); les regles CUSTOM són totalment teves." }, "library_key": { "type": "string", "nullable": true, "description": "Identificador de biblioteca estable; null per a regles personalitzades." }, "latest_triggered_at": { "type": "string", "format": "date-time", "nullable": true }, "run_count": { "type": "integer", "description": "Quantes transaccions han coincidit amb aquesta 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ó hipotètica de la regla per avaluar-la en relació amb transaccions recents. Només de lectura i gratuïta: no es crea ni es modifica res. Envia les mateixes conditions, aggregation, evaluation_mode i scope que la regla que pretens activar. Les condicions, agregacions i abasts omesos no afegeixen restriccions pròpies; ometre l'abast pot incloure direccions o tipus de transacció que la regla desada omet. Si s'omet evaluation_mode, el valor per defecte és ALL (la qual cosa pot reduir les coincidències per a una regla ANY), i si s'omet period_days, el valor per defecte és de 90 dies, no pas un historial il·limitat." }, "TransactionRuleBacktestResult": { "type": "object", "properties": { "evaluated": { "type": "integer", "description": "Transaccions avaluades (les més recents primer, limitades)." }, "matched": { "type": "integer", "description": "Transaccions amb les quals la configuració hauria coincidit." }, "affected_entities": { "type": "integer", "description": "Subjectes diferents (per vendor_data) entre les coincidències." }, "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": "Família funcional, p. ex. 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 aquest valor predefinit està instal·lat actualment a l'aplicació." } } }, "TransactionRuleInstallRequest": { "type": "object", "properties": { "library_keys": { "type": "array", "items": { "type": "string" }, "description": "Preajustos específics per instal·lar o desinstal·lar." }, "bundle": { "type": "string", "description": "En lloc d'això, instal·la o desinstal·la tots els ajustos predefinits d'aquest paquet." } }, "description": "Proporciona library_keys O bundle." }, "TransactionRuleInstallResult": { "type": "object", "properties": { "installed_library_keys": { "type": "array", "items": { "type": "string" }, "description": "Només POST (instal·lar): preconfiguracions instal·lades per aquesta crida." }, "installed_count": { "type": "integer", "description": "Només POST (instal·lar)." }, "uninstalled_count": { "type": "integer", "description": "Només DELETE (desinstal·lació): preajustos eliminats per aquesta crida." } } }, "WalletScreeningResult": { "type": "object", "properties": { "provider": { "type": "string", "description": "Proveïdor que ha dut a terme el cribratge (p. ex. `merklescience`, `crystal`)." }, "screening_type": { "type": "string", "enum": [ "WALLET_SCREENING" ], "description": "Sempre `WALLET_SCREENING` per a aquest endpoint." }, "risk_score": { "type": "integer", "description": "Puntuació de risc normalitzada de 0 a 100. Un valor més alt indica una exposició més gran a entitats de risc. Merkle Science qualifica una adreça de 0 a 5, la qual cosa es correspon amb 0, 15, 35, 55, 75 o 95." }, "severity": { "type": "string", "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "description": "Grup de risc derivat de `risk_score`: `0-9` UNKNOWN, `10-39` LOW, `40-69` MEDIUM, `70-89` HIGH, `90-100` CRITICAL. `UNKNOWN` és la franja més baixa, no un estat independent sense dades: un `risk_score` de 0 (el cas habitual d'una adreça neta) significa sense avaluació adversa, mentre que una puntuació diferent de zero en l'interval 1-9 és un senyal real però inferior a LOW; llegeix el `risk_score`, no només la franja. No tractis mai `UNKNOWN` com una qualificació afirmativa de risc baix o neta; no la mostris com un aprovat." }, "status": { "type": "string", "enum": [ "SCREENED", "PENDING", "ERROR" ], "description": "Estat del resultat del cribratge." }, "summary": { "type": "string", "description": "Resum del resultat del cribratge, llegible per a humans." }, "wallet_address": { "type": "string", "description": "L'adreça analitzada, que es retorna tal qual." }, "transaction_hash": { "type": "string", "nullable": true, "description": "Camp de cribratge de transaccions, compartit amb l'estructura del resultat. Sempre és `null` en un resultat de cribratge de carteres." }, "blockchain": { "type": "string", "description": "La blockchain que s'ha analitzat." }, "block_timestamp": { "type": "string", "nullable": true, "description": "Camp de cribratge de transaccions, compartit amb l'estructura del resultat. Sempre és `null` en un resultat de cribratge de carteres." }, "total_value_usd": { "type": "number", "nullable": true, "description": "Camp de cribratge de transaccions, compartit amb l'estructura del resultat. Sempre és `null` en un resultat de cribratge de carteres." }, "fee_usd": { "type": "number", "nullable": true, "description": "Camp de cribratge de transaccions, compartit amb l'estructura del resultat. Sempre és `null` en un resultat de cribratge de carteres." }, "sender_rows": { "type": "array", "items": { "type": "object" }, "description": "Camp de cribratge de transaccions, compartit amb l'estructura del resultat. Sempre està buit en un resultat de cribratge de carteres." }, "receiver_rows": { "type": "array", "items": { "type": "object" }, "description": "Camp de cribratge de transaccions, compartit amb l'estructura del resultat. Sempre està buit en un resultat de cribratge de carteres." }, "transaction_flows": { "type": "array", "items": { "type": "object" }, "description": "Camp de cribratge de transaccions, compartit amb l'estructura del resultat. Sempre està buit en un resultat de cribratge de carteres." }, "transaction_flows_status": { "type": "string", "nullable": true, "description": "Camp de cribratge de transaccions, compartit amb l'estructura del resultat. Sempre és `null` en un resultat de cribratge de carteres." }, "transaction_flows_error": { "type": "string", "nullable": true, "description": "Camp de cribratge de transaccions, compartit amb l'estructura del resultat. Sempre és `null` en un resultat de cribratge de carteres." }, "source_of_funds": { "type": "array", "description": "D'on ha rebut fons l'adreça, atribuït per entitat. Cada entrada és un desglossament de l'exposició.", "items": { "type": "object", "properties": { "category": { "type": "string", "description": "Categoria de risc normalitzada, p. ex. `exchange_licensed`, `dex`, `defi`, `payment_processor`, `mixer`, `darknet_market`, `sanctioned`, `stolen_funds`, `high_risk_exchange`." }, "percentage": { "type": "number", "description": "Proporció de l'exposició total de la direcció, 0-100." }, "amount_usd": { "type": "number", "nullable": true, "description": "Valor en USD atribuït a aquesta entitat." }, "entity_name": { "type": "string", "nullable": true, "description": "Nom de l'entitat atribuïda, per exemple una plataforma d'intercanvi, un mesclador o un grup sancionat." }, "entity_type": { "type": "string", "nullable": true, "description": "Tipus d'entitat del proveïdor (p. ex. `Exchange`, `DeFi`, `Sanctions`, `Theft`)." }, "entity_subtype": { "type": "string", "nullable": true, "description": "Subtipus més granular (p. ex., `Mandatory KYC and AML`, `OFAC`, `Yield Aggregator`)." }, "hops": { "type": "integer", "nullable": true, "description": "Nombre de salts fins a l'entitat (1 per a una contrapart directa), quan el proveïdor n'informa. Sempre és `null` per a Merkle Science, que només informa de si l'exposició és directa o indirecta: utilitza `exposure_type`." }, "description": { "type": "string", "nullable": true, "description": "`entity_type / entity_subtype`, tal com el proveïdor etiqueta l'entitat." }, "is_direct": { "type": "boolean", "description": "Cert quan `exposure_type` és `direct`." }, "exposure_direction": { "type": "string", "enum": [ "incoming", "outgoing", "connected" ], "description": "Indica si els fons provenien d'aquesta entitat (`incoming`) o hi anaven destinats (`outgoing`)." }, "exposure_type": { "type": "string", "enum": [ "direct", "indirect" ], "description": "Exposició `direct` (1 salt) o `indirect` (múltiples salts)." }, "provider_entity_id": { "type": "string", "nullable": true, "description": "L'identificador propi del proveïdor per a l'entitat." }, "provider_entity_type_id": { "type": "string", "nullable": true, "description": "L'identificador propi del proveïdor per a `entity_type`." }, "provider_entity_subtype_id": { "type": "string", "nullable": true, "description": "L'identificador propi del proveïdor per a `entity_subtype`." }, "country": { "type": "string", "nullable": true, "description": "País principal ISO 3166-1 alfa-2 de l'entitat. Buit o `null` si el proveïdor no el coneix." }, "raw_amount": { "type": "number", "nullable": true, "description": "Import en la unitat pròpia de l'actiu, quan el proveïdor ho notifica." }, "raw_currency": { "type": "string", "nullable": true, "description": "Unitat de `raw_amount`, quan el proveïdor la reporta." } } } }, "destination_of_funds": { "type": "array", "description": "Cap a on ha enviat fons l'adreça, atribuït per entitat. Té la mateixa estructura d'element que `source_of_funds` amb `exposure_direction` = `outgoing`.", "items": { "type": "object", "properties": { "category": { "type": "string", "description": "Categoria de risc normalitzada, p. ex. `exchange_licensed`, `dex`, `defi`, `payment_processor`, `mixer`, `darknet_market`, `sanctioned`, `stolen_funds`, `high_risk_exchange`." }, "percentage": { "type": "number", "description": "Proporció de l'exposició total de la direcció, 0-100." }, "amount_usd": { "type": "number", "nullable": true, "description": "Valor en USD atribuït a aquesta entitat." }, "entity_name": { "type": "string", "nullable": true, "description": "Nom de l'entitat atribuïda, per exemple una plataforma d'intercanvi, un mesclador o un grup sancionat." }, "entity_type": { "type": "string", "nullable": true, "description": "Tipus d'entitat del proveïdor (p. ex. `Exchange`, `DeFi`, `Sanctions`, `Theft`)." }, "entity_subtype": { "type": "string", "nullable": true, "description": "Subtipus més granular (p. ex., `Mandatory KYC and AML`, `OFAC`, `Yield Aggregator`)." }, "hops": { "type": "integer", "nullable": true, "description": "Nombre de salts fins a l'entitat (1 per a una contrapart directa), quan el proveïdor n'informa. Sempre és `null` per a Merkle Science, que només informa de si l'exposició és directa o indirecta: utilitza `exposure_type`." }, "description": { "type": "string", "nullable": true, "description": "`entity_type / entity_subtype`, tal com el proveïdor etiqueta l'entitat." }, "is_direct": { "type": "boolean", "description": "Cert quan `exposure_type` és `direct`." }, "exposure_direction": { "type": "string", "enum": [ "incoming", "outgoing", "connected" ], "description": "Indica si els fons provenien d'aquesta entitat (`incoming`) o hi anaven destinats (`outgoing`)." }, "exposure_type": { "type": "string", "enum": [ "direct", "indirect" ], "description": "Exposició `direct` (1 salt) o `indirect` (múltiples salts)." }, "provider_entity_id": { "type": "string", "nullable": true, "description": "L'identificador propi del proveïdor per a l'entitat." }, "provider_entity_type_id": { "type": "string", "nullable": true, "description": "L'identificador propi del proveïdor per a `entity_type`." }, "provider_entity_subtype_id": { "type": "string", "nullable": true, "description": "L'identificador propi del proveïdor per a `entity_subtype`." }, "country": { "type": "string", "nullable": true, "description": "País principal ISO 3166-1 alfa-2 de l'entitat. Buit o `null` si el proveïdor no el coneix." }, "raw_amount": { "type": "number", "nullable": true, "description": "Import en la unitat pròpia de l'actiu, quan el proveïdor ho notifica." }, "raw_currency": { "type": "string", "nullable": true, "description": "Unitat de `raw_amount`, quan el proveïdor la reporta." } } } }, "counterparty_connections": { "type": "array", "description": "Entitats a les quals el proveïdor atribueix l'adreça analitzada. En el cas de Merkle Science, provenen de les etiquetes de propietari i d'usuari de la mateixa adreça, de manera que la mateixa entitat pot aparèixer dues vegades, i no comporten fluxos de fons: `received_usd`, `sent_usd`, `received_hops` i `sent_hops` són `null` i `percentage` és 0. No facis encaminament segons `risk_level` o `is_direct` aquí: fes servir `sanctions_hit`, `dominant_risk_category` i `risk_factors[].is_high_risk` per al veredicte, i `exposure_type` a `source_of_funds`/`destination_of_funds` per determinar si són directes.", "items": { "type": "object", "properties": { "entity_name": { "type": "string", "nullable": true, "description": "Nom de l'entitat atribuïda." }, "entity_type": { "type": "string", "nullable": true, "description": "Tipus d'entitat del proveïdor." }, "entity_subtype": { "type": "string", "nullable": true, "description": "Subtipus d'entitat del proveïdor." }, "risk_level": { "type": "string", "description": "En minúscules i depenent del proveïdor. Per a Merkle Science és el grau de risc de 0 a 5 de la pròpia adreça (`no_risk`, `low`, `medium_low`, `medium`, `high`, `critical`), augmentat a `high` quan la categoria de l'entitat és d'alt risc; no és un grau independent de l'entitat." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Categories de risc normalitzades de l'entitat." }, "received_usd": { "type": "number", "nullable": true, "description": "USD rebuts de l'entitat, quan el proveïdor ho informa." }, "sent_usd": { "type": "number", "nullable": true, "description": "USD enviats a l'entitat, quan el proveïdor ho informa." }, "received_hops": { "type": "integer", "nullable": true, "description": "Salts fins a l'entitat de la part receptora, quan el proveïdor els informa." }, "sent_hops": { "type": "integer", "nullable": true, "description": "Salts fins a l'entitat de la part emissora, quan el proveïdor els informa." }, "percentage": { "type": "number", "description": "Proporció de l'exposició de l'adreça, quan el proveïdor ho informa; en cas contrari, 0." }, "is_direct": { "type": "boolean", "description": "Sempre `true` per a Merkle Science, les connexions del qual són atribucions en lloc de contraparts." }, "country": { "type": "string", "nullable": true, "description": "País de l'entitat, quan es coneix." }, "provider_entity_id": { "type": "string", "nullable": true, "description": "L'identificador propi del proveïdor per a l'entitat." } } } }, "network_nodes": { "type": "array", "items": { "type": "object" }, "description": "Nodes del graf d'exposició per al cribratge de transaccions. Buit en un resultat de cribratge de carteres." }, "network_edges": { "type": "array", "items": { "type": "object" }, "description": "Arestes del graf d'exposició per al cribratge de transaccions. Buit en un resultat de cribratge de carteres." }, "sanctions_hit": { "type": "boolean", "description": "Cert si l'adreça té exposició directa o indirecta a sancions." }, "pep_counterparty": { "type": "boolean", "description": "Exposició com a persona políticament exposada. `null` quan no hi ha cap detecció de PEP disponible, que és el cas de tots els resultats actualment perquè cap proveïdor n'informa; `false` només per a un resultat de cribratge explícitament negatiu. No interpretis `null` com una comprovació de PEP completada.", "nullable": true }, "dominant_risk_category": { "type": "string", "nullable": true, "description": "Categoria d'alt risc amb més pes, o `null` quan cap no és dominant (p. ex. `sanctioned`, `mixer`, `stolen_funds`)." }, "risk_factors": { "type": "array", "description": "Explicació classificada de `risk_score`: què ha produït aquest veredicte. Els proveïdors avaluen una adreça segons el seu propi model i només retornen un veredicte (Merkle Science retorna un enter del 0 al 5), de manera que la puntuació per si sola no permet prendre decisions. S'ordena primer per risc alt i després pel valor que ha passat per cada factor determinant, limitat als cinc més rellevants; `source_of_funds` i `destination_of_funds` sempre inclouen el desglossament complet. Un `risk_score` alt sense cap entrada `is_high_risk` significa que el proveïdor no ha detectat coincidències amb sancions ni entitats atribuïdes i ha avaluat l'adreça purament segons el seu propi model d'exposició; `summary` ho indica explícitament.", "items": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "attribution", "exposure" ], "description": "`attribution` és el que el proveïdor diu que és la pròpia adreça (la seva pròpia etiqueta o clúster); `exposure` és cap a on s'han mogut realment els seus fons." }, "category": { "type": "string", "description": "Categoria de risc normalitzada, mateix vocabulari que el desglossament d'exposició." }, "label": { "type": "string", "description": "La redacció pròpia del proveïdor per al factor determinant (per exemple, `Gambling / Crypto only`), que és el que també veuries a la consola del proveïdor." }, "entity_name": { "type": "string", "nullable": true, "description": "Entitat atribuïda darrere del factor determinant, per exemple un lloc web de jocs d'atzar o una plataforma d'intercanvi." }, "direction": { "type": "string", "enum": [ "incoming", "outgoing", "connected", "unknown", "attribution" ], "description": "Direcció del flux de fons, `attribution` quan el causant és l'etiqueta pròpia de l'adreça, o `unknown` quan el proveïdor no ha informat de cap direcció." }, "exposure_type": { "type": "string", "enum": [ "direct", "indirect", "unknown", "attribution" ], "description": "`direct` (1 salt) o `indirect` (múltiples salts), `attribution` per a l'etiqueta pròpia de l'adreça, o `unknown` quan el proveïdor no ha indicat a quants salts de distància és la contrapart. Tracta `unknown` com a no classificat, no com a `direct`." }, "amount_usd": { "type": "number", "format": "float", "nullable": true, "description": "Valor en USD atribuït a aquest factor determinant." }, "percentage": { "type": "number", "format": "float", "description": "Proporció del volum TOTAL analitzat de l'adreça, combinant ambdues direccions - a diferència de `percentage` dins de `source_of_funds`/`destination_of_funds`, que està normalitzat per direcció. Comparable i sumable a tota la llista." }, "is_high_risk": { "type": "boolean", "description": "Indica si la categoria és una de les que Didit tracta com d'alt risc (`sanctioned`, `mixer`, `stolen_funds`, `ransomware`, `scam`, `darknet_market`, `terrorist_financing`, `child_exploitation`, `hacked_exchange`, `high_risk_exchange`, `seized_funds`)." }, "description": { "type": "string", "description": "Representació en una línia del factor determinant, p. ex. `9.01% indirect outgoing exposure to Gambling / Crypto only (Example Gambling)`." } } } }, "raw_response": { "type": "object", "additionalProperties": true, "description": "El payload propi del proveïdor. La seva estructura és específica del proveïdor i pot canviar sense previ avís: llegeix els camps normalitzats en lloc d'analitzar-lo directament." }, "report_signature": { "type": "string", "description": "Signatura HMAC-SHA256 opaca sobre aquest resultat exacte, delimitada a la teva aplicació. No té sentit per si sola: torna a enviar el cos complet de la resposta, sense modificar i incloent aquest camp, a `POST /v3/wallet-screening/pdf/` per renderitzar-lo com a PDF. L'endpoint de PDF rebutja la sol·licitud amb `400` si falta `report_signature` o si s'ha editat algun camp signat (p. ex., `risk_score`, `severity`, `sanctions_hit`) abans de tornar-lo a enviar." } }, "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ó de risc, 0-100." }, "band": { "type": "string", "enum": [ "low", "medium", "high" ], "description": "Franja en què es representa la puntuació. high >= 70, medium >= 40; altrament, low." }, "bar": { "type": "number", "format": "float", "description": "Valor normalitzat de 0 a 1 per renderitzar una barra de risc." } } }, "NetworkNodeTag": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string", "nullable": true, "description": "Nul per a etiquetes de protecció, el token de color de les quals és gestionat pel renderitzador." }, "source": { "type": "string", "enum": [ "subject_tag", "session_tag", "transaction_tag", "signal_guard" ], "description": "D'on prové l'etiqueta: una etiqueta a l'usuari/empresa, una etiqueta a una sessió d'aquesta xarxa, una etiqueta a una transacció a la qual pertany una part o una condició de protecció d'un senyal (p. ex., concentrador, IP de centre de dades)." }, "category": { "type": "string", "enum": [ "customer", "quality" ], "nullable": true, "description": "customer per a etiquetes definides pel client, quality per a etiquetes de control de la qualitat del senyal. Null quan no sigui aplicable." } } }, "NetworkListItem": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "network_id": { "type": "string", "description": "ID seqüencial per organització llegible per a humans, p. ex. N-0001." }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "active", "in_review", "resolved", "dismissed" ], "description": "Estat del cicle de vida de la xarxa. Distint de l'outcome_status per sol·licitant dins d'una xarxa (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": "Els patrons d'agrupament detectats en aquesta xarxa." }, "signal_types": { "type": "array", "items": { "type": "string", "enum": [ "ip_address", "device", "face", "document_number", "phone", "email", "address" ] }, "description": "Els diferents tipus de senyals presents en aquesta xarxa." }, "member_counts": { "type": "object", "description": "Recomptes de membres per categoria (p. ex. total, per outcome_status)." }, "member_status": { "type": "object", "description": "Desglossament dels membres per outcome_status." }, "signal_coverage": { "type": "object", "description": "Cobertura dels membres d'aquesta xarxa per signal_type." }, "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ístiques agregades de la xarxa (p. ex., totals de membres)." }, "fraud_tags": { "type": "array", "items": { "type": "object" }, "description": "Etiquetes de patrons de frau detectades a la xarxa." }, "risk_signals": { "type": "object", "description": "Resums dels senyals de risc: 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": "Nombre de notes privades d'analista en aquesta investigació." } } }, "NetworkGraphNode": { "type": "object", "description": "Un node de subjecte o un node de senyal, distingits per tipus. Els nodes de subjecte (kind: vendor_user | vendor_business | transaction_party) inclouen id, kind, subject, node_status (approved | in_review | declined | not_completed) i tags. Els nodes de senyal (kind: signal) inclouen 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 i 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 node subjecte." }, "target": { "type": "string", "description": "ID del node de senyal." }, "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 per a una coincidència 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": "Profunditat efectiva aplicada, o null quan no està limitada (depth=all)." }, "truncated": { "type": "boolean", "description": "Cert si el veïnat s'ha truncat per profunditat." }, "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 aquest membre." }, "outcome_status": { "type": "string", "description": "El resultat de la verificació/decisió del subjecte." }, "node_status": { "type": "string", "enum": [ "approved", "in_review", "declined", "not_completed", "signal_active", "signal_guarded" ], "description": "Per a una fila de membre, sempre és un dels valors de subject-outcome: 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": "Cert quan aquest senyal vincula un nombre inusualment alt de subjectes." }, "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. ex. 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": "Nombre de punts d'adreça/ubicació diferents on convergeixen els membres." }, "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": "Context opcional de dispositiu i xarxa observat per la teva aplicació. Tots els camps són opcionals. Enviar-los alimenta la detecció de coincidències entre sessions a Networks.", "properties": { "ip": { "type": "string", "format": "ip", "description": "Adreça IPv4 o IPv6 observada per a l'usuari final.", "example": "192.0.2.1" }, "device_id": { "type": "string", "maxLength": 255, "description": "Identificador de dispositiu estable recollit per la teva aplicació (`ANDROID_ID` a Android, `identifierForVendor` a iOS)." }, "device_platform": { "type": "string", "enum": [ "android", "ios", "ipados", "tvos", "web" ], "description": "Plataforma del dispositiu de l'usuari final." }, "device_model": { "type": "string", "maxLength": 255, "description": "Model de dispositiu informat per la teva aplicació." }, "os_version": { "type": "string", "maxLength": 64, "description": "Versió del sistema operatiu." }, "app_version": { "type": "string", "maxLength": 64, "description": "Versió de la teva aplicació." }, "user_agent": { "type": "string", "maxLength": 512, "description": "Agent d'usuari del navegador o de l'aplicació." } } }, "PhoneRiskRequest": { "type": "object", "required": [ "phone_number" ], "properties": { "phone_number": { "type": "string", "maxLength": 20, "description": "Número de telèfon a puntuar. Es valida i es normalitza a E.164.", "example": "+14155552671" }, "country_code": { "type": "string", "maxLength": 3, "description": "Indicació opcional de país ISO 3166-1 alfa-2 o alfa-3 per a la cobertura d'intel·ligència.", "example": "US" }, "signals": { "$ref": "#/components/schemas/RiskSignals" }, "vendor_data": { "type": "string", "description": "La teva referència estable per a aquesta sol·licitud. S'emmagatzema a la sessió de l'API i es retorna a la resposta." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Les teves metadades JSON no sensibles. S'emmagatzemen a la sessió de l'API i es retornen a la resposta." }, "enable_social": { "type": "boolean", "default": false, "description": "Quan és cert, també consulta la petjada social del número: les plataformes de missatgeria, socials, de comerç electrònic i professionals on està registrat. Es factura com una unitat de `phone_social` per sol·licitud a més del preu propi d'aquest endpoint.", "example": true } } }, "EmailRiskRequest": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "description": "Adreça de correu electrònic a puntuar.", "example": "alice@example.com" }, "country_code": { "type": "string", "maxLength": 3, "description": "Indicació opcional de país ISO 3166-1 alfa-2 o alfa-3 per a la cobertura d'intel·ligència.", "example": "US" }, "signals": { "$ref": "#/components/schemas/RiskSignals" }, "vendor_data": { "type": "string", "description": "La teva referència estable per a aquesta sol·licitud. S'emmagatzema a la sessió de l'API i es retorna a la resposta." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Les teves metadades JSON no sensibles. S'emmagatzemen a la sessió de l'API i es retornen a la resposta." }, "enable_social": { "type": "boolean", "default": false, "description": "Quan és cert, també consulta la petjada social de l'adreça: les plataformes de correu electrònic, socials, professionals, de comerç electrònic i d'entreteniment on està registrada. Es factura com una unitat de `email_social` per sol·licitud a més del preu propi d'aquest endpoint.", "example": true } } }, "IPRiskRequest": { "type": "object", "required": [ "ip_address" ], "properties": { "ip_address": { "type": "string", "format": "ip", "description": "Adreça IPv4 o IPv6 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 declarat per l'usuari o la sessió. S'utilitza per calcular `country_mismatch`.", "example": "ESP" }, "user_agent": { "type": "string", "maxLength": 512, "description": "Agent d'usuari observat pel teu back-end. S'emmagatzema com a context de la sol·licitud; no proporciona empremta digital del dispositiu." }, "vendor_data": { "type": "string", "description": "La teva referència estable per a aquesta sol·licitud. S'emmagatzema a la sessió de l'API i es retorna a la resposta." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Les teves metadades JSON no sensibles. S'emmagatzemen a la sessió de l'API i es retornen a la resposta." } } }, "RiskWarning": { "type": "object", "required": [ "feature", "risk", "log_type", "short_description", "long_description" ], "properties": { "feature": { "type": "string", "description": "Funcionalitat que ha generat l'advertència." }, "risk": { "type": "string", "description": "Codi de risc llegible per màquina. Es poden afegir nous valors al llarg del temps." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Context específic del risc, o `null`." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Gravetat utilitzada per les regles de decisió." }, "short_description": { "type": "string", "description": "Resum d'una sola línia, llegible per a humans." }, "long_description": { "type": "string", "description": "Explicació fàcil de llegir." } } }, "RiskLifecycleEvent": { "type": "object", "required": [ "type", "timestamp", "details", "fee" ], "properties": { "type": { "type": "string", "description": "Tipus d'esdeveniment llegible per màquina. Se'n poden afegir nous valors amb el temps." }, "timestamp": { "type": "string", "format": "date-time", "description": "Quan va ocórrer l'esdeveniment." }, "details": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Payload específic de l'esdeveniment, o `null`." }, "fee": { "type": "number", "description": "Import en USD facturat per aquest esdeveniment." } } }, "PhoneMatchItem": { "type": "object", "description": "Una altra sessió de la teva aplicació que ha utilitzat el mateix número de telèfon amb un `vendor_data` diferent.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID de sessió de l'altra verificació que ha utilitzat aquest número de telèfon." }, "session_number": { "type": "integer", "description": "Número seqüencial fàcil de llegir d'aquesta sessió." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` d'aquella sessió." }, "verification_date": { "type": "string", "description": "Quan es va crear aquesta sessió (`YYYY-MM-DDTHH:MM:SSZ`)." }, "phone_number": { "type": "string", "description": "El número de telèfon coincident." }, "status": { "type": "string", "description": "Estat d'aquesta sessió (p. ex., `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Si el número de telèfon és a la llista de bloqueig de la teva aplicació." }, "api_service": { "type": "string", "nullable": true, "description": "Per a sessions de tipus API, l'API independent que la va crear; `null` per a sessions de verificació habituals." }, "source": { "type": "string", "description": "On s'ha trobat la coincidència. Normalment `session`; una coincidència amb la llista de bloqueig mitjançant una entrada de llista de l'organització utilitza `list_entry`." } } }, "EmailMatchItem": { "type": "object", "description": "Una altra sessió de la teva aplicació que ha utilitzat la mateixa adreça de correu electrònic amb un `vendor_data` diferent.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID de sessió de l'altra verificació que ha utilitzat aquesta adreça de correu electrònic." }, "session_number": { "type": "integer", "description": "Número seqüencial fàcil de llegir d'aquesta sessió." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` d'aquella sessió." }, "verification_date": { "type": "string", "description": "Quan es va crear aquesta sessió (`YYYY-MM-DDTHH:MM:SSZ`)." }, "email": { "type": "string", "description": "L'adreça de correu electrònic coincident." }, "status": { "type": "string", "description": "Estat d'aquesta sessió (p. ex., `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Indica si l'adreça de correu electrònic és a la llista de bloqueig de la teva aplicació." }, "api_service": { "type": "string", "nullable": true, "description": "Per a sessions de tipus API, l'API independent que la va crear; `null` per a sessions de verificació habituals." }, "source": { "type": "string", "description": "On s'ha trobat la coincidència. Normalment `session`; una coincidència amb la llista de bloqueig mitjançant una entrada de llista de l'organització utilitza `list_entry`." } } }, "PhoneIntelligence": { "type": "object", "description": "Bloc d'intel·ligència de telèfon normalitzat. Només present quan el complement d'intel·ligència s'ha executat per a aquesta consulta; quan és present també s'exposa sota l'àlies `enrichment` amb valors idèntics.", "properties": { "score": { "type": "number", "nullable": true, "description": "Puntuació de risc normalitzada de 0 a 100. Com més alta, més arriscada." }, "phone_type_risk": { "type": "string", "nullable": true, "description": "`Low`, `Medium` o `High`, derivat de la puntuació." }, "phone_trust_index": { "type": "number", "nullable": true, "description": "Invers de la puntuació, per a taulers que prefereixen que un valor més alt sigui millor." }, "network_stability_index": { "type": "number", "nullable": true, "description": "Estabilitat de la xarxa de la línia." }, "is_disposable": { "type": "boolean", "nullable": true, "description": "`true` quan el número sembla d'un sol ús o virtual." }, "is_ported": { "type": "boolean", "nullable": true, "description": "`true` quan el número ha canviat d'operador." }, "is_recently_ported": { "type": "boolean", "nullable": true, "description": "`true` quan la portabilitat s'ha produït recentment." }, "carrier_type": { "type": "string", "nullable": true, "description": "Classificació de la línia indicada per la cerca (p. ex., `mobile`)." }, "reason_codes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Identificador estable de Didit del senyal, per exemple `IR-5AC67A32`. Opac: agrupa i filtra per ell, no l'analitzis sintàcticament." }, "value": { "nullable": true, "description": "Per a un indicador de risc (per exemple `voip`, `leaked`, `disposable`, `spam_trap`), el seu valor: un booleà, un nivell o una data. Null per a un codi de motiu amb puntuació." }, "direction": { "type": "string", "enum": [ "risk", "trust" ], "description": "Si el senyal ha augmentat el risc o ha reforçat la confiança." }, "message": { "type": "string", "description": "Explicació fàcil de llegir del senyal, en anglès." }, "impact_level": { "type": "string", "nullable": true, "description": "Amb quina intensitat ha modificat la puntuació el senyal, per exemple `low`, `medium` o `high`." } } }, "description": "Senyals que expliquen la puntuació, cadascun amb un codi de Didit estable, una direcció, un missatge i un nivell d'impacte. Poden aparèixer codis nous al llarg del temps, de manera que no rebutgis els codis desconeguts." } } }, "EmailIntelligence": { "type": "object", "description": "Bloc d'intel·ligència de correu electrònic normalitzat. Només present quan el complement d'intel·ligència s'ha executat per a aquest correu electrònic; quan és present també s'exposa com l'àlies `enrichment` amb valors idèntics.", "properties": { "score": { "type": "number", "nullable": true, "description": "Puntuació de risc normalitzada de 0 a 100. Com més alta, més arriscada." }, "deliverable": { "type": "string", "nullable": true, "description": "Franja de capacitat de lliurament (p. ex., `high`)." }, "breach_risk_level": { "type": "string", "nullable": true, "description": "`Low`, `Medium` o `High`." }, "breach_risk_index": { "type": "number", "nullable": true, "description": "Índex numèric de risc de vulneració." }, "is_recent_breach": { "type": "boolean", "nullable": true, "description": "`true` quan l'adreça apareix en una filtració recent." }, "is_frequent_breached": { "type": "boolean", "nullable": true, "description": "`true` quan l'adreça apareix en moltes filtracions." }, "is_disposable": { "type": "boolean", "nullable": true, "description": "`true` quan el domini és un proveïdor d'un sol ús." }, "is_free_domain": { "type": "boolean", "nullable": true, "description": "`true` quan el domini és un proveïdor de correu gratuït." }, "is_breached": { "type": "boolean", "nullable": true, "description": "`true` quan l'adreça apareix en filtracions conegudes." }, "no_of_breaches": { "type": "number", "nullable": true, "description": "Nombre de filtracions conegudes que contenen l'adreça." }, "reason_codes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Identificador estable de Didit del senyal, per exemple `IR-5AC67A32`. Opac: agrupa i filtra per ell, no l'analitzis sintàcticament." }, "value": { "nullable": true, "description": "Per a un indicador de risc (per exemple `voip`, `leaked`, `disposable`, `spam_trap`), el seu valor: un booleà, un nivell o una data. Null per a un codi de motiu amb puntuació." }, "direction": { "type": "string", "enum": [ "risk", "trust" ], "description": "Si el senyal ha augmentat el risc o ha reforçat la confiança." }, "message": { "type": "string", "description": "Explicació fàcil de llegir del senyal, en anglès." }, "impact_level": { "type": "string", "nullable": true, "description": "Amb quina intensitat ha modificat la puntuació el senyal, per exemple `low`, `medium` o `high`." } } }, "description": "Senyals que expliquen la puntuació, cadascun amb un codi de Didit estable, una direcció, un missatge i un nivell d'impacte. Poden aparèixer codis nous al llarg del temps, de manera que no rebutgis els codis desconeguts." } } }, "IPRiskResult": { "type": "object", "description": "Resultat de risc d'IP. Els camps d'enriquiment individuals poden ser `null` quan la cerca no ha retornat dades utilitzables.", "required": [ "status", "threat" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review" ], "description": "`In Review` quan el país resolt entra en conflicte amb `claimed_country`, o quan l'adreça està associada a una infraestructura de VPN, Tor o centre de dades. En cas contrari, `Approved`." }, "ip_address": { "type": "string", "nullable": true, "description": "L'adreça puntuada. `null` quan cap font d'enriquiment ha retornat dades utilitzables." }, "ip_country": { "type": "string", "nullable": true, "description": "Nom del país resolt." }, "ip_country_code": { "type": "string", "nullable": true, "description": "Codi de país resolt. Compara els països mitjançant `country_mismatch` en lloc de comparar cadenes de país en brut pel teu compte." }, "ip_state": { "type": "string", "nullable": true, "description": "Estat o regió resolts." }, "ip_city": { "type": "string", "nullable": true, "description": "Ciutat resolta." }, "latitude": { "type": "number", "nullable": true, "description": "Geolocalització de xarxa aproximada, no una ubicació precisa del dispositiu." }, "longitude": { "type": "number", "nullable": true, "description": "Geolocalització de xarxa aproximada, no una ubicació precisa del dispositiu." }, "isp": { "type": "string", "nullable": true, "description": "Proveïdor de serveis d'Internet que presta servei a l'adreça." }, "organization": { "type": "string", "nullable": true, "description": "Organització propietària del bloc d'adreces." }, "is_vpn_or_tor": { "type": "boolean", "nullable": true, "description": "`true` quan l'adreça està associada amb infraestructura VPN o Tor." }, "is_data_center": { "type": "boolean", "nullable": true, "description": "`true` quan l'adreça pertany a una xarxa d'allotjament o de centre de dades." }, "time_zone": { "type": "string", "nullable": true, "description": "Zona horària de la ubicació resolta." }, "time_zone_offset": { "type": "string", "nullable": true, "description": "Desfasament UTC de la ubicació resolta." }, "asn_number": { "type": "number", "nullable": true, "description": "Número de sistema autònom." }, "asn_organization": { "type": "string", "nullable": true, "description": "Organització que opera el sistema autònom." }, "connection_type": { "type": "string", "nullable": true, "description": "Classificació de la connexió (p. ex., `cellular`, `hosting`)." }, "carrier": { "type": "string", "nullable": true, "description": "Operador mòbil quan l'adreça pertany a una xarxa mòbil." }, "proxy_type": { "type": "string", "nullable": true, "description": "Classificació de proxy quan l'adreça és darrere d'un proxy." }, "claimed_country": { "type": "string", "nullable": true, "description": "Ressò del `claimed_country` que has enviat." }, "country_mismatch": { "type": "boolean", "nullable": true, "description": "`true` quan el país resolt difereix de `claimed_country`. `null` quan no hi ha dades d'enriquiment o cap país declarat disponible." }, "threat": { "type": "object", "additionalProperties": true, "description": "Evidència d'amenaces de xarxa en format lliure de la font d'enriquiment (p. ex., `is_proxy`, `is_tor`). Objecte buit quan no hi ha dades d'enriquiment disponibles. Tracta-ho com a detall de diagnòstic, no com un contracte estable." } } }, "PhoneRiskResponse": { "type": "object", "required": [ "request_id", "status", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Identificador de la sessió d'API creada per a aquesta sol·licitud. Emmagatzema'l amb `vendor_data` si necessites correlacionar el resultat amb webhooks posteriors o amb l'activitat a la consola." }, "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Decisió final per a aquesta sessió d'API. Normalment `Approved`; l'avaluació de risc pot generar `In Review` o `Declined`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò de les `vendor_data` que has enviat, `null` si no n'has enviat cap." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ressò de les `metadata` que has enviat, `null` si no n'has enviat cap." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de temps d'aquesta resposta." }, "phone": { "type": "object", "description": "Informe normalitzat de telèfon, el mateix bloc utilitzat per les respostes de Verificació de telèfon.", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Decisió per a aquest número de telèfon. Reflecteix el camp `status` de nivell superior." }, "phone_number_prefix": { "type": "string", "description": "Codi telefònic de país que comença amb `+` (p. ex., `+1`).", "example": "+1" }, "phone_number": { "type": "string", "description": "Número nacional sense el prefix telefònic del país.", "example": "4155552671" }, "full_number": { "type": "string", "description": "Número complet en format 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": "Nom complet del país derivat de `country_code`.", "example": "United States" }, "carrier": { "type": "object", "nullable": true, "description": "Xarxa actual que dona servei al número. `null` quan la cerca no ha pogut resoldre cap operador.", "properties": { "name": { "type": "string", "description": "Nom de l'operador. Cadena buida quan la cerca no l'ha pogut identificar." }, "type": { "type": "string", "description": "Tipus de línia indicat per la cerca: `mobile`, `fixed_line`, `voip`, `isp`, `vpn`, `toll_free`, `premium_rate` o similar." } } }, "is_disposable": { "type": "boolean", "description": "`true` quan el número pertany a un servei de números temporals o d'un sol ús." }, "is_virtual": { "type": "boolean", "description": "`true` quan el tipus de línia és virtual (`voip`, `isp` o `vpn`)." }, "verification_method": { "type": "string", "nullable": true, "description": "Canal d'OTP de la verificació subjacent. `null` per a consultes de risc, que mai no envien cap codi." }, "verification_attempts": { "type": "integer", "description": "Enviaments d'OTP per a aquest número. `0` per a consultes de risc." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va verificar el número per darrera vegada mitjançant un OTP. `null` per a cerques de risc." }, "warnings": { "type": "array", "description": "Advertències de risc registrades per a aquesta sol·licitud. Matriu buida si no n'hi ha cap.", "items": { "$ref": "#/components/schemas/RiskWarning" } }, "lifecycle": { "type": "array", "description": "Traça d'auditoria cronològica de la sol·licitud. Matriu buida per a cerques de risc sense esdeveniments d'enviament.", "items": { "$ref": "#/components/schemas/RiskLifecycleEvent" } }, "matches": { "type": "array", "description": "Altres sessions de la teva aplicació on un usuari diferent (amb un `vendor_data` diferent) ha utilitzat el mateix número de telèfon. Fins a 5 entrades. Matriu buida quan no hi ha coincidències.", "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": "Identificador de la sessió d'API creada per a aquesta sol·licitud. Emmagatzema'l amb `vendor_data` si necessites correlacionar el resultat amb webhooks posteriors o amb l'activitat a la consola." }, "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Decisió final per a aquesta sessió d'API. Normalment `Approved`; l'avaluació de risc pot generar `In Review` o `Declined`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò de les `vendor_data` que has enviat, `null` si no n'has enviat cap." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ressò de les `metadata` que has enviat, `null` si no n'has enviat cap." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de temps d'aquesta resposta." }, "email": { "type": "object", "description": "Informe normalitzat de correu electrònic, el mateix bloc que s'utilitza a les respostes de Verificació de correu electrònic.", "required": [ "status", "email", "is_breached", "breaches", "is_disposable", "is_undeliverable" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Decisió per a aquesta adreça de correu electrònic. Reflecteix el camp `status` de nivell superior." }, "email": { "type": "string", "description": "L'adreça puntuada.", "example": "alice@example.com" }, "is_breached": { "type": "boolean", "description": "Indica si l'adreça apareix en una filtració coneguda de credencials." }, "breaches": { "type": "array", "description": "Fins a les 5 filtracions conegudes més recents que contenen aquesta adreça. Matriu buida quan `is_breached` és `false`.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Identificador de la filtració." }, "domain": { "type": "string", "description": "Domini del servei afectat per la filtració." }, "breach_date": { "type": "string", "format": "date", "description": "Data en què es va produir l'incompliment." }, "breach_emails_count": { "type": "integer", "description": "Nombre total de comptes exposats a la filtració." }, "description": { "type": "string", "description": "Descripció fàcil de llegir de la vulneració (pot contenir marcatge HTML)." }, "logo_path": { "type": "string", "description": "URL del logotip del servei afectat per la filtració." }, "data_classes": { "type": "array", "items": { "type": "string" }, "description": "Categories de dades exposades, en snake_case (p. ex., `email_addresses`, `passwords`)." }, "is_verified": { "type": "boolean", "description": "Indica si s'ha verificat que la filtració és legítima." } } } }, "is_disposable": { "type": "boolean", "description": "Indica si el domini pertany a un proveïdor d'un sol ús." }, "is_undeliverable": { "type": "boolean", "description": "Indica si s'ha determinat que l'adreça no es pot lliurar." }, "verification_attempts": { "type": "integer", "description": "Enviaments d'OTP per a aquesta adreça. `0` per a consultes de risc." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va verificar l'adreça per darrera vegada mitjançant un OTP. `null` per a cerques de risc." }, "warnings": { "type": "array", "description": "Advertències de risc registrades per a aquesta sol·licitud. Matriu buida si no n'hi ha cap.", "items": { "$ref": "#/components/schemas/RiskWarning" } }, "lifecycle": { "type": "array", "description": "Traça d'auditoria cronològica de la sol·licitud. Matriu buida per a cerques de risc sense enviaments.", "items": { "$ref": "#/components/schemas/RiskLifecycleEvent" } }, "matches": { "type": "array", "description": "Altres sessions de la teva aplicació on un usuari diferent (amb un `vendor_data` diferent) ha utilitzat la mateixa adreça de correu electrònic. Fins a 5 entrades. Matriu buida quan no hi ha coincidències.", "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": "Identificador de la sessió d'API creada per a aquesta sol·licitud. Emmagatzema'l amb `vendor_data` si necessites correlacionar el resultat amb webhooks posteriors o amb l'activitat a la consola." }, "status": { "type": "string", "enum": [ "Approved", "In Review" ], "description": "Decisió per a aquesta sessió de l'API: `In Review` per risc de xarxa o discrepància de país, en cas contrari `Approved`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò de les `vendor_data` que has enviat, `null` si no n'has enviat cap." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ressò de les `metadata` que has enviat, `null` si no n'has enviat cap." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de temps d'aquesta resposta." }, "ip": { "type": "object", "description": "Resultat de risc d'IP. Els camps d'enriquiment individuals poden ser `null` quan la cerca no ha retornat dades utilitzables.", "required": [ "status", "threat" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review" ], "description": "`In Review` quan el país resolt entra en conflicte amb `claimed_country`, o quan l'adreça està associada a una infraestructura de VPN, Tor o centre de dades. En cas contrari, `Approved`." }, "ip_address": { "type": "string", "nullable": true, "description": "L'adreça puntuada. `null` quan cap font d'enriquiment ha retornat dades utilitzables." }, "ip_country": { "type": "string", "nullable": true, "description": "Nom del país resolt." }, "ip_country_code": { "type": "string", "nullable": true, "description": "Codi de país resolt. Compara els països mitjançant `country_mismatch` en lloc de comparar cadenes de país en brut pel teu compte." }, "ip_state": { "type": "string", "nullable": true, "description": "Estat o regió resolts." }, "ip_city": { "type": "string", "nullable": true, "description": "Ciutat resolta." }, "latitude": { "type": "number", "nullable": true, "description": "Geolocalització de xarxa aproximada, no una ubicació precisa del dispositiu." }, "longitude": { "type": "number", "nullable": true, "description": "Geolocalització de xarxa aproximada, no una ubicació precisa del dispositiu." }, "isp": { "type": "string", "nullable": true, "description": "Proveïdor de serveis d'Internet que presta servei a l'adreça." }, "organization": { "type": "string", "nullable": true, "description": "Organització propietària del bloc d'adreces." }, "is_vpn_or_tor": { "type": "boolean", "nullable": true, "description": "`true` quan l'adreça està associada amb infraestructura VPN o Tor." }, "is_data_center": { "type": "boolean", "nullable": true, "description": "`true` quan l'adreça pertany a una xarxa d'allotjament o de centre de dades." }, "time_zone": { "type": "string", "nullable": true, "description": "Zona horària de la ubicació resolta." }, "time_zone_offset": { "type": "string", "nullable": true, "description": "Desfasament UTC de la ubicació resolta." }, "asn_number": { "type": "number", "nullable": true, "description": "Número de sistema autònom." }, "asn_organization": { "type": "string", "nullable": true, "description": "Organització que opera el sistema autònom." }, "connection_type": { "type": "string", "nullable": true, "description": "Classificació de la connexió (p. ex., `cellular`, `hosting`)." }, "carrier": { "type": "string", "nullable": true, "description": "Operador mòbil quan l'adreça pertany a una xarxa mòbil." }, "proxy_type": { "type": "string", "nullable": true, "description": "Classificació de proxy quan l'adreça és darrere d'un proxy." }, "claimed_country": { "type": "string", "nullable": true, "description": "Ressò del `claimed_country` que has enviat." }, "country_mismatch": { "type": "boolean", "nullable": true, "description": "`true` quan el país resolt difereix de `claimed_country`. `null` quan no hi ha dades d'enriquiment o cap país declarat disponible." }, "threat": { "type": "object", "additionalProperties": true, "description": "Evidència d'amenaces de xarxa en format lliure de la font d'enriquiment (p. ex., `is_proxy`, `is_tor`). Objecte buit quan no hi ha dades d'enriquiment disponibles. Tracta-ho com a detall de diagnòstic, no com un contracte estable." } } } } }, "SocialFootprintPlatform": { "type": "object", "properties": { "platform": { "type": "string", "description": "Identificador de plataforma.", "example": "whatsapp" }, "category": { "type": "string", "description": "Categoria de plataforma, p. ex. MESSAGING, SOCIAL_MEDIA, ECOMMERCE, PROFESSIONAL, EMAIL_PROVIDER.", "example": "MESSAGING" }, "scope": { "type": "string", "enum": [ "global", "local" ], "description": "`global` per a plataformes d'àmbit mundial, `local` per a les específiques d'una regió.", "example": "global" } } }, "SocialFootprintCategorySummary": { "type": "object", "properties": { "registered": { "type": "integer", "nullable": true, "description": "Plataformes d'aquesta categoria on el registre està confirmat.", "example": 2 }, "ratio": { "type": "number", "format": "float", "nullable": true, "description": "Proporció de les plataformes comprovades de la categoria amb un registre, 0.0-1.0.", "example": 0.6667 } } }, "SocialFootprintProfile": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Nom del perfil, quan la plataforma l'exposa." }, "photo": { "type": "string", "nullable": true, "description": "URL de la foto de perfil, quan la plataforma l'exposa." }, "about": { "type": "string", "nullable": true, "description": "Text d'informació/biografia del perfil, quan la plataforma l'exposa." }, "privacy_status": { "type": "string", "nullable": true, "enum": [ "PUBLIC", "PRIVATE", null ], "description": "Visibilitat del perfil, quan la plataforma l'exposa." }, "business_account": { "type": "boolean", "nullable": true, "description": "Si el perfil és un compte d'empresa, quan la plataforma l'exposa." } } }, "PhoneSocialFootprint": { "type": "object", "nullable": true, "description": "Petjada social del número de telèfon: les plataformes en línia on està registrat. Només present si s'ha definit `enable_social` i la comprovació s'ha completat. Cada recompte pot ser nul si no s'han obtingut dades. `profiles_registered: 0` significa que s'han consultat les plataformes i que el número de telèfon no s'ha trobat en cap d'elles: una resposta vàlida i facturable, i un senyal habitual d'identitat sintètica.", "properties": { "profiles_registered": { "type": "integer", "nullable": true, "description": "Plataformes on el número de telèfon està confirmat com a registrat.", "example": 5 }, "profiles_checked": { "type": "integer", "nullable": true, "description": "Plataformes avaluades per al registre.", "example": 14 }, "names_found": { "type": "integer", "nullable": true, "description": "Plataformes que han retornat un nom associat.", "example": 0 }, "photos_found": { "type": "integer", "nullable": true, "description": "Plataformes que han retornat una foto de perfil.", "example": 0 }, "communication_breadth": { "type": "integer", "nullable": true, "description": "Plataformes de comunicació amb presència detectada.", "example": 2 }, "digital_footprint_diversity": { "type": "integer", "nullable": true, "description": "Categories de plataforma diferents amb presència detectada.", "example": 5 }, "digital_sophistication_index": { "type": "integer", "nullable": true, "description": "Indicador compost de maduresa digital, 0-10.", "example": 5 }, "engagement_depth_index": { "type": "integer", "nullable": true, "description": "Indicador de riquesa del perfil, de 0 a 10.", "example": 3 }, "subscription_affordability_index": { "type": "integer", "nullable": true, "description": "Combinació de plataformes gratuïtes i de pagament, 0-10.", "example": 2 }, "free_platforms": { "type": "integer", "nullable": true, "description": "Registres en plataformes gratuïtes.", "example": 4 }, "full_paid_platforms": { "type": "integer", "nullable": true, "description": "Registres en plataformes totalment de pagament.", "example": 0 }, "partial_paid_platforms": { "type": "integer", "nullable": true, "description": "Registres en plataformes freemium.", "example": 1 }, "whatsapp_profile_completeness": { "type": "string", "nullable": true, "enum": [ "Basic", "Partial", "Complete", "Not Present", null ], "description": "Completitud del perfil de WhatsApp. Només per a telèfon; null per a correu electrònic.", "example": "Partial" }, "registered_platforms": { "type": "array", "description": "Plataformes on el registre està confirmat.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "not_registered_platforms": { "type": "array", "description": "Plataformes comprovades amb resultat negatiu.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "categories": { "type": "object", "description": "Recompte registrat i proporció per categoria de plataforma.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintCategorySummary" } }, "profiles": { "type": "object", "description": "Detalls del perfil per plataforma, indexats per plataforma, quan la plataforma els exposa.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintProfile" } } } }, "EmailSocialFootprint": { "type": "object", "nullable": true, "description": "Petjada social de l'adreça de correu electrònic: les plataformes en línia on està registrada. Només present si s'ha definit `enable_social` i la comprovació s'ha completat. Cada recompte pot ser nul si no s'han obtingut dades. `profiles_registered: 0` significa que s'han consultat les plataformes i que l'adreça de correu electrònic no s'ha trobat en cap d'elles: una resposta vàlida i facturable, i un senyal habitual d'identitat sintètica.", "properties": { "profiles_registered": { "type": "integer", "nullable": true, "description": "Plataformes on l'adreça de correu electrònic està confirmada com a registrada.", "example": 5 }, "profiles_checked": { "type": "integer", "nullable": true, "description": "Plataformes avaluades per al registre.", "example": 14 }, "names_found": { "type": "integer", "nullable": true, "description": "Plataformes que han retornat un nom associat.", "example": 0 }, "photos_found": { "type": "integer", "nullable": true, "description": "Plataformes que han retornat una foto de perfil.", "example": 0 }, "communication_breadth": { "type": "integer", "nullable": true, "description": "Plataformes de comunicació amb presència detectada.", "example": 2 }, "digital_footprint_diversity": { "type": "integer", "nullable": true, "description": "Categories de plataforma diferents amb presència detectada.", "example": 5 }, "digital_sophistication_index": { "type": "integer", "nullable": true, "description": "Indicador compost de maduresa digital, 0-10.", "example": 5 }, "engagement_depth_index": { "type": "integer", "nullable": true, "description": "Indicador de riquesa del perfil, de 0 a 10.", "example": 3 }, "subscription_affordability_index": { "type": "integer", "nullable": true, "description": "Combinació de plataformes gratuïtes i de pagament, 0-10.", "example": 2 }, "free_platforms": { "type": "integer", "nullable": true, "description": "Registres en plataformes gratuïtes.", "example": 4 }, "full_paid_platforms": { "type": "integer", "nullable": true, "description": "Registres en plataformes totalment de pagament.", "example": 0 }, "partial_paid_platforms": { "type": "integer", "nullable": true, "description": "Registres en plataformes freemium.", "example": 1 }, "whatsapp_profile_completeness": { "type": "string", "nullable": true, "enum": [ "Basic", "Partial", "Complete", "Not Present", null ], "description": "Completitud del perfil de WhatsApp. Només per a telèfon; null per a correu electrònic.", "example": "Partial" }, "registered_platforms": { "type": "array", "description": "Plataformes on el registre està confirmat.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "not_registered_platforms": { "type": "array", "description": "Plataformes comprovades amb resultat negatiu.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "categories": { "type": "object", "description": "Recompte registrat i proporció per categoria de plataforma.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintCategorySummary" } }, "profiles": { "type": "object", "description": "Detalls del perfil per plataforma, indexats per plataforma, quan la plataforma els exposa.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintProfile" } } } }, "KYBRegistryAddress": { "type": "object", "description": "Una adreça que indica el registre, amb el mateix format per a cada país i font de registre. Cada clau està sempre present; qualsevol part que el registre no publiqui és nul·la.", "properties": { "type": { "type": "string", "nullable": true, "description": "Tipus d'adreça en minúscules: `registered` per a la seu social; altres tipus segons com els anomena el registre (per exemple, `postal`, `office`). `null` quan el registre no indica de quin tipus d'adreça es tracta." }, "address": { "type": "string", "description": "L'adreça completa en una sola línia. Sempre present a cada adreça." }, "street": { "type": "string", "nullable": true, "description": "Carrer i número." }, "city": { "type": "string", "nullable": true, "description": "Ciutat o localitat." }, "postal_code": { "type": "string", "nullable": true, "description": "Codi postal." }, "region": { "type": "string", "nullable": true, "description": "Regió, estat o província." }, "country_code": { "type": "string", "nullable": true, "description": "Codi de país ISO 3166-1 alfa-2." }, "description": { "type": "string", "nullable": true, "description": "L'etiqueta pròpia del registre per a l'adreça, si en proporciona una." } }, "required": [ "type", "address", "street", "city", "postal_code", "region", "country_code", "description" ] }, "KYBRegistryIndustry": { "type": "object", "description": "Una activitat sota la qual el registre classifica l'empresa, amb el mateix format per a cada país i font de registre.", "properties": { "code": { "type": "string", "nullable": true, "description": "Codi d'activitat tal com l'imprimeix el registre (per exemple `73110`)." }, "description": { "type": "string", "nullable": true, "description": "Etiqueta de l'activitat, quan el registre en publica una." }, "scheme": { "type": "string", "nullable": true, "description": "Sistema de classificació, un nom per sistema independentment de la font que l'hagi informat: `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`; altres sistemes nacionals mantenen el propi nom del registre. Null quan el registre no indica el nom del sistema." }, "is_primary": { "type": "boolean", "description": "Cert per a l'activitat principal de l'empresa. Exactament una entrada és primària quan la llista no és buida." } }, "required": [ "code", "description", "scheme", "is_primary" ] }, "KYBRegistryShareholding": { "type": "object", "nullable": true, "description": "El que posseeix un titular, amb el mateix format per a tots els països i fonts de registres mercantils. Null quan el registre indica que no hi ha participació. Un interval (per exemple, el 25-50% d'un PSC del Regne Unit) no és una participació: `percentage` és null i l'interval es manté a `ownership_min_shares` / `ownership_max_shares`.", "properties": { "share_class": { "type": "string", "nullable": true, "description": "Classe o tipus d'acció tal com l'anomena el registre." }, "number_of_shares": { "type": "number", "nullable": true, "description": "Nombre d'accions posseïdes." }, "currency": { "type": "string", "nullable": true, "description": "Moneda ISO 4217 dels valors següents." }, "nominal_value": { "type": "number", "nullable": true, "description": "Valor nominal per acció." }, "total_value": { "type": "number", "nullable": true, "description": "Valor total de la participació." }, "percentage": { "type": "number", "nullable": true, "description": "Participació exacta en percentatge, amb quatre decimals." } }, "required": [ "share_class", "number_of_shares", "currency", "nominal_value", "total_value", "percentage" ] }, "KYBRegistryOwnership": { "type": "object", "description": "El resultat del nivell de titularitat (Accionistes / UBO), amb la mateixa estructura per a cada país i font de registre.", "properties": { "status": { "type": "string", "nullable": true, "enum": [ "not_requested", "pending", "delivered", "not_held", "unavailable", null ], "description": "`delivered` quan el registre ha publicat la titularitat; `not_held` quan el registre de titularitat ha respost i no llista en absolut l'empresa (consulta `unavailable_reason`); `unavailable` quan no ha servit les dades de titularitat per qualsevol altre motiu (consulta `unavailable_reason`); `pending` mentre el registre encara les està obtenint; `not_requested` per al nivell Basic." }, "tier_requested": { "type": "string", "nullable": true, "enum": [ "basic", "shareholders", "ubo", null ], "description": "El nivell que ha demanat el flux de treball." }, "tier_delivered": { "type": "string", "nullable": true, "enum": [ "basic", "shareholders", "ubo", null ], "description": "El nivell que ha lliurat el registre (i que es factura). Una sol·licitud d'UBO que es respon només amb accionistes directes és `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": "Per què no s'ha lliurat un nivell de titularitat sol·licitat. Nul tret que `status` sigui `unavailable` o `pending`." }, "direct_ownership_complete": { "type": "boolean", "nullable": true, "description": "Cert quan les participacions declarades dels accionistes directes sumen el 100% (dins d'un punt percentual d'arrodoniment); fals quan no és així; null quan no s'ha proporcionat la titularitat o no s'ha declarat una participació." }, "unresolved": { "type": "array", "description": "Parts de la cadena de titularitat que el registre no ha pogut resoldre, per exemple si no hi ha cap estructura de grup registrada per sobre dels propietaris directes.", "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": "Detall normalitzat del registre mercantil de Didit per a l'empresa: el resultat de titularitat (`ownership_error`, `section_errors`, `ubo_resolution`, `lite_enrichment`), les correccions fetes amb update-data i fets del registre que no tenen un camp propi. Mai conté el registre propi de la font registral. Cada clau és opcional i només és present quan l'empresa en té un valor; se'n poden afegir de noves. Consulta els camps canònics (`addresses`, `industries`, `ownership`, `beneficial_owners[].shareholding`) per a tot allò que cobreixen.", "properties": { "company_name": { "type": "string", "description": "Nom de l'empresa corregit a la consola." }, "registration_number": { "type": "string", "description": "Número de registre tal com l'indica el registre o una correcció de la consola." }, "country_code": { "type": "string", "description": "País del registre segons el registre o una correcció de la consola." }, "region": { "type": "string", "description": "Regió o estat del registre." }, "incorporation_date": { "type": "string", "description": "Data de constitució (ISO 8601)." }, "registration_date": { "type": "string", "description": "Data de registre (ISO 8601) quan el registre n'indica una de diferent de la data de constitució." }, "dissolution_date": { "type": "string", "description": "Data de dissolució (ISO 8601) quan el registre en fa constar una." }, "tax_number": { "type": "string", "description": "Identificador fiscal." }, "vat_number": { "type": "string", "description": "Número d'IVA." }, "legal_address": { "type": "string", "description": "Adreça social tal com s'ha corregit a la consola." }, "registered_address": { "type": "string", "description": "Adreça registrada tal com consta al registre." }, "company_type": { "type": "string", "description": "Forma jurídica." }, "registry_status": { "type": "string", "description": "Estat de l'empresa al registre mercantil." }, "verification_status": { "type": "string", "description": "Estat de la verificació." }, "alternative_names": { "type": "string", "description": "Altres noms comercials que l'empresa utilitza o ha utilitzat." }, "nature_of_business": { "type": "string", "description": "Descripció de l'activitat." }, "registered_capital": { "type": "string", "description": "Capital registrat tal com està imprès." }, "registered_capital_amount": { "type": "string", "description": "Import del capital registrat, com a cadena en format decimal." }, "registered_capital_currency": { "type": "string", "description": "Moneda del capital registrat (ISO 4217)." }, "website": { "type": "string", "description": "Lloc web." }, "email": { "type": "string", "description": "Correu electrònic de contacte." }, "phone": { "type": "string", "description": "Telèfon de contacte." }, "legal_entity_identifier": { "type": "string", "description": "Identificador d'entitat jurídica (LEI)." }, "location_of_registration": { "type": "string", "description": "Lloc de registre." }, "control_scheme": { "type": "string", "description": "Esquema de governança quan el registre l'exposa." }, "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": "Per què no s'ha lliurat un nivell de titularitat sol·licitat, amb els mateixos codis que `ownership.unavailable_reason`. `no_owners_on_record` (el registre ha respost i no indica cap titular) i `ownership_section_unavailable` (el registre no ha retornat la secció de titularitat) són resultats diferents." }, "section_errors": { "type": "object", "description": "Seccions que el registre no ha retornat, indexades per secció (`officers`, `shareholders`, `group_structure`). Una secció llistada aquí no s'ha lliurat mai: una llista buida al seu costat no diu res sobre l'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": "Els camps propis del registre per a l'empresa, indexats tal com els anomena el registre, com a valors plans (registres antics). Només s'inclouen els camps revisats com a fets del registre." }, "registry_sources": { "type": "array", "description": "Els registres oficials dels quals s'ha extret el registre (registres antics). No s'indiquen altres fonts.", "items": { "$ref": "#/components/schemas/KYBRegistrySource" } }, "previous_names": { "type": "array", "items": { "type": "string" }, "description": "Noms sota els quals l'empresa estava registrada anteriorment (registres històrics)." }, "parent_companies": { "type": "array", "items": { "type": "string" }, "description": "Empreses matriu que indica el registre (registres antics)." }, "documents_available": { "type": "integer", "description": "Quants registres ofereix el registre mercantil per a l'empresa (registres heretats)." } } }, "KYBRegistryGroupCompany": { "type": "object", "description": "Una empresa del grup corporatiu, segons la seva identitat registral.", "properties": { "name": { "type": "string", "nullable": true, "description": "Nom de l'empresa." }, "country_code": { "type": "string", "nullable": true, "description": "País de registre." }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registre." } }, "required": [ "name", "country_code", "registration_number" ] }, "KYBRegistryUboResolution": { "type": "object", "description": "Com ha recorregut el nivell d'UBO la cadena de titularitat per sobre de l'empresa.", "properties": { "parent_chain": { "type": "array", "description": "Matrius corporatives des de la matriu última fins a l'empresa.", "items": { "$ref": "#/components/schemas/KYBRegistryGroupCompany" } }, "subsidiaries": { "type": "array", "description": "Empreses directament subordinades a l'empresa en el seu grup empresarial.", "items": { "$ref": "#/components/schemas/KYBRegistryGroupCompany" } }, "unresolved": { "type": "array", "description": "Parts de la cadena que el registre no ha pogut resoldre (les mateixes entrades que `ownership.unresolved`).", "items": { "type": "object", "properties": { "reason": { "type": "string", "description": "Per què, per exemple `no_group_structure_on_record`, `selected_company_not_in_group_structure` o `section_error`." }, "section": { "type": "string", "nullable": true, "description": "La secció afectada, per exemple `group_structure`." } }, "required": [ "reason", "section" ] } } }, "required": [ "parent_chain", "subsidiaries", "unresolved" ] }, "KYBRegistrySectionError": { "type": "object", "description": "Una secció que el registre no ha retornat.", "properties": { "status_code": { "type": "integer", "nullable": true, "description": "L'estat que el registre ha respost per a la secció." } }, "required": [ "status_code" ] }, "KYBRegistryLiteEnrichment": { "type": "object", "description": "Camps buits del perfil Lite que una altra de les fonts del registre del país ha omplert. La font no s'especifica.", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "Els camps de l'empresa que s'han emplenat." }, "people_added": { "type": "integer", "description": "Quants administradors o titulars reals s'han afegit." } }, "required": [ "fields", "people_added" ] }, "KYBRegistrySource": { "type": "object", "description": "Un registre oficial del qual s'ha extret el registre. Només s'esmenten els registres governamentals oficials, els reguladors i el sistema oficial d'identificadors; qualsevol altra font s'omet.", "properties": { "name": { "type": "string", "description": "Nom del registre, per exemple `UK Companies House`." }, "source_type": { "type": "string", "enum": [ "official" ], "description": "Sempre `official`." } }, "required": [ "name", "source_type" ] }, "KYBOwnershipStructure": { "type": "object", "nullable": true, "description": "L'estructura de capital que ha acreditat el registre, tal com estava quan es va lliurar el nivell de titularitat: `shareholders` directes i `beneficial_owners`. Null quan el registre no ha acreditat cap titularitat. Mai conté les files pròpies de la font del registre; consulta `company.beneficial_owners` i `company.ownership` per al registre 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 titular de la instantània de titularitat: la mateixa identitat del registre i participació que `company.beneficial_owners[]`, i la seva `shareholding` canònica.", "properties": { "name": { "type": "string", "nullable": true, "description": "Nom del propietari tal com consta al registre." }, "first_name": { "type": "string", "nullable": true, "description": "Nom de pila, per a una persona física, quan el registre l'especifica." }, "last_name": { "type": "string", "nullable": true, "description": "Cognom, per a una persona física, quan el registre mercantil ho especifica." }, "date_of_birth": { "type": "string", "nullable": true, "description": "Data de naixement (ISO 8601) quan el registre la publica." }, "country_of_birth": { "type": "string", "nullable": true, "description": "País de naixement quan el registre el publica." }, "company_name": { "type": "string", "nullable": true, "description": "Nom de l'empresa, per a un titular corporatiu." }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registre, per a un propietari corporatiu." }, "entity_type": { "type": "string", "nullable": true, "enum": [ "person", "company", null ], "description": "Si el titular és una persona física o una empresa." }, "nationality": { "type": "string", "nullable": true, "description": "Nacionalitat quan el registre la indica." }, "designation": { "type": "string", "nullable": true, "description": "El càrrec o rol del titular tal com figura al registre." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "`shareholder` per a un titular directe, `ubo` per a un titular real." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Límit inferior de la participació, en percentatge (igual al límit superior per a una participació exacta)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Límit superior de la participació, en percentatge." }, "voting_min_shares": { "type": "string", "nullable": true, "description": "Límit inferior dels drets de vot, en percentatge." }, "voting_max_shares": { "type": "string", "nullable": true, "description": "Límit superior dels drets de vot, en percentatge." }, "appointment_date": { "type": "string", "nullable": true, "description": "Data en què va començar la participació o el nomenament (ISO 8601)." }, "is_active": { "type": "boolean", "nullable": true, "description": "Fals per a un antic propietari." }, "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": "Codi llegible per màquina estable, p. ex. 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": "Errors de validació de la sol·licitud: cada camp rebutjat amb els seus missatges.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "DigitalIdWalletApiWalletVerificationResponse": { "type": "object", "description": "Una verificació de cartera independent, tal com respon cada endpoint de carteres.", "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": "L'objecte de metadades enviat a l'inici, 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 mentre està pendent, després Approved (verificada) 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": "Cert un cop s'ha verificat la signatura de la credencial; null per a una de 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": "Nacionalitat ISO3, només quan la cartera n'afirmi una (mai deduïda)." }, "issuing_state": { "type": "string", "description": "País ISO3 l'esquema del qual ha emès la identitat." } }, "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: envia el navegador de l'usuari a url. confirm_in_app: mostra verification_code a l'usuari, que comprova que coincideixi amb el codi de la seva aplicació de cartera i confirma allà; després fes una consulta periòdica. request_digital_credential: en un gest de l'usuari a l'origen amb què has començat, sol·licita-ho a la cartera amb digital_credentials.request i, a continuació, envia el que retorni 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": "només redirect: on l'usuari inicia sessió amb la cartera." }, "digital_credentials": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWalletDigitalCredentialsRequest" } ], "description": "només request_digital_credential: la sol·licitud que s'ha de passar a la cartera." }, "verification_code": { "type": "string", "description": "Només confirm_in_app: el codi de comparació de 4 dígits que també mostra l'aplicació de la cartera." }, "poll_interval_seconds": { "type": "integer", "description": "Només confirm_in_app: amb quina freqüència s'ha de cridar POST .../verifications/{request_id}/poll/ per obtenir informació immediata. Didit també fa sondejos en segon pla dels inicis de sessió pendents, de manera que el webhook informa del resultat fins i tot si no fas sondejos." } }, "required": [ "type" ] }, "DigitalIdWalletApiWalletNextActionTypeEnum": { "enum": [ "redirect", "confirm_in_app", "request_digital_credential" ], "type": "string", "description": "* `redirect` - redirecció\n* `confirm_in_app` - confirma a l'aplicació\n* `request_digital_credential` - sol·licita una credencial digital" }, "DigitalIdWalletApiInteractionEnum": { "enum": [ "redirect", "in_app", "digital_credentials" ], "type": "string", "description": "* `redirect` - redirecció\n* `in_app` - a l'aplicació\n* `digital_credentials` - credencials digitals" }, "DigitalIdWalletApiWalletVerificationResultOutcomeEnum": { "enum": [ "pending", "verified", "cancelled", "timeout", "failed" ], "type": "string", "description": "* `pending` - Pendent\n* `verified` - Verificat\n* `cancelled` - Cancel·lat per l'usuari\n* `timeout` - Temps esgotat\n* `failed` - Fallit" }, "DigitalIdWalletApiWallet": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador de catàleg de la cartera, p. ex., bankid_se." }, "name": { "type": "string" }, "issuing_authority": { "type": "string", "nullable": true } }, "required": [ "id", "issuing_authority", "name" ] }, "DigitalIdWalletApiEudiWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificació d'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": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiEudiWalletVerificationStartCountryEnum" } ], "description": "País ISO 3166-1 alpha-3 de la identitat d'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 qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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` - mateix dispositiu\n* `cross_device` - entre dispositius" }, "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ó de ConnectID (AUS).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiConnectidWalletVerificationStartCountryEnum" } ], "default": "AUS", "description": "País ISO 3166-1 alpha-3 de la identitat de ConnectID. Per defecte és AUS, l'únic país al qual dóna servei.\n\n* `AUS` - AUS" }, "authorisation_server_id": { "type": "string", "minLength": 1, "description": "ID del servidor d'autorització seleccionat amb el selector de bancs de ConnectID. El sandbox utilitza per defecte Mock Bank A.", "maxLength": 36 }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó amb Auðkenni (ISL).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiAudkenniWalletVerificationStartCountryEnum" } ], "default": "ISL", "description": "País ISO 3166-1 alpha-3 de la identitat d'Auðkenni. Per defecte és ISL, l'únic país al qual dóna servei.\n\n* `ISL` - ISL" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó amb FranceConnect (FRA).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiFranceconnectWalletVerificationStartCountryEnum" } ], "default": "FRA", "description": "País ISO 3166-1 alpha-3 de la identitat de FranceConnect. Per defecte és FRA, l'únic país al qual dóna servei.\n\n* `FRA` - FRA" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó de Diia (UKR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDiiaWalletVerificationStartCountryEnum" } ], "default": "UKR", "description": "País ISO 3166-1 alpha-3 de la identitat de Diia. Per defecte és UKR, l'únic país al qual dóna servei.\n\n* `UKR` - UKR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó amb MojeID (CZE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryE2dEnum" } ], "default": "CZE", "description": "País ISO 3166-1 alpha-3 de la identitat MojeID. El valor per defecte és CZE, l'únic país al qual dona servei.\n\n* `CZE` - CZE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó de Bank iD (CZE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryE2dEnum" } ], "default": "CZE", "description": "País ISO 3166-1 alpha-3 de la identitat de Bank iD. Per defecte és CZE, l'únic país al qual dóna servei.\n\n* `CZE` - CZE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificació amb eParaksts mobile (LVA).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiEparakstsMobileWalletVerificationStartCountryEnum" } ], "default": "LVA", "description": "País ISO 3166-1 alpha-3 de la identitat mòbil eParaksts. El valor per defecte és LVA, l'únic país al qual dona servei.\n\n* `LVA` - LVA" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó de targeta d'identitat estoniana (EST).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum" } ], "default": "EST", "description": "País ISO 3166-1 alpha-3 de la identitat d'Estonian ID-card. Per defecte és EST, l'únic país al qual dóna servei.\n\n* `EST` - EST" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó amb Mobile-ID (EST, LTU).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiMobileIdWalletVerificationStartCountryEnum" } ], "description": "País ISO 3166-1 alpha-3 de la identitat Mobile-ID.\n\n* `EST` - EST\n* `LTU` - LTU" }, "personal_code": { "type": "string", "minLength": 1, "description": "El codi d'identificació personal nacional de l'usuari. S'adreça a l'aplicació Mobile-ID de l'usuari; l'usuari confirma el codi de comparació i introdueix el seu PIN a l'aplicació. No demanis mai el PIN.", "pattern": "^[0-9-]{6,20}$" }, "phone_number": { "type": "string", "minLength": 1, "description": "El número de telèfon de Mobile-ID en format 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ó amb Smart-ID (EST, LVA, LTU, BEL).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiSmartIdWalletVerificationStartCountryEnum" } ], "description": "País ISO 3166-1 alpha-3 de la identitat Smart-ID.\n\n* `EST` - EST\n* `LVA` - LVA\n* `LTU` - LTU\n* `BEL` - BEL" }, "personal_code": { "type": "string", "minLength": 1, "description": "El codi d'identificació personal nacional de l'usuari. S'adreça a l'aplicació Smart-ID de l'usuari; l'usuari confirma el codi de comparació i introdueix el seu PIN a l'aplicació. No demanis mai 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ó amb GOV.UK Wallet (GBR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountry520Enum" } ], "default": "GBR", "description": "País ISO 3166-1 alpha-3 de la identitat GOV.UK Wallet. El valor per defecte és GBR, l'únic país al qual dona servei.\n\n* `GBR` - GBR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó amb OneID (GBR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountry520Enum" } ], "default": "GBR", "description": "País ISO 3166-1 alpha-3 de la identitat OneID. El valor per defecte és GBR, l'únic país al qual dona servei.\n\n* `GBR` - GBR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiGovbrWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificació de gov.br (BRA).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiGovbrWalletVerificationStartCountryEnum" } ], "default": "BRA", "description": "País ISO 3166-1 alpha-3 de la identitat gov.br. El valor per defecte és BRA, l'únic país al qual dona servei.\n\n* `BRA` - BRA" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó amb UAE PASS (ARE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum" } ], "default": "ARE", "description": "País ISO 3166-1 alpha-3 de la identitat UAE PASS. El valor per defecte és ARE, l'únic país al qual dona servei.\n\n* `ARE` - ARE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó amb Freja eID (SWE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryEe9Enum" } ], "default": "SWE", "description": "País ISO 3166-1 alpha-3 de la identitat Freja eID. El valor per defecte és SWE, l'únic país al qual dona servei.\n\n* `SWE` - SWE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó amb el Personalausweis (DEU).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiPersonalausweisWalletVerificationStartCountryEnum" } ], "default": "DEU", "description": "País ISO 3166-1 alpha-3 de la identitat Personalausweis. El valor per defecte és DEU, l'únic país al qual dona servei.\n\n* `DEU` - DEU" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó amb Finnish Trust Network (FIN).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiFtnWalletVerificationStartCountryEnum" } ], "default": "FIN", "description": "País ISO 3166-1 alpha-3 de la identitat de Finnish Trust Network. Per defecte és FIN, l'únic país al qual dóna servei.\n\n* `FIN` - FIN" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó d'iDIN (NLD).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiIdinWalletVerificationStartCountryEnum" } ], "default": "NLD", "description": "País ISO 3166-1 alpha-3 de la identitat iDIN. El valor per defecte és NLD, l'únic país al qual dona servei.\n\n* `NLD` - NLD" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó d'itsme (BEL, LUX, NLD).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiItsmeWalletVerificationStartCountryEnum" } ], "description": "País ISO 3166-1 alpha-3 de la identitat itsme.\n\n* `BEL` - BEL\n* `LUX` - LUX\n* `NLD` - NLD" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó de Buypass ID (NOR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryAfcEnum" } ], "default": "NOR", "description": "País ISO 3166-1 alpha-3 de la identitat de Buypass ID. Per defecte és NOR, l'únic país al qual dóna servei.\n\n* `NOR` - NOR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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ó amb Vipps (NOR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryAfcEnum" } ], "default": "NOR", "description": "País ISO 3166-1 alpha-3 de la identitat Vipps. El valor per defecte és NOR, l'únic país al qual dona servei.\n\n* `NOR` - NOR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiBankidNoWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificació de BankID (NOR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryAfcEnum" } ], "default": "NOR", "description": "País ISO 3166-1 alpha-3 de la identitat de BankID. Per defecte és NOR, l'únic país al qual dóna servei.\n\n* `NOR` - NOR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiBankidSeWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificació de BankID (SWE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryEe9Enum" } ], "default": "SWE", "description": "País ISO 3166-1 alpha-3 de la identitat de BankID. Per defecte és SWE, l'únic país al qual dóna servei.\n\n* `SWE` - SWE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi QR de BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiMitidWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificació amb MitID (DNK).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiMitidWalletVerificationStartCountryEnum" } ], "default": "DNK", "description": "País ISO 3166-1 alpha-3 de la identitat MitID. El valor per defecte és DNK, l'únic país al qual dona servei.\n\n* `DNK` - DNK" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https a la qual torna el navegador de l'usuari després de la cartera, amb request_id i result afegits. El seu amfitrió ha d'estar registrat a allowed_return_hosts de l'aplicació (o ser el seu domini de marca blanca). No confiïs mai en result per si sol: consulta el resultat amb GET .../verifications/{request_id}/ o el webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quan l'usuari inicia sessió al dispositiu que mostra la teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi 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": "L'endpoint d'inici propi de la cartera." }, "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 aquesta aplicació pot iniciar-ho en aquest entorn ara mateix. Que estigui llistat no vol dir que estigui en producció." } }, "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": "Sessió de verificació nativa creada per a aquesta comprovació." }, "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` - Aprovar\n* `review` - Revisar\n* `reject` - Rebutjar" }, "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` - Sessió\n* `business_session` - Sessió d'empresa\n* `transaction` - Transacció" }, "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 sol·licitat\n* `no_reference` - Sense referència\n* `insufficient_history` - Historial insuficient\n* `unsupported_region` - Regió no admesa\n* `source_unavailable` - Font no disponible" }, "CasePublicationPolicyDraftResponse": { "type": "object", "properties": { "draft": { "allOf": [ { "$ref": "#/components/schemas/CasePublicationPolicyDraft" } ], "nullable": true } }, "required": [ "draft" ] }, "FraudCheckAttributesRequest": { "type": "object", "description": "Atributs de corroboració. Tots opcionals; amplien la cobertura del mòdul.", "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 autenticat, assignat pel 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` - usuari\n* `business` - empresa" }, "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": "Source i priority admeten equals o in amb els valors compatibles. Tags admet contains amb una etiqueta no buida." }, "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": "La teva pròpia referència per a aquesta comprovació. Actua també com a clau d'idempotència: reutilitzar-la amb el mateix cos retorna la comprovació original sense tornar a executar ni facturar els mòduls; reutilitzar-la amb un cos diferent retorna un 409.", "maxLength": 255 }, "profile": { "type": "string", "minLength": 1, "default": "standard", "description": "ID del perfil d'orquestració. Per defecte és el perfil `standard` de Didit.", "maxLength": 64 }, "profile_version": { "type": "string", "minLength": 1, "description": "Fixa una versió de perfil congelada. Per defecte s'utilitza la versió 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` - Normalització\n* `email_risk` - Risc de correu electrònic\n* `email_social` - Aspectes socials del correu electrònic\n* `phone_social` - Aspectes socials del telèfon\n* `phone_risk` - Risc de telèfon\n* `ip_risk` - Risc d'IP\n* `database_validation` - Validació en bases de dades\n* `networks_same_org` - Xarxes de la mateixa organització\n* `networks_cross_org` - Xarxes entre organitzacions\n* `biometric_identity` - Identitat 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` - Obert\n* `AWAITING_USER` - Esperant l'usuari\n* `RESOLVED` - Resolt" }, "FraudBandEnum": { "enum": [ "low", "medium", "high", "unknown" ], "type": "string", "description": "* `low` - Baix\n* `medium` - Mitjà\n* `high` - Alt\n* `unknown` - Desconegut" }, "CaseDuplicatePriorityEnum": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "* `LOW` - Baix\n* `MEDIUM` - Mitjà\n* `HIGH` - Alt" }, "FraudStatusEnum": { "enum": [ "planned", "completed", "skipped", "failed" ], "type": "string", "description": "* `planned` - Planificat\n* `completed` - Completat\n* `skipped` - Omès\n* `failed` - Fallit" }, "FraudCheckInput": { "type": "object", "properties": { "reference": { "type": "string", "description": "Àlies ofuscat per a l'identificador enviat." }, "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` - Correu electrònic\n* `phone` - Telèfon\n* `national_id` - Document d'identitat nacional\n* `tax_number` - Identificador fiscal\n* `passport_number` - Número de passaport\n* `driving_licence_number` - Número de permís de conduir\n* `residence_permit_number` - Número de permís de residència\n* `voter_id` - Identificador de votant\n* `external_id` - ID extern" }, "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` - Fals positiu\n* `VALID_THREAT` - Amenaça 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 JPEG, PNG o WebP codificat en Base64, de fins a 6 MB. Sense imatge de referència ni URL.", "maxLength": 8388672 }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/FraudCheckIdentifierRequest" }, "description": "Un o més identificadors tipats. Amb un és suficient.", "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 on el subjecte afirma trobar-se. Només contextual - mai una prova de titularitat de la identitat.", "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àtic" }, "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` - Pendent\n* `running` - En execució\n* `completed` - Completat\n* `failed` - Fallit" }, "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ó oberta per l'editor. Quan s'indica, les escriptures obsoletes retornen 409 sense 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` - Identitat\n* `contact` - Contacte\n* `device_network` - Dispositiu i xarxa\n* `behavioral` - Conductual\n* `fraud_network` - Xarxa de frau" }, "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` - Cap\n* `manual_review` - Revisió manual\n* `step_up` - Verificació addicional\n* `resubmit_capture` - Tornar a enviar 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": "Cert quan la sol·licitud ha proporcionat tot el que aquesta dimensió necessitava i la plataforma encara no ha pogut respondre-la. Mai es recomana aprovar una comprovació d'aquest tipus basant-se en la solidesa de les dimensions que sí que han respost." }, "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` - Cribratge AML\n* `TRANSACTION_RULE` - Regla de transacció\n* `WORKFLOW_BUILDER` - Creador de fluxos de treball" }, "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` - usuari\n* `business` - empresa" }, "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` - Coincidència\n* `mismatch` - Discrepància\n* `inconclusive` - No concloent\n* `no_reference` - Sense referència" }, "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": "Estableix a false per desar un esborrany mai publicat. El registre roman inactiu a la versió 0 fins que l'esborrany es publica explícitament. Ometre aquest camp manté la creació immediata per a integracions existents." } }, "required": [ "name", "conditions", "blueprint" ] }, "FraudCheckIdentifierRequest": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/FraudTypeEnum" } ], "description": "Tipus d'identificador. Determina quins camps de l'espai de noms són obligatoris.\n\n* `email` - Correu electrònic\n* `phone` - Telèfon\n* `national_id` - Document d'identitat nacional\n* `tax_number` - Número d'identificació fiscal\n* `passport_number` - Número de passaport\n* `driving_licence_number` - Número de permís de conduir\n* `residence_permit_number` - Número de permís de residència\n* `voter_id` - ID electoral\n* `external_id` - ID extern" }, "value": { "type": "string", "minLength": 1, "description": "El valor de l'identificador, en qualsevol format habitual.", "maxLength": 255 }, "country": { "type": "string", "description": "País emissor ISO-3166 alpha-2 o alpha-3. Obligatori per a tipus d'identificador governamental: els mateixos dígits representen persones diferents en països diferents.", "maxLength": 3 }, "issuer": { "type": "string", "description": "Autoritat emissora opcional o emissor subnacional, quan el país per si sol no permet identificar-lo unívocament.", "maxLength": 128 } }, "required": [ "type", "value" ] }, "CaseActionActionEnum": { "enum": [ "set_status", "add_tags", "add_note", "add_to_blocklist" ], "type": "string", "description": "* `set_status` - estableix l'estat\n* `add_tags` - afegeix etiquetes\n* `add_note` - afegeix una nota\n* `add_to_blocklist` - afegeix a la llista de bloqueig" }, "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` - origen\n* `priority` - prioritat\n* `tags` - etiquetes" }, "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` - Aplicat\n* `FAILED` - Fallit" }, "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 camp per col·locar en un document de la sessió: quin signant l'omple, com i on. Indica una posició (`page`, `x`, `y`, `width` i `height`) o un `anchor`. Les posicions són fraccions de la pàgina tal com es mostra, des de la cantonada superior esquerra, arrodonides a 4 decimals, i el camp ha de cabre dins de la pàgina. Un document admet fins a 200 camps i un signant fins a 500, i cada rol amb camps en un document necessita un camp `signature` o `initials`. Consulta [Camps al document](/ca/core-technology/electronic-signature/overview#camps-al-document).", "required": [ "key", "type" ], "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$", "description": "Dona nom al camp als resultats i a `sign.field_values`. Únic dins del document." }, "type": { "type": "string", "enum": [ "signature", "initials", "full_name", "date_signed", "text", "checkbox", "email", "data" ], "description": "Què conté el camp. El signant aplica la seva `signature` i `initials` adoptades, escriu `text`, marca una `checkbox` i escriu un `email` quan la sessió no té cap correu verificat. Didit emplena `full_name` (el nom verificat), `date_signed` (la data de signatura, en la zona horària del signant), `data` (a partir de `prefill`) i un `email` verificat, i els mostra només de lectura. No hi ha cap tipus de selector de dates: utilitza `text`." }, "role": { "type": "string", "enum": [ "verified_person", "legal_representative", "key_people" ], "description": "Qui emplena el camp, amb els valors de `signature_signer`. Un pas només emplena i segella els camps del seu propi signatari. Per defecte és el signatari del pas." }, "page": { "type": "integer", "minimum": 1, "description": "Número de pàgina, des d'1 fins al total de pàgines del document. Per a un document de Word, una pàgina del PDF convertit." }, "x": { "type": "number", "minimum": 0, "maximum": 1, "description": "Vora esquerra, com a fracció de l'amplada de la pàgina." }, "y": { "type": "number", "minimum": 0, "maximum": 1, "description": "Vora superior, com a fracció de l'alçada de la pàgina." }, "width": { "type": "number", "minimum": 0.02, "maximum": 1, "description": "Amplada, com a fracció de l'amplada de la pàgina. Una signatura té una amplada mínima de `0.12`." }, "height": { "type": "number", "minimum": 0.012, "maximum": 1, "description": "Alçada, com a fracció de l'alçada de la pàgina. Una signatura fa com a mínim `0.035` d'alçada." }, "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": "Es mostra al signant i als resultats. Pren el valor per defecte del tipus." }, "placeholder": { "type": "string", "nullable": true, "maxLength": 80, "description": "Només `text` i `email`." }, "validation": { "$ref": "#/components/schemas/SignatureFieldValidation" }, "prefill": { "type": "string", "nullable": true, "description": "D'on prové el 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 clau de `metadata` de la sessió) o `api.` (una clau de `sign.field_values`). Obligatori per a `data`. `full_name` sempre utilitza `identity.full_name` i `email` utilitza `contact.email`. Els valors dels camps `data`, `full_name` i `email` verificat es fixen quan el signant comença a signar." }, "editable_when_prefilled": { "type": "boolean", "default": false, "description": "Només `text` i `email`: el signant pot canviar un valor emplenat prèviament." }, "checked_by_default": { "type": "boolean", "default": false, "description": "Només `checkbox`: la casella comença marcada." }, "date_format": { "type": "string", "enum": [ "DD/MM/YYYY", "MM/DD/YYYY", "YYYY-MM-DD", "D MMMM YYYY" ], "default": "DD/MM/YYYY", "description": "Només `date_signed`." } } }, "SessionSignDocument": { "type": "object", "required": [ "file_name", "content_base64" ], "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Títol que es mostra al signant. Per defecte és `file_name`." }, "file_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Nom de fitxer, que acaba en `.pdf` o `.docx`." }, "content_base64": { "type": "string", "format": "byte", "description": "El fitxer, codificat en base64. Un PDF pot tenir fins a 20 MB i 100 pàgines, sense contrasenya, scripts ni fitxers adjunts. Un fitxer de Word (`.docx`) pot tenir fins a 20 MB i es converteix a PDF mentre s'executa la sol·licitud, en un màxim de 25 segons; el PDF té llavors els mateixos límits. Fins a 5 fitxers de Word per sessió. Un fitxer de Word amb macros, control de canvis, enllaços a contingut extern o objectes incrustats es rebutja amb `signature_document_not_supported`, i un que no es pugui convertir retorna `signature_document_conversion_failed`, cadascun amb un `reason`." }, "fields": { "type": "array", "description": "Camps opcionals per col·locar en aquest document, fins a 200. Les pàgines i posicions fan referència al PDF, o al PDF convertit en el cas d'un fitxer Word. Sense camps, el signant llegeix el document i l'accepta.", "items": { "$ref": "#/components/schemas/SignatureField" }, "maxItems": 200 } } }, "SignatureResult": { "type": "object", "description": "El resultat d'un signant per a un pas de Signatura electrònica. Consulta l'[informe de Signatura electrònica](/ca/core-technology/electronic-signature/report-electronic-signature).", "properties": { "id": { "type": "string", "format": "uuid", "description": "Passa-ho com a `signature_id` per descarregar les evidències d'aquest signant o validar la seva signatura." }, "node_id": { "type": "string", "description": "El pas del flux de treball que l'ha generat." }, "status": { "type": "string", "enum": [ "intro", "review", "code", "signing", "signed", "declined" ], "description": "En quin punt del pas es troba el signant. Només `signed` significa que els documents estan signats." }, "verdict": { "type": "string", "enum": [ "Not Finished", "Approved", "In Review", "Declined" ], "description": "El resultat del pas. Una advertència l'estableix mitjançant la seva regla; les regles d'estat personalitzades s'apliquen després." }, "level": { "type": "string", "enum": [ "simple", "aes", "qes" ], "description": "`simple` (per defecte) o `aes`. `qes` (signatura electrònica qualificada, QES) és un complement que encara no està disponible." }, "format": { "type": "string", "enum": [ "pdf", "pades" ], "description": "`pdf` per a una signatura simple, `pades` per a una signatura avançada (AES)." }, "profile": { "type": "string", "nullable": true, "description": "`PAdES-B-LT` un cop s'ha signat una signatura avançada (AES); altrament, null." }, "signer": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "El nom del signant. Verificat (a partir de la verificació d'identitat aprovada o de la sessió) excepte al nivell Simple sense un nom de sessió verificat, on és el nom que el signant ha introduït i no està verificat." }, "capacity": { "type": "string", "enum": [ "self", "company" ] }, "company": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true, "description": "El càrrec de la persona clau, tal com s'ha declarat." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Els rols estructurats de la persona clau, tal com s'han declarat per a l'empresa." }, "identity_session_id": { "type": "string", "format": "uuid", "description": "La sessió de KYC que ha verificat el signant." } } }, "identity_used": { "type": "object", "description": "La identitat verificada en què es basa la signatura. Buit per a una signatura Simple sense identitat 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 nom amb què havia de coincidir el signant." } } }, "certificate": { "type": "object", "nullable": true, "description": "El certificat amb què s'han signat els documents. `null` fins que es signen, i sempre `null` per a una signatura Simple.", "properties": { "issuer": { "type": "string" }, "issued_to": { "type": "string" }, "serial": { "type": "string", "description": "Número de sèrie, 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` per a una signatura simple, que no té codi." }, "destination": { "type": "string", "nullable": true, "description": "El contacte emmascarat al qual s'ha enviat el codi." }, "confirmed_at": { "type": "string", "format": "date-time", "nullable": true }, "attempts": { "type": "integer", "description": "Codis introduïts, inclòs el correcte." } } }, "timestamp": { "type": "object", "nullable": true, "description": "La marca de temps RFC 3161 a la signatura, emesa per Didit. `null` fins que se signa, i sempre `null` per a una signatura simple.", "properties": { "time": { "type": "string", "format": "date-time" }, "qualified": { "type": "boolean", "description": "Sempre `false` per a AES." }, "valid": { "type": "boolean" } } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "El document a la còpia d'aquest signant. Fes-lo servir per descarregar el fitxer signat." }, "uuid": { "type": "string", "format": "uuid", "description": "Igual que `id`." }, "title": { "type": "string" }, "file_name": { "type": "string" }, "pages": { "type": "integer", "description": "Pàgines del document signades. En el cas de Word, del PDF convertit." }, "size_bytes": { "type": "integer" }, "sha256_original": { "type": "string", "description": "SHA-256 del document tal com s'ha mostrat al signant." }, "sha256_signed": { "type": "string", "nullable": true, "description": "SHA-256 del PDF signat, un cop signat." }, "status": { "type": "string", "enum": [ "signed", "declined", "not_signed", "not_reached" ], "description": "`not_signed`: obert però no signat. `not_reached`: mai obert." }, "opened_at": { "type": "string", "format": "date-time", "nullable": true }, "read_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan el signant va arribar al final d'un document sense camps, quan el pas ho requereix." }, "read_to_end": { "type": "boolean" }, "consented_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan el signant va acceptar un document sense camps, o va completar els camps d'un document amb camps." }, "consent": { "type": "boolean" }, "signed_file": { "type": "string", "nullable": true, "description": "Ruta del PDF signat, un cop signat. Consulta [Descarregar un document signat](/ca/sessions-api/electronic-signature/download-signed-document)." }, "mode": { "type": "string", "enum": [ "fields", "read_and_agree" ], "description": "`fields` per a un document amb camps, `read_and_agree` per a un document sense." }, "source_format": { "type": "string", "enum": [ "pdf", "docx" ], "description": "`pdf`, o `docx` per a un document de Word que Didit ha convertit a PDF." }, "conversion": { "type": "object", "nullable": true, "description": "`null` per a un PDF. Per a un document de Word, el fitxer original i la conversió.", "properties": { "from": { "type": "string", "enum": [ "docx" ] }, "file_name": { "type": "string", "description": "El nom original del teu fitxer Word." }, "sha256": { "type": "string", "description": "SHA-256 del teu fitxer de Word original." }, "size_bytes": { "type": "integer", "description": "Mida del teu fitxer de Word original." }, "converter": { "type": "string", "description": "Versió del convertidor que ha produït el PDF." } } }, "fields": { "type": "array", "description": "Camps del document, amb els seus valors. Buit per a un document sense camps.", "items": { "$ref": "#/components/schemas/SignatureFieldResult" } } } } }, "adopted_signature": { "type": "object", "nullable": true, "description": "La signatura i les inicials que el signant ha adoptat per als camps de signatura i d'inicials. `null` fins que el signant n'adopti una.", "properties": { "method": { "type": "string", "enum": [ "typed", "drawn" ], "description": "`typed`: el nom verificat en estil manuscrit. `drawn`: dibuixat amb un dit o amb el ratolí." }, "font": { "type": "string", "nullable": true, "description": "L'estil cal·ligràfic d'una signatura mecanografiada. `null` quan és dibuixada." }, "adopted_at": { "type": "string", "format": "date-time" } } }, "electronic_signature_consent_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan el signant va acceptar, a la pantalla de revisió, signar els documents electrònicament. S'estableix quan algun document té camps." }, "evidence_file": { "type": "string", "nullable": true, "description": "Ruta del PDF de l'evidència, un cop signat. Consulta [Descarregar l'evidència de la signatura](/ca/sessions-api/electronic-signature/download-evidence)." }, "warnings": { "type": "array", "description": "Advertències generades per a aquest signant. Consulta [Advertències de Signatura electrònica](/ca/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": "L'última comprovació criptogràfica dels documents signats. `null` fins que se signin els documents. Si Didit no pot confirmar el resultat de la signatura, és `{\"valid\": null, \"reason\": \"signature_provider_outcome_unknown\", \"checked_at\": ...}` i `status` es manté en `signing`: tracta'l com a no signat.", "properties": { "valid": { "type": "boolean", "nullable": true, "description": "`true` quan cada document és vàlid. `null` quan el resultat de la signatura no s'ha pogut confirmar." }, "reason": { "type": "string", "description": "S'estableix quan `valid` és `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` quan tant la signatura com la marca de temps són vàlides i de confiança." }, "integrity": { "type": "boolean", "description": "`true` quan el document no s'ha modificat des de la signatura." }, "trusted": { "type": "boolean", "description": "`true` quan el certificat de signatura forma una cadena fins a una arrel de confiança." }, "revoked": { "type": "boolean" }, "trusted_list": { "type": "object", "description": "Comprovació a la llista de confiança de la UE (EU Trusted List). Per a AES: `{\"status\": \"not_applicable\", \"reason\": \"aes_not_qualified\"}`.", "properties": { "status": { "type": "string" }, "reason": { "type": "string" } } }, "certificate": { "type": "object", "nullable": true, "description": "El certificat amb què s'han signat els documents. `null` fins que es signen, i sempre `null` per a una signatura Simple.", "properties": { "issuer": { "type": "string" }, "issued_to": { "type": "string" }, "serial": { "type": "string", "description": "Número de sèrie, hexadecimal." }, "valid_from": { "type": "string", "format": "date-time" }, "valid_until": { "type": "string", "format": "date-time" } } }, "timestamp": { "type": "object", "nullable": true, "description": "La marca de temps RFC 3161 a la signatura, emesa per Didit. `null` fins que se signa, i sempre `null` per a una signatura simple.", "properties": { "time": { "type": "string", "format": "date-time" }, "qualified": { "type": "boolean", "description": "Sempre `false` per a 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": "Quan l'enllaç de signatura deixa 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": "L'adreça IP del signant quan va demanar el seu codi." }, "place": { "type": "string", "nullable": true, "description": "No recopilat: sempre `null`." }, "place_unavailable_reason": { "type": "string", "nullable": true, "enum": [ "not_collected" ] } } }, "SignatureFieldValidation": { "type": "object", "nullable": true, "description": "Regles per al valor d'un camp `text`. La previsualització a la consola, el flux de signatura i l'API apliquen les mateixes regles.", "properties": { "kind": { "type": "string", "enum": [ "any", "letters", "number", "email", "pattern" ], "description": "`letters`: lletres en qualsevol sistema d'escriptura, espais, guions i apòstrofs. `number`: dígits amb un separador decimal opcional. `pattern`: el valor ha de coincidir amb `pattern`." }, "min_length": { "type": "integer", "minimum": 0, "maximum": 500, "description": "De `0` fins a `max_length`." }, "max_length": { "type": "integer", "minimum": 1, "maximum": 500, "default": 120 }, "pattern": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 200, "description": "Obligatori amb `kind: \"pattern\"`. Una expressió regular amb la qual ha de coincidir el valor complet. No s'admeten lookarounds ni referències enrere." }, "message": { "type": "string", "nullable": true, "maxLength": 120, "description": "Es mostra al signant en lloc de l'error per defecte." } } }, "SignatureFieldAnchor": { "type": "object", "description": "Col·loca un camp mitjançant un fragment de text al document en lloc d'una posició. Didit no elimina el text del PDF, per la qual cosa escriu-lo en el mateix color que el fons de la pàgina. Quan el text no es troba, la crida retorna `400` amb `field_anchor_not_found`. Consulta [Col·locar camps mitjançant text d'ancoratge](/ca/sessions-api/create-session#col·locar-camps-mitjançant-text-d’ancoratge).", "required": [ "text" ], "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 64, "description": "Text cercat al document. Per a un fitxer de Word, al PDF convertit." }, "occurrence": { "type": "string", "enum": [ "first", "all" ], "default": "first", "description": "`all` col·loca un camp per coincidència; les claus posteriors a la primera reben `_2`, `_3`, etc." }, "offset_x": { "type": "number", "description": "Afegit a la vora esquerra del text, com a fracció de l'amplada de la pàgina." }, "offset_y": { "type": "number", "description": "Afegit a la vora superior del text, com a fracció de l'alçada de la pàgina." }, "width": { "type": "number", "minimum": 0.02, "maximum": 1, "description": "Amplada del camp, com a fracció de l'amplada de la pàgina." }, "height": { "type": "number", "minimum": 0.012, "maximum": 1, "description": "Alçada del camp, com a fracció de l'alçada de la pàgina." } } }, "SignatureFieldResult": { "type": "object", "description": "Un camp d'un document signat, amb el seu valor a la còpia d'aquest signant. Consulta [Camps](/ca/core-technology/electronic-signature/report-electronic-signature#camps).", "properties": { "key": { "type": "string", "description": "La clau del camp, tal com s'utilitza a `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 d'1. Per a un document de Word, una pàgina del PDF convertit." }, "x": { "type": "number", "description": "Vora esquerra, com a fracció de l'amplada de la pàgina." }, "y": { "type": "number", "description": "Vora superior, com a fracció de l'alçada de la pàgina." }, "width": { "type": "number", "description": "Amplada, com a fracció de l'amplada de la pàgina." }, "height": { "type": "number", "description": "Alçada, com a fracció de l'alçada de la pàgina." }, "required": { "type": "boolean" }, "value": { "nullable": true, "description": "Una cadena per a `text`, `email`, `full_name`, `date_signed` i `data`, un booleà per a `checkbox`, i `true` per a una signatura o inicials aplicades. `null` quan està buit." }, "display_value": { "type": "string", "nullable": true, "description": "El valor tal com s'ha estampat a la pàgina: dates en el `date_format` del camp, `Yes` o `No` per a una casella de selecció, `Signed` per a una signatura o inicials." }, "value_source": { "type": "string", "nullable": true, "enum": [ "signer", "identity", "contact", "company", "session", "metadata", "api", "signing_time", null ], "description": "D'on prové el valor: `signer` (escrit, marcat o aplicat pel signant), `identity` (el document d'identitat verificat), `contact` (el correu electrònic o telèfon verificat), `company` (l'empresa verificada), `session` (`vendor_data`), `metadata`, `api` (`sign.field_values`) o `signing_time` (la data de signatura)." }, "filled_at": { "type": "string", "format": "date-time", "nullable": true }, "image_url": { "type": "string", "nullable": true, "description": "Només signatura i inicials: la ruta de la imatge aplicada. Consulta [Descarregar una imatge de signatura](/ca/sessions-api/electronic-signature/download-field-image)." }, "value_unavailable_reason": { "type": "string", "nullable": true, "enum": [ "source_empty", null ], "description": "`source_empty` quan un camp emplenat prèviament no tenia cap valor a la sessió i `signature_field_data_missing_action` ha permès al signant signar de totes maneres." } } }, "VaspDirectoryWidgetEntry": { "type": "object", "description": "Què mostra el selector de VASP de l'usuari final: qui és el VASP i si s'hi pot contactar.", "properties": { "id": { "type": "string", "format": "uuid", "description": "L'identificador de l'entrada, per a GET /v3/travel-rule/vasps/{vasp_id}/." }, "kind": { "type": "string", "enum": [ "directory", "didit" ], "description": "directory per a una entrada del directori compartit; didit per a un membre de la xarxa Didit." }, "name": { "type": "string" }, "lei": { "type": "string" }, "jurisdiction": { "type": "string", "description": "Codi de país ISO 3166, tal com el proporciona la font." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Els dominis web del VASP. Sempre buits per als membres de la xarxa de Didit." }, "reachable": { "type": "boolean", "description": "Indica si la teva aplicació té una ruta disponible cap a aquest VASP, o cap a una de les seves entitats per a una marca. Sempre true per a un membre de la xarxa de Didit." } } }, "TravelRuleDataSharingFields": { "type": "object", "description": "Els camps que Didit envia al VASP de la contrapart sobre els teus propis usuaris, per tipus d'entitat. El `name` i la `wallet_address` s'envien sempre, digui el que digui la llista. Un tipus d'entitat que mai no hagis triat comparteix tots els camps. Una llista buida també és una opció: només comparteix el nom i la cartera.", "properties": { "individual": { "type": "array", "items": { "type": "string", "enum": [ "name", "wallet_address", "address", "national_id", "customer_identification", "date_of_birth", "place_of_birth" ] }, "description": "Camps compartits sobre una persona física." }, "company": { "type": "array", "items": { "type": "string", "enum": [ "name", "wallet_address", "address", "national_id", "customer_identification" ] }, "description": "Camps compartits sobre una persona jurídica." } } }, "TravelRuleMatchingRules": { "type": "object", "description": "Amb quin grau d'estrictesa es compara cada camp de les dades de la contrapart amb el que tens registrat, per tipus d'entitat. Un camp que ometis manté el seu valor per defecte. `NONE` omet la comparació, `STRICT` requereix exactament les mateixes paraules, `CONTAINS` accepta un valor les paraules del qual apareguin totes en l'altre, `DEFAULT` és la coincidència estàndard de subconjunt, i `FUZZY` accepta grafies properes (i, per a dates de naixement, dia i mes invertits).", "properties": { "individual": { "type": "object", "description": "Regles per a una persona física.", "properties": { "name": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Per defecte: segueix `name_matching_strictness`." }, "date_of_birth": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Per defecte `NONE`." }, "address": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Per defecte `NONE`." }, "account": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "La cartera per on s'ha encaminat l'intercanvi. Per defecte `STRICT`." } } }, "company": { "type": "object", "description": "Regles per a una persona jurídica.", "properties": { "name": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Per defecte: segueix `name_matching_strictness`." }, "address": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Per defecte `NONE`." }, "account": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "La cartera per on s'ha encaminat l'intercanvi. Per defecte `STRICT`." } } } } }, "TravelRuleDataMatch": { "type": "object", "nullable": true, "description": "Comparació camp per camp de les dades de les parts de la transferència amb el que l'altra part sap sobre el titular de la cartera. Nomena camps i resultats, mai valors, de manera que continua sent llegible mentre les dades de la contrapart estan emmascarades. Null fins que s'executi una comparació.", "properties": { "matched": { "type": "boolean", "description": "Cert quan cap camp comparat difereix." }, "mismatched_fields": { "type": "array", "items": { "type": "string", "enum": [ "name", "date_of_birth", "address", "account" ] }, "description": "Els camps que difereixen." }, "fields": { "type": "object", "description": "Una entrada per camp comparat per al tipus d'entitat de la part (`name`, `date_of_birth`, `address`, `account`; una empresa no té `date_of_birth`).", "additionalProperties": { "type": "object", "properties": { "result": { "type": "string", "enum": [ "matched", "mismatched", "not_compared" ], "description": "`not_compared` quan la regla és `NONE` o una de les dues parts no té cap valor per al camp." }, "strictness": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ] } } } } } }, "TravelRuleDataUnmasked": { "type": "object", "nullable": true, "description": "Registre d'auditoria del moment en què es van desenmascarar les dades de la contrapart. És null mentre les dades continuïn emmascarades, així com per a transferències sortints.", "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è va confirmar la titularitat: ownership_confirmed (la teva confirmació mitjançant la consola o l'API), wallet_proof (una prova de cartera al widget, o una transferència entrant INTERNAL, establerta quan es crea), address_book_match (una cartera de la llibreta d'adreces verificada), own_verified_wallet (la pròpia cartera verificada del teu usuari), inquiry_approved (la teva aprovació d'una consulta TRP entrant o un missatge GTR o Sygna), known_payment_method (una cartera amb la qual el teu usuari ja ha pagat) o travel_address (la Travel Address per cartera que va donar nom a la cartera)." }, "actor": { "type": "string", "description": "Qui ho ha confirmat: el correu electrònic de l'usuari de la consola o l'etiqueta de la clau d'API. En blanc per a una decisió automàtica." } } }, "TravelRuleMessageAttachment": { "type": "object", "nullable": true, "description": "El document adjunt a un missatge, emmagatzemat com qualsevol altre document de transacció.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "label": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true }, "uploaded_by": { "type": "string", "nullable": true, "description": "Qui l'ha adjuntat. Al portal de recollida, un fitxer que hagis enviat mostra el teu nom de VASP, mai la persona o la clau d'API que hi ha darrere." }, "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 descàrrega de durada 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` és el que ha enviat la part del lector. Al portal de recollida, la direcció és des de la part de la contrapart." }, "author": { "type": "string", "description": "Qui ho ha escrit per la seva banda: el correu electrònic d'un usuari de la consola o l'etiqueta d'una clau d'API, o el nom de l'altre VASP." }, "body": { "type": "string" }, "requested_documents": { "type": "array", "items": { "type": "string" }, "description": "El que sol·licita un DOCUMENT_REQUEST, en paraules del sol·licitant." }, "reply_to": { "type": "string", "format": "uuid", "nullable": true }, "fulfilled_at": { "type": "string", "format": "date-time", "nullable": true, "description": "S'estableix en una DOCUMENT_REQUEST un cop la resposta conté un document." }, "attachment": { "$ref": "#/components/schemas/TravelRuleMessageAttachment" }, "created_at": { "type": "string", "format": "date-time" } } }, "TravelRuleMessageCreateRequest": { "type": "object", "description": "Envia-ho com a JSON, o com a multipart/form-data amb els fitxers adjunts a `files`.", "properties": { "kind": { "type": "string", "enum": [ "MESSAGE", "DOCUMENT_REQUEST" ], "default": "MESSAGE" }, "body": { "type": "string", "maxLength": 5000, "description": "Obligatori per a un MESSAGE tret que s'adjunti un fitxer." }, "requested_documents": { "type": "array", "items": { "type": "string", "maxLength": 255 }, "maxItems": 10, "description": "Obligatori (almenys un) per a un DOCUMENT_REQUEST, i només permès aquí." }, "reply_to": { "type": "string", "format": "uuid", "nullable": true, "description": "Un missatge de la mateixa transferència. Una resposta que conté un document satisfà la sol·licitud de document a la qual respon." }, "files": { "type": "array", "items": { "type": "string", "format": "binary" }, "maxItems": 5, "description": "Només multipart. Fins a 5 fitxers de 10 MB cadascun." } } }, "SessionDeletionJob": { "type": "object", "description": "Una eliminació massiva de sessions en execució en segon pla: progrés i recomptes per resultat, mai quines sessions ha eliminat.", "properties": { "job_id": { "type": "string", "format": "uuid", "description": "Consulta periòdicament `GET /v3/sessions/delete/{job_id}/` amb aquest id." }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ], "description": "`PENDING`: acceptat, encara no iniciat. `PROCESSING`: suprimint; `processed` i `outcomes` s'estan actualitzant. `COMPLETED`: s'ha donat compte de totes les sessions seleccionades. `FAILED`: la feina s'ha aturat abans d'hora; consulta `error`." }, "total": { "type": "integer", "description": "Sessions seleccionades quan es va sol·licitar la supressió." }, "processed": { "type": "integer", "description": "Sessions que la tasca ha completat fins ara." }, "outcomes": { "type": "object", "description": "Quantes sessions han acabat en cada resultat. Totes les claus estan sempre presents.", "properties": { "deleted": { "type": "integer", "description": "Sessions suprimides juntament amb el seu embedding facial." }, "none": { "type": "integer", "description": "Sessions suprimides que no tenien cap embedding facial." }, "retained_with_user": { "type": "integer", "description": "Sessions suprimides mentre es va conservar una plantilla biomètrica sense imatges per al seu usuari, tal com demanava la sol·licitud o la política de l'aplicació." }, "ineligible_no_vendor_user": { "type": "integer", "description": "Sessions suprimides, amb el seu embedding facial, perquè se'n va sol·licitar la conservació però no tenien cap usuari vinculat." }, "failed_retryable": { "type": "integer", "description": "Sessions reportades com a no suprimides. Una tasca reintenta un grup que no ha pogut suprimir per si mateixa en lloc de comptabilitzar-lo aquí." }, "already_deleted": { "type": "integer", "description": "Sessions seleccionades que ja s'havien suprimit, per exemple mitjançant una altra sol·licitud, quan la tasca hi va arribar." } } }, "deleted_child_verifications": { "type": "integer", "description": "Verificacions creades per les verificacions d'empreses eliminades, eliminades amb elles. Sempre és `0` per a una tasca iniciada per `POST /v3/sessions/delete/`, que només elimina sessions de KYC." }, "error": { "type": "string", "nullable": true, "description": "`null` tret que `status` sigui `FAILED`; en aquest cas, el motiu pel qual s'ha aturat l'eliminació. Les sessions a les quals la tasca no ha arribat continuen existint: repeteix la sol·licitud per eliminar-les." }, "created_at": { "type": "string", "format": "date-time", "description": "Quan es va sol·licitar l'eliminació." }, "completed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan va finalitzar la tasca; `null` mentre s'està executant." } } }, "EntityStatusUpdateRequest": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Nou estat del cicle de vida. `BLOCKED` també afegeix el `vendor_data` a la llista de bloqueig 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 prèvia del cost. Es retorna directament quan estimate_only és true (no s'escriu res).", "properties": { "users_total": { "type": "integer", "description": "Perfils que coincideixen amb la selecció." }, "already_enabled": { "type": "integer", "description": "Perfils que ja estan monitorats (res a fer en activar; són els que es desactiven en desactivar)." }, "with_existing_aml": { "type": "integer", "description": "Perfils el cribratge AML existent dels quals passarà a estar monitorat (sense nou cribratge)." }, "needing_screening": { "type": "integer", "description": "Perfils sense cap cribratge AML als quals es farà primer un cribratge (facturat com un cribratge AML ordinari)." }, "skipped_no_identity_data": { "type": "integer", "description": "Perfils que no es poden sotmetre a cribratge perquè manquen dades d'identitat." }, "skipped_blocked": { "type": "integer", "description": "Usuaris bloquejats que s'ometran (sempre 0 per a empreses)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Cost únic dels nous cribratges." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Cost de monitoratge anual dels perfils que passaran a estar monitorats." }, "balance_sufficient": { "type": "boolean", "description": "Si el saldo de l'organització cobreix el cribratge més el primer any de monitoratge." }, "unmatched": { "type": "array", "items": { "type": "string" }, "description": "Identificadors de la sol·licitud que no coincideixen amb cap perfil d'aquesta aplicació, exactament tal com s'han enviat." } } }, { "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 quan la tasca activa el monitoratge, false quan el desactiva." }, "target_type": { "type": "string", "enum": [ "user", "business" ], "description": "Quina família de perfils commuta la tasca." }, "total": { "type": "integer", "description": "Perfils que processa la tasca." }, "processed": { "type": "integer", "description": "Perfils processats fins ara." }, "outcomes": { "type": "object", "description": "Comptadors de resultats per registre. Cada perfil seleccionat s'assigna exactament a un comptador; no s'omet res silenciosament.", "properties": { "enabled": { "type": "integer", "description": "Monitoratge activat en un cribratge AML existent." }, "screened_and_enabled": { "type": "integer", "description": "S'ha creat un nou cribratge AML (facturat) i s'hi ha activat el monitoratge." }, "already_enabled": { "type": "integer", "description": "El monitoratge ja estava actiu; no s'ha modificat res ni s'ha facturat res." }, "disabled": { "type": "integer", "description": "Monitoratge desactivat a tots els cribratges AML del perfil." }, "skipped_no_identity_data": { "type": "integer", "description": "Omès: el perfil no disposa del nom complet, la data de naixement i el país (usuaris) o del nom (empreses) necessaris per cribrar." }, "skipped_blocked": { "type": "integer", "description": "Omès: l'usuari està bloquejat." }, "skipped_sandbox": { "type": "integer", "description": "Omès: aplicació de sandbox, no es crea cap cribratge." }, "failed_provider": { "type": "integer", "description": "No s'ha pogut completar el cribratge; reintenta-ho més tard." }, "failed_insufficient_balance": { "type": "integer", "description": "El saldo s'ha esgotat mentre s'executava la tasca." } } }, "results": { "type": "array", "description": "Una entrada per perfil processat, en ordre de processament. Creix mentre s'executa la tasca; es completa un cop l'estat és COMPLETED. Es registra per a les tasques iniciades mitjançant l'API.", "items": { "type": "object", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "ID intern de Didit del perfil." }, "vendor_data": { "type": "string", "nullable": true, "description": "El teu propi identificador per al 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": "Missatge d'error genèric quan l'estat és FAILED; la causa detallada es manté a la plataforma." }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "estimate": { "type": "object", "description": "Vista prèvia del cost. Es retorna directament quan estimate_only és true (no s'escriu res).", "properties": { "users_total": { "type": "integer", "description": "Perfils que coincideixen amb la selecció." }, "already_enabled": { "type": "integer", "description": "Perfils que ja estan monitorats (res a fer en activar; són els que es desactiven en desactivar)." }, "with_existing_aml": { "type": "integer", "description": "Perfils el cribratge AML existent dels quals passarà a estar monitorat (sense nou cribratge)." }, "needing_screening": { "type": "integer", "description": "Perfils sense cap cribratge AML als quals es farà primer un cribratge (facturat com un cribratge AML ordinari)." }, "skipped_no_identity_data": { "type": "integer", "description": "Perfils que no es poden sotmetre a cribratge perquè manquen dades d'identitat." }, "skipped_blocked": { "type": "integer", "description": "Usuaris bloquejats que s'ometran (sempre 0 per a empreses)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Cost únic dels nous cribratges." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Cost de monitoratge anual dels perfils que passaran a estar monitorats." }, "balance_sufficient": { "type": "boolean", "description": "Si el saldo de l'organització cobreix el cribratge més el primer any de monitoratge." } } }, "unmatched": { "type": "array", "items": { "type": "string" }, "description": "Identificadors de la sol·licitud que no coincideixen amb cap perfil d'aquesta aplicació, exactament tal com s'han enviat. No formen part de la tasca." } } } ] }, "AMLMonitoringJob": { "type": "object", "properties": { "job_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ] }, "is_enabled": { "type": "boolean", "description": "true quan la tasca activa el monitoratge, false quan el desactiva." }, "target_type": { "type": "string", "enum": [ "user", "business" ], "description": "Quina família de perfils commuta la tasca." }, "total": { "type": "integer", "description": "Perfils que processa la tasca." }, "processed": { "type": "integer", "description": "Perfils processats fins ara." }, "outcomes": { "type": "object", "description": "Comptadors de resultats per registre. Cada perfil seleccionat s'assigna exactament a un comptador; no s'omet res silenciosament.", "properties": { "enabled": { "type": "integer", "description": "Monitoratge activat en un cribratge AML existent." }, "screened_and_enabled": { "type": "integer", "description": "S'ha creat un nou cribratge AML (facturat) i s'hi ha activat el monitoratge." }, "already_enabled": { "type": "integer", "description": "El monitoratge ja estava actiu; no s'ha modificat res ni s'ha facturat res." }, "disabled": { "type": "integer", "description": "Monitoratge desactivat a tots els cribratges AML del perfil." }, "skipped_no_identity_data": { "type": "integer", "description": "Omès: el perfil no disposa del nom complet, la data de naixement i el país (usuaris) o del nom (empreses) necessaris per cribrar." }, "skipped_blocked": { "type": "integer", "description": "Omès: l'usuari està bloquejat." }, "skipped_sandbox": { "type": "integer", "description": "Omès: aplicació de sandbox, no es crea cap cribratge." }, "failed_provider": { "type": "integer", "description": "No s'ha pogut completar el cribratge; reintenta-ho més tard." }, "failed_insufficient_balance": { "type": "integer", "description": "El saldo s'ha esgotat mentre s'executava la tasca." } } }, "results": { "type": "array", "description": "Una entrada per perfil processat, en ordre de processament. Creix mentre s'executa la tasca; es completa un cop l'estat és COMPLETED. Es registra per a les tasques iniciades mitjançant l'API.", "items": { "type": "object", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "ID intern de Didit del perfil." }, "vendor_data": { "type": "string", "nullable": true, "description": "El teu propi identificador per al 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": "Missatge d'error genèric quan l'estat és FAILED; la causa detallada es manté a la plataforma." }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "estimate": { "type": "object", "description": "Vista prèvia del cost. Es retorna directament quan estimate_only és true (no s'escriu res).", "properties": { "users_total": { "type": "integer", "description": "Perfils que coincideixen amb la selecció." }, "already_enabled": { "type": "integer", "description": "Perfils que ja estan monitorats (res a fer en activar; són els que es desactiven en desactivar)." }, "with_existing_aml": { "type": "integer", "description": "Perfils el cribratge AML existent dels quals passarà a estar monitorat (sense nou cribratge)." }, "needing_screening": { "type": "integer", "description": "Perfils sense cap cribratge AML als quals es farà primer un cribratge (facturat com un cribratge AML ordinari)." }, "skipped_no_identity_data": { "type": "integer", "description": "Perfils que no es poden sotmetre a cribratge perquè manquen dades d'identitat." }, "skipped_blocked": { "type": "integer", "description": "Usuaris bloquejats que s'ometran (sempre 0 per a empreses)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Cost únic dels nous cribratges." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Cost de monitoratge anual dels perfils que passaran a estar monitorats." }, "balance_sufficient": { "type": "boolean", "description": "Si el saldo de l'organització cobreix el cribratge més el primer any de monitoratge." } } }, "unmatched": { "type": "array", "items": { "type": "string" }, "description": "Identificadors de la sol·licitud que no coincideixen amb cap perfil d'aquesta aplicació, exactament tal com s'han enviat. No formen part de la tasca." } } }, "OngoingMonitoringToggleRequest": { "type": "object", "required": [ "is_enabled" ], "properties": { "is_enabled": { "type": "boolean", "description": "true per activar el monitoratge, false per desactivar-lo." }, "estimate_only": { "type": "boolean", "default": false, "description": "Quan és cert, retorna l'estimació del cost i no realitza cap escriptura." }, "update_all": { "type": "boolean", "default": false, "description": "Aplica a totes les entitats de l'aplicació (delimitades pels paràmetres filter_* quan són presents)." }, "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": "Entitats que cal commutar. Obligatori tret que update_all sigui cert." } } }, "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": "Comptadors de resultats per entitat. No s'omet res silenciosament: cada entitat sol·licitada correspon exactament a un comptador.", "properties": { "enabled": { "type": "integer", "description": "Monitoratge activat en un cribratge AML existent." }, "screened_and_enabled": { "type": "integer", "description": "S'ha creat un nou cribratge AML (facturat) i s'ha activat el monitoratge." }, "already_enabled": { "type": "integer", "description": "El monitoratge ja estava actiu (les files duplicades antigues s'han consolidat)." }, "disabled": { "type": "integer", "description": "Monitoratge desactivat a totes les files d'AML de l'entitat." }, "skipped_no_identity_data": { "type": "integer", "description": "Omès: no hi ha nom complet + data de naixement + país disponibles per cribrar." }, "skipped_blocked": { "type": "integer", "description": "Omès: l'usuari està bloquejat." }, "skipped_sandbox": { "type": "integer", "description": "Omès: aplicació de sandbox." }, "failed_provider": { "type": "integer", "description": "La crida al proveïdor de cribratge ha fallat." }, "failed_insufficient_balance": { "type": "integer", "description": "El saldo s'ha esgotat a mig procés." } } }, "error": { "type": "string", "nullable": true }, "estimate": { "type": "object", "description": "Vista prèvia del cost. Es retorna directament quan estimate_only és true (no s'executa cap escriptura).", "properties": { "users_total": { "type": "integer", "description": "Entitats de la selecció." }, "already_enabled": { "type": "integer" }, "with_existing_aml": { "type": "integer", "description": "Entitats el cribratge AML existent de les quals passarà a estar monitorat." }, "needing_screening": { "type": "integer", "description": "Entitats sense cap cribratge AML que es cribraran primer (facturades)." }, "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 prèvia del cost. Es retorna directament quan estimate_only és true (no s'executa cap escriptura).", "properties": { "users_total": { "type": "integer", "description": "Entitats de la selecció." }, "already_enabled": { "type": "integer" }, "with_existing_aml": { "type": "integer", "description": "Entitats el cribratge AML existent de les quals passarà a estar monitorat." }, "needing_screening": { "type": "integer", "description": "Entitats sense cap cribratge AML que es cribraran primer (facturades)." }, "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": "Nombre de files coincidents, limitat a 100 per motius de rendiment." }, "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": "L'identificador únic de la sessió." }, "session_kind": { "type": "string", "enum": [ "user", "business" ], "description": "Discriminador que indica si es tracta d'una sessió de Verificació d'usuaris (KYC) o de Verificació d'empreses (KYB). Quan és `user`, s'apliquen les matrius de funcionalitats de KYC (`id_verifications`, `nfc_verifications`, `liveness_checks`, `face_matches`, `poa_verifications`, `document_ai_documents`, `database_validations`, ...) i les matrius d'empresa no hi són presents. Quan és `business`, el payload conté en el seu lloc `registry_checks`, `document_verifications`, `key_people_checks` a més de les matrius compartides (`aml_screenings`, `phone_verifications`, `email_verifications`, `ip_analyses`, `questionnaire_responses`). **S'omet quan es passa `include=events`** — l'estructura d'esdeveniments només existeix per a sessions d'usuari, de manera que el discriminador s'elimina d'aquesta variant." }, "shared_from_session": { "type": "string", "format": "uuid", "nullable": true, "description": "Per a una sessió clonada amb `POST /v3/session/import-shared/`: el `session_id` de la sessió original a l'aplicació d'origen. `null` per a qualsevol altra sessió. S'omet quan es passa `include=events`." }, "shared_from_session_number": { "type": "integer", "nullable": true, "description": "`session_number` de la sessió d'origen quan aquesta sessió s'ha importat des d'una altra aplicació de la teva organització. En cas contrari, `null`." }, "session_number": { "type": "integer", "description": "El número de la sessió.", "nullable": true }, "session_url": { "type": "string", "format": "uri", "description": "L'URL de la sessió.", "nullable": true }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Awaiting User", "In Review", "Approved", "Declined", "Resubmitted", "Expired", "Kyc Expired", "Abandoned" ], "description": "Estat global del cicle de vida de la sessió — el resultat agregat del flux de treball. Els valors finals són `Approved`, `Declined`, `In Review`, `Expired`, `Kyc Expired` i `Abandoned`; `Not Started`, `In Progress`, `Awaiting User` i `Resubmitted` indiquen que la sessió encara està avançant pel flux de treball." }, "status_override": { "type": "object", "nullable": true, "description": "Present quan un revisor ha definit `status` manualment. `null` quan l'estat s'ha establert automàticament. Fes-lo servir per distingir una aprovació manual d'una d'automàtica.", "properties": { "overridden_at": { "type": "string", "format": "date-time", "nullable": true }, "automatic_status": { "type": "string", "nullable": true, "description": "L'estat que conclouen les comprovacions pròpies de la plataforma." } } }, "decision_trace": { "type": "object", "description": "Com s'ha assolit l'estat: qui l'ha establert i quines advertències hi han contribuït.", "properties": { "status": { "type": "string", "description": "L'estat de la sessió." }, "decided_by": { "type": "string", "nullable": true, "enum": [ "manual", "automatic", "investigator", null ], "description": "Qui ha definit l'estat. `null` mentre la sessió no estigui decidida." }, "decided_at": { "type": "string", "format": "date-time", "nullable": true }, "automatic_status": { "type": "string", "nullable": true, "description": "El que conclouen les comprovacions pròpies de la plataforma, que difereix de `status` després d'una decisió manual." }, "terminal_node_id": { "type": "string", "nullable": true, "description": "El node d'estat del flux de treball que ha finalitzat la sessió, si n'hi ha hagut cap." }, "actor": { "type": "object", "nullable": true, "description": "El revisor responsable d'una decisió manual.", "properties": { "user": { "type": "string", "nullable": true }, "actor_type": { "type": "string", "nullable": true } } }, "warning_counts": { "type": "object", "description": "Advertències per `log_type` (`error`, `warning`, `information`) i `total`.", "additionalProperties": { "type": "integer" } }, "status_warnings": { "type": "array", "description": "Les advertències que estableixen un estat `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 llista del payload d'on prové l'advertència, per exemple `id_verifications`." }, "short_description": { "type": "string", "nullable": true } } } } } }, "linked_records": { "type": "object", "nullable": true, "description": "Un resum d'altres registres vinculats a la sessió. `null` quan no hi ha res a mostrar i per a fluxos de treball que declaren un estàndard d'assegurament de l'edat.", "properties": { "same_face": { "type": "object", "nullable": true, "description": "Altres persones la cara de les quals ha coincidit amb una de les cerques facials d'aquesta sessió.", "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 grup del flux de treball que ha generat aquesta sessió. Els fluxos de treball tenen versions: aquest valor identifica el flux de treball en si, no la versió específica.", "nullable": true }, "features": { "type": "array", "items": { "type": "string", "description": "La funcionalitat de la sessió." }, "description": "Llista de funcionalitats de verificació configurades per a aquesta sessió, com a noms visibles: `ID_VERIFICATION`, `NFC`, `LIVENESS`, `FACE_MATCH`, `POA`, `PHONE`, `EMAIL_VERIFICATION`, `AML`, `IP_ANALYSIS`, `DATABASE_VALIDATION`, `QUESTIONNAIRE`, `AGE_ESTIMATION`, `FACE_SEARCH`, `GEOLOCATION` (verificació d'ubicació) (les sessions de Verificació d'empreses utilitzen el conjunt de funcionalitats de KYB: `KYB_REGISTRY`, `KYB_DOCUMENTS`, `KYB_KEY_PEOPLE`, `AML`, `PHONE`, `EMAIL_VERIFICATION`, `IP_ANALYSIS`, `QUESTIONNAIRE`). Amb `include=events` cada entrada es converteix en un objecte `{feature, node_id}` en comptes d'una cadena simple, i la funcionalitat de correu electrònic es reanomena: apareix com a `EMAIL` en mode d'esdeveniments en lloc del `EMAIL_VERIFICATION` utilitzat aquí." }, "vendor_data": { "type": "string", "description": "El vendor_data de la sessió.", "nullable": true }, "metadata": { "type": "object", "description": "Les metadades de la sessió.", "nullable": true }, "expected_details": { "type": "object", "description": "Detalls esperats proporcionats en crear la sessió — s'utilitzen per a la validació creuada amb les dades extretes (KYC) o per emplenar prèviament la cerca al registre mercantil (KYB). Retorna exactament les claus que s'han proporcionat; `null` quan no se n'ha proporcionat cap. Les sessions de KYC contenen els camps de persona; les sessions d'empreses (KYB) contenen `company_name`, `registry_country` i `registration_number`.", "properties": { "first_name": { "type": "string", "description": "Nom de pila de l'usuari. Per exemple, `John`." }, "last_name": { "type": "string", "description": "Cognom de l'usuari. Per exemple, `Doe`." }, "date_of_birth": { "type": "string", "format": "date", "description": "Data de naixement de l'usuari en format: YYYY-MM-DD. Per exemple, `1990-05-15`." }, "gender": { "type": "string", "nullable": true, "enum": [ "M", "F" ], "default": null, "description": "Gènere de l'usuari. Ha de ser 'M', 'F' o null." }, "nationality": { "type": "string", "description": "Codi de país ISO 3166-1 alpha-3 que representa el país d'origen del sol·licitant. Per exemple, `USA`." }, "country": { "type": "string", "description": "Codi de país ISO 3166-1 alpha-3 que representa el país del document del comprovant de domicili o el país del document d'identitat del sol·licitant, que pot ser diferent de la nacionalitat. Per exemple, `GBR`." }, "address": { "type": "string", "description": "L'adreça en un format llegible per humans, que inclou tanta informació com sigui possible. Per exemple, `123 Main St, San Francisco, CA 94105, USA`." }, "identification_number": { "type": "string", "description": "El número de document, número personal o identificador fiscal de l'usuari. Per exemple, `123456789`." }, "ip_address": { "type": "string", "format": "ipv4", "description": "Adreça IP esperada per a la sessió. Si l'adreça IP real difereix d'aquest valor, es registrarà una advertència. Per exemple, `192.168.1.100`." }, "expected_document_types": { "type": "array", "description": "Tipus de document als quals es va restringir el pas de verificació d'identitat durant la creació de la sessió. Buit/no establert significa sense restricció. Codis: `P` (passaport), `ID` (document nacional d'identitat), `DL` (permís de conduir), `RP` (permís de residència), `HIC` (targeta sanitària), `TC` (targeta fiscal), `SSC` (targeta de la seguretat social).", "items": { "type": "string", "enum": [ "P", "ID", "DL", "RP", "HIC", "TC", "SSC" ] } }, "id_country": { "type": "string", "nullable": true, "description": "País emissor esperat del document d'identitat (ISO 3166-1 alpha-3), quan es restringeix en el moment de la creació.", "example": "ESP" }, "poa_country": { "type": "string", "nullable": true, "description": "País esperat del document de Comprovant de domicili (ISO 3166-1 alpha-3), quan es restringeix en el moment de la creació.", "example": "ESP" }, "company_name": { "type": "string", "description": "Raó social esperada de l'empresa. Només per a sessions d'empreses (KYB)." }, "registry_country": { "type": "string", "description": "País del registre esperat com a `XX` o `XX-YY` (ISO 3166-1 alfa-2, opcionalment amb una subdivisió ISO 3166-2 per a registres d'àmbit estatal, p. ex. `US-CA`). Només per a sessions d'empreses (KYB)." }, "registration_number": { "type": "string", "description": "Número de registre de l'empresa esperat. Només sessions d'empresa (KYB)." } }, "nullable": true }, "contact_details": { "type": "object", "description": "Dades de contacte facilitades en crear la sessió (utilitzades per als correus electrònics de notificació, la verificació de telèfon/correu electrònic amb les dades emplenades prèviament i l'idioma de comunicació). `null` quan no s'ha proporcionat cap correu electrònic ni número de telèfon.", "properties": { "email": { "type": "string", "description": "Adreça de correu electrònic de l'usuari (p. ex., \"john.doe@example.com\") que s'utilitzarà durant el pas de Verificació de correu electrònic. Si no es proporciona, l'usuari l'haurà d'introduir durant el flux de verificació." }, "email_lang": { "type": "string", "description": "Codi d'idioma (ISO 639-1) per a les notificacions per correu electrònic. Controla l'idioma de totes les comunicacions per correu electrònic (p. ex., \"en\", \"es\", \"fr\")." }, "send_notification_emails": { "type": "boolean", "default": false, "description": "Si és cert i s'indica un correu electrònic, Didit envia el correu inicial «Verifica la teva identitat» de manera asíncrona quan es crea la sessió de Verificació d'usuaris (KYC) o Verificació d'empreses (KYB). Didit també envia notificacions sobre l'estat de la verificació per a les sessions que requereixen revisió manual a l'adreça de correu electrònic proporcionada." }, "phone": { "type": "string", "nullable": true, "description": "Número de telèfon de l'usuari en format E.164 si està disponible (p. ex., +14155552671). `null` quan només s'ha proporcionat un correu electrònic en crear la sessió. Nota: Aquest camp retorna el número de telèfon original proporcionat durant la creació de la sessió. Si el número no era vàlid, és possible que no estigui en format E.164." } }, "nullable": true }, "callback": { "type": "string", "format": "uri", "description": "L'URL de callback de la sessió.", "nullable": true }, "id_verifications": { "type": "array", "nullable": true, "description": "**Matriu d'informes de verificació d'identitat (OCR)** generats per passos de document d'identitat al graf del flux de treball. Sempre és una matriu JSON — llegeix `id_verifications[0]` i itera si el teu flux de treball pot executar més d'una comprovació d'identitat (per exemple, una comprovació principal més un pas d'escalada). `null` fins que almenys un pas d'identitat hagi generat dades. Cada element és l'informe complet, incloent-hi `node_id`, l'`status` a nivell de funcionalitat, camps del document extrets, URL de les imatges, puntuacions de qualitat, MRZ, anàlisi de l'adreça, coincidències entre sessions i `warnings[]`.", "items": { "type": "object", "description": "Un informe de Verificació d'identitat: l'informe complet per a un únic pas de Verificació d'identitat. `verification_method` indica quin dels tres mètodes l'ha generat (captura de document, consulta sense document o inici de sessió amb cartera) i el bloc d'evidències específic del mètode s'omple en conseqüència.", "properties": { "node_id": { "type": "string", "description": "ID del node del graf del flux de treball del pas d'OCR que ha generat aquest informe." }, "verification_method": { "type": "string", "enum": [ "document", "id_lookup", "wallet" ], "description": "Quin mètode de verificació d'identitat ha generat aquest informe. `document`: l'usuari ha fotografiat un document d'identitat físic (el valor per defecte, i el valor a cada sessió creada abans que existissin els altres mètodes). `id_lookup`: l'usuari ha introduït el seu número de document d'identitat nacional i s'ha comprovat contra un registre governamental o una altra font oficial d'aquell país (`id_lookup.source` n'indica quina). `wallet`: l'usuari ha iniciat sessió amb una identitat digital governamental o bancària." }, "assurance": { "type": "string", "enum": [ "documentary", "data_match", "cryptographic" ], "description": "Nivell de garantia derivat de `verification_method`: `documentary` per a un document capturat i comprovat, `data_match` per a dades que coincideixen amb un registre de la font consultada, `cryptographic` per a atributs autenticats i signats per un proveïdor d'identitat." }, "wallet_provider": { "type": "string", "nullable": true, "description": "Identificador de catàleg de la cartera quan `verification_method` és `wallet` (`mitid`, `bankid_se`, `itsme`, ...). `null` en cas contrari." }, "fallback_from": { "type": "object", "nullable": true, "description": "Per què un mètode sense document no ha finalitzat el pas d'identificació. S'estableix quan una cerca o un inici de sessió amb cartera ha fallat: a la verificació de document amb la qual l'usuari ha continuat quan l'opció alternativa del país era `fallback_to_document` (`action` és `fallback_to_document`), o a l'informe rebutjat quan era `decline`. `null` en cas contrari.", "properties": { "method": { "type": "string", "enum": [ "id_lookup", "wallet" ], "description": "El mètode que ha fallat." }, "reason": { "type": "string", "description": "El resultat que l'ha finalitzat, p. ex. `no_match`, `provider_error`, `cancelled`, `timeout`." }, "action": { "type": "string", "enum": [ "fallback_to_document", "decline" ], "description": "L'acció configurada que s'ha dut a terme: `fallback_to_document` o `decline`." } } }, "id_lookup": { "type": "object", "nullable": true, "description": "Evidència del registre. Present només quan `verification_method` és `id_lookup`; `null` en cas contrari.", "properties": { "source": { "type": "string", "description": "Nom visible per al client de la font consultada, p. ex. `Department of Home Affairs` (un registre governamental) o `UK credit bureau and financial services records` (no és un registre governamental). Aquesta és l'única indicació de procedència de la cerca; no assumeixis que es tracta d'una font governamental." }, "checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan va respondre el registre." }, "attempts": { "type": "integer", "description": "Número d'intent, començant per 1, del qual prové aquest informe." }, "max_attempts": { "type": "integer", "description": "Pressupost d'intents configurat per al país (d'1 a 5, per defecte 1)." }, "outcome": { "type": "string", "enum": [ "match", "partial_match", "no_match", "provider_error", "format_rejected" ], "nullable": true, "description": "El que ha respost el registre. Només `match`, `partial_match` i `no_match` descompten del pressupost d'intents i es facturen." }, "comparison": { "type": "array", "description": "Una fila per camp comparable sobre el qual ha respost la font, més una fila per cada error de la font. Les files de comparació utilitzen els noms de camp normalitzats que es mostren a continuació en comptes de les claus dels camps de sol·licitud del país, perquè diversos camps de sol·licitud (nom i cognoms, o qualsevol dels àlies d'identificador) es redueixen a una única comparació. Una font que hagi fallat afegeix una fila amb `field: \"provider\"` i `result: \"error\"`, de manera que cal llegir `result` abans de tractar una fila com un veredicte del camp.", "items": { "type": "object", "required": [ "field", "label", "provided", "record", "result" ], "properties": { "field": { "type": "string", "enum": [ "identification_number", "full_name", "date_of_birth", "address", "provider" ], "description": "Camp de comparació normalitzat. `provider` no és un camp d'usuari: marca una fila d'error d'origen." }, "label": { "type": "string", "description": "Etiqueta visible per a la fila, p. ex. `ID number`, `Full name`, `Provider`." }, "provided": { "type": "string", "nullable": true, "description": "El que ha escrit l'usuari. `null` en una fila d'error de `provider`." }, "record": { "type": "string", "nullable": true, "description": "El que contenia la font. En una fila d'error de `provider`, això conté el missatge d'error en el seu lloc." }, "result": { "type": "string", "enum": [ "match", "partial", "no_match", "error" ], "description": "Resultat de la comparació camp per camp. `error` només apareix en una fila de `provider` i significa que aquesta font no ha respost; tracta-ho com a evidència sobre la consulta, mai com una no coincidència de camps." } } } }, "registry_portrait": { "type": "string", "format": "uri", "nullable": true, "description": "URL presignada de curta durada al retrat que ha retornat la font. Només els quatre registres governamentals que en retornen un (Sud-àfrica, Nigèria, Argentina, Panamà)." }, "face_match_score": { "type": "number", "nullable": true, "description": "Selfie comparada amb el retrat del registre, 0-100. Només quan el registre retorna un retrat." } } }, "wallet_verification": { "type": "object", "nullable": true, "description": "Evidència de la credencial. Present només quan `verification_method` és `wallet`; `null` en cas contrari.", "properties": { "provider": { "type": "string", "description": "Identificador de catàleg de la cartera, p. ex., `mitid`." }, "provider_name": { "type": "string", "nullable": true, "description": "Nom de la cartera tal com el coneix l'usuari final, p. ex. `MitID`." }, "issuing_authority": { "type": "string", "nullable": true, "description": "L'autoritat darrere de la cartera, p. ex. `Danish Agency for Digital Government`." }, "issuing_country": { "type": "string", "description": "País ISO 3166-1 alpha-3 en què s'ha ofert la cartera." }, "credential_type": { "type": "string", "nullable": true, "description": "Credencial que ha presentat la cartera, p. ex. `person_identification`." }, "level_of_assurance": { "type": "string", "enum": [ "low", "substantial", "high" ], "nullable": true, "description": "El nivell de garantia que ha declarat la cartera. Un inici de sessió que declari menys del nivell sol·licitat falla en lloc de degradar-se." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "L'instant d'autenticació de la cartera." }, "signature_valid": { "type": "boolean", "nullable": true, "description": "Si l'asserció signada que ha retornat la cartera s'ha validat." }, "attributes": { "type": "object", "additionalProperties": true, "description": "Els atributs que la cartera ha compartit, indexats com els llista l'entrada del catàleg de la cartera." }, "portrait": { "type": "string", "format": "uri", "nullable": true, "description": "URL presignada de curta durada al retrat que ha compartit la cartera, en cas que en comparteixi un." }, "face_match_score": { "type": "number", "nullable": true, "description": "Selfie comparada amb el retrat de la cartera, 0-100, quan la cartera en comparteix un." } } }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Expired" ], "description": "Estat a nivell de funcionalitat d'aquest pas de verificació d'identitat. Independent de l'`status` de la sessió de nivell superior: una sessió pot assolir la seva decisió global mentre una funcionalitat individual roman `In Review`." }, "document_type": { "type": "string", "description": "Tipus de document d'identitat" }, "document_subtype": { "type": "string", "nullable": true, "description": "Codi de subtipus de document acceptat de la configuració de documents del flux de treball, incloent-hi la regió del document quan correspongui. Exemples: `ID_CARD_GENERIC`, `QUEENSLAND_DRIVER_LICENSE_GENERIC`." }, "document_number": { "type": "string", "description": "Número d'identificació del document" }, "personal_number": { "type": "string", "description": "Número d'identificació personal" }, "portrait_image": { "type": "string", "format": "uri", "description": "URL de la imatge de retrat" }, "front_image": { "type": "string", "format": "uri", "description": "URL de la imatge de l'anvers del document" }, "front_video": { "type": "string", "format": "uri", "description": "URL del vídeo de l'anvers del document" }, "back_image": { "type": "string", "format": "uri", "description": "URL de la imatge del revers del document" }, "back_video": { "type": "string", "format": "uri", "description": "URL del vídeo del revers del document" }, "full_front_image": { "type": "string", "format": "uri", "description": "URL de la imatge completa de l'anvers del document" }, "full_back_image": { "type": "string", "format": "uri", "description": "URL de la imatge completa del revers del document" }, "front_image_camera_front": { "type": "string", "format": "uri", "description": "URL de la imatge de l'anvers del document capturada des de la càmera frontal" }, "back_image_camera_front": { "type": "string", "format": "uri", "description": "URL de la imatge del revers del document capturada des de la càmera frontal" }, "date_of_birth": { "type": "string", "format": "date", "description": "Data de naixement del document" }, "age": { "type": "integer", "description": "Edat calculada a partir de la data de naixement" }, "expiration_date": { "type": "string", "format": "date", "description": "Data de caducitat del document" }, "date_of_issue": { "type": "string", "format": "date", "description": "Data d'emissió del document" }, "issuing_state": { "type": "string", "description": "Codi ISO de l'estat emissor" }, "issuing_state_name": { "type": "string", "description": "Nom complet de l'estat emissor" }, "first_name": { "type": "string", "description": "Nom de pila del document" }, "last_name": { "type": "string", "description": "Cognom del document" }, "full_name": { "type": "string", "description": "Nom complet extret del document" }, "gender": { "type": "string", "description": "Gènere extret del document" }, "address": { "type": "string", "description": "Adreça en brut del document" }, "formatted_address": { "type": "string", "description": "Adreça completa amb format" }, "place_of_birth": { "type": "string", "description": "Lloc de naixement del document" }, "marital_status": { "type": "string", "description": "Estat civil extret del document" }, "nationality": { "type": "string", "description": "Codi ISO de nacionalitat" }, "extra_fields": { "type": "object", "description": "Camps addicionals del document. Inclou atributs específics del document (p. ex., `dl_categories`, `blood_group`, `sponsor`, `employer`, `dl_class_code_b_from`, `dl_class_code_b_to`). Les dates de validesa de les classes del permís de conduir es retornen com a `dl_class_code__from` i `dl_class_code__to`, i els codis de restricció/informació per classe (p. ex., la columna 12 dels permisos del Regne Unit) com a `dl_class_code__notes`. Quan el document conté noms, adreça o lloc de naixement en diversos sistemes d'escriptura, aquest objecte també inclou versions d'aquests camps en l'escriptura alternativa. La configuració del flux de treball `preferred_characters` (`latin` o `non_latin`) controla quin sistema d'escriptura emplena els camps de nivell superior (`first_name`, `last_name`, `full_name`, `address`, `place_of_birth`); l'escriptura oposada s'inclou aquí com a `first_name_non_latin` / `last_name_non_latin` / `full_name_non_latin` / `middle_name_non_latin` / `address_non_latin` / `place_of_birth_non_latin` (quan `preferred_characters` és `latin`) o amb un sufix `_latin` (quan `preferred_characters` és `non_latin`). Les claus només apareixen quan l'OCR extreu realment un valor en una escriptura alternativa real: s'omet un camp el valor alternatiu del qual està en el mateix sistema d'escriptura que el conjunt preferit (per exemple, un camp amb etiqueta en ciríl·lic el valor OCR del qual s'ha retornat en homòglifs llatins). Quan `preferred_characters` és `latin` però el document només conté text no llatí, Didit translitera els valors extrets i exposa `first_name_latin` / `last_name_latin` / etc. com a alternativa.", "additionalProperties": true, "properties": { "dl_categories": { "type": "array", "items": { "type": "string" } }, "blood_group": { "type": "string", "nullable": true }, "first_name_non_latin": { "type": "string", "description": "Nom de pila en el sistema d'escriptura no llatí quan `preferred_characters=latin` i hi ha una versió en sistema d'escriptura no llatí al document (p. ex. `Айна` per a un document d'identitat kirguís)." }, "last_name_non_latin": { "type": "string", "description": "Cognom en el sistema d'escriptura no llatí quan `preferred_characters=latin` i hi ha present una versió no llatina al document." }, "middle_name_non_latin": { "type": "string", "description": "Segon nom / patronímic en el sistema d'escriptura no llatí quan `preferred_characters=latin` i hi ha una versió no llatina present al document." }, "full_name_non_latin": { "type": "string", "description": "Nom complet compost en el sistema d'escriptura no llatí. Es reconstrueix a partir dels components individuals quan tant el nom com els cognoms estan disponibles." }, "address_non_latin": { "type": "string", "description": "Adreça en el sistema d'escriptura no llatí quan `preferred_characters=latin` i hi ha una versió no llatina present al document." }, "place_of_birth_non_latin": { "type": "string", "description": "Lloc de naixement en el sistema d'escriptura no llatí quan `preferred_characters=latin` i hi ha una versió no llatina present al document." }, "first_name_latin": { "type": "string", "description": "Nom de pila en sistema d'escriptura llatí. S'omple quan `preferred_characters=non_latin` i hi ha una versió en sistema d'escriptura llatí al document, o —com a recurs de transliteració— quan `preferred_characters=latin` però el document només conté text en un sistema d'escriptura no llatí." }, "last_name_latin": { "type": "string", "description": "Cognom en sistema d'escriptura llatí. Mateixes regles que `first_name_latin`." }, "middle_name_latin": { "type": "string", "description": "Segon nom / patronímic en sistema d'escriptura llatí. Les mateixes regles que `first_name_latin`." }, "full_name_latin": { "type": "string", "description": "Nom complet compost en alfabet llatí. Sempre es reconstrueix a partir dels components individuals quan tant el nom com els cognoms estan disponibles." }, "address_latin": { "type": "string", "description": "Adreça en sistema d'escriptura llatí. S'apliquen les mateixes regles que a `first_name_latin`." }, "place_of_birth_latin": { "type": "string", "description": "Lloc de naixement en sistema d'escriptura llatí. Mateixes regles que `first_name_latin`." } } }, "mrz": { "type": "object", "nullable": true, "description": "Camps de la zona de lectura mecànica (MRZ) analitzats i extrets del document. `null` si no s'ha detectat cap MRZ.", "properties": { "surname": { "type": "string", "example": "MARTINEZ_families` / `very_high_similarity_plus__families`. Només present quan `match_source` és `recovered_high`." } } } }, "browser_version": { "type": "string", "nullable": true }, "os_version": { "type": "string", "nullable": true }, "user_agent": { "type": "string", "nullable": true, "description": "La cadena de l'agent d'usuari del navegador." }, "accept_language": { "type": "string", "nullable": true, "description": "La capçalera `Accept-Language` que ha enviat el navegador." }, "session_identifier": { "type": "string", "nullable": true, "description": "Identificador de la sessió de navegació en què s'ha executat la verificació." }, "session_age_ms": { "type": "integer", "nullable": true, "description": "Antiguitat d'aquesta sessió de navegació en mil·lisegons quan es va executar el pas." }, "coords_accuracy": { "type": "number", "nullable": true, "description": "Radi de precisió, en metres, de les coordenades que ha notificat el dispositiu." }, "raw_device_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Senyals de dispositiu en brut recopilats per al pas." } } } }, "geolocation_checks": { "type": "array", "nullable": true, "description": "**Matriu de resultats de verificació d'ubicació**, un per cada pas de verificació d'ubicació: l'intent acceptat d'aquest pas. `null` fins que un pas de verificació d'ubicació hagi generat dades. Els intents anteriors del mateix pas es troben a `geolocation_attempts`.", "items": { "$ref": "#/components/schemas/GeolocationCheck" } }, "geolocation_attempts": { "type": "array", "nullable": true, "description": "Tots els intents de cada pas de verificació d'ubicació d'aquesta sessió, del més antic al més recent. Els intents substituïts per un reenviament s'ometen. Un flux de treball que retingui `geolocation_checks` mitjançant els seus atributs de resposta també reté aquesta llista.", "items": { "$ref": "#/components/schemas/GeolocationAttempt" } }, "database_validations": { "type": "array", "nullable": true, "description": "**Array d'informes de Validació en bases de dades** — sempre és un array JSON, mai un objecte `database_validation` singular. `null` fins que almenys un pas de validació en bases de dades hagi generat dades. Cada element és l'informe complet, incloent-hi `node_id`, el `status` a nivell de funcionalitat, `screened_data`, les `validations[]` per servei (cadascuna amb el seu `source_data` del registre) i `warnings[]`. Els camps `screened_data` i `source_data` varien segons 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}. Utilitza la validació biomètrica de coincidència facial del RENAPER. El gènere s'infereix automàticament a partir de l'anàlisi facial o del nom de pila quan no està present al document (p. ex., permisos de conduir)\n\n**BOL (Bolívia)**: 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 sempre inclou {identification_number, first_name, last_name, date_of_birth, lgpd_minor, minor_under_18, minor_under_16} per a coincidències satisfactòries de CPF. Les consultes d'adults satisfactòries estableixen aquests indicadors a false. El servei Consulta CPF de la Receita Federal pot retornar HTTP 422 (menor de 18 anys) o 451 (menor de 16 anys) amb dades retingudes per la LGPD; en aquests casos, source_data estableix els indicadors de menor a true segons correspongui, inclou l'estat HTTP del servei d'origen i la validació a nivell de camp és no_match. Consulta la secció del Brasil de la referència de Codis de resultats de la validació en bases de dades per obtenir la llista completa de codis.\n\n**CHL (Xile)**: 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 (Colòmbia)**: 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} (només retorna vàlid/invàlid)\n\n**ECU (Equador)**: 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 (Espanya)**: 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 (Hondures)**: screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**MEX (Mèxic)**: 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}. Utilitza el registre civil RENAPO. També hi ha disponible un servei independent de verificació de validesa de l'INE per a MEX com a validació addicional individual.\n\n**PAN (Panamà)**: screened_data: {personal_number, selfie}. source_data: {identification_number}. Utilitza la validació biomètrica del 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 (Paraguai)**: 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 (Uruguai)**: screened_data: {personal_number, date_of_birth, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**VEN (Veneçuela)**: 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 únic per a aquest pas de validació en bases de dades al graf del flux de treball." }, "issuing_state": { "type": "string", "description": "Codi ISO 3166-1 alpha-3 del país les fonts governamentals o de registres del qual s'han consultat (p. ex., `BRA`, `MEX`, `ESP`, `NGA`, `IDN`). Validació en bases de dades cobreix 60+ països d'Amèrica, Europa, Àfrica, l'Orient Mitjà i Àsia-Pacífic, a més de fonts globals multipaís — la cobertura s'amplia regularment, així que tracta el valor com un conjunt obert en lloc d'un enum fix." }, "validation_type": { "type": "string", "enum": [ "one_by_one", "two_by_two", "not_enabled" ], "description": "Com s'ha corroborat el resultat: `one_by_one` (resultat d'un únic servei), `two_by_two` (dos o més serveis diferents han fet coincidir de manera independent i completa el número d'identificació), o `not_enabled` (es desa quan cap servei ha produït una coincidència utilitzable). El valor mai és `null`. Actualment hi ha modes de validació 2x2 biomètrics dedicats per a `ECU` i `PER`." }, "screened_data": { "type": "object", "description": "Les dades d'entrada utilitzades per a la validació. Els camps varien segons el país; consulta la documentació de Validació en bases de dades (`/core-technology/database-validation/overview`) per conèixer els formats específics de cada país.", "properties": { "last_name": { "type": "string" }, "first_name": { "type": "string" }, "tax_number": { "type": "string", "description": "Brasil: CPF (11 dígits)" }, "personal_number": { "type": "string", "description": "Xile: RUT, DOM: Cédula (11 dígits), ECU: Cédula (10 dígits), ESP: DNI/NIE, MEX: CURP (18 caràcters), PER: DNI (8 dígits), 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": "Obligatori per a ESP" } } }, "validations": { "type": "array", "description": "Una entrada per servei de registre que hagi retornat un payload de validació. Cada entrada identifica el servei (`service_id`, `service_name`) i conté la comparació de `validation` camp per camp, l'`outcome_code` / `outcome_detail` del servei quan s'informa, i el registre normalitzat a `source_data`.", "items": { "type": "object", "properties": { "service_id": { "type": "string", "description": "Identificador del servei de registre que ha generat aquest resultat de validació.", "example": "bra_cpf" }, "service_name": { "type": "string", "description": "Nom fàcil de llegir del servei de registre.", "example": "Brazil - CPF status check" }, "validation": { "type": "object", "description": "Els resultats de les validacions dels camps.", "properties": { "full_name": { "type": "string", "description": "Resultat de coincidència per al nom complet (p. ex., 'full_match', 'partial_match', 'no_match')." }, "date_of_birth": { "type": "string", "description": "Resultat de coincidència per a la data de naixement." }, "identification_number": { "type": "string", "description": "Resultat de coincidència per al número d'identificació." } } }, "outcome_code": { "type": "string", "nullable": true, "description": "Resultat llegible per màquina de la consulta al registre (p. ex., `MATCH`, `NO_MATCH`, `PARTIAL_MATCH`, `INCONCLUSIVE`, codis específics de la font). Present quan el servei en proporciona un." }, "outcome_detail": { "type": "string", "nullable": true, "description": "Explicació fàcil de llegir d'`outcome_code`, quan la proporciona el servei." }, "source_data": { "type": "object", "description": "Les dades retornades de la base de dades governamental. Camps comuns: identification_number, first_name, last_name, full_name, date_of_birth, gender. Camps addicionals per país: BRA sempre inclou lgpd_minor, minor_under_18 i minor_under_16 en coincidències de CPF satisfactòries; també inclou l'estat HTTP del sistema d'origen quan les dades del CPF es retenen sota la LGPD (HTTP 422/451). ECU afegeix street, formatted_address, nationality, education, marital_status, spouse, mother_name, father_name, profession. PER afegeix paternal_name, maternal_name, verification_number, verification_letter. ESP afegeix document_type, expiration_date. VEN/COL afegeixen document_type.", "additionalProperties": true } } } }, "errors": { "type": "array", "description": "Errors retornats pels serveis de registre durant la validació, cadascun etiquetat amb el `service_id` que l'ha produït. **Aquesta clau s'omet completament quan no hi ha errors.**", "items": { "type": "object", "description": "L'objecte d'error del servei upstream desplegat tal qual —les seves claus varien segons el servei (normalment un missatge/codi i qualsevol detall específic del proveïdor)—, a més de `service_id`, que identifica el servei que ha fallat.", "properties": { "service_id": { "type": "string", "nullable": true, "description": "Identificador del servei de registre que ha fallat." } }, "additionalProperties": true } }, "match_type": { "type": "string", "enum": [ "no_match", "partial_match", "full_match" ], "nullable": true, "description": "El resultat agregat de coincidència entre els serveis consultats. `null` fins que la validació s'hagi avaluat." }, "status": { "type": "string", "description": "Estat a nivell de funcionalitat d'aquesta validació en bases de dades. Independent de l'`status` de la sessió de nivell superior: una sessió pot assolir la seva decisió global mentre una funcionalitat individual roman `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 funcionalitat que ha generat aquesta advertència. El valor identifica el bloc de funcionalitat al qual pertany l'advertència. L'array d'advertències de cada mòdul sol utilitzar el valor que coincideix amb el seu mòdul (p. ex. `PHONE` dins de `phone_verifications[].warnings`), però l'enum anterior és vinculant per a totes les advertències de funcionalitats al payload de la decisió." }, "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": "L'ID del node del graf del flux de treball que ha generat aquesta advertència" } } }, "description": "Advertències relacionades amb la validació en bases de dades." } } } }, "database_validation_not_performed_reason": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Per què una validació en bases de dades configurada no ha produït cap resultat, com a `{code, message}` més camps de context. Només està present quan `database_validations` és `null` per a un flux de treball que té el pas, de manera que pots distingir entre \"el registre ha donat el vistiplau\" i \"no s'ha executat res\". `null` en cas contrari.", "properties": { "code": { "type": "string", "description": "Motiu llegible per màquina estable." }, "message": { "type": "string", "description": "Explicació fàcil de llegir." } } }, "reviews": { "type": "array", "items": { "type": "object", "properties": { "user": { "type": "string", "description": "Qui ha fet la revisió. Normalment és l'identificador del revisor de la consola (el seu correu electrònic), però el valor és `\"API Client\"` per a les actualitzacions d'estat fetes amb una clau d'API i `\"Unknown\"` quan no s'ha pogut determinar cap actor; per tant, no analitzis aquest camp com una adreça de correu electrònic." }, "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 a qui s'ha assignat la sessió, o `null` quan ningú la té assignada.", "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": "Quan la sessió va començar a esperar la revisió. `null` tret que la sessió estigui `In Review` i la teva aplicació estableixi un termini de revisió." }, "sla_due_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data límit de la revisió. `null` tret que la sessió estigui `In Review` i la teva aplicació estableixi un termini de revisió." }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de temps en què es va crear la sessió (ISO 8601, UTC)." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de temps en què està programada la caducitat d'aquesta sessió. S'estableix a les sessions de Verificació d'usuaris (KYC) quan se'n va configurar la caducitat en el moment de la creació (o un cop l'estat `Approved` activa el càlcul de caducitat de KYC). `null` per a sessions sense una caducitat configurada i per a tipus que no utilitzen caducitat (p. ex., sessions de Verificació d'empreses (KYB) que mai no han rebut un `expires_at`)." }, "registry_checks": { "type": "array", "nullable": true, "description": "Comprovacions del registre mercantil. Només present quan `session_kind = business`. Cada element conté el payload complet del registre mercantil.", "items": { "type": "object", "description": "Una comprovació del registre mercantil: el payload complet del registre mercantil enriquit amb l'estructura de titularitat i advertències. Només present quan `session_kind = business`.", "properties": { "status": { "type": "string", "description": "Estat del cicle de vida de la funcionalitat." }, "node_id": { "type": "string", "nullable": true }, "data_resolved": { "type": "boolean" }, "company": { "type": "object", "description": "Payload complet del registre per a l'empresa (registre mercantil combinat amb qualsevol dada proporcionada per l'usuari o editada a 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ó (ISO 3166-1 alpha-2, p. ex. `GB`, `DE`, `US`)." }, "region": { "type": "string", "nullable": true, "description": "Codi de subdivisió ISO 3166-2 quan sigui aplicable (p. ex., `CA`, `NY` per a estats dels EUA)." }, "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": "Noms alternatius, comercials, anteriors o en l'idioma original de l'empresa com a text, quan s'hagin informat." }, "nature_of_business": { "type": "string", "nullable": true }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "format": "decimal", "nullable": true, "description": "Import del capital social/registrat com a cadena decimal (p. ex. `\"100.00\"`), analitzat a partir del document presentat al registre. `null` quan no estigui disponible." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Codi de moneda ISO 4217 de `registered_capital_amount` (p. ex. `\"GBP\"`). `null` quan no estigui 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 d'IVA de la UE, quan es recull durant el pas de registre allotjat o s'edita posteriorment." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Resultat de la validació del número d'IVA o, si no n'hi ha, del `tax_number`, en enviar al registre. `valid` / `invalid`: determinat pel registre oficial del país (VIES de la UE, Noruega, Suïssa, Brasil, Colòmbia, Costa Rica, Equador, Paraguai; Polònia també pel seu registre intern d'IVA). `format_valid` / `invalid_format`: determinat per les regles de format i dígit de control del país on no es pot consultar cap registre. `could_not_validate`: el registre no estava disponible. `not_applicable`: sense número, un país sense registre o regles, o una sessió de sandbox." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "El número que s'ha comprovat, tal com el coneix la font (per exemple, el número d'IVA derivat d'un SIREN francès o d'un RSIN holandès). `null` quan no s'ha executat cap comprovació." }, "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 font que ha determinat `vat_validation_status`: un registre oficial o `format_rules`. `null` quan no s'ha executat cap comprovació." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Nom registrat amb la font que ha validat el número, quan en revela un. Només s'estableix quan l'estat és `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Adreça registrada amb la font que ha validat el número, quan en divulga una. Només s'estableix quan l'estat és `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Marca de temps de la comprovació. `null` quan no s'ha executat cap comprovació." }, "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": "Nom de pila quan el registre el reporta explícitament; no deduït del nom complet." }, "last_name": { "type": "string", "nullable": true, "description": "Cognom quan el registre mercantil l'informa explícitament." }, "address": { "type": "string", "nullable": true, "description": "Adreça de l'administrador notificada pel registre mercantil." }, "appointment_date": { "type": "string", "nullable": true, "description": "Data en què es va nomenar el directiu.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Data en què va finalitzar el càrrec, quan s'ha notificat.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Data de naixement completa informada pel registre. Null quan només es coneix l'any o el mes de naixement.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Any de naixement notificat pel registre, inclòs quan la data completa no està disponible." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Mes de naixement notificat pel registre. Nul quan només es coneix l'any." } } } }, "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ímit inferior del percentatge de titularitat segons informa el registre. Cadena de text lliure (p. ex., `\"25.00\"`, `\"50\"`); utilitza `effective_ownership_percent` per obtenir un valor numèric processat." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Límit superior del percentatge de titularitat segons el registre. Cadena de text lliure; utilitza `effective_ownership_percent` per a un valor numèric analitzat." }, "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": "Data de naixement completa quan s'ha informat.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Data de nomenament quan s'ha informat.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } } }, "addresses": { "type": "array", "nullable": true, "description": "Totes les adreces que indica el registre, en un format canònic. Null si no n'indica cap.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "Les activitats sota les quals el registre classifica l'empresa, en un format canònic. Null si no n'indica cap.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Dates de presentació al registre, quan estiguin disponibles. Els informes anuals i les juntes generals utilitzen last_annual_return_date i last_agm_date; són diferents dels comptes financers." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "description": "Dades confirmades o editades per l'usuari 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 nivell de registre que ha sol·licitat el flux de treball: `basic`, `shareholders` o `ubo`. També a `ownership.tier_requested`." }, "registry_tier_delivered": { "type": "string", "nullable": true, "description": "El nivell que ha lliurat el registre i que es factura. També a `ownership.tier_delivered`." }, "registry_ownership_status": { "type": "string", "nullable": true, "description": "`not_requested`, `pending`, `delivered`, `not_held` o `unavailable`. També a `ownership.status`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "El monitor de registre més recent per a l'empresa, o `null` quan no n'existeix cap.", "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": "Els camps de l'empresa que el monitor supervisa." } } } } }, "ownership_structure": { "$ref": "#/components/schemas/KYBOwnershipStructure" }, "warnings": { "type": "array", "items": { "type": "object" } } } } }, "key_people_checks": { "type": "array", "nullable": true, "description": "Comprovacions agregades de persones clau. Present només quan `session_kind = business`. Cada element utilitza l'estructura de dos blocs (`registry`, `submitted`, `ubo_kyc_summary`).", "items": { "type": "object", "description": "Comprovació agregada sobre els administradors i titulars reals de l'empresa. Utilitza l'estructura `registry` / `submitted`. Present només quan session_kind = business.", "properties": { "status": { "type": "string" }, "node_id": { "type": "string", "nullable": true }, "registry": { "type": "object", "description": "Parts descobertes mitjançant la comprovació del registre.", "properties": { "officers": { "type": "array", "description": "Administradors descoberts mitjançant la comprovació del registre mercantil, cadascun enriquit amb l'estat de qualsevol sessió de KYC filla i el cribratge AML generats per a ells.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Nom complet de l'administrador tal com figura al registre mercantil." }, "designation": { "type": "string", "nullable": true, "description": "Designació de text lliure del registre (p. ex., `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 d'oficial normalitzat." }, "nationality": { "type": "string", "nullable": true }, "appointment_date": { "type": "string", "nullable": true, "description": "Data en què es va nomenar el directiu.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Data en què va finalitzar el càrrec, quan s'ha notificat.", "format": "date" }, "is_active": { "type": "boolean" }, "address": { "type": "string", "nullable": true, "description": "Adreça de l'administrador notificada pel registre mercantil." }, "aml_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "nullable": true, "description": "Estat del cribratge AML executat per a aquest administrador. `null` quan no s'ha executat cap cribratge AML." }, "kyc_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "nullable": true, "description": "Estat del cicle de vida en brut de la sessió de KYC filla generada per a aquest responsable. És l'enum complet d'estats de sessió (no pas un conjunt reduït Approved/Declined/Pending). `null` quan no existeix cap sessió de KYC filla." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL per compartir de la sessió de KYC filla. `null` quan no existeix cap sessió filla." }, "kyc_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID de sessió de la sessió KYC filla. Transmet-lo a aquest mateix endpoint de decisió per obtenir l'informe KYC complet de la persona. `null` quan no existeix cap sessió filla." }, "verification_workflow_type": { "type": "string", "nullable": true, "description": "Tipus base de flux de treball de la sessió filla (p. ex., `kyc`). `null` per a fluxos de treball basats en grafs o quan no existeix cap sessió filla." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID del flux de treball utilitzat per la sessió filla. `null` quan no existeix cap sessió filla." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Etiqueta fàcil de llegir del flux de treball de la sessió filla. `null` quan no s'ha establert." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Progrés per funcionalitat de la sessió de verificació filla, p. ex. `[{\"feature\": \"ID_VERIFICATION\", \"status\": \"Approved\"}]`. `null` quan la sessió filla no té cap llista de funcionalitats que es puguin resoldre.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Nom visible de la funcionalitat (p. ex. `ID_VERIFICATION`, `LIVENESS`, `AML`)." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estat a nivell de funcionalitat dins de la sessió filla." } } } }, "didit_internal_id": { "type": "string", "nullable": true, "description": "Identificador intern estable de la persona verificada darrere de la sessió filla — útil per enllaçar entre sessions. `null` quan no existeix cap sessió filla o l'usuari encara no s'ha resolt." }, "kyc_document_type": { "type": "string", "nullable": true, "description": "Tipus de document presentat a la sessió de KYC filla (p. ex., `P`, `ID`, `DL`). `null` fins que la sessió filla tingui un resultat de verificació d'identitat." }, "kyc_nationality": { "type": "string", "nullable": true, "description": "Nacionalitat extreta del document a la sessió KYC filla. `null` fins que estigui disponible." }, "kyc_liveness_passed": { "type": "boolean", "nullable": true, "description": "Indica si la prova de vida de la sessió KYC filla s'ha superat. `null` quan no s'ha executat cap prova de vida." }, "kyc_verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan la sessió de KYC filla va assolir `Approved`. `null` mentre la sessió filla té qualsevol altre estat." }, "kyc_aml_categories": { "type": "object", "nullable": true, "description": "Resum per categoria derivat de les coincidències AML de la persona. `null` quan no hi ha coincidències.", "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 temps ISO 8601 de l'última notificació d'invitació de verificació enviada per a la sessió filla d'aquesta persona. `null` quan no se n'ha enviat cap." }, "first_name": { "type": "string", "nullable": true, "description": "Nom de pila quan el registre el reporta explícitament; no deduït del nom complet." }, "last_name": { "type": "string", "nullable": true, "description": "Cognom quan el registre mercantil l'informa explícitament." }, "date_of_birth": { "type": "string", "nullable": true, "description": "Data de naixement completa informada pel registre. Null quan només es coneix l'any o el mes de naixement.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Any de naixement notificat pel registre, inclòs quan la data completa no està disponible." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Mes de naixement notificat pel registre. Nul quan només es coneix l'any." } } } }, "beneficial_owners": { "type": "array", "description": "Titulars reals descoberts mitjançant la comprovació del registre, cadascun enriquit amb l'estat de qualsevol sessió de KYC filla i cribratge AML generats per a ells.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Nom complet del titular real (o nom de l'empresa per a UBOs corporatius)." }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "nullable": true, "description": "Data de naixement completa quan s'ha informat.", "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": "Noms de rol que té aquest titular, p. ex., `[\"ubo\", \"shareholder\"]`.", "items": { "type": "string" } }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Límit inferior del percentatge de titularitat segons informa el registre. Cadena de text lliure (p. ex., `\"25\"`, `\"25-50%\"`); utilitza `effective_ownership_percent` per obtenir un valor numèric processat." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Límit superior del percentatge de titularitat segons el registre. Cadena de text lliure; utilitza `effective_ownership_percent` per a un valor numèric analitzat." }, "is_active": { "type": "boolean" }, "aml_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "nullable": true, "description": "Estat del cribratge AML executat per a aquest titular real. `null` quan no s'ha executat cap cribratge AML." }, "kyc_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "nullable": true, "description": "Estat del cicle de vida en brut de la sessió de KYC filla generada per a aquest titular real. És l'enum complet d'estats de sessió (no pas un conjunt reduït Approved/Declined/Pending). `null` quan no existeix cap sessió de KYC filla." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL per compartir de la sessió de KYC filla. `null` quan no existeix cap sessió filla." }, "kyc_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID de sessió de la sessió KYC filla. Transmet-lo a aquest mateix endpoint de decisió per obtenir l'informe KYC complet de la persona. `null` quan no existeix cap sessió filla." }, "verification_workflow_type": { "type": "string", "nullable": true, "description": "Tipus base de flux de treball de la sessió filla (p. ex., `kyc`). `null` per a fluxos de treball basats en grafs o quan no existeix cap sessió filla." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID del flux de treball utilitzat per la sessió filla. `null` quan no existeix cap sessió filla." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Etiqueta fàcil de llegir del flux de treball de la sessió filla. `null` quan no s'ha establert." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Progrés per funcionalitat de la sessió de verificació filla, p. ex. `[{\"feature\": \"ID_VERIFICATION\", \"status\": \"Approved\"}]`. `null` quan la sessió filla no té cap llista de funcionalitats que es puguin resoldre.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Nom visible de la funcionalitat (p. ex. `ID_VERIFICATION`, `LIVENESS`, `AML`)." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estat a nivell de funcionalitat dins de la sessió filla." } } } }, "didit_internal_id": { "type": "string", "nullable": true, "description": "Identificador intern estable de la persona verificada darrere de la sessió filla — útil per enllaçar entre sessions. `null` quan no existeix cap sessió filla o l'usuari encara no s'ha resolt." }, "kyc_document_type": { "type": "string", "nullable": true, "description": "Tipus de document presentat a la sessió de KYC filla (p. ex., `P`, `ID`, `DL`). `null` fins que la sessió filla tingui un resultat de verificació d'identitat." }, "kyc_nationality": { "type": "string", "nullable": true, "description": "Nacionalitat extreta del document a la sessió KYC filla. `null` fins que estigui disponible." }, "kyc_liveness_passed": { "type": "boolean", "nullable": true, "description": "Indica si la prova de vida de la sessió KYC filla s'ha superat. `null` quan no s'ha executat cap prova de vida." }, "kyc_verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan la sessió de KYC filla va assolir `Approved`. `null` mentre la sessió filla té qualsevol altre estat." }, "kyc_aml_categories": { "type": "object", "nullable": true, "description": "Resum per categoria derivat de les coincidències AML de la persona. `null` quan no hi ha coincidències.", "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 temps ISO 8601 de l'última notificació d'invitació de verificació enviada per a la sessió filla d'aquesta persona. `null` quan no se n'ha enviat cap." }, "child_beneficial_owners": { "type": "array", "description": "Per a titulars reals corporatius: els titulars reals de la mateixa entitat propietària, com a objectes en brut extrets del registre mercantil. Matriu buida quan no sigui aplicable.", "items": { "type": "object" } }, "effective_ownership_percent": { "type": "number", "nullable": true, "description": "Percentatge de titularitat numèric analitzat: el límit màxim quan estigui disponible; en cas contrari, el límit mínim. `null` si no s'ha pogut analitzar cap dels dos límits." }, "voting_min_shares": { "type": "string", "nullable": true }, "voting_max_shares": { "type": "string", "nullable": true }, "appointment_date": { "type": "string", "nullable": true, "description": "Data de nomenament quan s'ha informat.", "format": "date" } } } } } }, "submitted": { "type": "object", "description": "Parts enviades per l'administrador de l'empresa durant el flux de Persones clau (files BusinessParty en què source=USER).", "properties": { "parties": { "type": "array", "items": { "type": "object", "description": "Part enviada per l'administrador de l'empresa a través del flux de Persones clau (source=USER).", "properties": { "uuid": { "type": "string", "format": "uuid" }, "entity_type": { "type": "string", "enum": [ "person", "company" ] }, "source": { "type": "string", "enum": [ "USER" ], "description": "Sempre `USER` aquí — aquest grup només conté parts introduïdes o confirmades per l'usuari final en el flux de persones clau (les persones descobertes al registre apareixen a `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": "Nacionalitat per a persones; país de constitució per a parts que siguin empreses." }, "phone_number": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "position": { "type": "string", "nullable": true, "description": "Càrrec o posició de text lliure (només per a persones)." }, "custom_fields": { "type": "object", "description": "Camps personalitzats definits pel flux de treball i recollits per a aquesta part; les claus estan definides pels descriptors de camp de persones clau del flux de treball." }, "is_active": { "type": "boolean" }, "is_skipped": { "type": "boolean", "description": "Cert quan l'usuari final ha omès la verificació per a aquesta part (només és possible quan el rol permet ometre-la)." }, "requires_verification": { "type": "boolean", "description": "Cert quan es requereix una subsessió filla de KYC / KYB per a aquesta part en funció de la configuració de rols i els llindars de titularitat." }, "roles": { "type": "array", "description": "Tots els rols que té aquesta part, cadascun amb els seus propis percentatges de titularitat i de vot. No hi ha cap `role`/`ownership_percent` escalar a la part mateixa.", "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 sessió KYC filla per a les parts de persona física que requereixen verificació. `null` en cas contrari." }, "kyc_session_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "nullable": true, "description": "Estat del cicle de vida de la sessió de KYC filla. `null` quan no hi ha cap sessió de KYC filla." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true }, "kyb_sub_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID de la subsessió KYB filla per a les parts corporatives que requereixen verificació. `null` en cas contrari." }, "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": "Estat del cicle de vida de la subsessió de KYB filla. `null` quan no hi ha cap subsessió." }, "kyb_sub_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL per compartir de la subsessió de KYB filla. `null` quan no existeix cap subsessió." }, "verification_workflow_type": { "type": "string", "nullable": true, "description": "Tipus base de flux de treball de la sessió filla (es prioritza la sessió de KYC, recorrent a la subsessió de KYB si no n'hi ha). `null` per a fluxos de treball basats en grafs o quan no existeix cap sessió filla." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID del flux de treball utilitzat per la sessió filla. `null` quan no existeix cap sessió filla." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Etiqueta fàcil de llegir del flux de treball de la sessió filla. `null` quan no s'ha establert." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Progrés per funcionalitat de la sessió de verificació filla, p. ex. `[{\"feature\": \"ID_VERIFICATION\", \"status\": \"Approved\"}]`. `null` quan la sessió filla no té cap llista de funcionalitats que es puguin resoldre.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Nom visible de la funcionalitat (p. ex. `ID_VERIFICATION`, `LIVENESS`, `AML`)." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estat a nivell de funcionalitat dins de la sessió filla." } } } }, "didit_internal_id": { "type": "string", "nullable": true, "description": "Identificador intern estable de la persona verificada darrere de la sessió filla. `null` quan no s'ha resolt." } } } } } }, "ubo_kyc_summary": { "type": "object", "nullable": true, "description": "Progrés agregat de KYC dels titulars reals, o null quan cap titular real té sessions de KYC enllaçades.", "properties": { "total": { "type": "integer" }, "approved": { "type": "integer" }, "flagged": { "type": "integer", "description": "Titulars reals (UBO) el KYC dels quals està en estat Rebutjada o en revisió." }, "pending": { "type": "integer" } } }, "warnings": { "type": "array", "items": { "type": "object" } } } } }, "document_verifications": { "type": "array", "nullable": true, "description": "Comprovacions de verificació de documents agrupades per node del flux de treball. Només presents quan `session_kind = business`.", "items": { "type": "object", "description": "Documents agrupats per node del flux de treball. Només presents quan 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": "Grup de documents de KYB d'alt nivell en què s'ha classificat el fitxer. `null` mentre no estigui classificat." }, "document_subtype": { "type": "string", "nullable": true, "description": "Subtipus específic detectat per OCR (p. ex. `CERTIFICATE_OF_INCORPORATION`, `SHAREHOLDER_REGISTRY`); `UNKNOWN` si l'OCR no ha pogut classificar el document amb seguretat." }, "document_group": { "type": "string", "enum": [ "LEGAL_PRESENCE", "COMPANY_DETAILS", "OWNERSHIP_STRUCTURE", "REPRESENTATIVES_AUTHORIZATION", "OTHER" ], "nullable": true, "description": "Àlies de `document_type` — el nom de grup utilitzat per `groups` i `required_groups`." }, "file_url": { "type": "string", "format": "uri", "nullable": true, "description": "Enllaç presignat de curta durada al fitxer pujat. `null` per als marcadors de posició de sol·licitud de documents creats per analistes (`is_requested = true`) que encara no s'han completat." }, "original_filename": { "type": "string", "nullable": true, "description": "Nom de fitxer tal com l'ha penjat l'usuari o analista." }, "file_size": { "type": "integer", "nullable": true, "description": "Mida del fitxer en bytes." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estat de verificació per document." }, "created_at": { "type": "string", "format": "date-time" }, "cross_check_result": { "type": "object", "nullable": true, "description": "Comprovació creuada dels camps del document extrets per OCR amb el perfil de l'empresa al registre mercantil. Un objecte amb les seccions `critical`, `non_critical` i `people`, cadascuna assignant un nom de camp (p. ex. `company_name`, `registration_number`, `incorporation_date`, `registered_address`) a un registre de comparació com ara `{\"document\": \"...\", \"registry\": \"...\", \"match\": true, \"score\": 0.97}`. `null` quan el document no tenia dades d'OCR o no hi havia cap empresa del registre mercantil amb la qual comparar." }, "document_metadata": { "type": "object", "nullable": true, "description": "Metadades extretes del document corporatiu pujat. Quan l'extracció de metadades ha estat satisfactòria, totes les 16 claus estan sempre presents (els valors individuals són `null` quan no són aplicables al tipus de fitxer); tot l'objecte és `null` quan no s'ha pogut extreure res. Per a fitxers PDF, `overlay_manipulation` conté l'anàlisi forense de text superposat.", "properties": { "file_size": { "type": "integer", "nullable": true, "description": "Mida del document." }, "content_type": { "type": "string", "nullable": true, "description": "Tipus de contingut del document." }, "creation_date": { "type": "string", "nullable": true, "description": "Data en què es va crear el document." }, "modified_date": { "type": "string", "nullable": true, "description": "Data en què es va modificar el document." }, "creator": { "type": "string", "nullable": true, "description": "Eina o usuari d'autoria registrat a les metadades del fitxer (PDF `Creator`)." }, "producer": { "type": "string", "nullable": true, "description": "Programari que ha generat el fitxer (`Producer` del PDF)." }, "software": { "type": "string", "nullable": true, "description": "Programari d'edició registrat a les metadades del fitxer." }, "encryption": { "type": "string", "nullable": true, "description": "Esquema de xifratge del fitxer, quan està xifrat." }, "is_signed": { "type": "boolean", "nullable": true, "description": "Indica si el document conté una signatura digital." }, "is_tampered": { "type": "boolean", "nullable": true, "description": "Indica si la signatura digital ha fallat la validació (modificació posterior a la signatura)." }, "signature_info": { "type": "object", "nullable": true, "description": "Detalls de la signatura o signatures digitals, quan n'hi hagi." }, "exif_original_date": { "type": "string", "nullable": true, "description": "Data de captura original EXIF, per a càrregues d'imatges." }, "exif_digitized_date": { "type": "string", "nullable": true, "description": "Data de digitalització EXIF, per a càrregues d'imatges." }, "processed_by_known_editor": { "type": "boolean", "nullable": true, "description": "Indica si les metadades indiquen que el fitxer ha passat per un editor d'imatges/PDF conegut." }, "has_different_creation_mod_date": { "type": "boolean", "nullable": true, "description": "Indica si les dates de creació i modificació difereixen — un possible senyal (però no concloent) d'edició." }, "overlay_manipulation": { "type": "object", "nullable": true, "description": "Anàlisi forense de PDF per sospita de manipulació de text superposat. Null quan no s'ha trobat cap indici de manipulació per superposició o el document no era un PDF.", "properties": { "detected": { "type": "boolean", "description": "Indica si s'han detectat indicis de manipulació de text superposat." }, "analyzed": { "type": "boolean", "description": "Indica si s'ha pogut analitzar el PDF." }, "analysis_incomplete": { "type": "boolean", "description": "És present i té el valor true només quan el fitxer no s'ha pogut verificar completament. El que sí que s'ha verificat conserva les seves troballes quan és possible, i el document mostra l'advertència de substitució de text no demostrada." }, "signals": { "type": "array", "items": { "type": "string" }, "description": "Senyals forenses que s'han activat, com ara duplicate_font_subset o glyph_fragmentation." }, "manipulated_regions": { "type": "array", "description": "Àrees amb sospita de manipulació en coordenades de pàgina 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 motiu proporcionat per l'analista per a una sol·licitud de document. `null` per a pujades habituals." }, "is_requested": { "type": "boolean", "description": "Cert per als marcadors de posició de sol·licitud de documents creats per analistes que estan pendents de pujada." }, "ocr_data": { "type": "object", "nullable": true }, "is_console_upload": { "type": "boolean", "description": "Cert per a documents pujats des de la consola en lloc del flux d'usuari final. Les pujades des de la consola mai canvien l'estat agregat de la funcionalitat." }, "is_confirmed": { "type": "boolean", "description": "Les càrregues des de la consola comencen com a `false` i canvien a `true` un cop l'administrador les confirma; les càrregues dels usuaris finals sempre són `true`." } } } }, "groups": { "type": "object", "description": "Comptadors de progrés per grup indexats pel nom del grup (p. ex., 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": "Marcadors de posició sol·licitats sense cap fitxer penjat encara." } } } }, "required_groups": { "type": "array", "items": { "type": "string" } }, "warnings": { "type": "array", "items": { "type": "object" } } } } }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Si la sessió s'ha creat mitjançant una aplicació de producció (`live`) o una aplicació de sandbox (`sandbox`). Les sessions de sandbox són gratuïtes, completament simulades i mai no facturen crèdits." }, "sandbox_scenario": { "type": "string", "nullable": true, "description": "L'escenari de sandbox amb el qual es va crear la sessió. `null` per a sessions de producció i per a sessions de sandbox creades sense cap escenari." }, "resubmissions": { "type": "array", "description": "Retornat només amb `include=resubmissions`, per a sessions d'usuari i d'empresa. Una entrada per sol·licitud de reenviament, començant per la més antiga. Cada entrada conté els resultats que els passos tornats a enviar van retornar abans de la sol·licitud, de manera que les trameses anteriors es mantenen consultables. Si s'elimina la sessió, s'eliminen totes les trameses.", "items": { "type": "object", "properties": { "number": { "type": "integer", "description": "1 per al primer reenviament de la sessió, 2 per al segon, i així successivament." }, "created_at": { "type": "string", "format": "date-time", "description": "Quan es va sol·licitar el reenviament." }, "previous_status": { "type": "string", "description": "L'estat de la sessió just abans de la sol·licitud." }, "nodes": { "type": "array", "description": "Els passos del flux de treball retornats a l'usuari.", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "feature": { "type": "string" } } } }, "reasons": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" }, "description": "El motiu indicat per a cada pas, indexat per `node_id`." }, "requested_by": { "type": "object", "nullable": true, "description": "Qui ha sol·licitat el reenviament.", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "type": { "type": "string" } } }, "results": { "type": "object", "additionalProperties": true, "description": "El que van retornar els passos reenviats abans de la sol·licitud, sota les mateixes claus i amb la mateixa estructura que els resultats actuals d'aquesta resposta (`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`; per a sessions d'empresa també `document_verifications`). Només apareixen les claus dels passos que es van reenviar." } } } }, "biometric_consent": { "type": "object", "nullable": true, "description": "Si la sessió ha requerit consentiment biomètric explícit abans d'una captura facial, per què i l'evidència de la resposta. Només per a sessions de Verificació d'usuaris (KYC); el mateix objecte es troba a la `decision` dels webhooks de sessió. `null` quan la sessió no s'ha avaluat mai, per exemple en un flux de treball sense captura facial. Els camps sense cap valor registrat són `null`. Un SDK natiu inferior a 4.10.0, o un que no informi de la seva versió, no pot mostrar el pas de consentiment: les seves captures facials s'executen com abans, i una sessió que requeria consentiment informa llavors de `status: \"pending\"` amb `reason: \"BIOMETRIC_CONSENT_UNSUPPORTED_SDK\"`. Consulta [Consentiment biomètric](/ca/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": "Per què es requereix el consentiment o com s'ha satisfet. `declared_state`: has declarat un estat cobert (`user_state`, o una adreça dels EUA a `expected_details`). `ip_state`: la IP de la persona es troba en un estat cobert (Illinois, Texas, Colorado). `ip_unknown`: les proves situen la persona als EUA, però no se'n pot determinar l'estat (la IP és als EUA sense estat, o no es pot localitzar mentre que les teves dades o el document situen la persona als EUA). `document_issuer`: el document d'identitat ha estat emès per un estat cobert. `forced`: el mode de l'aplicació és Always. `customer_collected`: has enviat `biometric_consent` en crear la sessió. `null` mentre no sigui obligatori." }, "status": { "type": "string", "enum": [ "not_required", "pending", "given", "declined" ], "description": "`not_required`; `pending` (requerit i no facilitat: la persona encara no ha respost, o `reason` n'explica el motiu pel qual no s'ha recollit); `given`; `declined` (s'ha registrat un rebuig i la sessió ha finalitzat com a `Declined`; actualment cap pantalla de Didit ofereix un rebuig)." }, "given_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va donar el consentiment. Per a `customer_collected`, el `given_at` que vas enviar." }, "declined_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va registrar un rebuig." }, "text_version": { "type": "string", "nullable": true, "description": "Identificador de versió del text de consentiment al qual la persona ha respost, o el que has enviat." }, "text_hash": { "type": "string", "nullable": true, "description": "SHA-256 (hex) del text exacte de consentiment mostrat, en l'idioma en què s'ha mostrat." }, "locale": { "type": "string", "nullable": true, "description": "Idioma en què es va mostrar el text de consentiment." }, "policy_url": { "type": "string", "format": "uri", "nullable": true, "description": "La política de dades biomètriques a la qual enllaçava el pas de consentiment." }, "step": { "type": "string", "nullable": true, "description": "Pas del flux de treball en què es trobava la sessió quan la persona ha respost, per exemple `LIVENESS`." }, "node_id": { "type": "string", "nullable": true, "description": "Node del graf del flux de treball en què es trobava la sessió quan la persona ha respost." }, "ip_address": { "type": "string", "nullable": true, "description": "IP des d'on s'ha rebut la resposta." }, "ip_country_code": { "type": "string", "nullable": true, "description": "País ISO 3166-1 alpha-2 de la IP de la resposta." }, "ip_state": { "type": "string", "nullable": true, "description": "Subdivisió ISO 3166-2 de la IP de la resposta, per exemple `US-IL`." }, "ip_city": { "type": "string", "nullable": true, "description": "Ciutat de la IP de la resposta." }, "user_agent": { "type": "string", "nullable": true, "description": "Agent d'usuari de la sol·licitud de la resposta." }, "detected_ip_address": { "type": "string", "nullable": true, "description": "La IP de la persona des de la qual es va avaluar el requisit per última vegada. Pot diferir d'`ip_address` quan la persona ha respost des d'un altre dispositiu." }, "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ó ISO 3166-2 de la IP detectada." }, "detected_city": { "type": "string", "nullable": true, "description": "Ciutat de la IP detectada." }, "declared_state": { "type": "string", "nullable": true, "description": "Subdivisió ISO 3166-2 que has declarat: `user_state`, o l'estat d'una adreça dels EUA a `expected_details`." }, "document_state": { "type": "string", "nullable": true, "description": "Subdivisió ISO 3166-2 que ha emès el document d'identitat, llegida durant la captura de l'ID." }, "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Estats dels EUA (codis USPS, per exemple `IL`) la legislació biomètrica dels quals empara la persona. `US` quan les proves situen la persona als EUA però no se'n coneix cap estat concret. Buit quan no n'aplica cap." }, "retention_months": { "type": "integer", "nullable": true, "description": "El límit de conservació biomètrica més curt, en mesos, entre `jurisdictions`. `null` quan no se n'aplica cap." }, "reason": { "type": "string", "nullable": true, "enum": [ "BIOMETRIC_CONSENT_UNSUPPORTED_SDK", "BIOMETRIC_CONSENT_DECLINED" ], "description": "`BIOMETRIC_CONSENT_UNSUPPORTED_SDK`: es requeria consentiment i un SDK natiu inferior a 4.10.0, o un que no va informar de la seva versió, ha capturat una cara sense el pas de consentiment; `status` roman en `pending`, o `given` si la persona hi ha acceptat més endavant en el flux allotjat. `BIOMETRIC_CONSENT_DECLINED`: s'ha registrat un rebuig (substitueix el motiu de l'SDK). `null` en cas contrari, i sempre `null` quan la sessió no requeria consentiment." }, "decline_reason": { "type": "string", "nullable": true, "enum": [ "BIOMETRIC_CONSENT_DECLINED" ], "description": "`BIOMETRIC_CONSENT_DECLINED` quan un rebuig registrat ha finalitzat la sessió; altrament, `null`." }, "face_data_deleted_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan el rebuig va eliminar les imatges facials, els vídeos i les plantilles facials de la sessió. `null` tret que s'hagi registrat un rebuig." } } }, "investigator": { "$ref": "#/components/schemas/InvestigatorBlock" }, "biometric_retention": { "$ref": "#/components/schemas/BiometricRetention" }, "fraud_check": { "type": "object", "nullable": true, "additionalProperties": true, "description": "El resultat d'una crida a la Fraud Check API. `null` per a qualsevol altra sessió." }, "full_session_video": { "type": "string", "format": "uri", "nullable": true, "description": "URL temporal de la gravació completa de la sessió. Només es retorna quan la teva organització grava el vídeo de la sessió completa." }, "full_session_video_recorded_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va fer la gravació de la sessió completa. Es retorna només quan la teva organització grava el vídeo de la sessió completa." } } }, "WorkflowDetail": { "type": "object", "description": "Els camps següents estan tipats; l'objecte també conté la resta de columnes de la configuració del flux de treball (commutadors de funcionalitats, llindars, accions d'advertència, documents permesos, callbacks) com a propietats addicionals. Els camps que no s'apliquen al `workflow_type` són `null`.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador per versió (`settings_uuid`). Cada versió d'un flux de treball té el seu propi identificador." }, "workflow_id": { "type": "string", "format": "uuid", "description": "Identificador estable compartit per totes les versions del flux de treball. Les sessions creades amb aquest identificador utilitzen l'última versió publicada." }, "workflow_label": { "type": "string", "description": "Nom visible del flux de treball." }, "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 de flux de treball. `null` per a fluxos de treball basats en grafs creats sense plantilla." }, "is_default": { "type": "boolean", "description": "Si aquest és el flux de treball per defecte de l'aplicació." }, "is_archived": { "type": "boolean", "description": "Els fluxos de treball arxivats no poden iniciar noves sessions." }, "version": { "type": "integer", "description": "Número de versió dins del flux de treball." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Les versions en esborrany són editables; les versions publicades són immutables i s'utilitzen per a noves sessions." }, "published_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va publicar aquesta versió. `null` per a esborranys." }, "is_simple_workflow": { "type": "boolean", "description": "`true` quan el flux de treball no té cap `workflow_graph` personalitzat." }, "is_editable": { "type": "boolean", "description": "`true` només per a versions `draft`." }, "workflow_url": { "type": "string", "format": "uri", "description": "URL pública que inicia una sessió amb aquest flux de treball." }, "workflow_graph": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Estructura del graf del flux de treball (nodes i arestes). `null` per a fluxos de treball simples." }, "features": { "type": "string", "description": "Funcionalitats habilitades unides amb `\" + \"`, per exemple `\"OCR + LIVENESS\"`." }, "total_price": { "type": "number", "nullable": true, "description": "Preu per sessió; per als fluxos de treball amb graf, el camí més car." }, "min_price": { "type": "number", "nullable": true, "description": "Preu del camí més econòmic a través del flux de treball." }, "max_price": { "type": "number", "nullable": true, "description": "Preu del camí més car a través del flux de treball." }, "special_add_on_prices": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Preus de complements específics de l'organització, o `null` si no n'hi ha cap de definit." }, "max_retry_attempts": { "type": "integer", "description": "Reintents permesos després d'una verificació rebutjada." }, "retry_window_days": { "type": "integer", "nullable": true, "description": "Dies durant els quals es permeten els reintents." }, "session_expiration_time": { "type": "integer", "description": "Segons abans que caduqui una sessió no finalitzada." }, "questionnaire": { "type": "object", "nullable": true, "additionalProperties": true, "description": "El qüestionari adjunt al flux de treball, o `null`." }, "kyb_role_settings": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Configuració de verificació per rol per a persones clau de KYB." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "signature_availability": { "type": "object", "description": "Quins nivells de signatura electrònica poden signar ara mateix. Comprova-ho abans d'establir `signature_level`. Es retorna en fluxos de treball `kyc`, `kyb` i de graf.", "properties": { "simple": { "type": "boolean", "description": "El pla Simple sempre està disponible." }, "aes": { "type": "boolean", "description": "Indica si es pot signar amb signatura avançada (AES) en aquest moment. Mentre sigui `false`, desar un nou pas amb `signature_level: \"aes\"` es rebutjarà amb `aes_not_available`." }, "qes": { "type": "boolean", "description": "Indica si es pot signar amb signatura qualificada (QES) en aquest moment. És `false` fins que es connecti un proveïdor qualificat." } } }, "is_bank_verification_enabled": { "type": "boolean", "description": "Indica si un flux de treball senzill de KYC o KYB executa la verificació bancària. S'executa després dels passos de contacte (i la verificació d'ubicació) i abans de la validació en bases de dades, l'anàlisi AML i l'anàlisi d'IP. La verificació bancària encara no està disponible de manera general: activar-la es rebutjarà allà on no estigui habilitada." }, "bank_verification_config": { "type": "object", "additionalProperties": true, "description": "Configuració de verificació bancària d'un flux de treball simple, amb les mateixes claus que accepta un node `BANK_VERIFICATION` (per exemple `bank_countries` i `bank_method_order`). Les claus desconegudes es descarten. Cada clau és opcional i una clau absent manté el seu valor per defecte, de manera que `{}` indica tots els valors per defecte. Consulta [Configuració de verificació bancària](/ca/management-api/workflows/feature-configs#verificació-bancària).", "example": {} }, "is_geolocation_enabled": { "type": "boolean", "description": "Indica si un flux de treball senzill de KYC executa la verificació d'ubicació. S'executa després dels passos de contacte i abans de la verificació bancària i la validació en bases de dades. Els fluxos de treball d'empreses (KYB) no la poden executar." }, "geolocation_config": { "type": "object", "additionalProperties": true, "description": "Configuració de verificació d'ubicació d'un flux de treball simple, amb les mateixes claus que accepta un node `GEOLOCATION` (per exemple, `is_geolocation_geofencing_enabled` i `geolocation_max_attempts`). S'ometen les claus desconegudes. Totes les claus són opcionals i una clau absent manté el seu valor per defecte, de manera que `{}` implica tots els valors per defecte.", "example": {} } }, "additionalProperties": true }, "UserSessionListItem": { "title": "KYC session row (session_kind: user)", "type": "object", "description": "Fila de resum per a una sessió de Verificació d'usuaris (KYC). Els camps d'identitat (`full_name`, `country`, `document_type`, `portrait_image`, camps de contacte) s'emplenen progressivament a mesura que l'usuari completa els passos de verificació, i són `null` fins que finalitza el pas corresponent. Els camps restringits per la configuració dels atributs de resposta del flux de treball també es retornen com a `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 únic de la sessió de verificació. Utilitza'l amb `GET /v3/session/{sessionId}/decision/` per obtenir el payload complet de la decisió.", "example": "5b3720ed-d429-42ef-b67f-37ea805f48ee" }, "session_kind": { "type": "string", "enum": [ "user" ], "description": "Discriminador de fila. Sempre `\"user\"` per a files de KYC; les files de Verificació d'empreses (KYB) tenen `\"business\"` i una estructura diferent.", "example": "user" }, "session_number": { "type": "integer", "description": "Número seqüencial fàcil de llegir de la sessió dins de la teva aplicació. També coincideix amb el paràmetre `search`.", "example": 720 }, "session_url": { "type": "string", "nullable": true, "description": "URL de verificació allotjada que l'usuari final obre per completar el flux. `null` quan la sessió no té cap URL allotjada.", "example": "https://verify.didit.me/session/CuXoBYCYVO5Y" }, "portrait_image": { "type": "string", "nullable": true, "description": "URL temporal (presignada) del millor retrat disponible: la foto del xip NFC si està disponible; en cas contrari, el retrat del document d'identitat; si no, la imatge de referència de la prova de vida. `null` fins que n'existeixi alguna. Descarrega-la de seguida; l'enllaç caduca.", "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": "Tipus de document d'identitat verificat llegible per a humans. `null` abans que es completi la verificació del document, i també `null` després de completar-se quan el codi verificat no té correspondència de visualització (`SSC`, `WP`, `VISA`, `PSC`, `BC`, `OTHER`). Nota: el paràmetre de consulta `document_type` filtra per codis curts (`P`, `ID`, `DL`, `RP`, ...), no per aquests valors de visualització.", "example": "Passport" }, "full_name": { "type": "string", "nullable": true, "description": "Millor nom complet disponible per a la sessió, resolt per ordre: OCR del document d'identitat, dades sotmeses a cribratge AML, dades sotmeses a validació en bases de dades, comprovant de domicili, i després els detalls esperats proporcionats durant la creació de la sessió. `null` quan encara no n'hi ha cap de disponible.", "example": "Jane Marie Doe" }, "country": { "type": "string", "nullable": true, "description": "País ISO 3166-1 alpha-3 associat a la sessió, resolt per aquest ordre: estat emissor del document d'identitat, estat emissor de la validació en bases de dades, estat emissor del comprovant de domicili, dades esperades i, finalment, país del telèfon verificat. Pot ser diferent de la nacionalitat.", "example": "ESP" }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Estat global de la sessió. Consulta la pàgina [Estats de verificació](/ca/integration/verification-statuses) per al cicle de vida.", "example": "Approved" }, "vendor_data": { "type": "string", "nullable": true, "description": "El teu propi identificador per a l'usuari final, retornat exactament com es va enviar en crear la sessió.", "example": "your-user-id-123" }, "didit_internal_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Identificador intern de Didit per al perfil d'usuari verificat darrere d'aquesta sessió. Estable al llarg de múltiples sessions del mateix usuari; es pot filtrar mitjançant el paràmetre de consulta `didit_internal_id`.", "example": "d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147" }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de temps UTC en què es va crear la sessió.", "example": "2026-06-09T12:26:54.328364Z" }, "features": { "type": "array", "description": "Estat de cada funcionalitat per a cada pas de verificació configurat al flux de treball de la sessió, en l'ordre del flux de treball.", "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 funcionalitat de verificació.", "example": "ID_VERIFICATION" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estat d'aquesta funcionalitat. `Not Finished` fins que es completi el pas.", "example": "Approved" } } } }, "phone_number": { "type": "object", "nullable": true, "description": "Telèfon associat a la sessió: el telèfon verificat quan s'ha executat la verificació de telèfon, o altrament el telèfon de contacte proporcionat durant la creació de la sessió. `null` quan no existeix cap dels dos.", "required": [ "number", "is_verified" ], "properties": { "number": { "type": "string", "description": "Número de telèfon en format E.164.", "example": "+14155552671" }, "is_verified": { "type": "boolean", "description": "`true` només quan la funcionalitat de verificació de telèfon ha aprovat aquest número.", "example": true } } }, "email_address": { "type": "object", "nullable": true, "description": "Correu electrònic associat a la sessió: el correu electrònic verificat si s'ha executat la verificació de correu electrònic; en cas contrari, el correu electrònic de contacte proporcionat en crear la sessió. `null` quan no existeix cap dels dos.", "required": [ "email", "is_verified" ], "properties": { "email": { "type": "string", "format": "email", "example": "jane@example.com" }, "is_verified": { "type": "boolean", "description": "`true` només quan la funcionalitat de verificació de correu electrònic ha aprovat aquesta adreça.", "example": true } } }, "additional_details": { "type": "object", "nullable": true, "description": "Dades addicionals compactes per funcionalitat. Com a claus només apareixen les funcionalitats que han generat dades; `null` quan cap funcionalitat no ha generat dades addicionals. Els camps exclosos per la configuració d'atributs de resposta del flux de treball s'ometen.", "properties": { "aml": { "type": "object", "description": "Present quan s'ha executat el cribratge AML.", "properties": { "total_hits": { "type": "integer", "description": "Nombre de coincidències del cribratge AML.", "example": 0 }, "entity_type": { "type": "string", "description": "Tipus d'entitat sotmesa a cribratge.", "example": "person" }, "is_adverse_media_fetched": { "type": "boolean", "example": false }, "screened_data": { "type": "object", "description": "Subconjunt de les dades sotmeses a cribratge. Només s'inclouen les claus no buides.", "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": "Present quan s'ha executat la validació en bases de dades.", "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 document que s'ha validat (el primer disponible).", "example": "12345678Z" } } }, "poa": { "type": "object", "description": "Present quan s'ha dut a terme la verificació del comprovant de domicili.", "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": "Present quan s'ha executat una comprovació de prova de vida.", "properties": { "method": { "type": "string", "example": "PASSIVE" }, "score": { "type": "number", "description": "Puntuació de confiança de la prova de vida, arrodonida a 2 decimals.", "example": 0.98 } } }, "face_match": { "type": "object", "description": "Present quan s'ha executat la coincidència facial.", "properties": { "score": { "type": "number", "description": "Puntuació de similitud de la coincidència facial, arrodonida a 2 decimals.", "example": 0.95 }, "source_image": { "type": "string", "description": "URL temporal (presignada) de la imatge facial d'origen.", "example": "https:///faces/source.jpg?X-Amz-Expires=3600&..." }, "target_image": { "type": "string", "description": "URL temporal (presignada) de la imatge facial de destinació.", "example": "https:///faces/target.jpg?X-Amz-Expires=3600&..." } } }, "phone_verification": { "type": "object", "description": "Present quan s'ha executat la verificació de telèfon.", "properties": { "country_code": { "type": "string", "description": "País ISO 3166-1 alpha-2 del número de telèfon.", "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": "Present quan s'ha executat la verificació de correu electrònic.", "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 a qui s'ha assignat la sessió, o `null` quan ningú la té assignada.", "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": "Quan la sessió va començar a esperar la revisió. `null` tret que la sessió estigui `In Review`." }, "sla_due_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data límit de la revisió, a partir del termini de revisió establert per a la teva aplicació a la consola. `null` tret que la sessió estigui `In Review` i s'hagi establert un termini." }, "top_warnings": { "type": "array", "description": "Fins a algunes de les advertències més importants de la sessió, per a una visualització ràpida de triatge. La llista completa es troba a la decisió.", "items": { "type": "object", "properties": { "risk": { "type": "string", "description": "Codi d'advertència, per exemple `FACE_MATCH_LOW_SIMILARITY`." }, "feature": { "type": "string", "description": "La funcionalitat que l'ha generada." }, "log_type": { "type": "string", "nullable": true, "description": "`error` o `warning`; `null` per a una entrada antiga." }, "short_description": { "type": "string" } } } }, "warnings_count": { "type": "integer", "description": "Nombre d'advertències a la sessió." } } }, "BusinessSessionListItem": { "title": "KYB session row (session_kind: business)", "type": "object", "description": "Fila de resum per a una sessió de Verificació d'empreses (KYB). Només es retorna quan `session_kind` és `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 únic de la sessió de verificació d'empreses.", "example": "8a1f63c2-1b9e-4f3a-9c41-2f6a1f0b7d52" }, "session_kind": { "type": "string", "enum": [ "business" ], "description": "Discriminador de fila. Sempre `\"business\"` per a files de KYB.", "example": "business" }, "session_number": { "type": "integer", "description": "Número seqüencial fàcil de llegir de la sessió d'empresa dins de la teva aplicació. Numerat independentment de les sessions de KYC.", "example": 42 }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Estat global de la sessió. Consulta la pàgina [Estats de verificació](/ca/integration/verification-statuses).", "example": "Approved" }, "vendor_data": { "type": "string", "nullable": true, "description": "El teu propi identificador per a l'empresa, retornat exactament com es va enviar en crear la sessió.", "example": "your-company-id-77" }, "created_at": { "type": "string", "format": "date-time", "description": "Marca de temps UTC en què es va crear la sessió.", "example": "2026-06-08T09:14:02.118450Z" }, "workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Identificador del flux de treball amb el qual s'ha creat aquesta sessió.", "example": "9f9b1234-aaaa-bbbb-cccc-1234567890ab" }, "workflow_type": { "type": "string", "nullable": true, "description": "Tipus de flux de treball. `kyb` per a fluxos de treball d'empreses.", "example": "kyb" }, "workflow_label": { "type": "string", "nullable": true, "description": "Nom visible del flux de treball.", "example": "Standard KYB" }, "company_name": { "type": "string", "nullable": true, "description": "Nom de l'empresa que s'està verificant, procedent de l'empresa del registre vinculada a la sessió. `null` fins que se seleccioni una empresa.", "example": "Acme Holdings S.L." }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registre de l'empresa procedent de l'empresa del registre vinculada a la sessió.", "example": "B12345678" }, "country": { "type": "string", "nullable": true, "description": "Codi de país de l'empresa del registre vinculada a la sessió.", "example": "ES" } } }, "TransactionVerificationSessionAction": { "title": "Verification session", "type": "object", "properties": { "type": { "type": "string", "enum": [ "verification_session" ] }, "url": { "type": "string", "format": "uri", "description": "URL de verificació allotjada per obrir per a l'usuari final." }, "session_id": { "type": "string", "format": "uuid", "description": "ID de la sessió de verificació." }, "session_token": { "type": "string", "description": "Token de sessió, utilitzat pels SDK mòbils per iniciar el flux de manera nativa." }, "status": { "type": "string", "description": "Estat de la sessió de verificació." } }, "required": [ "type", "url" ] }, "TransactionWalletOwnershipAction": { "title": "Wallet ownership", "type": "object", "properties": { "type": { "type": "string", "enum": [ "wallet_ownership" ] }, "url": { "type": "string", "format": "uri", "description": "URL del giny allotjat de titularitat de la cartera. Obre'l en un navegador real; al mòbil fes servir SFSafariViewController o una pestanya personalitzada de Chrome, mai una webview incrustada." }, "widget_session_id": { "type": "string", "format": "uuid", "description": "ID de sessió del widget de titularitat de la cartera." }, "expires_at": { "type": "string", "format": "date-time", "description": "Quan caduca la sessió del widget." } }, "required": [ "type", "url" ] }, "TransactionRuleActionAddScore": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "add_score" ] }, "value": { "type": "integer", "description": "Punts afegits a la puntuació de risc de la transacció. Poden ser negatius." } }, "description": "Afegeix punts a la puntuació de risc acumulada de la transacció; el total decideix l'estat mitjançant els llindars de revisió/rebuig de l'aplicació." }, "TransactionRuleActionChangeStatus": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "change_status" ] }, "value": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Estat a establir immediatament, independentment de la puntuació. Clau d'àlies: status." }, "workflow_id": { "type": "string", "format": "uuid", "description": "OBLIGATORI quan el valor és AWAITING_USER: el flux de treball de verificació que el subjecte ha de completar. Clau d'àlies: remediation_workflow_id. Didit crea una sessió de resolució allotjada per al subjecte quan s'activa la regla." } }, "description": "Estableix directament l'estat de la transacció. DECLINED sempre preval entre les regles coincidents." }, "TransactionRuleActionAddTags": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "add_tags" ] }, "tag_uuid": { "type": "string", "format": "uuid", "description": "Etiqueta d'aplicació existent per adjuntar." }, "tag_name": { "type": "string", "description": "Nom de l'etiqueta per adjuntar; es crea amb el primer ús (s'emmagatzema en majúscules). Proporciona tag_uuid o tag_name." }, "tag_color": { "type": "string", "description": "Color hexadecimal utilitzat quan tag_name crea una etiqueta nova, p. ex. #007AFE." } }, "description": "Adjunta una etiqueta d'aplicació a la transacció coincident." }, "TransactionRuleActionAddNote": { "type": "object", "required": [ "type", "note" ], "properties": { "type": { "type": "string", "enum": [ "add_note" ] }, "note": { "type": "string", "description": "Text de la nota adjunt a la transacció (autor: Rule Engine). Clau d'àlies: valor." } }, "description": "Adjunta una nota d'analista automatitzada a la transacció coincident." }, "TransactionRuleActionAddToList": { "type": "object", "required": [ "type", "list_id" ], "properties": { "type": { "type": "string", "enum": [ "add_to_list" ] }, "list_id": { "type": "string", "format": "uuid", "description": "Llista a la qual s'ha d'afegir el vendor_data del subjecte." } }, "description": "Afegeix el vendor_data del subjecte a una llista de bloqueig, llista d'admesos o llista personalitzada." }, "TransactionRuleActionOpenCase": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "open_case" ] }, "blueprint": { "type": "string", "format": "uuid", "description": "UUID del blueprint del cas; per defecte s'utilitza el blueprint per defecte de l'aplicació." }, "grouping": { "type": "string", "enum": [ "by_applicant", "by_rule_and_applicant" ], "description": "Indica si les coincidències repetides s'associen a un únic cas per sol·licitant o a un per regla+sol·licitant." }, "attach_matched_transaction": { "type": "boolean", "description": "Adjunta la transacció coincident al cas." } }, "description": "Obre (o afegeix a) un cas d'investigació. Només s'aplica la primera acció open_case d'una regla." }, "KYBRegistrySearchResults": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "kyb_response_id": { "type": "string", "nullable": true, "description": "Identificador d'aquest candidat; passa'l a `POST /v3/kyb/select/` per obtenir el perfil complet. És efímer i està limitat a aquesta cerca: no l'emmagatzemis a llarg termini; torna a cercar per obtenir-ne un de nou.", "example": "69aeeb95febb0f1704042259" }, "name": { "type": "string", "nullable": true, "description": "Nom de l'empresa registrada.", "example": "Tesco PLC" }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registre del registre mercantil.", "example": "00445790" }, "status": { "type": "string", "nullable": true, "description": "Estat registral normalitzat de l'empresa (p. ex. `active`, `dissolved`, `inactive`, `struck off`).", "example": "active" }, "type": { "type": "string", "nullable": true, "description": "Forma jurídica segons el que indica el registre.", "example": "Public Limited Company" }, "registered_address": { "type": "string", "nullable": true, "description": "Adreça registrada del candidat, quan el registre en retorna una. Utilitza-la, juntament amb el número de registre, per distingir empreses amb el mateix nom: als Estats Units un candidat pot figurar sota l'estat on opera l'empresa en lloc de l'estat que has cercat.", "example": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, AL7 1GA" }, "risk_level": { "type": "string", "nullable": true, "description": "Nivell de risc notificat pel registre, quan estigui disponible. Normalment `null` en el moment de la cerca." }, "fetch_status": { "type": "string", "nullable": true, "description": "Sempre `pending` per als candidats de cerca; el perfil complet de l'empresa només s'obté (i es factura) quan selecciones el candidat.", "example": "pending" } } }, "description": "Llista de candidats deduplicada. Buida mentre `search_resolved=false` (mode webhook) o quan no hi ha hagut cap coincidència." }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "description": "Nombre de candidats retornats." }, "page": { "type": "integer" }, "per_page": { "type": "integer", "example": 25 } } }, "search_status": { "type": "string", "nullable": true, "enum": [ "pending", "resolved" ], "description": "Estat del cicle de vida de la cerca al registre." }, "search_resolved": { "type": "boolean", "description": "`true` un cop la llista de candidats és definitiva." } } }, "KYBRegistryCandidateRequest": { "type": "object", "required": [ "kyb_response_id" ], "properties": { "kyb_response_id": { "type": "string", "maxLength": 1024, "description": "Identificador de candidat de `POST /v3/kyb/search/` (`kyb_registry.companies[].kyb_response_id`). Efímer: fes-lo servir poc després de la cerca que l'ha generat. Els identificadors poden ser llargs, de manera que has d'emmagatzemar i enviar el valor exactament com s'ha retornat, sense retallar-lo ni assumir-ne una longitud.", "example": "69aeeb95febb0f1704042259" }, "vendor_data": { "type": "string", "description": "El teu identificador per a aquesta empresa; es retorna tal com s'ha enviat i s'emmagatzema amb la sessió de l'empresa." }, "metadata": { "type": "object", "nullable": true, "description": "JSON de format lliure emmagatzemat amb la sessió d'empresa i retornat com a resposta." }, "save_api_request": { "type": "boolean", "default": true, "description": "Ha de ser `true` (per defecte). Les seleccions de registres KYB sempre es guarden perquè se'n pugui fer el seguiment de la facturació i la recuperació; `false` retorna `400`." } } }, "WebhookEventEnvelope": { "type": "object", "description": "Camps que Didit afegeix a cada lliurament de webhook signat, sigui quin sigui el tipus d'esdeveniment. Llegeix `webhook_type` per saber quin payload has rebut.", "required": [ "event_id", "webhook_type", "timestamp", "created_at", "application_id", "environment" ], "properties": { "event_id": { "type": "string", "format": "uuid", "description": "Identificador de l'esdeveniment. Cada destinació rep el mateix valor i un relliurament el manté, per la qual cosa utilitza'l per deduplicar." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "timestamp": { "type": "integer", "description": "Temps Unix en segons en què es va signar aquest lliurament. Igual a la capçalera `X-Timestamp`; un relliurament porta un valor nou." }, "created_at": { "type": "integer", "description": "Temps Unix en segons del canvi que va produir l'esdeveniment." }, "application_id": { "type": "string", "format": "uuid", "description": "L'aplicació a la qual pertany l'esdeveniment." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "`sandbox` per a sessions de sandbox i aplicacions de sandbox; en cas contrari, `live`." } } }, "SessionWebhookEventData": { "type": "object", "description": "Camps de sessió de `status.updated` i `data.updated`. Els camps opcionals s'ometen, mai s'envien com a `null`, quan no s'apliquen. Les sessions d'empresa (KYB) afegeixen `business_session_id`, `session_kind` i `vendor_business_id`.", "required": [ "session_id", "status", "sandbox_scenario" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "La sessió de verificació." }, "business_session_id": { "type": "string", "format": "uuid", "description": "Només sessions d'empresa (KYB): el mateix valor que `session_id`." }, "session_kind": { "type": "string", "enum": [ "business" ], "description": "Només sessions d'empresa (KYB). Els esdeveniments de sessió d'usuari (KYC) no inclouen `session_kind` al nivell superior; consulta `decision.session_kind` en el seu lloc." }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Estat de la sessió després del canvi." }, "trigger": { "type": "string", "description": "Present quan l'esdeveniment no l'ha generat el flux de verificació mateix, per exemple `manual_review`, `manual_step_update`, `ongoing_monitoring`, `webhook_reconciliation` (un `status.updated` reenviat perquè el primer webhook terminal no es va crear mai, de manera que pots rebre un segon esdeveniment per a una decisió que ja tenies: deduplica per `session_id` i `status`), `manual_webhook_recovery`, `kyb_registry_change`, `biometric_retention` (un `data.updated` enviat quan les dades biomètriques en viu de la sessió s'eliminen segons el calendari) o una edició `console_*` com ara `console_registry_edit`, `console_key_people_skip` o `console_key_people_regenerate`." }, "workflow_id": { "type": "string", "format": "uuid", "description": "El flux de treball de la sessió. S'omet quan la sessió no en té cap." }, "workflow_version": { "type": "integer", "description": "Versió del flux de treball en què s'ha executat la sessió. S'envia juntament amb `workflow_id`." }, "vendor_data": { "type": "string", "description": "El teu `vendor_data` per a la sessió. S'omet quan està buit." }, "vendor_business_id": { "type": "string", "description": "Només sessions d'empresa (KYB): l'empresa a la qual pertany la sessió. S'omet quan no n'hi ha cap." }, "metadata": { "type": "object", "additionalProperties": true, "description": "Les `metadata` de la teva sessió. S'ometen quan estan buides." }, "decision": { "$ref": "#/components/schemas/SessionDecision" }, "resubmit_info": { "type": "object", "description": "Només quan `status` és `Resubmitted`: els passos que l'usuari ha de refer i el motiu.", "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 node tal com apareix a la definició del flux de treball de la sessió (per exemple `feature_ocr`, `feature_liveness`).", "example": "feature_poa" }, "feature": { "type": "string", "description": "Tipus de funcionalitat del node, per exemple `OCR`, `LIVENESS` o `PROOF_OF_ADDRESS`.", "example": "PROOF_OF_ADDRESS" } } }, "description": "Passos del flux de treball que l'usuari ha de refer. Les mateixes entrades `{node_id, feature}` que `nodes_to_resubmit` a [Actualitzar estat](#patch-/v3/session/-sessionId-/update-status/)." }, "reasons": { "type": "object", "additionalProperties": true, "description": "Motiu per `node_id` a `nodes_to_resubmit`." } } }, "sandbox_scenario": { "type": "string", "nullable": true, "description": "El resultat simulat preparat en una sessió de sandbox, o bé `null`. Sempre és `null` per a sessions de producció." } } }, "SessionStatusUpdatedEvent": { "description": "Una sessió de verificació ha canviat d'estat. `decision` només s'envia per a `Approved`, `Declined`, `In Review` i `Abandoned`; té l'estructura de `GET /v3/session/{sessionId}/decision/` per a destinacions a la versió 3 del webhook (per defecte), i l'estructura reduïda anterior per a destinacions de la versió 1 o 2. Les sessions d'empresa sempre reben la decisió d'empresa de la versió 3.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "$ref": "#/components/schemas/SessionWebhookEventData" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "status.updated" ], "description": "Sempre `status.updated`." } }, "required": [ "webhook_type" ] } ] }, "SessionDataUpdatedEvent": { "description": "Les dades d'una sessió de verificació han canviat sense un canvi d'estat, per exemple després d'una edició de revisió manual, una sobreescriptura de pas o un nou cribratge de monitoratge continu. `decision` només s'envia per a `Approved`, `Declined`, `In Review` i `Abandoned`; té l'estructura de `GET /v3/session/{sessionId}/decision/` per a destinacions a la versió 3 del webhook (per defecte), i l'estructura reduïda anterior per a destinacions de versió 1 o 2. Les sessions d'empresa sempre reben la decisió d'empresa de la versió 3.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "$ref": "#/components/schemas/SessionWebhookEventData" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "data.updated" ], "description": "Sempre `data.updated`." } }, "required": [ "webhook_type" ] } ] }, "UserStatusUpdatedEvent": { "description": "Un usuari ha canviat d'estat. No s'envia quan es crea l'usuari.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "user.status.updated" ], "description": "Sempre `user.status.updated`." }, "vendor_user_id": { "type": "string", "format": "uuid", "description": "L'usuari sobre el qual tracta l'esdeveniment." }, "vendor_data": { "type": "string", "nullable": true, "description": "El teu `vendor_data` per a l'usuari, o `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Estat de l'usuari després del canvi." }, "previous_status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Estat abans del canvi." } }, "required": [ "webhook_type", "vendor_user_id", "vendor_data", "status", "previous_status" ] } ] }, "UserDataUpdatedEvent": { "description": "Camps d'un usuari modificats. No s'envia quan es crea l'usuari. Una sola acció de desar pot produir alhora un esdeveniment d'estat i un de dades.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "user.data.updated" ], "description": "Sempre `user.data.updated`." }, "vendor_user_id": { "type": "string", "format": "uuid", "description": "L'usuari sobre el qual tracta l'esdeveniment." }, "vendor_data": { "type": "string", "nullable": true, "description": "El teu `vendor_data` per a l'usuari, o `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Estat de l'usuari després del canvi." }, "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": "Noms dels camps que han canviat." }, "changes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "previous": { "nullable": true, "description": "Valor abans del canvi. Les dates són cadenes ISO 8601." }, "current": { "nullable": true, "description": "Valor després del canvi. Les dates són cadenes ISO 8601." } } }, "description": "Valor anterior i actual de cada camp modificat, indexat pel nom del camp. Els valors poden ser dades personals (noms, dates de naixement, enllaços de retrat, correus electrònics, números de telèfon); tracta'ls en conseqüència." } }, "required": [ "webhook_type", "vendor_user_id", "vendor_data", "status", "changed_fields", "changes" ] } ] }, "BusinessStatusUpdatedEvent": { "description": "Una empresa ha canviat d'estat. No s'envia quan es crea l'empresa.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "business.status.updated" ], "description": "Sempre `business.status.updated`." }, "vendor_business_id": { "type": "string", "format": "uuid", "description": "L'empresa sobre la qual tracta l'esdeveniment." }, "vendor_data": { "type": "string", "nullable": true, "description": "El teu `vendor_data` per a l'empresa, o `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Estat de l'empresa després del canvi." }, "previous_status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Estat abans del canvi." } }, "required": [ "webhook_type", "vendor_business_id", "vendor_data", "status", "previous_status" ] } ] }, "BusinessDataUpdatedEvent": { "description": "Camps d'una empresa modificats. No s'envia quan es crea l'empresa. Una única operació de desament pot produir alhora un esdeveniment d'estat i un de dades.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "business.data.updated" ], "description": "Sempre `business.data.updated`." }, "vendor_business_id": { "type": "string", "format": "uuid", "description": "L'empresa sobre la qual tracta l'esdeveniment." }, "vendor_data": { "type": "string", "nullable": true, "description": "El teu `vendor_data` per a l'empresa, o `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Estat de l'empresa després del canvi." }, "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": "Noms dels camps que han canviat." }, "changes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "previous": { "nullable": true, "description": "Valor abans del canvi. Les dates són cadenes ISO 8601." }, "current": { "nullable": true, "description": "Valor després del canvi. Les dates són cadenes ISO 8601." } } }, "description": "Valor anterior i actual de cada camp modificat, indexat pel nom del camp." } }, "required": [ "webhook_type", "vendor_business_id", "vendor_data", "status", "changed_fields", "changes" ] } ] }, "TransactionCreatedEvent": { "description": "S'ha creat una transacció i s'ha sotmès a cribratge. S'envia només per a aplicacions de producció.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "transaction.created" ], "description": "Sempre `transaction.created`." }, "transaction_id": { "type": "string", "format": "uuid", "description": "Identificador de Didit de la transacció." }, "txn_id": { "type": "string", "nullable": true, "description": "El `transaction_id` que has proporcionat en el moment de la creació, o `null`." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Estat del monitoratge després del canvi." }, "score": { "type": "integer", "description": "Puntuació de risc acumulada per les regles." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Gravetat del risc, o `null` fins que una regla o un proveïdor l'estableixi." }, "amount": { "type": "string", "description": "Import de la transacció com a cadena decimal. A diferència de l'API, no està normalitzat, de manera que pot contenir zeros finals (fins a 18 decimals)." }, "currency": { "type": "string", "description": "Codi de moneda o símbol d'actiu cripto de `amount`." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Direcció relativa al subjecte." }, "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ó pendent de l'usuari final, o `null`. Mateix objecte que `action_required` a la transacció; `session_token` és una credencial, així que mai la registris." } }, "required": [ "webhook_type", "transaction_id", "txn_id", "status", "score", "severity", "amount", "currency", "direction", "action_required" ] } ] }, "TransactionStatusUpdatedEvent": { "description": "Una transacció ha canviat d'estat, a partir d'una regla, una revisió o una acció de l'usuari final. S'envia només per a aplicacions de producció.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "transaction.status.updated" ], "description": "Sempre `transaction.status.updated`." }, "transaction_id": { "type": "string", "format": "uuid", "description": "Identificador de Didit de la transacció." }, "txn_id": { "type": "string", "nullable": true, "description": "El `transaction_id` que has proporcionat en el moment de la creació, o `null`." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Estat del monitoratge després del canvi." }, "score": { "type": "integer", "description": "Puntuació de risc acumulada per les regles." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Gravetat del risc, o `null` fins que una regla o un proveïdor l'estableixi." }, "amount": { "type": "string", "description": "Import de la transacció com a cadena decimal. A diferència de l'API, no està normalitzat, de manera que pot contenir zeros finals (fins a 18 decimals)." }, "currency": { "type": "string", "description": "Codi de moneda o símbol d'actiu cripto de `amount`." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Direcció relativa al subjecte." }, "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ó pendent de l'usuari final, o `null`. Mateix objecte que `action_required` a la transacció; `session_token` és una credencial, així que mai la registris." } }, "required": [ "webhook_type", "transaction_id", "txn_id", "status", "score", "severity", "amount", "currency", "direction", "action_required" ] } ] }, "TravelRuleStatusUpdatedEvent": { "description": "Un intercanvi de Travel Rule ha canviat d'estat. S'envia en cada transició fins a `FINISHED`, `CANCELLED` o `EXPIRED` (inclosos), mai després. S'envia per a aplicacions de producció i, en el cas d'intercanvis de Travel Rule, també per a aplicacions de sandbox (`environment: sandbox`). No hi ha cap `status` de nivell superior.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "travel_rule.status.updated" ], "description": "Sempre `travel_rule.status.updated`." }, "transaction_id": { "type": "string", "format": "uuid", "description": "La transacció a la qual pertany l'intercanvi." }, "txn_id": { "type": "string", "nullable": true, "description": "El `transaction_id` que has proporcionat en el moment de la creació, 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": "Estat de l'intercanvi després del canvi." }, "rail": { "type": "string", "enum": [ "", "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL", "TEST_VASP" ], "description": "Xarxa en què s'executa l'intercanvi, o una cadena buida quan no se n'ha pogut resoldre cap. `TEST_VASP` és una transferència de sandbox que ha respost el Didit Test VASP." }, "test_vasp": { "type": "boolean", "description": "Present i `true` només en una transferència de sandbox que el Didit Test VASP ha respost." }, "test_vasp_scenario": { "type": "string", "description": "Present només amb `test_vasp`: l'escenari de sandbox que ha determinat el resultat, o una cadena buida." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Direcció de la transferència." } }, "required": [ "webhook_type", "transaction_id", "txn_id", "travel_rule_status", "rail", "direction" ] } ] }, "WorkflowComplianceChangedEvent": { "description": "L'estat de compliment d'un flux de treball publicat ha canviat després d'una reavaluació. Un esdeveniment per flux de treball. No hi ha cap `status` de nivell superior.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "workflow.compliance_changed" ], "description": "Sempre `workflow.compliance_changed`." }, "workflow_id": { "type": "string", "format": "uuid", "description": "El flux de treball que ha canviat." }, "workflow_version": { "type": "integer", "description": "Versió que s'ha avaluat." }, "workflow_label": { "type": "string", "nullable": true, "description": "Nom visible del flux de treball." }, "transition": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "type": "string", "enum": [ "compliant", "gaps_detected", "pending_change", "unknown_coverage", "not_evaluated" ], "description": "Estat abans de la reavaluació." }, "to": { "type": "string", "enum": [ "compliant", "gaps_detected", "pending_change", "unknown_coverage", "not_evaluated" ], "description": "Estat després de la reavaluació." } } }, "severity": { "type": "string", "enum": [ "actionable", "indicative", "informative" ], "description": "`actionable` quan s'han detectat mancances, `indicative` per a un canvi pendent, `informative` quan s'han resolt les mancances." }, "kb_version": { "type": "string", "description": "Versió de la base de coneixement normatiu utilitzada." } }, "required": [ "webhook_type", "workflow_id", "workflow_version", "workflow_label", "transition", "severity", "kb_version" ] } ] }, "WebhookEventPayload": { "description": "Cos d'un lliurament de webhook signat, discriminat per `webhook_type`. Es pot subscriure a `activity.created`, però avui dia no s'envia. Tracta qualsevol altre `webhook_type` com un nou tipus d'esdeveniment i conserva el cos en brut.", "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": "Cos del callback enviat a la `webhook_url` de `POST /v3/kyb/search/` un cop es resol la cerca al registre. No està signat: la sol·licitud inclou `X-Didit-Unsigned-Callback: true` i cap de les capçaleres de signatura, per la qual cosa cal confirmar-lo fent coincidir `request_id` amb una cerca que hagis iniciat. Utilitza `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": "Sempre `kyb.registry_search.resolved`." }, "request_id": { "type": "string", "format": "uuid", "description": "El `request_id` retornat per `POST /v3/kyb/search/`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ressò del `vendor_data` que has enviat." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ressò de les `metadata` que has enviat." }, "search_status": { "type": "string", "description": "Sempre `resolved` actualment." }, "search_resolved": { "type": "boolean", "description": "`true` quan `search_status` és `resolved`." }, "kyb_registry": { "$ref": "#/components/schemas/KYBRegistrySearchResults" }, "timestamp": { "type": "integer", "description": "Temps Unix en segons en què el callback es va posar a la cua." }, "created_at": { "type": "integer", "description": "Temps Unix en segons en què el callback es va posar a la cua." } } }, "AMLScreening": { "type": "object", "properties": { "node_id": { "type": "string", "description": "Identificador únic per a aquest pas d'AML al graf del flux de treball." }, "status": { "type": "string", "description": "Estat a nivell de funcionalitat d'aquest cribratge AML. Independent de l'`status` de la sessió de nivell superior: una sessió pot assolir la seva decisió global mentre una funcionalitat individual roman `In Review`.", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ] }, "total_hits": { "type": "integer", "description": "Nombre total de coincidències trobades" }, "entity_type": { "type": "string", "description": "Tipus d'entitat cribrada: persona o empresa" }, "hits": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador estable de Didit per a la coincidència: `hit_` seguit de 24 caràcters hexadecimals. La mateixa entitat coincident manté el mateix `id` quan se sotmet el subjecte a un nou cribratge. Transmet-lo com a `hit_id` als endpoints de revisió de coincidències d'AML." }, "url": { "type": "string", "format": "uri", "description": "URL d'origen de la coincidència" }, "match": { "type": "boolean", "description": "Si es tracta d'una coincidència confirmada" }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 1, "description": "Puntuació de coincidència ponderada obsoleta en el rang 0-1 (p. ex. `0.73`). Fes servir `match_score` (0-100) en el seu lloc.", "deprecated": true }, "target": { "type": "boolean", "nullable": true, "description": "Indica si l'entitat coincident és l'objectiu directe de la llista (en contraposició a una part relacionada). `null` quan la font no ho especifica." }, "caption": { "type": "string", "description": "Peu o títol de la coincidència" }, "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": "Llista de categories de conjunts de dades on s'ha trobat la coincidència. Indica si l'entitat ha aparegut en llistes de PEP (amb nivell), bases de dades de sancions, mitjans adversos, advertències/mesures reguladores o altres conjunts de dades de compliment. `Other Lists` quan la font de l'entitat no indica cap d'aquestes categories." }, "features": { "type": "object", "nullable": true, "description": "Característiques addicionals de la coincidència" }, "rca_name": { "type": "string", "description": "Nom de la RCA si escau" }, "last_seen": { "type": "string", "format": "date-time", "description": "Data en què es va detectar la coincidència per darrera vegada" }, "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": "Data en què es va detectar la coincidència per primera vegada" }, "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ó de confiança de la identitat ponderada (0-100) calculada a partir de la similitud del nom, la data de naixement i la coincidència de país. S'utilitza per determinar si una coincidència és un fals positiu o una possible coincidència.", "format": "float", "nullable": true }, "risk_score": { "type": "number", "description": "Puntuació de risc de l'entitat (0-100). S'utilitza per determinar l'estat AML final (Aprovada/En revisió/Rebutjada) segons el risk_score més alt entre les coincidències que no siguin falsos positius." }, "review_status": { "type": "string", "description": "Estat de revisió d'aquesta coincidència. Pot ser 'Unreviewed', 'Confirmed Match', 'False Positive' o 'Inconclusive'.", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ] }, "score_breakdown": { "type": "object", "description": "Desglossament detallat de com s'ha calculat el match_score.", "properties": { "name_score": { "type": "integer", "description": "Percentatge de similitud del nom en brut (0-100)." }, "name_weight": { "type": "integer", "description": "Pes original per al nom des de la configuració (0-100)." }, "name_weight_normalized": { "type": "number", "description": "Pes normalitzat per al nom després de reponderar per dades que manquen (0-100)." }, "name_contribution": { "type": "number", "description": "Punts aportats pel nom a la puntuació total." }, "dob_score": { "type": "integer", "description": "Puntuació de coincidència de data de naixement (-100 a 100)." }, "dob_weight": { "type": "integer", "description": "Pes original per a la data de naixement des de la configuració (0-100)." }, "dob_weight_normalized": { "type": "number", "description": "Pes normalitzat per a la data de naixement després de reponderar per dades que manquen (0-100)." }, "dob_contribution": { "type": "number", "description": "Punts aportats per la data de naixement a la puntuació total." }, "country_score": { "type": "integer", "description": "Puntuació de coincidència de país (-100 a 100)." }, "country_weight": { "type": "integer", "description": "Pes original per al país des de la configuració (0-100)." }, "country_weight_normalized": { "type": "number", "description": "Pes normalitzat per al país després de reponderar per dades que manquen (0-100)." }, "country_contribution": { "type": "number", "description": "Punts aportats pel país a la puntuació total." }, "document_number_match_type": { "type": "string", "description": "Resultat de l'avaluació de «Golden Key» del número de document.", "enum": [ "MATCH", "NEUTRAL", "HARD_MISMATCH" ] }, "document_number_effect": { "type": "string", "description": "Descripció fàcil de llegir de l'efecte del número de document sobre la puntuació." }, "total_score": { "type": "integer", "description": "Puntuació de coincidència 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": "Llista de coincidències d'advertències i mesures reguladores. Inclou entrades de les categories: Warning, SIP, Warnings and Regulatory Enforcement, Fitness and Probity, SIE i Insolvency.", "items": { "type": "object", "properties": { "list_name": { "type": "string", "description": "Nom de l'editor de la llista d'advertències" }, "matched_name": { "type": "string", "description": "Nom que ha coincidit a la llista d'advertències" }, "description": { "type": "string", "description": "Descripció de l'entrada d'advertència" }, "publisher": { "type": "string", "description": "Publicador o font de l'advertència" }, "source_url": { "type": "string", "format": "uri", "description": "URL de la font de l'advertència" }, "other_sources": { "type": "array", "items": { "type": "string" }, "description": "URL d'origen addicionals" }, "countries": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Països associats amb l'advertència" }, "created_at": { "type": "string", "nullable": true, "description": "Data en què es va crear l'entrada d'advertència" }, "updated_at": { "type": "string", "nullable": true, "description": "Data en què es va actualitzar per darrera vegada l'entrada d'advertència" }, "additional_data": { "type": "object", "description": "Dades addicionals de la font de l'advertència. Pot contenir un objecte `data` amb una matriu `case_details`.", "properties": { "data": { "type": "object", "properties": { "case_details": { "type": "array", "description": "Detalls dels casos d'advertència associats amb aquesta coincidència", "items": { "type": "object", "properties": { "case_type": { "type": "string", "description": "Tipus del cas d'advertència", "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": "Llista de coincidències en llistes de sancions trobades per a aquesta entitat.", "items": { "type": "object", "properties": { "list_name": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Nom(s) de la llista o llistes de sancions" }, "matched_name": { "type": "string", "description": "Nom que ha coincidit a la llista de sancions" }, "description": { "type": "string", "description": "Descripció de l'entrada de sanció" }, "reason": { "type": "string", "nullable": true, "description": "Motiu de text lliure pel qual es va sancionar l'entitat. Obtingut a partir de les entrades de motius de la llista de sancions. Exemples: '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 font de la sanció" }, "other_sources": { "type": "array", "items": { "type": "string" }, "description": "URL d'origen addicionals" }, "details": { "type": "array", "items": { "type": "string" }, "description": "Detalls addicionals sobre la sanció" }, "legal_basis": { "type": "array", "items": { "type": "string" }, "description": "Base jurídica de la sanció" }, "listed_on": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Data o dates en què l'entitat es va incloure a la llista" }, "sanction_list": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Identificador(s) de la llista de sancions" }, "sanction_program": { "type": "array", "items": { "type": "string" }, "description": "Programa(es) de sancions en què figura l'entitat" }, "sanctioning_authority": { "type": "array", "items": { "type": "string" }, "description": "Autoritat o autoritats que han imposat la sanció" }, "updated_on": { "type": "array", "items": { "type": "string" }, "description": "Data o dates en què l'entrada de sancions es va actualitzar per darrera vegada" }, "additional_data": { "type": "object", "description": "Dades addicionals de la font de la sanció no recollides als camps principals" } } } }, "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ó global de cribratge AML — la puntuació de risc més alta de totes les coincidències (nombre decimal, 0-100). `null` fins que es calculi." }, "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 el monitoratge AML continu està habilitat per a aquest cribratge. Quan és `true`, l'entitat es torna a analitzar periòdicament i qualsevol nova coincidència actualitza l'informe." }, "next_ongoing_monitoring_bill_date": { "type": "string", "format": "date", "nullable": true, "description": "Data (YYYY-MM-DD) en què es facturarà de nou aquesta subscripció de monitoratge continu. Es calcula com la data de l'última facturació del monitoratge continu més 365 dies quan `is_ongoing_monitoring_enabled = true`; en cas contrari `null`. Aquesta és una data de facturació, no una data de cribratge; fes servir `last_ongoing_screening_at` per a això." }, "last_ongoing_screening_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan el monitoratge continu va completar per darrera vegada un nou cribratge d'aquest registre, hagi canviat o no el resultat. `null` quan el registre no s'ha tornat a sotmetre mai a cribratge; mai s'emplena retroactivament a partir de la data d'habilitació o facturació." }, "last_ongoing_screening_datasets_updated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "La data d'actualització del conjunt de dades AML més recent que el proveïdor ha informat en el moment d'aquest cribratge. `null` quan el proveïdor no ha informat de dates del conjunt de dades; mai s'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 funcionalitat que ha generat aquesta advertència. El valor identifica el bloc de funcionalitat al qual pertany l'advertència. Dins d'un cribratge AML sol ser `AML`, però l'enum anterior és vinculant per a totes les advertències de funcionalitats al payload de la decisió." }, "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": "L'ID del node del graf del flux de treball que ha generat aquesta advertència" } } } } } }, "MonitoringEvent": { "type": "object", "description": "Un esdeveniment de monitoratge emmagatzemat tal com el retornen els endpoints de llista i de cronologia del subjecte. Les proves restringides (payload, context del dispositiu, proves de regles) només les retorna `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 de l'esdeveniment. Utilitza'l com a `{event_uuid}` a les crides de recuperació i eliminació." }, "event_id": { "type": "string", "maxLength": 128, "description": "El teu propi identificador, la clau d'idempotència que has enviat." }, "event_category": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ], "description": "Categoria de l'esdeveniment." }, "action_type": { "type": "string", "maxLength": 128, "description": "Què ha passat dins de la categoria, tal com ho has enviat." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Quan va ocórrer l'esdeveniment al teu costat." }, "received_at": { "type": "string", "format": "date-time", "description": "Quan Didit ha acceptat l'esdeveniment." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "`ACCEPTED`: emmagatzemat, cap regla coincident no n'ha canviat l'estat (la resposta habitual per a la majoria d'esdeveniments, i sempre la resposta en una aplicació de sandbox, on no s'executa cap regla). `APPROVED`: una regla ha coincidit i la puntuació s'ha mantingut per sota del teu llindar de revisió. `IN_REVIEW`: una regla ha fet que la puntuació superés el llindar de revisió o n'ha establert l'estat. `DECLINED`: una regla ho ha rebutjat o la puntuació ha superat el teu llindar de rebuig." }, "score": { "type": "integer", "description": "Puntuació de regles acumulada. Comença a 0; les accions `add_score` de les regles la modifiquen (es permeten increments negatius)." }, "subject_vendor_data": { "type": "string", "maxLength": 255, "description": "`subject.vendor_data` de l'esdeveniment: el teu id per a l'usuari o l'empresa." }, "subject_entity_type": { "type": "string", "description": "`individual` o `company`: quin tipus de subjecte indica `subject_vendor_data`.", "example": "individual" }, "subject_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID de l'usuari (persona física) o empresa al qual s'ha resolt l'esdeveniment, o null quan aquest registre ja no existeix." }, "counterparty_vendor_data": { "type": "string", "nullable": true, "description": "L'altre participant d'un esdeveniment P2P (promogut des de `payload.counterparty_vendor_data`).", "maxLength": 255 }, "session_id": { "type": "string", "nullable": true, "description": "`session.session_id` enviat amb l'esdeveniment.", "maxLength": 255 }, "device_fingerprint": { "type": "string", "nullable": true, "description": "`device_context.fingerprint` enviat amb l'esdeveniment.", "maxLength": 255 }, "ip_address": { "type": "string", "nullable": true, "description": "Adreça IP de l'esdeveniment. A la via del servidor és `device_context.network_context.ip_address` tal com la vas enviar; a la via del dispositiu és la IP de la sol·licitud.", "maxLength": 64 }, "ip_country": { "type": "string", "nullable": true, "description": "Codi de país d'`ip_address` obtingut de l'enriquiment d'IP, o null quan l'adreça no s'ha enriquit (telemetria absent, privada o de baix valor l'adreça de la qual encara no es coneixia).", "example": "ES" }, "amount": { "type": "string", "nullable": true, "description": "Import com a cadena decimal amb 18 decimals, procedent de `transaction_context.amount`, `payload.amount` o `payload.stake_amount`, en aquest ordre.", "example": "250.000000000000000000" }, "currency": { "type": "string", "nullable": true, "description": "Moneda de `transaction_context.currency` o `payload.currency`.", "maxLength": 10 }, "game_id": { "type": "string", "nullable": true, "description": "Promogut des de `payload.game_id`.", "maxLength": 128 }, "round_id": { "type": "string", "nullable": true, "description": "Promogut des de `payload.round_id`.", "maxLength": 128 }, "bonus_id": { "type": "string", "nullable": true, "description": "Promocionat des de `payload.bonus_id`.", "maxLength": 128 }, "affiliate_code": { "type": "string", "nullable": true, "description": "Promocionat des de `payload.affiliate_code`.", "maxLength": 128 }, "payment_reference_id": { "type": "string", "nullable": true, "description": "Referència de pagament de `transaction_context.payment_reference_id` o `payload.payment_reference_id`.", "maxLength": 255 }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Classe de conservació de dades. Els esdeveniments de pagament i disputa són `monetary_or_compliance`; els esdeveniments de seguretat i joc responsable són `risk_relevant`; `session.page_view`, `session.sdk_heartbeat`, `session.sdk_loaded`, `session.device_seen`, `session.bot_signal_observed`, `bonus.promotion_viewed` i `affiliate.referral_clicked` són `low_value`; tota la resta és `standard`. Un esdeveniment que hagi coincidit amb una regla activa es promociona a `risk_relevant` (mai es degrada)." }, "rules_matched_count": { "type": "integer", "minimum": 0, "description": "Nombre de regles que han coincidit amb l'esdeveniment, incloses les regles en mode `TEST` (que registren proves però no apliquen cap acció)." }, "correlation_pending": { "type": "boolean", "description": "`true` mentre una regla asíncrona (correlació entre subjectes o una seqüència de més de 24 hores) encara s'ha d'executar per a aquest esdeveniment. Es resol en qüestió de minuts i `status`, `score` i `rules_matched_count` s'actualitzen in situ." }, "is_droppable": { "type": "boolean", "description": "Indica si un SDK sotmès a contrapressió pot descartar esdeveniments d'aquest tipus. `false` per a tots els esdeveniments de `security`, `payment`, `dispute` i `responsible_gambling` i per a `gameplay.bet_placed`, `gameplay.bet_settled` i `gameplay.p2p_settlement`." } } }, "MonitoringEventDetail": { "description": "Un esdeveniment de monitoratge amb el seu sobre complet, enriquiment i evidències de regles. Tots els camps de `MonitoringEvent` més els camps següents.", "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": "Els camps de categoria que has enviat a `payload`." }, "custom_values": { "type": "object", "additionalProperties": true, "description": "Els `custom_values` escalars que has enviat. Didit afegeix `vpn_or_proxy_detected: true` o `is_data_center: true` quan l'enriquiment d'IP marca l'adreça i no els havies definit." }, "device_context": { "type": "object", "additionalProperties": true, "description": "El context de dispositiu tal com s'ha emmagatzemat: el teu `device_context` (inclosos `fingerprint`, `persistent_device_id` i `bot_score` quan s'envien) amb el `network_context` completat per l'enriquiment d'IP (`ip_country`, `ip_country_code`, `ip_city`, `asn_number`, `asn_organization`, `is_vpn_or_tor`, `is_data_center`, `proxy_type`, `connection_type`) per a les claus que hagis deixat buides." }, "field_sources": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "customer", "sdk", "server" ] }, "description": "Ruta del camp fins a la procedència: `customer` (enviat pel teu backend), `sdk` (enviat a través del canal del dispositiu) o `server` (derivat per Didit, com ara `received_at` i camps de xarxa enriquits). Comprova-ho abans d'actuar sobre una coincidència." }, "session_sequence": { "type": "integer", "format": "int64", "nullable": true, "description": "`session.sequence` enviat amb l'esdeveniment." }, "table_id": { "type": "string", "nullable": true, "description": "Promogut des de `payload.table_id`.", "maxLength": 128 }, "hand_id": { "type": "string", "nullable": true, "description": "Promogut des de `payload.hand_id`.", "maxLength": 128 }, "match_id": { "type": "string", "nullable": true, "description": "Promogut des de `payload.match_id`.", "maxLength": 128 }, "market_id": { "type": "string", "nullable": true, "description": "Promogut des de `payload.market_id`.", "maxLength": 128 }, "side": { "type": "string", "nullable": true, "description": "Promogut des de `payload.side`.", "maxLength": 64 }, "role": { "type": "string", "nullable": true, "description": "Promogut des de `payload.role`.", "maxLength": 64 }, "net_result_amount": { "type": "string", "nullable": true, "description": "Promogut des de `payload.net_result_amount`, com una cadena decimal amb 18 xifres decimals.", "example": "-120.000000000000000000" }, "payment_fingerprint": { "type": "string", "nullable": true, "description": "Promogut des de `payload.payment_fingerprint`.", "maxLength": 255 }, "instrument_reference_hash": { "type": "string", "nullable": true, "description": "Promogut des de `payload.instrument_reference_hash`.", "maxLength": 255 }, "withdrawal_address_hash": { "type": "string", "nullable": true, "description": "Promogut des de `payload.withdrawal_address_hash` (o `payload.destination_reference_hash`).", "maxLength": 255 }, "dispute_id": { "type": "string", "nullable": true, "description": "Promogut des de `payload.dispute_id`.", "maxLength": 255 }, "chargeback_id": { "type": "string", "nullable": true, "description": "Promogut des de `payload.chargeback_id`.", "maxLength": 255 }, "changed_field": { "type": "string", "nullable": true, "description": "Promogut des de `payload.changed_field` (esdeveniments de canvi de seguretat).", "maxLength": 128 }, "identity_match_ref": { "type": "string", "nullable": true, "description": "Promogut des de `payload.identity_match_ref` (coincidències amb el registre de joc responsable).", "maxLength": 255 }, "schema_version": { "type": "integer", "description": "Versió de l'esquema de l'embolcall de l'esdeveniment. Actualment `1`.", "example": 1 }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan l'esdeveniment caduca segons la seva classe de conservació i s'elimina: `occurred_at` més el període de la classe (14, 30 o 90 dies per defecte, ajustable per aplicació). Null per a esdeveniments `monetary_or_compliance`, que segueixen la conservació de transaccions." }, "rules_evaluated_count": { "type": "integer", "minimum": 0, "description": "Nombre de regles d'esdeveniment avaluades per a aquest esdeveniment." }, "rule_runs": { "type": "array", "description": "Totes les regles que han coincidit amb l'esdeveniment, de la més recent a la més antiga.", "items": { "$ref": "#/components/schemas/MonitoringEventRuleRun" } }, "ip_enrichment": { "type": "object", "nullable": true, "description": "Enriquiment de l'adreça IP de l'esdeveniment, o null quan l'adreça no s'ha enriquit. Consulta [Enriquiment d'IP](https://docs.didit.me/ca/transaction-monitoring/ip-enrichment).", "properties": { "ip_country_code": { "type": "string", "nullable": true, "description": "Codi de país de l'adreça." }, "ip_city": { "type": "string", "nullable": true, "description": "Ciutat de l'adreça." }, "asn_number": { "type": "integer", "nullable": true, "description": "Número de sistema autònom." }, "asn_organization": { "type": "string", "nullable": true, "description": "Organització que opera el sistema autònom." }, "is_vpn_or_tor": { "type": "boolean", "description": "Indica si l'adreça és una sortida coneguda de VPN o Tor." }, "is_data_center": { "type": "boolean", "description": "Indica si l'adreça pertany a una xarxa d'allotjament o de centre de dades." }, "proxy_type": { "type": "string", "nullable": true, "description": "Classificació de proxy de l'adreça com a cadena opaca, o null." }, "last_enriched_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va enriquir l'adreça per darrera vegada." } }, "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": "Senyals de risc de correu electrònic i telèfon del subjecte emmagatzemats a la memòria cau, o null quan no existeix cap perfil per al subjecte.", "properties": { "email_risk_score": { "type": "integer", "nullable": true, "description": "Puntuació de risc del correu electrònic." }, "email_deliverability": { "type": "string", "nullable": true, "description": "Veredicte de lliurabilitat del correu electrònic." }, "email_is_disposable": { "type": "boolean", "nullable": true, "description": "Indica si l'adreça de correu electrònic és d'un sol ús." }, "email_is_breached": { "type": "boolean", "nullable": true, "description": "Indica si l'adreça de correu electrònic apareix en filtracions de dades conegudes." }, "email_social_count": { "type": "integer", "nullable": true, "description": "Nombre de comptes en línia vinculats a l'adreça de correu electrònic." }, "email_social_providers": { "type": "array", "items": { "type": "string" }, "description": "Noms dels serveis en línia on s'ha trobat un compte vinculat a l'adreça de correu electrònic." }, "phone_risk_score": { "type": "integer", "nullable": true, "description": "Puntuació de risc del telèfon." }, "phone_line_type": { "type": "string", "nullable": true, "description": "Tipus de línia telefònica." }, "phone_carrier": { "type": "string", "nullable": true, "description": "Nom de l'operador de telefonia." }, "phone_social_count": { "type": "integer", "nullable": true, "description": "Nombre de comptes en línia vinculats al número de telèfon." }, "phone_social_providers": { "type": "array", "items": { "type": "string" }, "description": "Noms dels serveis en línia on s'ha trobat un compte vinculat al número de telèfon." }, "source_provider": { "type": "string", "nullable": true, "description": "Identificador opac de l'origen del perfil." }, "last_enriched_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va actualitzar el perfil per darrera vegada." } }, "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": "Noms de les etiquetes adjuntades a l'esdeveniment (accions `add_tags` de la regla)." } } } ] }, "MonitoringEventRuleRun": { "type": "object", "properties": { "rule_uuid": { "type": "string", "format": "uuid", "description": "UUID de la regla de monitoratge de transaccions." }, "rule_title": { "type": "string", "description": "Títol de la regla." }, "library_key": { "type": "string", "nullable": true, "description": "Clau de la biblioteca quan la regla es va instal·lar des de la biblioteca de regles; en cas contrari, null." }, "matched": { "type": "boolean", "description": "Sempre `true`: només es registren les execucions coincidents." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Mode de la regla en executar-se. Una execució en `TEST` registra evidències però no aplica cap acció." }, "is_async": { "type": "boolean", "description": "`true` quan l'execució prové de la passada de correlació asíncrona en lloc de la sol·licitud d'ingesta." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Gravetat de la regla. Null per a execucions de `TEST` i per a regles sense gravetat." }, "score_delta": { "type": "integer", "description": "Quant ha canviat aquesta execució la puntuació de l'esdeveniment (0 per a execucions de tipus `TEST`)." }, "action_summary": { "type": "string", "nullable": true, "description": "Resum breu de les accions aplicades, per exemple `score +40; add_tag:VPN_LOGIN`. Null quan no s'ha aplicat res." }, "matched_payload": { "type": "array", "description": "Les condicions i agregacions que han coincidit. Les entrades de condició inclouen `field`, `operator`, `expected_value`, `current_value`, `matched`, `group_index`, `group_logic` i `field_source` (`server`, `sdk` o `customer`); les entrades d'agregació inclouen `metric`, `field`, `operator`, `expected_value`, `computed_value`, `window`, `filters`, `matched` i `sample_references`.", "items": { "type": "object", "additionalProperties": true } }, "created_at": { "type": "string", "format": "date-time", "description": "Quan es va registrar l'execució 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 d'esdeveniments de monitoratge, amb el `occurred_at` més recent primer.", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Nombre d'esdeveniments coincidents, exacte fins a 100 i limitat a 100 per sobre d'aquest valor. No calculis el nombre de pàgines a partir d'aquest valor; segueix `next` fins que sigui nul." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la pàgina següent, o null a l'última pàgina." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL de la pàgina anterior, o null a la primera pàgina." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoringEvent" } } } }, "MonitoringEventCreateRequest": { "type": "object", "description": "El sobre de l'esdeveniment, el mateix per a cada categoria. S'accepten àlies en camelCase: `eventId`, `eventCategory` (o `category`), `actionType`, `occurredAt`, `timeZone` (o `zoneId`), `deviceContext` (o `device`), `transactionContext`, `customValues` (o `props`); dins de `subject`: `vendorData`, `entityType`, `fullName`; dins de `session`: `sessionId`, `pageUrl`; dins de `transaction_context`: `paymentReferenceId`.", "required": [ "event_id", "event_category", "action_type", "occurred_at", "subject" ], "properties": { "event_id": { "type": "string", "maxLength": 128, "description": "El teu identificador per a l'esdeveniment, únic per aplicació. És la clau d'idempotència: reenviar els mateixos `event_category`, `action_type`, `occurred_at`, `subject.vendor_data` i `payload` amb aquest identificador és una repetició; qualsevol diferència és un conflicte.", "example": "login-2026-10-17-000001" }, "event_category": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ], "description": "Categoria de l'esdeveniment.", "example": "auth" }, "action_type": { "type": "string", "minLength": 1, "maxLength": 128, "description": "Què ha passat dins de la categoria. Vocabulari obert; les accions gestionades llistades a [Event ingestion](https://docs.didit.me/ca/transaction-monitoring/events) (per exemple, `login`, `deposit_completed`, `chargeback_opened`) desbloquegen la validació tipada i els camps de regles gestionades. S'eliminen els espais en blanc inicials i finals.", "example": "login" }, "occurred_at": { "type": "string", "format": "date-time", "description": "Quan va ocórrer l'esdeveniment al teu costat, ISO 8601 (un valor sense decalatge es llegeix com a UTC). No ha de ser de més de 7 dies en el passat ni de més de 5 minuts en el futur.", "example": "2026-10-17T09:15:02.481Z" }, "time_zone": { "type": "string", "nullable": true, "maxLength": 64, "description": "Zona horària de l'ocurrència al teu costat, per exemple `Europe/Madrid`. S'emmagatzema amb l'esdeveniment; no la retornen els endpoints de lectura." }, "subject": { "type": "object", "description": "L'usuari o empresa a qui pertany l'esdeveniment. Es resol en l'usuari (o empresa) amb aquest `vendor_data` a la teva aplicació; se'n crea un quan no n'hi ha cap.", "required": [ "vendor_data" ], "properties": { "vendor_data": { "type": "string", "minLength": 1, "maxLength": 255, "description": "El teu id per al subjecte.", "example": "user-42" }, "entity_type": { "type": "string", "maxLength": 32, "default": "individual", "description": "`company` resol el subjecte com a empresa; qualsevol altre valor (per defecte `individual`) el resol com a particular. El mateix `vendor_data` en pot anomenar un de cada.", "example": "individual" }, "full_name": { "type": "string", "nullable": true, "maxLength": 512, "description": "Nom visible, utilitzat només quan aquest esdeveniment crea l'usuari o l'empresa." }, "email": { "type": "string", "format": "email", "nullable": true, "description": "Validat com a adreça de correu electrònic; no s'emmagatzema a l'esdeveniment." }, "phone": { "type": "string", "nullable": true, "maxLength": 32, "description": "Validat; no s'emmagatzema a l'esdeveniment." }, "country": { "type": "string", "nullable": true, "maxLength": 3, "description": "Validat; no s'emmagatzema a l'esdeveniment." } } }, "business": { "type": "object", "description": "L'empresa a la qual pertany l'esdeveniment, quan difereix del subjecte. Només es llegeix `vendor_data`.", "additionalProperties": true, "properties": { "vendor_data": { "type": "string", "maxLength": 255, "description": "El teu id per a l'empresa. Es pot filtrar com a `business_vendor_data`.", "example": "merchant-7" } } }, "session": { "type": "object", "description": "El context de la teva sessió per a l'esdeveniment.", "properties": { "session_id": { "type": "string", "nullable": true, "maxLength": 255, "description": "El teu identificador de sessió. Filtrable i retornat com a `session_id`." }, "sequence": { "type": "integer", "nullable": true, "description": "Posició de l'esdeveniment dins de la sessió. Es retorna com a `session_sequence`." }, "page_url": { "type": "string", "nullable": true, "maxLength": 2048, "description": "Validat; no s'emmagatzema a l'esdeveniment." }, "referrer": { "type": "string", "nullable": true, "maxLength": 2048, "description": "Validat; no s'emmagatzema a l'esdeveniment." } } }, "device_context": { "type": "object", "additionalProperties": true, "description": "Context del dispositiu i de la xarxa, emmagatzemat tal com s'ha enviat i retornat per `GET /v3/events/{event_uuid}/`. En aquesta via de servidor Didit no veu la connexió de l'usuari final, de manera que l'adreça IP enriquida i utilitzada per les regles és `network_context.ip_address` tal com l'envies.", "properties": { "fingerprint": { "type": "string", "maxLength": 255, "description": "Petjada digital del dispositiu. Es pot filtrar com a `device_fingerprint`." }, "persistent_device_id": { "type": "string", "maxLength": 255, "description": "El teu identificador de dispositiu persistent." }, "bot_score": { "type": "integer", "description": "Puntuació de bot de la teva pròpia detecció, com a enter." }, "network_context": { "type": "object", "additionalProperties": true, "properties": { "ip_address": { "type": "string", "maxLength": 64, "description": "Adreça IP de l'usuari final. Les adreces públiques s'enriqueixen una vegada per adreça única.", "example": "203.0.113.42" } } } } }, "transaction_context": { "type": "object", "description": "Context monetari. Els valors no buits d'aquí també satisfan les claus de payload requerides de l'acció.", "properties": { "amount": { "type": "string", "nullable": true, "description": "Import com a cadena decimal (també s'accepta un número).", "example": "1000.00" }, "currency": { "type": "string", "nullable": true, "maxLength": 10, "description": "Codi de moneda." }, "direction": { "type": "string", "nullable": true, "maxLength": 16, "description": "Direcció del moviment de diners, per exemple `inbound` o `outbound`." }, "payment_reference_id": { "type": "string", "nullable": true, "maxLength": 255, "description": "La teva referència de pagament. Filtrable com a `payment_reference_id`." } } }, "payload": { "type": "object", "additionalProperties": true, "description": "Els camps de domini de la categoria, com a màxim 16384 bytes un cop codificats en JSON. Algunes accions requereixen claus (a `payload` o `transaction_context`): `gameplay.p2p_settlement` necessita `game_id`, `counterparty_vendor_data`, `stake_amount`, `net_result_amount`, `role` i un de `hand_id`, `round_id`, `match_id`; `gameplay.bet_placed` i `gameplay.bet_settled` necessiten `game_id`; `payment.deposit_initiated`, `payment.deposit_completed`, `payment.withdrawal_requested` i `payment.withdrawal_completed` necessiten `payment_reference_id`, `amount`, `currency`, `payment_method`, `status`; `payment.withdrawal_address_changed` necessita `withdrawal_address_hash`; `dispute.chargeback_opened`, `dispute.chargeback_won` i `dispute.chargeback_lost` necessiten `payment_reference_id` i un de `dispute_id`, `chargeback_id`; `session.bot_signal_observed` necessita `telemetry_schema_version` i un de `bot_score`, `actions_per_minute`, `timing_variance_ms`, `pointer_entropy`, `keystroke_entropy`, `reaction_time_ms_p50`; `responsible_gambling.self_exclusion_match` necessita `registry_source`, `exclusion_status`, `identity_match_ref`. Tota acció de `security` que acabi en `_changed` necessita `changed_field`, a més de `previous_reference_hash` o `new_reference_hash` quan el camp és `password`, `mfa_method`, `mfa`, `email`, `phone`, `withdrawal_address`, `payout_method` o `api_key`. Envia valors hash i referències, mai un número de targeta, una adreça de retirada completa, un hash de contrasenya o un secret MFA." }, "custom_values": { "type": "object", "description": "Fins a 100 claus pròpies, accessibles des de les regles com a `custom_values.`. Els valors han de ser escalars (string, number, boolean o null); es rebutgen els objectes niats i les matrius.", "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": "Resultat de la ingesta d'un esdeveniment. Es retorna la mateixa estructura tant per a un esdeveniment nou com per a una repetició idempotent.", "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 de l'esdeveniment emmagatzemat." }, "event_id": { "type": "string", "description": "El teu `event_id`." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "Estat després d'executar les regles en temps real. Consulta `MonitoringEvent.status`." }, "score": { "type": "integer", "description": "Puntuació després de l'execució de les regles en temps real." }, "rules_evaluated_count": { "type": "integer", "minimum": 0, "description": "Nombre de regles d'esdeveniment avaluades a la sol·licitud. 0 en una aplicació de sandbox, on no s'executa cap regla." }, "rules_matched_count": { "type": "integer", "minimum": 0, "description": "Nombre de regles que han coincidit, incloses les regles en mode `TEST`." }, "correlation_pending": { "type": "boolean", "description": "`true` quan encara s'ha d'executar una regla asíncrona. Consulta `GET /v3/events/{event_uuid}/` uns minuts més tard per obtenir els valors definitius de `status` i `score`." }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Classe de conservació de dades, després de qualsevol promoció per una regla que hagi coincidit." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan l'esdeveniment caduca segons la seva classe de conservació i s'elimina. Null per a esdeveniments `monetary_or_compliance` (pagaments i disputes)." }, "idempotent_replay": { "type": "boolean", "description": "`true` quan ja s'havia emmagatzemat un esdeveniment amb aquest `event_id` i el mateix contingut; els valors són els de l'esdeveniment emmagatzemat i no s'ha tornat a executar cap regla." }, "rule_matches": { "type": "array", "description": "Regles que han coincidit amb l'esdeveniment.", "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": "Clau de la biblioteca quan la regla es va instal·lar des de la biblioteca de regles; en cas contrari, null." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Les regles `TEST` registren la coincidència però no apliquen cap acció." }, "is_async": { "type": "boolean", "description": "`true` quan la coincidència prové de la passada asíncrona." } } } } } }, "ComplianceList": { "type": "object", "description": "Una llista de bloqueig, llista de permesos o llista personalitzada d'una aplicació.", "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 llista. Utilitza'l com a `list_uuid` als endpoints de llistes i entrades, i com a valor d'una condició de regla de flux de treball o de transacció amb `value_type: \"list\"`." }, "name": { "type": "string", "maxLength": 255, "description": "Nom de la llista, únic entre les llistes de l'aplicació." }, "description": { "type": "string", "description": "Descripció de text lliure. Cadena buida si no s'ha definit." }, "list_type": { "type": "string", "enum": [ "blocklist", "allowlist", "custom" ], "description": "`blocklist`: una coincidència rebutja la sessió o la transacció (només llistes del sistema, una per tipus d'entrada). `allowlist`: els elements coincidents són de confiança; per exemple, una llista d'autorització facial omet l'acció de detecció de cares duplicades; mai no anul·la una coincidència amb una llista de bloqueig. `custom`: s'utilitza en condicions de regles de fluxos de treball i transaccions (`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è conté la llista: `face`, `document` (número de document), `phone`, `email`, `ip_address` (adreça o rang CIDR), `device_fingerprint`, `wallet_address`, `bank_account`, `country` (ISO 3166-1 alpha-3), `user` o `business` (el teu `vendor_data`), o `key` (qualsevol cadena). Decideix com es validen i es comparen els valors de les entrades." }, "is_system": { "type": "boolean", "description": "`true` per a les llistes que Didit aprovisiona: una llista de bloqueig per tipus d'entrada (`face`, `document`, `phone`, `email`, `ip_address`, `device_fingerprint`, `wallet_address`, `bank_account`, `user`, `business`), la llista personalitzada **High Risk Countries** i les llistes d'admesos del sistema. Les llistes del sistema no es poden reanomenar, editar ni suprimir; pots afegir i suprimir les seves entrades." }, "entry_count": { "type": "integer", "minimum": 0, "description": "Nombre d'entrades actualment a la llista." }, "last_entry_added_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va afegir l'entrada actual més recent. `null` per a una llista buida." }, "created_at": { "type": "string", "format": "date-time", "description": "Quan es va crear la llista." }, "updated_at": { "type": "string", "format": "date-time", "description": "Quan es va actualitzar la llista per darrera vegada." } } }, "ComplianceListEntry": { "type": "object", "description": "Un valor en una llista.", "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 l'entrada. Utilitza'l com a `entry_uuid` a l'operació «Eliminar una entrada de llista»." }, "value": { "type": "string", "description": "El valor llistat: un número de telèfon en E.164, una adreça de correu electrònic, un número de document, una adreça IP o rang CIDR, una empremta digital de dispositiu, una adreça de cartera, un compte bancari, un codi de país ISO 3166-1 alfa-3, un `vendor_data`, qualsevol cadena en una llista `key`, o l'UUID de la cara emmagatzemada en una llista de cares. Els valors que envies s'emmagatzemen en minúscules, excepte els números de telèfon i els codis de país. La coincidència no distingeix entre majúscules i minúscules." }, "display_label": { "type": "string", "nullable": true, "maxLength": 512, "description": "Etiqueta fàcil de llegir. Didit l'emplena per a entrades extretes d'una sessió (per exemple, el nom del titular i el número de document) quan no n'envies cap." }, "comment": { "type": "string", "description": "Nota de text lliure. Cadena buida si no s'ha definit." }, "added_by": { "type": "string", "nullable": true, "description": "Qui ha afegit l'entrada: `api` (una clau d'API), l'adreça de correu electrònic d'un usuari de la consola o `console`, `system` o `migration` (entrades creades per Didit) o `rule` (una acció de regla de transacció o de monitoratge)." }, "reference_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Sessió de verificació d'on s'ha extret l'entrada. `null` quan l'entrada s'ha afegit per valor." }, "reference_session_number": { "type": "integer", "nullable": true, "description": "Número d'aquesta sessió en l'àmbit de l'aplicació, tal com es mostra a la consola." }, "reference_session_type": { "type": "string", "nullable": true, "enum": [ "kyc", "kyb", null ], "description": "`kyc` per a una sessió de verificació de persona, `kyb` per a una sessió de verificació d'empresa, `null` quan no hi ha cap sessió." }, "reference_object_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "El registre que representa l'entrada: el registre de rostre, document, telèfon o correu electrònic llegit d'una sessió, el rostre creat per Upload a face to a list, o l'UUID que has enviat (per exemple, un UUID de transacció o el `didit_internal_id` d'un usuari)." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Context addicional. Conté les claus que estableix Didit (llistades aquí) combinades amb qualsevol `metadata` que hagis enviat en crear l'entrada, retornades tal com s'han desat. `null` quan no n'hi ha cap.", "properties": { "reference_image_url": { "type": "string", "description": "Entrades facials: URL signada de curta durada, emesa de nou en cada crida; `null` per a una clau d'API amb un àmbit que no inclou `media: read`. Absent quan cap imatge pertany a l'entrada." }, "front_image_url": { "type": "string", "description": "Entrades de document que contenen una imatge frontal del document: URL signat de curta durada, emès novament a cada crida; `null` per a una clau d'API amb abast limitat sense `media: read`." }, "full_name": { "type": "string", "description": "Entrades de document obtingudes d'una sessió: nom complet del titular." }, "issuing_state": { "type": "string", "description": "Entrades de document obtingudes d'una sessió: país emissor ISO 3166-1 alfa-3." }, "document_type": { "type": "string", "description": "Entrades de document obtingudes d'una sessió: codi de tipus de document, per exemple `P`, `ID` o `DL`." }, "region": { "type": "string", "description": "Entrades de document obtingudes d'una sessió: estat o província emissor d'un document emès regionalment, buit quan no correspongui. No s'estableix mitjançant Add session items to the blocklist." }, "document_number": { "type": "string", "description": "Entrades de document obtingudes d'una sessió: el número de document." }, "face_image_source": { "type": "string", "enum": [ "front_image_camera_front", "back_image_camera_front" ], "description": "Entrades facials obtingudes d'una selfie de captura de documents: quina selfie. No apareix per a cares de prova de vida." }, "reference_node_id": { "type": "string", "nullable": true, "description": "Entrades facials obtingudes d'una selfie de captura de documents: el node de verificació d'identitat d'on prové la selfie." }, "fingerprint_tier": { "type": "string", "nullable": true, "enum": [ "persistent_id", "composite_hash", "legacy_fp", "unknown", null ], "description": "Entrades de la petjada digital del dispositiu obtingudes d'una sessió: com es va derivar la petjada digital. `persistent_id` identifica un sol dispositiu; `composite_hash` i `legacy_fp` es poden compartir entre dispositius del mateix model." }, "sandbox": { "type": "boolean", "description": "`true` en una entrada facial pujada en una aplicació sandbox; aquesta entrada no coincideix amb res." }, "reference_type": { "type": "string", "enum": [ "transaction", "vendor_user", "vendor_business" ], "description": "Definit per tu: a què apunta `reference_object_uuid`, perquè la consola hi enllaci de tornada." }, "reference_id": { "type": "string", "description": "Definit per tu: identificador del registre d'origen." } } }, "created_at": { "type": "string", "format": "date-time", "description": "Quan es va afegir l'entrada." } } }, "BlocklistedItem": { "type": "object", "description": "Una cara, document d'identitat, número de telèfon o adreça de correu electrònic a la llista de bloqueig d'una sessió de verificació. Els camps que no s'apliquen al `type` de l'element són `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è s'ha afegit a la llista de bloqueig." }, "session_id": { "type": "string", "format": "uuid", "description": "Sessió de verificació a la qual pertany l'element." }, "session_number": { "type": "integer", "nullable": true, "description": "Número d'aquesta sessió en l'àmbit de l'aplicació, tal com es mostra a la consola." }, "blocklisted_at": { "type": "string", "format": "date-time", "description": "Quan es va afegir l'element a la llista de bloqueig per darrera vegada." }, "face_image": { "type": "string", "nullable": true, "description": "Elements facials: URL signada de curta durada, emesa de nou en cada crida; `null` per a una clau d'API amb àmbit sense `media: read`. També `null` quan no hi ha cap imatge de referència emmagatzemada." }, "document_type": { "type": "string", "nullable": true, "description": "Elements de document: codi de tipus de document, per exemple `P` (passaport), `ID` (document nacional d'identitat), `DL` (permís de conduir) o `RP` (permís de residència)." }, "document_number": { "type": "string", "nullable": true, "description": "Elements de document: el número de document, o el número personal quan el document no en té cap." }, "front_image": { "type": "string", "nullable": true, "description": "Elements de document: imatge frontal del document, URL signat de curta durada, emès novament a cada crida; `null` per a una clau d'API amb abast limitat sense `media: read`." }, "phone_number": { "type": "string", "nullable": true, "description": "Elements de telèfon: el número de telèfon en E.164." }, "country_code": { "type": "string", "nullable": true, "description": "Elements de telèfon: país ISO 3166-1 alfa-2 del número." }, "email": { "type": "string", "nullable": true, "description": "Elements de correu electrònic: l'adreça de correu electrònic." } } }, "TransactionNote": { "type": "object", "description": "Una nota a la línia temporal de revisió d'una transacció monitorada.", "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": "Cos de la nota en text pla." }, "actor_email": { "type": "string", "format": "email", "nullable": true, "description": "Correu electrònic de l'usuari de la Console que ha escrit la nota o ha canviat l'estat. `null` per a notes creades amb una clau d'API i per a notes que Didit afegeix automàticament." }, "actor_name": { "type": "string", "nullable": true, "description": "Nom visible de l'usuari de la consola (el seu correu electrònic quan no té nom). `Rule Engine` en les notes que Didit afegeix automàticament. `null` per a notes creades amb una clau d'API." }, "metadata": { "type": "object", "description": "Distingeix els tipus de notes. Les notes escrites a través de l'API o de la consola porten `mentioned_emails`. Un canvi d'estat fet a la consola porta `type: status_change` amb `previous_status`, `new_status`, `reason_code` i `reason_label`. Les notes que Didit afegeix porten `source`: `rule_action` (amb `rule_uuid`) per a l'acció `add_note` d'una regla, o `remediation_session` per a un problema en crear la sessió de verificació per a l'acció de l'usuari.", "properties": { "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Membres de l'organització esmentats, en minúscules i sense duplicats. Buit si no s'ha esmentat ningú." }, "type": { "type": "string", "enum": [ "status_change" ], "description": "Present en notes que registren un canvi d'estat fet a la consola." }, "previous_status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Estat abans del canvi." }, "new_status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Estat després del canvi." }, "reason_code": { "type": "string", "nullable": true, "description": "Codi de motiu facilitat amb el canvi." }, "reason_label": { "type": "string", "nullable": true, "description": "Etiqueta de motiu facilitada amb el canvi." }, "source": { "type": "string", "enum": [ "rule_action", "remediation_session" ], "description": "Present en notes que Didit afegeix automàticament." }, "rule_uuid": { "type": "string", "format": "uuid", "description": "Regla l'acció `add_note` de la qual ha escrit la nota (amb `source: rule_action`)." } } }, "created_at": { "type": "string", "format": "date-time", "description": "Quan es va desar la nota." } } }, "TransactionSummary": { "type": "object", "description": "Resum d'una transacció monitorada, en el format que mostra `GET /v3/transactions/`. Crida `GET /v3/transactions/{transaction_id}/` amb `uuid` per obtenir les parts, alertes i execucions de regles.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID de transacció de Didit. Utilitza'l com a `{transaction_id}` als endpoints de transaccions." }, "transaction_number": { "type": "integer", "nullable": true, "description": "Número seqüencial en l'àmbit de l'aplicació que es mostra a la consola." }, "txn_id": { "type": "string", "nullable": true, "description": "El teu propi identificador de la crida de creació. Únic per aplicació." }, "transaction_type": { "type": "string", "description": "Categoria tal com s'emmagatzema: `finance`, `kyc`, `travelRule`, `userPlatformEvent`, `gamblingBet`, `gamblingLimitChange`, `gamblingBonusChange` o `auditTrailEvent`." }, "action_type": { "type": "string", "description": "Subtipus dins de la categoria, per exemple `withdrawal`." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Veredicte de monitoratge actual." }, "source": { "type": "string", "enum": [ "LIVE", "IMPORTED" ], "description": "`LIVE` per a transaccions enviades a monitoratge, `IMPORTED` per a importacions històriques." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Direcció relativa al subjecte." }, "amount": { "type": "string", "description": "Import com a cadena decimal sense els zeros finals (fins a 18 decimals)." }, "currency": { "type": "string", "description": "Codi de moneda o símbol d'actiu cripto de `amount`." }, "currency_type": { "type": "string", "nullable": true, "description": "`fiat` o `crypto` quan es conegui." }, "preferred_currency_amount": { "type": "string", "nullable": true, "description": "`amount` convertit a la moneda preferida de l'aplicació, quan hi havia un tipus de canvi disponible." }, "preferred_currency_code": { "type": "string", "nullable": true, "description": "Moneda de `preferred_currency_amount`." }, "payment_details": { "type": "string", "nullable": true, "description": "Referència de pagament de text lliure." }, "txn_date": { "type": "string", "format": "date-time", "description": "Quan va tenir lloc la transacció." }, "created_at": { "type": "string", "format": "date-time", "description": "Quan Didit ho ha registrat." }, "score": { "type": "integer", "description": "Puntuació de risc. Com més alta, més risc." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Gravetat del risc, `null` fins que algun procés l'estableixi." }, "decision_reason_code": { "type": "string", "nullable": true, "description": "Motiu llegible per màquina per a l'`status` actual." }, "decision_reason_label": { "type": "string", "nullable": true, "description": "Etiqueta fàcil de llegir per a `decision_reason_code`." }, "tags": { "type": "array", "description": "Etiquetes a la transacció.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string", "description": "Color hexadecimal, per exemple `#F59E0B`." }, "description": { "type": "string", "nullable": true }, "source": { "type": "string", "enum": [ "didit", "custom" ], "description": "Etiqueta predefinida o personalitzada de Didit." } } } }, "subject_name": { "type": "string", "nullable": true, "description": "Nom complet de la part `APPLICANT`." }, "subject_vendor_data": { "type": "string", "nullable": true, "description": "El teu `vendor_data` per al sol·licitant." }, "subject_type": { "type": "string", "nullable": true, "enum": [ "user", "business", null ], "description": "Indica si el sol·licitant està vinculat a un usuari o empresa de Didit; `null` quan no està vinculat a cap dels dos." }, "subject_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID de l'usuari o de l'empresa de Didit a qui està vinculat el sol·licitant." }, "subject_country": { "type": "string", "nullable": true, "description": "Codi de país del sol·licitant." }, "counterparty_name": { "type": "string", "nullable": true, "description": "Nom complet de la part `COUNTERPARTY`, si n'hi ha." }, "counterparty_vendor_data": { "type": "string", "nullable": true, "description": "El teu `vendor_data` per a la contrapart." }, "counterparty_country": { "type": "string", "nullable": true, "description": "Codi de país de la contrapart." }, "assigned_to_name": { "type": "string", "nullable": true, "description": "Nom del revisor de la Console assignat a la transacció." }, "travel_rule_status": { "type": "string", "nullable": true, "description": "Estat de la transferència de Travel Rule de la transacció, o `null` quan no en té cap." }, "application_id": { "type": "string", "format": "uuid", "description": "Aplicació propietària de la transacció." }, "application_name": { "type": "string", "nullable": true, "description": "Nom d'aquella aplicació." }, "organization_id": { "type": "string", "format": "uuid", "description": "Organització propietària de l'aplicació." }, "organization_name": { "type": "string", "nullable": true, "description": "Nom d'aquella organització." } } }, "ApplicationAnalyticsDataPoint": { "type": "object", "description": "Recomptes de sessions per a un dia, per data de creació (UTC). Cada recompte reflecteix l'estat actual de la sessió. Els punts del període anterior contenen com a mínim els camps obligatoris.", "required": [ "rounded_date", "total", "approved", "declined", "canceled", "pending" ], "properties": { "rounded_date": { "type": "string", "format": "date", "description": "El dia, `YYYY-MM-DD`." }, "total": { "type": "integer", "description": "Sessions creades aquell dia." }, "approved": { "type": "integer", "description": "D'aquestes, sessions `Approved` o `Kyc Expired`." }, "declined": { "type": "integer", "description": "Sessions `Declined`." }, "canceled": { "type": "integer", "description": "Sessions `Expired` o `Abandoned`." }, "pending": { "type": "integer", "description": "Sessions `Not Started`, `In Progress` o `In Review`." }, "in_review": { "type": "integer", "description": "Sessions `In Review`." }, "expired": { "type": "integer", "description": "Sessions `Expired`." }, "abandoned": { "type": "integer", "description": "Sessions `Abandoned`." }, "in_progress": { "type": "integer", "description": "Sessions `In Progress`." }, "not_started": { "type": "integer", "description": "Sessions `Not Started`." }, "manually_approved": { "type": "integer", "description": "Sessions que un revisor ha aprovat després que el flux de treball hagi donat un altre veredicte." }, "manually_declined": { "type": "integer", "description": "Sessions que un revisor ha rebutjat després que el flux de treball hagi donat un altre veredicte." } } }, "ApplicationAnalyticsRequestBreakdown": { "type": "object", "description": "Totals d'estat per a l'interval. El desglossament del període anterior conté com a mínim els camps obligatoris.", "required": [ "total_approved", "total_in_review", "total_declined", "total_canceled", "total_pending" ], "properties": { "total_approved": { "type": "integer", "description": "Sessions `Approved` o `Kyc Expired`." }, "total_in_review": { "type": "integer", "description": "Sessions `In Review`." }, "total_declined": { "type": "integer", "description": "Sessions `Declined`." }, "total_canceled": { "type": "integer", "description": "Sessions `Expired` o `Abandoned`." }, "total_pending": { "type": "integer", "description": "Sessions `Not Started`, `In Progress` o `In Review` (inclou `total_in_review`)." }, "total_expired": { "type": "integer", "description": "Sessions `Expired`." }, "total_abandoned": { "type": "integer", "description": "Sessions `Abandoned`." }, "total_in_progress": { "type": "integer", "description": "Sessions `In Progress`." }, "total_not_started": { "type": "integer", "description": "Sessions `Not Started`." }, "total_manually_approved": { "type": "integer", "description": "Aprovada per un revisor." }, "total_manually_declined": { "type": "integer", "description": "Rebutjada per un revisor." } } }, "ApplicationAnalyticsCountryCount": { "type": "object", "properties": { "country": { "type": "string", "description": "Nom del país." }, "country_code": { "type": "string", "description": "Codi de país de dues lletres." }, "session_count": { "type": "integer", "description": "Sessions d'aquell país." } } }, "ApplicationAnalyticsLocationStats": { "type": "object", "properties": { "ip_countries": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsCountryCount" }, "description": "Països de les adreces IP dels usuaris, amb més sessions primer." }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsCountryCount" }, "description": "La mateixa llista que `ip_countries`." }, "id_countries": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsCountryCount" }, "description": "Països emissors dels documents d'identitat verificats, primer els països amb més sessions." }, "conversion_by_country": { "type": "array", "description": "Per país emissor del document: sessions finalitzades (aprovades, rebutjades o en revisió) i quantes han estat aprovades. Les més finalitzades primer.", "items": { "type": "object", "properties": { "country": { "type": "string" }, "country_code": { "type": "string" }, "finished": { "type": "integer" }, "approved": { "type": "integer" } } } }, "cities": { "type": "array", "description": "Fins a 100 ciutats per IP, primer les que tenen més sessions.", "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": "Sessions per franja d'edat a partir del document d'identitat. Buit quan no hi ha dades.", "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": "Sessions per codi de gènere del document: `M`, `F` o `U` (desconegut).", "additionalProperties": { "type": "integer" } } } }, "ApplicationAnalyticsDeviceDetails": { "type": "object", "description": "Els cinc primers de cadascun, amb més sessions primer.", "properties": { "device_models": { "type": "array", "description": "Marques de dispositius: `Apple`, `Android`, `LG`, i tota la resta agrupada com a `Other`.", "items": { "type": "object", "properties": { "device": { "type": "string" }, "count": { "type": "integer" } } } }, "browsers": { "type": "array", "description": "Navegadors: `Chrome`, `Safari`, `Didit App`, `Firefox`, i tota la resta agrupada com a `Other`.", "items": { "type": "object", "properties": { "browser": { "type": "string" }, "count": { "type": "integer" } } } }, "operating_systems": { "type": "array", "description": "Sistemes operatius.", "items": { "type": "object", "properties": { "os": { "type": "string" }, "count": { "type": "integer" } } } } } }, "ApplicationAnalyticsWorkflowFunnel": { "type": "object", "description": "Indexat per ID de flux de treball. `total` és el nombre de sessions iniciades en aquest flux de treball; `steps` compta les sessions que han arribat a cada pas (`OCR`, `LIVENESS`, `FACE_MATCH`, `AML`, `POA`, `PHONE`, `EMAIL`, `NFC`, `DATABASE_VALIDATION`, `QUESTIONNAIRE`, `IP_ANALYSIS`, `AGE_ESTIMATION`, `KYB_REGISTRY`, `KYB_DOCUMENTS`, `KYB_KEY_PEOPLE`). Arribar a un pas no equival a superar-lo.", "additionalProperties": { "type": "object", "properties": { "total": { "type": "integer" }, "steps": { "type": "object", "additionalProperties": { "type": "object", "properties": { "reached": { "type": "integer" } } } } } } }, "ApplicationAnalyticsVerificationTimeStats": { "type": "object", "description": "Temps actiu que els usuaris han passat verificant, ignorant els intervals d'inactivitat. És un objecte buit quan no hi ha dades.", "properties": { "overall_avg_seconds": { "type": "number", "description": "Mitjana per sessió, un decimal." }, "overall_count": { "type": "integer", "description": "Sessions mesurades." }, "per_feature": { "type": "object", "description": "Indexat per funcionalitat, per exemple `OCR` o `LIVENESS`.", "additionalProperties": { "type": "object", "properties": { "avg_seconds": { "type": "number" }, "total_seconds": { "type": "number" }, "count": { "type": "integer" } } } }, "per_sub_step": { "type": "object", "description": "Indexat per funcionalitat, després per subpas, per exemple `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": "Sessions finalitzades sense cap reenviament." }, "second": { "type": "integer", "description": "Sessions finalitzades reenviades una vegada." }, "third_plus": { "type": "integer", "description": "Sessions finalitzades reenviades dues o més vegades." }, "abandoned": { "type": "integer", "description": "Sessions abandonades." } } }, "ApplicationAnalyticsOriginalStatusStats": { "type": "object", "description": "El veredicte automàtic del flux de treball, abans que cap revisor el modifiqués.", "properties": { "approved": { "type": "integer" }, "in_review": { "type": "integer" }, "declined": { "type": "integer" } } }, "ApplicationAnalyticsWarningStats": { "type": "object", "description": "Indexat per funcionalitat (`ID_VERIFICATION`, `LIVENESS`, `FACEMATCH`, `AML`, `PROOF_OF_ADDRESS`, `PHONE`, `EMAIL`, `NFC`, `LOCATION`, `DATABASE_VALIDATION`, `QUESTIONNAIRE` i les funcionalitats de KYB). `total` és el nombre de sessions que han arribat a la funcionalitat; `risks` compta les sessions per codi d'advertència i nivell.", "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": "Clau del període: `YYYY-MM-DD` per a un dia, el dilluns d'una setmana, o `YYYY-MM` per a un mes, segons `grouping_mode`." }, "age_distribution": { "type": "object", "additionalProperties": { "type": "integer" } }, "gender_distribution": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "ApplicationAnalyticsDevicePoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Clau del període: `YYYY-MM-DD` per a un dia, el dilluns d'una setmana, o `YYYY-MM` per a un mes, segons `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": "Clau del període: `YYYY-MM-DD` per a un dia, el dilluns d'una setmana, o `YYYY-MM` per a un mes, segons `grouping_mode`." }, "overall_avg": { "type": "number", "description": "Mitjana de segons actius per sessió." }, "per_feature": { "type": "object", "description": "Mitjana de segons actius per funcionalitat.", "additionalProperties": { "type": "number" } } } }, "ApplicationAnalyticsResubmissionPoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Clau del període: `YYYY-MM-DD` per a un dia, el dilluns d'una setmana, o `YYYY-MM` per a un mes, segons `grouping_mode`." }, "first_pass": { "type": "integer" }, "second": { "type": "integer" }, "third_plus": { "type": "integer" }, "abandoned": { "type": "integer" } } }, "ApplicationAnalyticsOriginalStatusPoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Clau del període: `YYYY-MM-DD` per a un dia, el dilluns d'una setmana, o `YYYY-MM` per a un mes, segons `grouping_mode`." }, "approved": { "type": "integer" }, "in_review": { "type": "integer" }, "declined": { "type": "integer" } } }, "ApplicationAnalyticsSummary": { "type": "object", "description": "Resum de la verificació d'usuaris (KYC), retornat quan no s'envia 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 punt per dia, des del primer dia amb sessions a l'interval fins a `end_date`. Sempre diari, independentment del que indiqui `grouping_mode`." }, "request_breakdown": { "$ref": "#/components/schemas/ApplicationAnalyticsRequestBreakdown" }, "previous_data_points": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDataPoint" }, "description": "Punts diaris per al període de la mateixa durada just abans de `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`, un decimal. `null` quan no s'ha finalitzat res." }, "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": "Com s'agrupen les llistes de `*_time_series`: `day` per a períodes de fins a 14 dies, `week` per a períodes de fins a 90 dies i `month` per a períodes superiors. Es mesura a partir del primer dia amb sessions dins l'interval." }, "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 giny del tauler. Cada giny té `kind` i `title`; els altres camps depenen de `kind`. Els ginys de sessió reutilitzen els objectes de resum (`data_points`, `request_breakdown`, `workflow_funnel_stats`, etc.); els ginys de llista posen les seves entrades a `items`; les mètriques de transaccions utilitzen `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": "Tipus de widget." }, "title": { "type": "string", "description": "Títol visible, per exemple `Verification volume`." }, "grouping_mode": { "type": "string", "enum": [ "day", "week", "month" ], "description": "Com s'agrupen les llistes de `*_time_series`: `day` per a períodes de fins a 14 dies, `week` per a períodes de fins a 90 dies i `month` per a períodes superiors. Es mesura a partir del primer dia amb sessions dins l'interval." }, "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": "Entrades d'un widget de llista. `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` amb `count` i `volume`, o `tag_id`, `tag_name`, `count`. `leaderboard`: `rule_title`, `trigger_count` o `assignee`, `handled_count`, `average_processing_seconds`, cadascun amb `approved_percentage`, `declined_percentage`, `flagged_percentage`. `histogram`: `score`, `count`.", "items": { "type": "object", "additionalProperties": {} } }, "previous_items": { "type": "array", "description": "Sèrie temporal de transaccions per al període de la mateixa durada just abans de `start_date`.", "items": { "type": "object", "additionalProperties": {} } }, "value": { "type": "number", "description": "Ginys `metric`: la xifra per a l'interval." }, "currency": { "type": "string", "nullable": true, "description": "Ginys de volum i import de transaccions: la moneda de transacció per defecte de l'aplicació." }, "thresholds": { "type": "object", "description": "Giny `histogram`: els llindars de puntuació de revisió i rebuig de l'aplicació.", "properties": { "review": { "type": "integer" }, "decline": { "type": "integer" } } }, "search": { "type": "object", "description": "Giny `kyb_registry_coverage`: totals de cerca al registre.", "properties": { "searches_total": { "type": "integer" }, "searches_with_no_candidates": { "type": "integer" } } } } }, "ApplicationAnalyticsWidgetResponse": { "type": "object", "description": "Ginys del tauler, retornats quan s'envia `scope` o `widget_keys`.", "required": [ "scope", "available_widget_keys", "requested_widget_keys", "widgets" ], "properties": { "scope": { "type": "string", "enum": [ "home", "kyc", "kyb", "transactions" ], "description": "Pestanya del tauler." }, "available_widget_keys": { "type": "array", "items": { "type": "string" }, "description": "Totes les claus de widget que accepta aquest abast." }, "requested_widget_keys": { "type": "array", "items": { "type": "string" }, "description": "Les claus del widget retornades, en ordre: les teves `widget_keys` vàlides, o els valors per defecte de l'abast." }, "widgets": { "type": "object", "description": "Indexat per clau de widget, en l'ordre de `requested_widget_keys`.", "additionalProperties": { "$ref": "#/components/schemas/ApplicationAnalyticsWidget" } } } }, "ApplicationAnalyticsToday": { "type": "object", "description": "Verificacions d'avui per hora local respecte al mateix dia de la setmana de la setmana passada.", "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 horària IANA corresponent al dia i a les seves hores.", "example": "Europe/Madrid" }, "date": { "type": "string", "format": "date", "description": "Avui en aquesta zona horària.", "example": "2026-10-30" }, "current_hour": { "type": "integer", "minimum": 0, "maximum": 23, "description": "L'hora local que és ara.", "example": 14 }, "previous_date": { "type": "string", "format": "date", "description": "El dia de comparació: el mateix dia de la setmana una setmana abans.", "example": "2026-10-23" }, "hours": { "type": "array", "items": { "type": "integer", "minimum": 0 }, "minItems": 24, "maxItems": 24, "description": "Verificacions creades avui, per hora local a partir de les 00:00. Les hores que encara han de venir són 0." }, "previous_hours": { "type": "array", "items": { "type": "integer", "minimum": 0 }, "minItems": 24, "maxItems": 24, "description": "Verificacions creades el dia de comparació, per hora local a partir de les 00:00." }, "total": { "type": "integer", "minimum": 0, "description": "Verificacions creades avui fins ara.", "example": 165 }, "previous_total_so_far": { "type": "integer", "minimum": 0, "description": "Verificacions creades el dia de comparació fins a la mateixa hora local.", "example": 151 }, "outcomes": { "type": "object", "description": "De les verificacions d'avui, quantes estan aprovades, pendents en revisió i rebutjades ara mateix. La resta encara no ha finalitzat.", "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": "Una destinació del webhook tal com apareix a la configuració del webhook, sense mètriques de lliurament. `GET /v3/webhook/destinations/{destination_uuid}/` afegeix el seu resum de lliurament.", "required": [ "uuid", "label", "url", "enabled", "webhook_version", "secret_shared_key", "subscribed_events", "created_at", "updated_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID de la destinació." }, "label": { "type": "string", "maxLength": 255, "description": "Nom llegible per a humans." }, "url": { "type": "string", "format": "uri", "maxLength": 2000, "description": "Endpoint HTTPS on Didit envia els esdeveniments." }, "enabled": { "type": "boolean", "description": "`false` posa en pausa els lliuraments a aquesta destinació." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Versió del payload enviat a aquesta destinació." }, "secret_shared_key": { "type": "string", "description": "El secret de signatura d'aquesta destinació (token de 43 caràcters segur per a URL). Verifica cada webhook amb el secret de la destinació a la qual s'ha enviat. Les crides amb clau d'API sempre el reben complet; els usuaris de la consola sense `read:webhooks` reben una cadena buida." }, "subscribed_events": { "type": "array", "uniqueItems": true, "description": "Tipus d'esdeveniments lliurats a aquesta destinació. Buit quan la destinació es va crear sense esdeveniments, cas en què no rep res.", "items": { "$ref": "#/components/schemas/WebhookEvent" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "WebhookConfig": { "type": "object", "description": "Configuració de webhook a nivell d'aplicació, política de conservació i amfitrions de retorn de la cartera de Digital ID, amb totes les destinacions 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 nivell d'aplicació (heretada). Didit només hi fa enviaments mentre l'aplicació no tingui cap destinació activada, i en aquest cas només envia `status.updated` i `data.updated`. Cada creació, actualització o eliminació d'una destinació l'estableix a la URL de la destinació activada més antiga, o a `null` si no n'hi ha cap d'activada." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Versió del payload de la `webhook_url` heretada. Cada destinació té la seva pròpia `webhook_version`." }, "secret_shared_key": { "type": "string", "description": "Secret de signatura a nivell d'aplicació (token de 43 caràcters segur per a URL). Només signa els lliuraments a la `webhook_url` heretada; cada destinació signa amb la seva pròpia `secret_shared_key`. Els clients que cridin amb clau d'API sempre el reben complet; els usuaris de la consola sense `read:webhooks` reben una cadena buida." }, "capture_method": { "type": "string", "enum": [ "MOBILE", "MOBILE_AND_DESKTOP" ], "description": "Configuració antiga de l'aplicació. El flux de verificació no la llegeix: les opcions de captura es configuren per flux de treball." }, "data_retention_months": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 120, "description": "Finestra d'eliminació automàtica. Les sessions de verificació d'usuaris creades fa més d'aquest nombre de mesos (un mes compta com a 30 dies) s'eliminen automàticament, i aquesta eliminació és irreversible. `null` significa que les sessions no s'eliminen mai automàticament. Consulta [Conservació de dades](https://docs.didit.me/ca/console/data-retention)." }, "face_retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "Què passa amb l'embedding facial d'una sessió quan se suprimeix la sessió. `delete_with_session` (per defecte) el suprimeix amb la sessió. `retain_until_user_deleted` és la [conservació de la plantilla biomètrica](https://docs.didit.me/ca/console/data-retention#conservació-de-plantilles-biomètriques) opcional: una plantilla biomètrica sense imatges vinculada a l'usuari es gestiona per separat fins que finalitza el seu període de conservació, se suprimeix l'usuari o bé la purges." }, "face_retention_days": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 3650, "description": "Període de conservació de dades, en dies, de les plantilles biomètriques sota `retain_until_user_deleted`. Obligatori quan s'estableix aquesta política." }, "biometric_consent_mode": { "type": "string", "enum": [ "auto", "always", "never" ], "description": "Quan el flux allotjat i els SDK natius demanen a la persona el consentiment biomètric explícit abans d'una captura facial. `auto` (per defecte) només el demana quan s'aplica un activador: un estat declarat, la IP de la persona o l'emissor del document d'identitat es troba a Illinois, Texas o Colorado, o la persona sembla ser als EUA sense un estat conegut. `always` el demana a cada persona el flux de treball de la qual captura una cara. `never` no mostra mai el pas, i recopiles el consentiment pel teu compte abans de la selfie. Cada canvi es registra al registre d'auditoria. Consulta [Consentiment biomètric](https://docs.didit.me/ca/getting-started/biometric-consent)." }, "available_events": { "type": "array", "description": "Tots els tipus d'esdeveniments als quals es pot subscriure una destinació, amb una etiqueta que es mostra.", "items": { "type": "object", "required": [ "value", "label" ], "properties": { "value": { "$ref": "#/components/schemas/WebhookEvent" }, "label": { "type": "string", "description": "Etiqueta visible, per exemple `Session status updated`." } } } }, "allowed_return_hosts": { "type": "array", "maxItems": 20, "description": "Noms d'amfitrió (coincidència exacta, només HTTPS) als quals una verificació independent de cartera de Digital ID pot retornar l'usuari amb el seu `return_url`. El teu domini de marca blanca també està permès sempre. Consulta [Registra la teva destinació de retorn](https://docs.didit.me/ca/standalone-apis/digital-id-wallets#registra-la-teva-destinació-de-retorn).", "items": { "type": "string", "maxLength": 253 } }, "endpoints": { "type": "array", "description": "Totes les destinacions del webhook de l'aplicació, de la més antiga a la més recent, cadascuna amb el seu secret de signatura. Aquí només es poden consultar: gestiona les destinacions amb els endpoints `/v3/webhook/destinations/`.", "items": { "$ref": "#/components/schemas/WebhookConfigDestination" } }, "allowed_domains": { "type": "array", "maxItems": 50, "items": { "type": "string", "maxLength": 300 }, "description": "Orígens (per exemple `https://app.example.com`; `http` només per a `localhost`) on es pot incrustar el flux de verificació allotjat i als quals es pot redirigir l'usuari amb un callback de sessió. Les crides de servidor a servidor no es veuen afectades. Una llista buida significa sense restriccions. Didit emmagatzema cada origen en minúscules sense cap port per defecte. Una entrada no vàlida falla amb `400` a `allowed_domains`.", "example": [ "https://app.example.com" ] } } }, "WebhookDestinationDelivery": { "type": "object", "description": "Un intent de lliurament a una destinació del webhook. El primer enviament d'un esdeveniment, cada reintent automàtic i cada reenviament són lliuraments independents.", "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 lliurament, per a les crides de detall i de reenviament." }, "session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Sessió de verificació d'usuaris a la qual fa referència l'esdeveniment. `null` per a esdeveniments de sessió d'empresa, usuari, empresa, transacció, Travel Rule i flux de treball." }, "request_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL a la qual s'ha enviat el lliurament: la URL de la destinació quan s'ha generat l'esdeveniment." }, "response_status": { "type": "integer", "nullable": true, "description": "Estat HTTP que ha retornat el teu endpoint. `null` mentre el lliurament està a la cua i encara no s'ha intentat. Quan no s'ha rebut cap resposta HTTP, Didit registra un estat propi: `504` quan el teu endpoint no ha respost en 5 segons, `503` per una fallada de connexió, `400` quan l'URL s'ha rebutjat per no ser segura (per exemple una adreça privada o interna), i `404` per a qualsevol altre error de sol·licitud. Un valor de `400` o superior compta com a lliurament fallit." }, "response_time_ms": { "type": "integer", "nullable": true, "minimum": 0, "description": "Temps que ha trigat l'intent, en mil·lisegons. `null` mentre el lliurament estigui a la cua." }, "status": { "type": "string", "nullable": true, "description": "Estat que l'esdeveniment va indicar quan es va generar: l'estat de la sessió per a esdeveniments de sessió (per exemple `Approved` o `In Review`), l'estat de la persona o l'empresa per a esdeveniments d'usuari i d'empresa, i l'estat de la transacció per a esdeveniments de transacció. `null` per a esdeveniments que no inclouen cap estat." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "created_at": { "type": "string", "format": "date-time", "description": "Quan es va crear el lliurament." } } }, "WebhookDestinationDeliveryDetail": { "type": "object", "description": "Un intent de lliurament a una destinació del webhook, amb les capçaleres i el cos exactes de la sol·licitud que Didit va enviar.", "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 lliurament, per a les crides de detall i de reenviament." }, "session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Sessió de verificació d'usuaris a la qual fa referència l'esdeveniment. `null` per a esdeveniments de sessió d'empresa, usuari, empresa, transacció, Travel Rule i flux de treball." }, "request_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL a la qual s'ha enviat el lliurament: la URL de la destinació quan s'ha generat l'esdeveniment." }, "response_status": { "type": "integer", "nullable": true, "description": "Estat HTTP que ha retornat el teu endpoint. `null` mentre el lliurament està a la cua i encara no s'ha intentat. Quan no s'ha rebut cap resposta HTTP, Didit registra un estat propi: `504` quan el teu endpoint no ha respost en 5 segons, `503` per una fallada de connexió, `400` quan l'URL s'ha rebutjat per no ser segura (per exemple una adreça privada o interna), i `404` per a qualsevol altre error de sol·licitud. Un valor de `400` o superior compta com a lliurament fallit." }, "response_time_ms": { "type": "integer", "nullable": true, "minimum": 0, "description": "Temps que ha trigat l'intent, en mil·lisegons. `null` mentre el lliurament estigui a la cua." }, "status": { "type": "string", "nullable": true, "description": "Estat que l'esdeveniment va indicar quan es va generar: l'estat de la sessió per a esdeveniments de sessió (per exemple `Approved` o `In Review`), l'estat de la persona o l'empresa per a esdeveniments d'usuari i d'empresa, i l'estat de la transacció per a esdeveniments de transacció. `null` per a esdeveniments que no inclouen cap estat." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "created_at": { "type": "string", "format": "date-time", "description": "Quan es va crear el lliurament." }, "request_header": { "type": "string", "description": "Text JSON (una cadena) de les capçaleres de sol·licitud que Didit ha enviat: `Content-Type`, `X-Signature`, `X-Signature-V2`, `X-Signature-Simple`, `X-Timestamp` i `User-Agent`. Analitza'l amb un analitzador de JSON. Conté signatures, mai el secret de signatura." }, "request_body": { "type": "string", "description": "Text JSON (una cadena) del payload exacte que Didit ha enviat, claus ordenades, incloent-hi `event_id` i `timestamp`. Analitza'l amb un analitzador de JSON; consulta [Forma del payload](https://docs.didit.me/ca/integration/webhooks#forma-del-payload). Per a una clau amb àmbit sense `media: read`, els URL de mitjans del seu interior són `null`; sense `sessions: write`, els tokens de sessió i els enllaços de verificació allotjats són `null`. Un cos modificat d'aquesta manera ja no coincideix amb les seves signatures. Didit no enregistra el cos de la resposta que ha retornat el teu endpoint." } } }, "SessionWebhookDelivery": { "type": "object", "description": "Un intent de lliurament de webhook registrat per a una sessió de verificació, amb les capçaleres i el cos exactes de la sol·licitud que Didit va enviar.", "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 lliurament. Utilitza'l com a `{webhook_uuid}` per obtenir o reenviar aquest lliurament." }, "session_id": { "type": "string", "format": "uuid", "description": "La sessió a la qual pertany el lliurament (la sessió a la ruta)." }, "request_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL a la qual s'ha enviat el lliurament." }, "response_status": { "type": "integer", "nullable": true, "description": "Estat HTTP que ha retornat el teu endpoint. `null` mentre el lliurament està a la cua i encara no s'ha intentat. Quan no s'ha rebut cap resposta HTTP, Didit registra un estat propi: `504` quan el teu endpoint no ha respost en 5 segons, `503` per una fallada de connexió, `400` quan l'URL s'ha rebutjat per no ser segura (per exemple una adreça privada o interna), i `404` per a qualsevol altre error de sol·licitud. Un valor de `400` o superior compta com a lliurament fallit." }, "status": { "type": "string", "nullable": true, "description": "Estat de la sessió quan es va generar l'esdeveniment, per exemple `In Progress`, `Approved` o `Declined`." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "request_header": { "type": "string", "description": "Text JSON (una cadena) de les capçaleres de sol·licitud que Didit ha enviat: `Content-Type`, `X-Signature`, `X-Signature-V2`, `X-Signature-Simple`, `X-Timestamp` i `User-Agent`. Analitza'l amb un analitzador de JSON. Conté signatures, mai el secret de signatura." }, "request_body": { "type": "string", "description": "Text JSON (una cadena) del payload exacte que Didit ha enviat, claus ordenades, incloent-hi `event_id` i `timestamp`. Analitza'l amb un analitzador de JSON; consulta [Forma del payload](https://docs.didit.me/ca/integration/webhooks#forma-del-payload). Per a una clau amb àmbit sense `media: read`, els URL de mitjans del seu interior són `null`; sense `sessions: write`, els tokens de sessió i els enllaços de verificació allotjats són `null`. Un cos modificat d'aquesta manera ja no coincideix amb les seves signatures. Didit no enregistra el cos de la resposta que ha retornat el teu endpoint." }, "created_at": { "type": "string", "format": "date-time", "description": "Quan es va crear el lliurament." } } }, "SessionEvent": { "type": "object", "description": "Una entrada de la línia temporal d'esdeveniments d'una sessió de verificació.", "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 de l'esdeveniment." }, "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è ha passat. Notificat pel dispositiu durant el flux allotjat o l'SDK: `LINK_OPENED`, `STEP_RENDERED`, `BUTTON_CLICKED`, `FORM_SUBMITTED`, `FILE_UPLOADED`, `ATTEMPT_FAILED` i `LOG` (depuració). Enregistrat pel 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` i `WORKFLOW_STATUS_NODE_REACHED` (la traça d'encaminament del flux de treball). `SESSION_COMPLETED`, `NOTE_ADDED` i `MANUAL_REVIEW_STARTED` poden aparèixer en sessions més antigues." }, "created_at": { "type": "string", "format": "date-time", "description": "Quan Didit ha emmagatzemat l'esdeveniment. Els esdeveniments s'emmagatzemen de manera asíncrona, uns segons després de `sent_at`." }, "component": { "type": "string", "nullable": true, "description": "Component de la interfície d'usuari que ha informat de l'esdeveniment (només esdeveniments de dispositiu)." }, "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": "Funcionalitat de verificació en què es trobava la sessió quan es va produir l'esdeveniment." }, "step": { "type": "string", "nullable": true, "description": "Pantalla dins de la funcionalitat, per exemple `DOCUMENT_CAPTURE_FRONT` o `FACE_PASSIVE_LIVENESS`." }, "details": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Dades específiques de l'esdeveniment. Les claus depenen d'`event_type`." }, "ip_address": { "type": "string", "nullable": true, "description": "Adreça IP des de la qual el dispositiu ha informat de l'esdeveniment. `null` per a esdeveniments registrats pel servidor." }, "user_agent": { "type": "string", "nullable": true, "description": "Agent d'usuari del dispositiu. `null` per a esdeveniments registrats pel servidor." }, "device_info": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Detalls del dispositiu informats per l'SDK o el navegador." }, "file_url": { "type": "string", "format": "uri", "nullable": true, "description": "Enllaç presignat de curta durada a un fitxer adjunt a l'esdeveniment (per exemple, una imatge capturada). `null` quan no n'hi ha cap, i sempre `null` per a una clau d'API d'abast limitat sense `media: read`." }, "sent_at": { "type": "integer", "format": "int64", "description": "Quan va ocórrer l'esdeveniment, com a marca de temps Unix en mil·lisegons. Els resultats s'ordenen per aquest valor." } } }, "AMLDatasetSourceFreshness": { "type": "object", "description": "Grau d'actualització d'una família de conjunts de dades d'AML.", "required": [ "last_updated_at", "oldest_updated_at", "dataset_count", "dated_dataset_count" ], "properties": { "last_updated_at": { "type": "string", "format": "date-time", "description": "Actualització més recent de qualsevol conjunt de dades de la família." }, "oldest_updated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Límit d'antiguitat: tots els conjunts de dades de la família estan com a mínim així d'actualitzats. `null` quan almenys un conjunt de dades de la família no ha informat de cap data d'actualització, ja que en aquest cas el límit és desconegut." }, "dataset_count": { "type": "integer", "description": "Nombre de conjunts de dades a la família." }, "dated_dataset_count": { "type": "integer", "description": "Nombre d'aquests conjunts de dades que han informat d'una data d'actualització." } } }, "AMLDatasetFreshness": { "type": "object", "description": "Com d'actualitzats estaven els conjunts de dades AML quan es va executar un cribratge. Les dates no s'estimen mai.", "required": [ "captured_at", "provider", "catalog_version", "sources" ], "properties": { "captured_at": { "type": "string", "format": "date-time", "description": "Quan Didit ha llegit el catàleg de conjunts de dades d'on prové aquesta frescor de les dades." }, "provider": { "type": "string", "description": "Identificador opac de la font de dades d'AML. Tracta'l com una cadena opaca; no hi facis bifurcacions.", "example": "aml_data_source" }, "catalog_version": { "type": "string", "nullable": true, "description": "Identificador de versió del catàleg de conjunts de dades, quan la font en reporta un." }, "sources": { "type": "object", "description": "Grau d'actualització per família de conjunts de dades. Si els conjunts de dades d'una família no han informat de cap data d'actualització, s'omet en lloc d'omplir-se amb `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 nou cribratge completat de monitoratge continu d'una comprovació 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 d'aquesta execució de cribratge." }, "run_id": { "type": "string", "format": "uuid", "description": "L'execució de monitoratge a la qual pertany aquest cribratge. Totes les verificacions sotmeses a cribratge en la mateixa execució la comparteixen." }, "completed_at": { "type": "string", "format": "date-time", "description": "Quan va finalitzar el recribratge d'aquest subjecte. Els resultats s'ordenen segons aquest valor, primer els més recents." }, "started_at": { "type": "string", "format": "date-time", "description": "Quan va començar el lot de monitoratge al qual pertany aquest recribratge." }, "outcome": { "type": "string", "enum": [ "NO_CHANGE", "CHANGED", "FAILED" ], "description": "`NO_CHANGE`: completat i el resultat no ha variat. `CHANGED`: completat i la puntuació, l'estat, el recompte de coincidències o les coincidències han canviat. `FAILED`: cap resposta utilitzable per a aquest subjecte, de manera que la comprovació s'ha deixat tal com estava." }, "trigger": { "type": "string", "enum": [ "ONGOING_MONITORING" ], "description": "Què va iniciar el cribratge. Sempre `ONGOING_MONITORING` actualment." }, "provider": { "type": "string", "description": "Identificador opac de la font de dades d'AML que ha respost. Tracta'l com una cadena opaca; no hi facis bifurcacions.", "example": "aml_data_source" }, "status": { "type": "string", "nullable": true, "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested", null ], "description": "Estat de la comprovació AML en què ha quedat la comprovació després d'aquesta execució." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Puntuació AML amb què ha quedat la comprovació després d'aquesta execució." }, "total_hits": { "type": "integer", "nullable": true, "description": "Nombre de coincidències que aquesta execució ha deixat a la comprovació." }, "new_hits": { "type": "integer", "nullable": true, "description": "Nombre de coincidències que ha trobat aquesta execució i que la comprovació no tenia abans. `0` quan no s'ha trobat res nou; `null` quan l'execució ha fallat o s'ha registrat abans que existís aquest recompte." }, "entities_screened": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Nombre d'entitats que aquesta execució ha analitzat per a la verificació: `1` quan s'ha analitzat el subjecte, `0` quan l'execució ha fallat." }, "dataset_freshness": { "allOf": [ { "$ref": "#/components/schemas/AMLDatasetFreshness" } ], "nullable": true, "description": "Actualitat del conjunt de dades en què es basa aquesta execució, o `null` quan no hi havia dates disponibles." } } }, "KYBKeyPeopleParty": { "type": "object", "description": "Una part de persones clau d'una sessió de Verificació d'empreses (KYB), amb la seva verificació dependent. La mateixa part apareix a `key_people_checks[].submitted.parties[]` de la decisió de la sessió d'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 part." }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Si la part és una persona física o una empresa." }, "source": { "type": "string", "enum": [ "REGISTRY", "USER" ], "description": "`REGISTRY`: obtingut del registre mercantil. `USER`: introduït a la pantalla Persones clau." }, "name": { "type": "string", "description": "Nom visible de la part." }, "first_name": { "type": "string", "nullable": true, "description": "Nom de pila (persones)." }, "last_name": { "type": "string", "nullable": true, "description": "Cognom (persones físiques)." }, "company_name": { "type": "string", "nullable": true, "description": "Nom de l'empresa (parts empresarials)." }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registre de l'empresa (parts empresarials)." }, "email": { "type": "string", "format": "email", "nullable": true, "description": "Correu electrònic al qual s'envia l'enllaç de verificació." }, "nationality": { "type": "string", "nullable": true, "description": "Nacionalitat per a persones, país de constitució per a empreses." }, "phone_number": { "type": "string", "nullable": true, "description": "Número de telèfon recollit per a la part." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Data de naixement (persones)." }, "position": { "type": "string", "nullable": true, "description": "Càrrec de text lliure (per a persones)." }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Camps personalitzats definits pel flux de treball i recollits per a la part, indexats per clau de camp." }, "is_active": { "type": "boolean", "description": "Si la part està activa." }, "is_skipped": { "type": "boolean", "description": "Si la part està exempta de verificació. En regenerar-la, s'esborra." }, "requires_verification": { "type": "boolean", "description": "Si les regles de rol i titularitat requereixen una verificació per a aquesta part." }, "roles": { "type": "array", "description": "Rols que té la part a l'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": "Codi de rol." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Percentatge de titularitat d'aquest rol, quan es conegui." }, "voting_percent": { "type": "number", "nullable": true, "description": "Percentatge de drets de vot per a aquest rol, quan es coneix." } } } }, "kyc_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Sessió KYC individual filla (persones físiques)." }, "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": "Estat de la sessió KYC filla. Una sessió eliminada manté l'estat que tenia quan es va eliminar." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "Enllaç allotjat de la sessió de KYC filla. `null` quan no n'hi ha cap o s'ha suprimit, i per a una clau d'API amb àmbit restringit sense `sessions: write`." }, "kyc_session_deleted": { "type": "boolean", "description": "La sessió fill de KYC s'ha suprimit, de manera que no es podrà liquidar mai." }, "kyb_sub_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Sessió KYB filla (parts d'empresa)." }, "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": "Estat de la sessió KYB filla." }, "kyb_sub_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "Enllaç allotjat de la sessió de KYB filla, amb les mateixes regles de `null` que `kyc_session_url`." }, "kyb_sub_session_deleted": { "type": "boolean", "description": "Homòleg per a empreses de `kyc_session_deleted`." }, "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": "Tipus del flux de treball que executa la sessió filla." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Flux de treball que executa la sessió filla." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Etiqueta d'aquest flux de treball." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Funcionalitats del flux de treball de la sessió filla amb els seus estats actuals.", "items": { "type": "object", "required": [ "feature", "status" ], "properties": { "feature": { "type": "string", "description": "Codi de la funcionalitat, per exemple `ID_VERIFICATION` o `LIVENESS`." }, "status": { "type": "string", "description": "Estat de la funcionalitat, `Not Finished` fins que s'executa." } } } }, "didit_internal_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Identificador de Didit de la persona verificada, un cop conegut." } } }, "TravelRuleDelivery": { "type": "object", "description": "Estat en què es troba l'últim missatge que la transferència deu a l'altra part. Didit contacta amb la contrapart un cop retornada la sol·licitud que ha creat o modificat la transferència, de manera que aquest objecte indica si el missatge s'ha lliurat: en cua, enviant-se, esperant per reintentar després d'un error, lliurat o fallit. Una fallada de la qual la xarxa encara es pot recuperar (sense resposta a temps, connexió fallida, HTTP `408`, `429` o `5xx`) es reintenta al cap de 30 segons, 2 minuts, 10 minuts, 30 minuts i 1 hora. Quan un primer missatge (`kind: SEND`) falla definitivament, perquè la xarxa l'ha rebutjat o perquè el sisè intent també ha fallat, la transferència passa a `COUNTERPARTY_VASP_NOT_REACHABLE` amb `last_error` a la seva `timeline`; qualsevol altre missatge que falli definitivament s'anota a la `timeline`. L'`status` de la transferència continua sent la font de referència de l'intercanvi en si.", "required": [ "kind", "status", "rail", "attempts", "last_error", "next_attempt_at", "delivered_at" ], "properties": { "kind": { "type": "string", "enum": [ "SEND", "ANSWER", "TXID", "CANCEL", "POLL" ], "description": "Què transmet el missatge. `SEND`: el primer missatge de la transferència a la contrapart (sortint; el canal es tria quan s'envia). `ANSWER`: la teva acceptació o rebuig, que es deu a la xarxa que ho ha sol·licitat (entrant). `TXID`: el hash de la transacció on-chain, un cop finalitzis la transferència. `CANCEL`: la cancel·lació, un cop la cancel·lis. `POLL`: una consulta d'estat a una xarxa que n'ofereixi una, repetida cada 5 minuts mentre la transferència espera la contrapart." }, "status": { "type": "string", "enum": [ "QUEUED", "SENDING", "RETRYING", "DELIVERED", "FAILED" ], "description": "`QUEUED`: esperant per enviar-se. `SENDING`: hi ha un intent en curs. `RETRYING`: un intent ha fallat i el següent s'executarà a `next_attempt_at`. `DELIVERED`: l'altra part ha rebut el missatge. `FAILED`: l'altra part l'ha rebutjat o el darrer intent ha fallat." }, "rail": { "type": "string", "enum": [ "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL", "" ], "description": "El rail que transporta el missatge. Buit fins que Didit n'hagi triat un per a un primer missatge." }, "attempts": { "type": "integer", "minimum": 0, "description": "Intents realitzats fins ara per a aquest missatge. Un missatge que no sigui un sondeig d'estat s'intenta com a màxim 6 vegades." }, "last_error": { "type": "string", "description": "El tipus d'error que ha afectat l'últim intent, `\"\"` quan no n'hi ha hagut cap: per exemple `email undeliverable`, `trp identity endpoint unreachable` o `trp transfer inquiry delivery failed`. Mai no conté la resposta de la contrapart mateixa, que roman al `timeline` de la transferència.\nQuan GTR respon amb un error, s'hi inclouen el seu propi codi d'estat i missatge. Els cossos de resposta no s'inclouen mai.", "example": "email undeliverable" }, "next_attempt_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan s'executa el següent intent mentre el missatge està en estat `QUEUED` o `RETRYING`." }, "delivered_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan l'altra part va rebre el missatge." } } }, "TravelRuleDiscoveryStep": { "type": "object", "description": "Un pas de la detecció de la contrapart que Didit ha executat per a una transferència sortint, en l'ordre en què els ha executat. El primer pas que anomena un VASP amb una ruta finalitza la cadena.", "properties": { "step": { "type": "string", "enum": [ "internal_address_book", "wallet_attribution", "network_lookup", "customer_hint", "end_user" ], "description": "`internal_address_book`: un altre client de Didit que ha demostrat el control de la cartera de destinació. `wallet_attribution`: l'atribució d'analítica blockchain de la cartera. `network_lookup`: una xarxa que pot indicar quin VASP té l'adreça. `customer_hint`: el nom del VASP, LEI o jurisdicció que has enviat a `beneficiary_data`. `end_user`: la contrapart que l'usuari final (o tu) ha triat, o la sol·licitud per triar-ne una." }, "outcome": { "type": "string", "enum": [ "match", "miss", "skipped" ], "description": "`match`: el pas ha indicat una contrapart. `miss`: s'ha executat i no n'ha trobat cap. `skipped`: no s'ha pogut executar, i `reason` n'explica el motiu." }, "reason": { "type": "string", "description": "Motiu llegible per màquina, `\"\"` en cas de coincidència: `no_proven_internal_wallet`, `attribution_disabled`, `already_attributed`, `no_attributed_entity`, `directory_match_no_route`, `gtr_address_lookup_runs_on_dispatch`, `no_membership`, `network_switched_off`, `no_network_address_lookup`, `no_directory_match`, `awaiting_end_user` o `picked_member_without_proven_wallet`." }, "vasp": { "type": "string", "format": "uuid", "nullable": true, "description": "El VASP del directori que ha indicat el pas, si n'ha indicat algun." }, "rail": { "type": "string", "nullable": true, "description": "El rail que arriba a aquesta contrapart, quan el pas n'ha trobat un." }, "at": { "type": "string", "format": "date-time" } } }, "TravelRuleNextAction": { "type": "object", "description": "Un element que fa avançar una transferència `COUNTERPARTY_VASP_NOT_FOUND` o `COUNTERPARTY_VASP_NOT_REACHABLE`. Consulta [Per què una transferència està bloquejada](/ca/transaction-monitoring/travel-rule#per-què-una-transferència-està-bloquejada).", "properties": { "action": { "type": "string", "enum": [ "select_counterparty_vasp", "declare_self_hosted", "add_vasp_hint", "update_compliance_email", "resend" ], "description": "`select_counterparty_vasp`: l'usuari final tria el VASP de destinació al widget de titularitat de la cartera, o fas un PATCH amb `action=beneficiary_vasp`. `declare_self_hosted`: l'usuari final declara que la cartera és autoallotjada al widget. `add_vasp_hint`: indica a Didit qui és la contrapart, amb un nom de VASP, LEI o Travel Address (per exemple, un `travel_address` a l'entrada de la llibreta d'adreces de la cartera de destinació), i després torna a enviar. `update_compliance_email` i `resend` són valors d'`action` de `PATCH /v3/transactions/{transaction_id}/travel-rule/`: torna a proporcionar el correu electrònic de compliment de la contrapart i torna a executar l'encaminament." }, "url": { "type": "string", "format": "uri", "description": "L'enllaç del widget de titularitat de la cartera, a `select_counterparty_vasp` i `declare_self_hosted` mentre la transferència té una sessió de widget oberta." } }, "required": [ "action" ] }, "TransactionTravelRule": { "type": "object", "description": "Una transferència Travel Rule d'una transacció, tal com la retornen `GET /v3/transactions/{transaction_id}/`, el `201` de `POST /v3/transactions/` i cada fila de `GET /v3/transactions/`. `direction`, `rail`, `counterparty_vasp`, `delivery`, `discovery`, `reason` i `next_actions` tenen la mateixa estructura que a `PATCH /v3/transactions/{transaction_id}/travel-rule/`, de manera que una lectura d'una transacció indica per què la seva transferència està bloquejada i què cal per fer-la avançar.", "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": "Part ordenant. Per a una transferència entrant, els valors de la contrapart s'emmascaren fins que se'n confirmi la titularitat." }, "beneficiary_data": { "type": "object", "description": "Part beneficiària. Per a una transferència entrant, els valors de la contrapart s'emmascaren fins que es confirmi la titularitat." }, "name_match": { "type": "object", "nullable": true, "description": "La comparació de noms que ha decidit la transferència (puntuació i estrictesa). Null fins que se n'hagi executat una. Els noms comparats s'emmascaren juntament amb les parts." }, "data_match": { "$ref": "#/components/schemas/TravelRuleDataMatch" }, "mismatched_fields": { "type": "array", "items": { "type": "string" }, "description": "Drecera per a `data_match.mismatched_fields`. Buit quan no hi ha cap diferència." }, "data_unmasked": { "$ref": "#/components/schemas/TravelRuleDataUnmasked" }, "data_masked": { "type": "boolean", "description": "Cert mentre les dades personals de la contrapart estiguin emmascarades en aquesta resposta." }, "metadata": { "type": "object" }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "A quin costat de l'intercanvi pertany aquesta transferència." }, "rail": { "type": "string", "nullable": true, "description": "El rail pel qual s'ha enviat la transferència: `INTERNAL`, `TRP`, `GTR`, `TRUST`, `VERIFYVASP`, `SYGNA` o `EMAIL` (`TEST_VASP` en una aplicació de sandbox, quan el Didit Test VASP ha respost), o `null` fins que es triï un rail." }, "counterparty_vasp": { "type": "object", "nullable": true, "properties": { "name": { "type": "string" }, "lei": { "type": "string" }, "dd_score": { "type": "integer", "description": "Puntuació de diligència deguda de 0 a 100, on un valor més alt és millor. La mateixa escala que al directori de VASP." }, "dd_score_breakdown": { "type": "object", "description": "Contribucions per component a dd_score, un objecte per component tal com apareix al directori de VASP (jurisdiction, verification, protocol, lei, history, essentials, responsiveness), cadascun amb {points, max, reason, detail}. {} fins que s'hagi avaluat la contrapart.", "additionalProperties": { "type": "object", "properties": { "points": { "type": "number", "description": "Punts atorgats per a aquest component." }, "max": { "type": "integer", "description": "Nombre màxim de punts que pot atorgar aquest component." }, "reason": { "type": "string", "description": "Codi llegible per màquina del veredicte del component." }, "detail": { "type": "string", "description": "Motiu dels punts atorgats, llegible per a humans." } } } }, "dd_assessed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va executar per darrera vegada l'avaluació de diligència deguda. Null fins que s'hagi avaluat la contrapart." } }, "description": "L'entrada del directori de la contrapart, o `null` si la transferència no n'enllaça cap." }, "delivery": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TravelRuleDelivery" } ], "description": "El missatge més recent que la transferència deu a una altra part. `null` quan no n'ha degut cap, per exemple per sota de `threshold_amount` o per a una cartera autoallotjada declarada." }, "discovery": { "type": "array", "description": "Com Didit ha cercat la contrapart, una entrada per cada pas que s'ha executat. Buit quan no s'ha executat cap descobriment, per exemple en una transferència entrant.", "items": { "$ref": "#/components/schemas/TravelRuleDiscoveryStep" } }, "reason": { "type": "string", "description": "Per què una transferència `COUNTERPARTY_VASP_NOT_FOUND` o `COUNTERPARTY_VASP_NOT_REACHABLE` està encallada; `\"\"` per a qualsevol altre estat. Un lliurament fallit ho determina primer, només a `COUNTERPARTY_VASP_NOT_REACHABLE`: `email_undeliverable` (el proveïdor de correu ha refusat el correu electrònic de compliment i no queda cap adreça per provar: quan s'ha enviat, en un recordatori o com un rebot permanent notificat més tard) o `delivery_failed` (el canal que l'estava lliurant ha fallat definitivament: un canal de xarxa ha refusat el missatge o s'ha quedat sense reintents, un host d'identitat `TRP` no ha respost o l'host `TRP` de la contrapart no ha acceptat la consulta). En cas contrari, el rastreig de `discovery` ho determina: `awaiting_end_user` (cap pas ha indicat una contrapart a la qual Didit pugui arribar), `directory_match_no_route` (un pas ha indicat un VASP del directori que no té ruta), `picked_member_without_proven_wallet` (l'usuari final ha triat un client de Didit que no ha demostrat el control de la cartera) o `no_directory_match` quan el rastreig no dóna cap altre motiu. Un reenviament fa avançar la transferència, de manera que el motiu s'esborra. Consulta [Per què una transferència està encallada](/ca/transaction-monitoring/travel-rule#per-què-una-transferència-està-bloquejada)." }, "next_actions": { "type": "array", "description": "Què fa avançar la transferència; `[]` per a qualsevol estat excepte `COUNTERPARTY_VASP_NOT_FOUND` o `COUNTERPARTY_VASP_NOT_REACHABLE`. `email_undeliverable` ofereix `update_compliance_email` i després `resend`. `delivery_failed` ofereix `resend`. Un motiu de descobriment ofereix `select_counterparty_vasp`, `declare_self_hosted`, `add_vasp_hint` i `resend`.", "items": { "$ref": "#/components/schemas/TravelRuleNextAction" } }, "chain_details": { "$ref": "#/components/schemas/TravelRuleChainDetails" } } }, "NetworkListCounts": { "type": "object", "description": "Recomptes de xarxes per a les visualitzacions i les opcions de filtre de la llista, comptant cada xarxa una sola vegada. Només es retorna quan `summary` no és `false`. `scopes` compta totes les xarxes visibles per a l'aplicació. `views` compta les xarxes visibles dins del `scope` seleccionat. `facets` compta les xarxes a la visualització de `scope` i `status` seleccionada (les xarxes descartades s'exclouen tret que `status` les inclogui). La resta de filtres de la llista no modifiquen aquests recomptes.", "properties": { "scopes": { "type": "object", "description": "Xarxes visibles per producte.", "properties": { "all": { "type": "integer" }, "identity": { "type": "integer", "description": "Tota la resta de xarxes." }, "transactions": { "type": "integer", "description": "Xarxes els membres de les quals són tots parts de la transacció." } } }, "views": { "type": "object", "description": "Xarxes visibles dins del `scope` seleccionat, per estat, més dues visualitzacions desades.", "properties": { "all": { "type": "integer" }, "active": { "type": "integer" }, "in_review": { "type": "integer" }, "resolved": { "type": "integer" }, "dismissed": { "type": "integer" }, "mine": { "type": "integer", "description": "Xarxes assignades al membre de la consola que fa la crida. Sempre és 0 per a una clau d'API." }, "high_risk": { "type": "integer", "description": "Xarxes amb una puntuació de risc de 80 o més que no s'han descartat." } } }, "facets": { "type": "object", "description": "Recomptes per a cada opció de filtre, dins del `scope` i de la visualització d'estat seleccionats.", "properties": { "total": { "type": "integer", "description": "Xarxes a la visualització de `scope` i estat seleccionada." }, "last_activity_days": { "type": "object", "description": "Xarxes amb activitat en els darrers 7, 30 i 90 dies, indexades pel nombre de dies.", "properties": { "7": { "type": "integer" }, "30": { "type": "integer" }, "90": { "type": "integer" } } }, "risk_min": { "type": "object", "description": "Xarxes amb una puntuació de risc d'almenys 50 i almenys 80, indexades pel llindar.", "properties": { "50": { "type": "integer" }, "80": { "type": "integer" } } }, "signal_types": { "type": "object", "description": "Xarxes amb almenys un senyal de cada tipus.", "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": "Xarxes per prioritat. `none` compta les xarxes sense prioritat.", "properties": { "low": { "type": "integer" }, "medium": { "type": "integer" }, "high": { "type": "integer" }, "none": { "type": "integer" } } }, "assignee": { "type": "object", "description": "Xarxes per persona assignada.", "properties": { "me": { "type": "integer", "description": "Assignat al membre de la consola que fa la crida. Sempre és 0 per a una clau d'API." }, "unassigned": { "type": "integer", "description": "No assignat a ningú." }, "users": { "type": "array", "description": "Una entrada per persona assignada, primer les que tenen més xarxes.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "full_name": { "type": "string", "description": "El nom de la persona assignada, o el seu correu electrònic quan no s'ha definit cap nom." }, "email": { "type": "string" }, "count": { "type": "integer" } } } } } }, "has_case": { "type": "integer", "description": "Xarxes per a les quals aquesta aplicació ha obert un cas." }, "min_size": { "type": "object", "description": "Xarxes amb almenys 10 membres, indexades per la mida mínima.", "properties": { "10": { "type": "integer" } } } } } } }, "NetworkTag": { "type": "object", "description": "Una de les etiquetes de la teva aplicació a la xarxa.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "L'UUID de l'etiqueta, el mateix valor que passes com a `tag_uuid`." }, "name": { "type": "string" }, "color": { "type": "string", "description": "Color hexadecimal, per exemple `#6366F1`." }, "source": { "type": "string", "enum": [ "didit", "custom" ], "description": "`didit` per a una etiqueta predefinida de Didit, `custom` per a una etiqueta que hagi creat el teu equip." }, "added_by": { "type": "string", "nullable": true, "description": "Correu electrònic del membre de la consola que ha afegit l'etiqueta. Null quan l'ha afegit una clau d'API." }, "added_at": { "type": "string", "format": "date-time" } } }, "NetworkOutcomes": { "type": "object", "description": "Estat en què es troben les persones i empreses de la xarxa. Cada membre que pots veure compta un cop, segons l'estat de la seva verificació més recent que hagi arribat a una decisió. Les parts de la transacció no es comptabilitzen.", "properties": { "approved": { "type": "integer", "description": "Membres la verificació decidida més recent dels quals ha estat aprovada." }, "declined": { "type": "integer", "description": "Membres la verificació decidida més recent dels quals ha estat rebutjada." }, "in_review": { "type": "integer", "description": "Membres la verificació decidida més recent dels quals està en revisió." }, "total": { "type": "integer", "description": "Membres amb almenys una verificació, decidida o no. Un membre amb totes les verificacions no decidides (no iniciades, en curs, caducades o abandonades) es compta aquí i en cap altra clau." } } }, "NetworkPatternScore": { "type": "object", "description": "Fins a quin punt s'assembla un tipus de dada entre els membres de tota la xarxa. Un patró no és un senyal: cap valor compartit no enllaça els membres.", "properties": { "type": { "type": "string", "enum": [ "background" ], "description": "`background`: la similitud mitjana de cada parell de fons de les selfies dels membres, emmascarant la persona. Llegeix la selfie més recent de cada persona, com a màxim les 50 més recents, i omet les sessions d'assegurament de l'edat. Cobreix tota la xarxa, no només els membres de les teves aplicacions." }, "score": { "type": "number", "nullable": true, "minimum": 0, "maximum": 1, "description": "De 0 a 1, arrodonit a 4 decimals. Null quan s'hagi definit `reason`." }, "members": { "type": "integer", "nullable": true, "description": "Quantes selfies de membres ha comparat la puntuació. Una selfie que no es pugui llegir o que mostri massa poc fons no es compara. Null mentre estigui en estat `computing`; 0 o 1 amb `not_enough_selfies`." }, "reason": { "type": "string", "enum": [ "computing", "not_enough_selfies" ], "nullable": true, "description": "Per què no hi ha puntuació. `computing`: s'està calculant la puntuació per als membres actuals; torna a llegir la xarxa més tard. `not_enough_selfies`: menys de dos membres tenen una selfie utilitzable. Null quan hi ha una puntuació." }, "computed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va calcular la puntuació. Null mentre estigui en estat `computing`." } } }, "NetworkDetailResponse": { "description": "El detall de la xarxa, a més del mode d'ús compartit de l'organització, si se li apliquen senyals interorganitzatius, les etiquetes de la teva aplicació a la xarxa, els resultats dels membres i les puntuacions de patrons.", "allOf": [ { "$ref": "#/components/schemas/NetworkDetail" }, { "type": "object", "properties": { "sharing_mode": { "type": "string", "enum": [ "off", "private", "global" ], "description": "El mode de compartició entre organitzacions de l'organització. Només `global` compara xarxes entre organitzacions; `private` i `off` les mantenen a l'historial propi de l'organització.", "example": "global" }, "cross_org_available": { "type": "boolean", "description": "Indica si els senyals entre organitzacions s'apliquen a aquesta organització. Necessiten tant el pla Enterprise com el mode de compartició `global`.", "example": true }, "cross_org_unavailable_reason": { "type": "string", "enum": [ "plan", "sharing_mode" ], "nullable": true, "description": "Per què no s'apliquen els senyals interorganitzacionals, comprovats en aquest ordre. `plan`: el pla de l'organització no inclou la xarxa de frau interorganitzacional (necessita el pla Enterprise), independentment del mode de compartició. `sharing_mode`: el pla la inclou, però el mode de compartició és `private` o `off`. Null quan `cross_org_available` és `true`.", "example": null }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTag" }, "description": "Les etiquetes de la teva aplicació a la xarxa, les més antigues primer. Cada aplicació només veu les seves pròpies etiquetes. `fraud_tags` és independent i no canvia: les etiquetes que porten els membres de la xarxa." }, "outcomes": { "$ref": "#/components/schemas/NetworkOutcomes" }, "patterns": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkPatternScore" }, "description": "Puntuacions de patrons a tota la xarxa. Actualment un element, `background`." } } } ] }, "NetworkTagRequest": { "type": "object", "required": [ "tag_uuid" ], "properties": { "tag_uuid": { "type": "string", "format": "uuid", "description": "UUID d'una de les etiquetes de la teva aplicació." } }, "example": { "tag_uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7" } }, "NetworkTimeline": { "title": "Default timeline (no contract)", "type": "object", "description": "Sense `contract`: els esdeveniments propis de la xarxa, primer els més antics, sense paginació.", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTimelineEvent" } } } }, "NetworkTimelinePage": { "title": "Typed timeline page (contract=2)", "type": "object", "description": "Amb `contract=2`: una pàgina d'esdeveniments tipats, els més recents primer.", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTypedTimelineEvent" } }, "next_cursor": { "type": "string", "nullable": true, "description": "Passa-ho com a `cursor` per llegir la pàgina següent. Null a l'última pàgina." } } }, "NetworkTypedTimelineEvent": { "type": "object", "description": "Un esdeveniment tipat de la línia temporal: els quatre camps per defecte, més el seu identificador, quan Didit el va emmagatzemar, el compte de membre i el registre al qual pertany, i el bloc de detalls del seu tipus d'esdeveniment. La resta de blocs de detalls són null.", "properties": { "id": { "type": "string", "description": "`:`, únic dins de la cronologia.", "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": "Quan va ocórrer." }, "ingested_at": { "type": "string", "format": "date-time", "description": "Quan Didit ho ha emmagatzemat." }, "label": { "type": "string", "description": "Una etiqueta curta en anglès, per exemple `Verification attempt 2 of 3`." }, "metadata": { "type": "object", "description": "Per als esdeveniments propis de la xarxa, les mateixes metadades que la línia de temps per defecte. Buit en cas contrari." }, "account": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineAccount" } ], "nullable": true, "description": "El compte de membre. Null per als esdeveniments propis de la xarxa, `case_linked` i `note_added`." }, "source_ref": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineSourceRef" } ], "nullable": true, "description": "El registre d'origen. Null per als esdeveniments propis de la xarxa i per a `note_added`." }, "verification_attempt": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineAttempt" } ], "nullable": true, "description": "Establert en esdeveniments `verification_attempt`." }, "transaction": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineTransaction" } ], "nullable": true, "description": "Establert en esdeveniments `transaction`." }, "login": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineLogin" } ], "nullable": true, "description": "Establert en esdeveniments `login`." }, "rule_hit": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineRuleHit" } ], "nullable": true, "description": "Establert en esdeveniments `rule_hit`." }, "case_linked": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineCaseLinked" } ], "nullable": true, "description": "Establert en esdeveniments `case_linked`." }, "note_added": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineNoteAdded" } ], "nullable": true, "description": "Establert en esdeveniments `note_added`. Mai es retorna a una clau d'API." } } }, "NetworkTimelineAccount": { "type": "object", "description": "El compte de membre al qual pertany l'esdeveniment.", "properties": { "node_id": { "type": "string", "description": "`:`, on el tipus és `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` quan el registre pertany a l'aplicació que has cridat (per a un membre de la consola, a una aplicació a la qual se li ha concedit accés). `organization` quan pertany a una altra aplicació de la teva organització." }, "route": { "$ref": "#/components/schemas/NetworkTimelineRoute" } } }, "NetworkTimelineSourceRef": { "type": "object", "description": "El registre del qual s'ha llegit l'esdeveniment.", "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` quan el registre pertany a l'aplicació que has cridat (per a un membre de la consola, a una aplicació a la qual se li ha concedit accés). `organization` quan pertany a una altra aplicació de la teva organització." }, "route": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineRoute" } ], "description": "Absent en `monitoring_event` i `case`." } } }, "NetworkTimelineRoute": { "type": "object", "description": "On s'obre el registre: el seu tipus, el seu UUID i l'aplicació a la qual pertany.", "properties": { "kind": { "type": "string", "description": "`user`, `business` o `transaction_party` per a un compte; `session`, `business_session` o `transaction` per a un registre d'origen." }, "id": { "type": "string", "format": "uuid" }, "application_id": { "type": "string", "format": "uuid" } } }, "NetworkTimelineAttempt": { "type": "object", "description": "Una sessió de verificació del compte.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "L'UUID de la sessió, o l'UUID de la sessió d'empresa per a una companyia." }, "session_number": { "type": "integer", "nullable": true }, "attempt": { "type": "integer", "description": "La posició d'aquesta sessió entre les sessions del compte, per ordre de creació." }, "attempt_count": { "type": "integer", "description": "Quantes sessions té el compte." }, "status": { "type": "string", "description": "L'estat de la sessió, per exemple `Approved` o `Declined`." }, "status_changed_at": { "type": "string", "format": "date-time", "nullable": true }, "decline_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTimelineDeclineReason" }, "description": "Només per a una sessió rebutjada: les seves advertències, de més antiga a més recent, una vegada per advertència. Buit en cas contrari." } } }, "NetworkTimelineDeclineReason": { "type": "object", "properties": { "risk": { "type": "string", "description": "El codi d'advertència." }, "feature": { "type": "string", "description": "La funcionalitat que ha generat l'advertència." }, "short_description": { "type": "string" } } }, "NetworkTimelineTransaction": { "type": "object", "description": "Una transacció en què ha participat un compte membre, datada per la seva data de transacció.", "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": "Nul quan la transacció no té cap import." }, "status": { "type": "string" }, "decision_reason_code": { "type": "string", "nullable": true }, "decision_reason_label": { "type": "string", "nullable": true }, "party_role": { "type": "string", "description": "El rol del compte a la transacció: `APPLICANT`, `REMITTER`, `BENEFICIARY` o `COUNTERPARTY`." } } }, "NetworkTimelineAmount": { "type": "object", "properties": { "value": { "type": "string", "description": "Quantitat decimal com a cadena de text." }, "currency": { "type": "string" }, "direction": { "type": "string", "nullable": true } } }, "NetworkTimelineLogin": { "type": "object", "description": "Un esdeveniment d'inici de sessió que has enviat per a una persona mitjançant l'API d'esdeveniments.", "properties": { "action": { "type": "string", "description": "`.`: `auth.login` o `security.login_succeeded` per a un inici de sessió, `auth.login_failed` o `security.login_failed` per a un inici de sessió fallit." }, "succeeded": { "type": "boolean" }, "status": { "type": "string", "description": "L'estat de l'esdeveniment." }, "ip": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineIP" } ], "nullable": true, "description": "Nul quan l'esdeveniment no té adreça IP." }, "device": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineDevice" } ], "nullable": true, "description": "Nul quan l'esdeveniment no té empremta digital de dispositiu ni context." }, "is_first_login": { "type": "boolean", "description": "El primer inici de sessió satisfactori registrat del compte." }, "is_new_device": { "type": "boolean", "description": "Un inici de sessió satisfactori des d'un dispositiu del qual no procedia cap dels inicis de sessió satisfactoris anteriors del compte. Mai és cert en el primer inici de sessió." } } }, "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": "L'etiqueta del tipus de connexió per a l'adreça, com a text lliure." }, "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 dispositiu llegible generada a partir del context de dispositiu de l'esdeveniment." } } }, "NetworkTimelineRuleHit": { "type": "object", "description": "Una regla activa que ha coincidit amb una transacció o esdeveniment d'un membre. No s'inclouen les coincidències en mode de prova.", "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 cas obert per a la xarxa a la teva organització. `source_ref.ownership` indica si pertany a l'aplicació que has cridat.", "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 deixada a la xarxa. El text de la nota no s'inclou.", "properties": { "note_id": { "type": "string", "format": "uuid" }, "author_email": { "type": "string" } } }, "FeatureStatusOverride": { "type": "object", "description": "Una sobreescriptura de l'estat d'una comprovació (funcionalitat) feta amb `PATCH /v3/session/{sessionId}/features/{nodeId}/update-status/`: què canvia, si s'ha aplicat o encara espera que la persona finalitzi el flux, qui ho ha sol·licitat i per 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 sobreescriptura. Transmet-lo a l'endpoint de cancel·lació.", "example": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }, "node_id": { "type": "string", "description": "El node del flux de treball indicat a la sol·licitud (`default` per a un pas sense node).", "example": "feature_ocr_1" }, "feature_type": { "type": "string", "description": "El `feature_type` que ha passat la sol·licitud, o una cadena buida si no n'ha passat cap.", "example": "" }, "feature_model": { "type": "string", "description": "El tipus de comprovació que s'ha anul·lat, per exemple `KYC`, `Face`, `AML` o `GeolocationCheck`.", "example": "KYC" }, "previous_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "L'estat de la comprovació quan es va sol·licitar la sobreescriptura.", "example": "In Review" }, "new_status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "L'estat que estableix l'anul·lació.", "example": "Approved" }, "state": { "type": "string", "enum": [ "applied", "pending_until_flow_finishes", "cancelled" ], "description": "`applied`: la comprovació té el nou estat. `pending_until_flow_finishes`: la sobreescriptura espera i s'aplica quan la persona finalitza el flux. `cancelled`: ha esperat i no s'ha arribat a aplicar mai (consulta `cancel_reason`).", "example": "applied" }, "forced": { "type": "boolean", "description": "`true` quan la sobreescriptura s'ha aplicat immediatament mentre la persona encara era al flux.", "example": false }, "reason": { "type": "string", "nullable": true, "description": "El `comment` enviat amb la sol·licitud, o `null`.", "example": "Document manually verified by compliance." }, "requested_by": { "type": "object", "nullable": true, "description": "Qui ha sol·licitat la substitució, o `null` si no se sap.", "properties": { "email": { "type": "string", "format": "email", "nullable": true, "description": "Correu electrònic de l'usuari de la consola, o `null` per a claus d'API i el sistema.", "example": "reviewer@example.com" }, "name": { "type": "string", "nullable": true, "description": "Nom visible del sol·licitant, o `null`.", "example": "Alex Reviewer" }, "type": { "type": "string", "enum": [ "CONSOLE_USER", "API_KEY", "SYSTEM" ], "description": "Qui ha fet la sol·licitud: un usuari de la consola, una clau d'API o el mateix Didit.", "example": "CONSOLE_USER" } } }, "requested_at": { "type": "string", "format": "date-time", "description": "Quan es va sol·licitar la sobreescriptura.", "example": "2026-10-13T09:15:00Z" }, "applied_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan la comprovació va adoptar el nou estat, o `null` mentre està en espera o un cop cancel·lada.", "example": "2026-10-13T09:15:00Z" }, "cancelled_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va cancel·lar una substitució en espera, o `null`.", "example": null }, "cancel_reason": { "type": "string", "nullable": true, "enum": [ "cancelled_by_reviewer", "replaced", "check_changed", "session_closed", null ], "description": "Per què no es va aplicar mai una substitució en espera, o `null`. `cancelled_by_reviewer`: cancel·lada amb l'endpoint de cancel·lació. `replaced`: una substitució més recent en la mateixa comprovació la va substituir. `check_changed`: la persona ha tornat a fer la comprovació abans d'acabar el flux. `session_closed`: la sessió ha sortit del flux abans que la persona l'acabés (abandonada, caducada o decidida a mig flux).", "example": null } } }, "SandboxSimulateRequest": { "type": "object", "description": "Força l'estat d'una sessió de sandbox. Tots els camps són opcionals, però es requereix com a mínim un de `new_status`, `scenario` o `risk`.", "properties": { "new_status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Abandoned" ], "description": "L'estat que s'ha d'establir. Si l'omets, pren per defecte l'estat per defecte del cas de risc (`risk`, o el primer risc que incloguin els valors màgics de l'escenari); en cas contrari, l'estat per defecte de l'escenari.", "example": "Declined" }, "comment": { "type": "string", "maxLength": 500, "description": "Nota afegida a l'entrada d'activitat que registra el canvi d'estat.", "example": "Testing the decline path" }, "scenario": { "type": "string", "maxLength": 100, "description": "Un slug d'escenari del catàleg (`GET /v1/sandbox/scenarios/`). Proporciona l'estat per defecte i, sense `risk`, l'advertència que comporten els seus valors màgics. Un slug desconegut retorna `400`.", "example": "decline_aml_hit" }, "risk": { "type": "string", "maxLength": 128, "description": "Un cas de risc del catàleg. La seva advertència s'afegeix a la sessió, amb un tipus de registre que segueix `new_status`. Un valor desconegut retorna `400`.", "example": "POSSIBLE_MATCH_FOUND" }, "node_id": { "type": "string", "maxLength": 128, "description": "Node del flux de treball al qual està adjunta l'advertència de risc. Per defecte és el node actual de la sessió.", "example": "feature_aml_1" }, "send_webhooks": { "type": "boolean", "default": true, "description": "`true` envia exactament els webhooks que envia un canvi d'estat real a les destinacions de l'aplicació sandbox: `status.updated`, més els esdeveniments `user.status.updated` / `user.data.updated` (o `business.status.updated` / `business.data.updated`) que provoca el canvi, per a les destinacions que hi estan subscrites. `false` canvia l'estat sense registrar ni enviar cap webhook: la recuperació de webhooks perduts mai no torna a enviar aquesta decisió, la consola es continua actualitzant en directe i el següent canvi d'estat de la sessió envia webhooks com de costum.", "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": "L'estat de la sessió abans de la simulació.", "example": "In Progress" }, "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Abandoned" ], "description": "L'estat que ha establert la simulació.", "example": "Declined" }, "scenario": { "type": "string", "nullable": true, "description": "L'slug de l'escenari que has passat, o `null`.", "example": "decline_aml_hit" }, "risk": { "type": "string", "nullable": true, "description": "El cas de risc aplicat (`risk`, o l'obtingut de l'escenari), o bé `null` si no n'hi ha cap.", "example": "POSSIBLE_MATCH_FOUND" }, "send_webhooks": { "type": "boolean", "description": "El valor `send_webhooks` que ha aplicat la simulació.", "example": false } } }, "CaseTeamSummary": { "type": "object", "nullable": true, "description": "L'equip de revisió propietari del cas, o null quan cap equip n'és el propietari. L'encaminament l'assigna quan una regla d'encaminament assigna el cas a un dels seus equips. Canvia'l o buida'l amb `PATCH .../cases/{case_uuid}/` (`team`).", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "CaseChecker": { "type": "object", "nullable": true, "description": "El membre designat per aprovar o rebutjar la resolució pendent. Només s'estableix mentre una resolució de quatre ulls espera un revisor designat. Null quan no hi ha res pendent, mentre la resolució pendent espera a la cua de revisors i un cop la resolució ha estat aprovada, rebutjada o retornada per a una nova revisió perquè les proves han canviat.", "properties": { "member_uuid": { "type": "string", "format": "uuid", "description": "L'uuid d'usuari del membre: el valor que passes com a `checker` quan resols el cas." }, "name": { "type": "string", "nullable": true, "description": "El nom complet del membre, o null quan no es coneix." }, "email": { "type": "string", "format": "email" } } }, "ServiceStatusFeed": { "type": "object", "description": "Estat públic del servei: l'estat de cada servei de Didit, l'estat general i els incidents en curs o resolts en els darrers 7 dies.", "required": [ "status", "updated_at", "services", "incidents" ], "properties": { "status": { "type": "string", "enum": [ "operational", "degraded", "down" ], "description": "El pitjor estat de qualsevol servei en aquest moment, determinat únicament pels incidents en curs.", "example": "degraded" }, "updated_at": { "type": "string", "format": "date-time", "description": "Quan Didit ha generat aquesta resposta (ISO 8601, UTC). Les respostes s'emmagatzemen a la memòria cau durant 30 segons, de manera que poden tenir fins a 30 segons d'antiguitat.", "example": "2026-10-13T09:41:07.512345Z" }, "services": { "type": "array", "description": "Una entrada per servei, amb tots els serveis sempre llistats.", "items": { "$ref": "#/components/schemas/ServiceStatusService" } }, "incidents": { "type": "array", "description": "El `started_at` més recent primer. Tots els incidents en curs, més els incidents resolts en els darrers 7 dies (com a màxim 50 incidents resolts). Buit si no ha passat res durant aquest temps.", "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": "Clau de servei estable. Compara segons aquesta clau, mai pel nom visible. `service_id_verification`: Verificació d'identitat, `service_liveness_face_match`: Prova de vida i coincidència facial, `service_aml_screening`: Cribratge AML, `service_kyb_registries`: Registres KYB, `service_database_validation`: Validació en bases de dades, `service_phone_delivery`: Lliurament de verificació de telèfon, `service_email_delivery`: Lliurament de verificació de correu electrònic, `service_transaction_monitoring`: Monitoratge de transaccions.", "example": "service_database_validation" }, "name": { "type": "string", "description": "Nom visible en anglès del servei.", "example": "Database validation" }, "status": { "type": "string", "enum": [ "operational", "degraded", "down" ], "description": "`operational` quan no hi ha cap incident en curs al servei; en cas contrari, el pitjor estat dels seus incidents en curs.", "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 de la incidència.", "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": "Clau del servei afectat (consulta `services[].key`).", "example": "service_database_validation" }, "service_name": { "type": "string", "description": "Nom visible en anglès del servei afectat.", "example": "Database validation" }, "state": { "type": "string", "enum": [ "degraded", "down" ], "description": "Com es veu afectat el servei. Un incident resolt manté l'últim estat que va tenir.", "example": "degraded" }, "status": { "type": "string", "enum": [ "ongoing", "resolved" ], "description": "`ongoing` fins que el servei es recuperi; després, `resolved`.", "example": "ongoing" }, "title": { "type": "string", "description": "Titular en anglès. Per traduir-lo, construeix el teu propi text a partir de `service`, `state` i `country_name`.", "example": "Database validation is degraded in Brazil." }, "body": { "type": "string", "description": "Línia de detall en anglès: des de quan les comprovacions poden ser lentes o fallar, o quan s'ha recuperat.", "example": "Checks against Brazil (CPF) may be slow or fail since 08:55 UTC." }, "affected": { "type": "string", "description": "Països o registres afectats, per exemple `Brazil (CPF)`. Buit quan l'incident no està vinculat a cap país o registre.", "example": "Brazil (CPF)" }, "country_name": { "type": "string", "description": "País afectat, en anglès. Buit quan l'incident no està vinculat a cap país.", "example": "Brazil" }, "started_at": { "type": "string", "format": "date-time", "description": "Quan va començar l'incident (ISO 8601, UTC).", "example": "2026-10-13T08:55:00Z" }, "resolved_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es va recuperar el servei (ISO 8601, UTC). `null` mentre l'incident estigui en curs." }, "duration_minutes": { "type": "integer", "nullable": true, "description": "Minuts sencers des de `started_at` fins a `resolved_at`. `null` mentre l'incident estigui en curs." } } }, "TravelRuleJoinInvitation": { "type": "object", "description": "El que mostra la pàgina per unir-s'hi abans que s'escrigui res.", "properties": { "email": { "type": "string", "format": "email", "description": "L'adreça a la qual s'ha enviat la invitació." }, "vasp_name": { "type": "string" }, "source": { "type": "string", "description": "D'on prové la invitació, per exemple `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": "Ha de ser l'adreça a la qual s'ha enviat la invitació." }, "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 codi de 6 caràcters enviat per correu electrònic després de registrar-se." } } }, "TravelRuleJoinCredentials": { "type": "object", "description": "La nova organització gratuïta i les credencials amb les quals la seva aplicació crida l'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": "Envia-ho com a capçalera `x-api-key` als endpoints de l'espai de treball." } } }, "TravelRuleWorkspaceClaimRequest": { "type": "object", "required": [ "vasp_id" ], "properties": { "vasp_id": { "type": "string", "format": "uuid", "description": "L'entrada de directori que representa aquest espai de treball. Llegeix els identificadors des 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": "Només s'accepta `true`: la facturació de sortida no es pot tornar a desactivar mitjançant l'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 registre TXT que s'ha de publicar per a la prova de DNS. Buit fins que s'hagi iniciat una prova.", "properties": { "host": { "type": "string", "example": "didit-tr-verify.example.com" }, "value": { "type": "string" } } }, "TravelRuleWorkspace": { "type": "object", "description": "L'espai de treball gratuït de Travel Rule d'una aplicació que s'ha unit de franc.", "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": "Valors del perfil extrets de l'entrada del directori: `vasp_id`, `legal_name`, `lei`, `jurisdiction`, `compliance_email`, `domains`. No s'escriu res fins que es reclama el perfil." }, "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": "Rebre dades de la Travel Rule és gratuït. L'enviament només es factura un cop activada la facturació." }, "billing_enabled_at": { "type": "string", "format": "date-time", "nullable": true }, "didit_network": { "type": "object", "description": "Indica si la xarxa Didit inclou aquest VASP i, si no és així, cadascuna de les condicions que encara no compleix." }, "settings": { "$ref": "#/components/schemas/TravelRuleSettingsDetail" } } }, "InvestigatorDecision": { "type": "object", "description": "Com ha sortit l'element de la cua de l'Investigator. `decided_by`, `original_outcome` i `overrides` es retornen als endpoints d'acceptació i d'anul·lació, així com a l'informe; el bloc `investigator` de la decisió d'una sessió conté els altres camps.", "properties": { "outcome": { "type": "string", "enum": [ "accepted", "edited", "overridden", "decided_elsewhere", "automated" ], "description": "`accepted` o `edited` ha adoptat la recomanació (`edited` amb una narrativa reescrita), `overridden` ha pres una altra acció, `decided_elsewhere` és una decisió presa fora de l'Investigator mentre l'informe estava obert, `automated` és una decisió que l'Investigator ha pres pel seu compte." }, "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": "L'estat de l'element després de la decisió." }, "agreed": { "type": "boolean", "description": "Indica si la decisió ha coincidit amb la recomanació.", "nullable": true }, "decided_at": { "type": "string", "format": "date-time" }, "billed": { "type": "boolean", "description": "S'ha cobrat la revisió." }, "decided_by": { "type": "string", "enum": [ "investigator", "member" ] }, "original_outcome": { "type": "object", "description": "La decisió que l'Investigator ha pres pel seu compte, sense canvis per sobreescriptures posteriors. Null per a una decisió que hagi pres l'equip.", "properties": { "action": { "type": "string" }, "final_status": { "type": "string" }, "decided_at": { "type": "string", "format": "date-time" } }, "nullable": true }, "overrides": { "type": "array", "description": "Totes les substitucions d'una decisió que l'Investigator va prendre pel seu compte, de la més antiga a la més recent.", "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ó més recent d'Investigator de l'element, o null quan mai no n'ha tingut cap. S'inclou a la decisió de la sessió V3 i de la sessió d'empresa (i, per tant, als webhooks de `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": "L'Investigator ha decidit pel seu compte, fins i tot si la decisió s'ha invalidat posteriorment." }, "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": "L'element en revisió: `id`, `number`, `status`, `name` i, segons el tipus, `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": "Les barreres de protecció bloquejades que contenen aquest element, si n'hi ha cap." }, "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": "Quantes seccions i registres vinculats ha llegit." }, "duration_ms": { "type": "integer", "nullable": true }, "agent_version": { "type": "string" }, "prepared_before_opened": { "type": "boolean", "nullable": true }, "report": { "type": "object", "additionalProperties": true, "description": "L'informe: raonament, punts d'evidència amb el seu veredicte (`ok`, `risk`, `look`, `explained`, `context`) i fonts citades, veredictes de coincidències del cribratge (`same`, `not_same`, `unclear`) i passos següents suggerits." }, "trail": { "description": "El que he comprovat: el resum, les seccions i els registres que s'han llegit, en ordre." }, "decision": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/InvestigatorDecision" } ], "type": "object" }, "autonomy": { "type": "object", "additionalProperties": true, "description": "El que l'autonomia ha determinat a partir de l'informe (`result`, `reason`, `tier`, `policy_version`, `rule`, `agreement`, `decisions`, `threshold`, `at`). Null quan la cua no està automatitzada.", "nullable": true } } } ] }, "InvestigatorAcceptRequest": { "type": "object", "properties": { "narrative": { "type": "string", "maxLength": 4000, "description": "Una explicació redactada de nou. Enviar-ne una registra la decisió com a editada i acceptada." }, "send_email": { "type": "boolean", "default": false, "description": "Envia un correu electrònic a la persona sobre la decisió." }, "email_address": { "type": "string", "format": "email", "description": "Obligatori quan `send_email` és 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": "Envia un correu electrònic a la persona sobre la decisió." }, "email_address": { "type": "string", "format": "email", "description": "Obligatori quan `send_email` és 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ímit mensual en la teva moneda de facturació, de 0.01 a 1,000,000. El valor nul el 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 preu de cada informe de producció obert, retingut perquè acceptar-lo implica el seu cobrament." }, "currency": { "type": "string" }, "paused": { "type": "boolean", "description": "Al límit: no s'inicia cap revisió nova." } } } } }, "TravelRuleUtxoEntry": { "type": "object", "description": "Una entrada o sortida d'una transacció UTXO, tal com la va registrar la cadena.", "required": [ "address" ], "properties": { "address": { "type": "string", "maxLength": 128 }, "amount": { "type": "string", "nullable": true, "description": "Cadena decimal en la unitat pròpia de la moneda (BTC, no satoshis). Opcional.", "example": "0.0125" }, "txid": { "type": "string", "maxLength": 128, "description": "Opcional. La transacció que gasta un input." }, "vout": { "type": "integer", "nullable": true, "minimum": 0, "description": "Opcional. L'índex de la sortida que consumeix una entrada." } } }, "TravelRuleUtxo": { "type": "object", "description": "Les entrades i sortides d'una transferència UTXO (BTC, LTC, BCH, DOGE). Només s'admeten en aquestes xarxes: en qualsevol altra xarxa respon amb un `400`. A partir d'aquestes, Didit infereix la cartera de l'ordenant (la declarada o, si no n'hi ha, l'adreça d'entrada que més ha aportat) i la sortida del beneficiari (la declarada o, si no n'hi ha, l'única sortida que no retorna canvi a una adreça d'entrada o, si no, la sortida que paga l'import de la transferència). El resultat es troba a `chain_details` de la transferència.", "required": [ "outputs" ], "properties": { "inputs": { "type": "array", "maxItems": 1000, "items": { "$ref": "#/components/schemas/TravelRuleUtxoEntry" }, "description": "Opcional. Sense entrades no s'infereix cap ordenant ni es reconeix cap sortida de canvi." }, "outputs": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/TravelRuleUtxoEntry" } } } }, "TravelRuleChainSide": { "type": "object", "description": "La cartera d'una de les parts tal com Didit l'ha resolt a partir de les dades de la cadena.", "properties": { "address": { "type": "string", "description": "La cartera. En una xarxa amb memo, l'adreça clàssica (una adreça X d'XRP es divideix en la seva adreça clàssica i la seva etiqueta); a Lightning, l'ID del node del beneficiari o l'adreça Lightning." }, "memo": { "type": "string", "description": "L'etiqueta de destinació o nota que forma part de la cartera; `\"\"` quan no n'hi ha cap." }, "source": { "type": "string", "enum": [ "declared", "x_address", "largest_input", "only_non_change_output", "amount_match", "invoice_payee", "updated" ], "description": "D'on prové la cartera: `declared` (la teva sol·licitud), `x_address` (desglossada d'una adreça X d'XRP), `largest_input` (l'adreça d'entrada UTXO que ha aportat més), `only_non_change_output` (l'única sortida UTXO que no és canvi), `amount_match` (l'única sortida UTXO que paga l'import de la transferència), `invoice_payee` (el beneficiari que indica una sol·licitud de pagament de Lightning), `updated` (establert més tard amb `action: update_originator_wallet`)." } } }, "TravelRuleChainDetails": { "type": "object", "description": "Com anomena la cadena de la transferència les seves dues carteres, quan es tracta de més d'una adreça pagant-ne una altra. Buit (`{}`) per a una transferència de cadena basada en comptes (EVM, Solana, Tron), on les dues adreces són les carteres. La coincidència, l'encaminament i la llibreta d'adreces llegeixen primer les carteres d'aquí.", "properties": { "chain": { "type": "string", "description": "Cadena canònica, p. ex. `BTC`, `XRP` o `LIGHTNING` per a una transferència Lightning." }, "shape": { "type": "string", "enum": [ "utxo", "memo", "lightning" ] }, "originator": { "$ref": "#/components/schemas/TravelRuleChainSide" }, "beneficiary": { "$ref": "#/components/schemas/TravelRuleChainSide" }, "utxo": { "type": "object", "description": "En una transferència UTXO: les entrades i sortides tal com s'han emmagatzemat (imports com a cadenes decimals) i què ha llegit Didit en cada sortida.", "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": "Sortides que retornen el pagament a una adreça d'entrada." }, "beneficiary_output_index": { "type": "integer", "nullable": true, "description": "La sortida que paga al beneficiari; null quan no se'n pot distingir cap." } } }, "lightning": { "type": "object", "description": "En una transferència de Lightning: el que diu la sol·licitud de pagament. Sempre `kind` (`bolt11`, `bolt12_offer`, `bolt12_invoice`, `bolt12_invoice_request`, `lnurl`, `lightning_address`, `node_id` o `unknown`); una factura BOLT11 afegeix `network`, `payee_node_id`, `payment_hash`, `amount_msat`, `created_at` i `expires_at`; una cadena BOLT12 afegeix `blinded_paths` i `payee_node_id`; un LNURL o una Lightning Address inclou el seu `domain`. No es resol res a través de la xarxa: la sol·licitud només es descodifica.", "additionalProperties": true }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "declared_originator_not_an_input", "declared_beneficiary_not_an_output", "beneficiary_output_ambiguous", "beneficiary_output_amount_differs" ] }, "description": "Inconsistències d'UTXO que val la pena revisar: l'ordenant declarat no és una entrada, el beneficiari declarat no és una sortida, no s'ha pogut distingir cap sortida de beneficiari única o la sortida del beneficiari paga un import diferent del que indica la transacció." }, "not_applicable_reason": { "type": "string", "enum": [ "LIGHTNING_NO_PAYEE_IDENTIFIER", "LIGHTNING_BOLT12_BLINDED_PAYEE", "LIGHTNING_LNURL_NAMES_NO_PAYEE" ], "description": "En una transferència sortint de Lightning la sol·licitud de pagament de la qual no especifica cap beneficiari: per què la transferència és `NOT_APPLICABLE`. `LIGHTNING_NO_PAYEE_IDENTIFIER` (la sol·licitud no especifica cap node beneficiari, o no s'ha pogut descodificar), `LIGHTNING_BOLT12_BLINDED_PAYEE` (l'oferta amaga el seu beneficiari darrere de rutes cegues), `LIGHTNING_LNURL_NAMES_NO_PAYEE` (un LNURL especifica un servei, no un beneficiari). El mateix codi obre l'última entrada de la `timeline` de la transferència." } } }, "WalletAddressImportRow": { "type": "object", "description": "Una cartera per importar: per la seva `address`, el seu `address_hash` o tots dos. Les formes en camelCase d'aquests camps també s'accepten, així com `walletAddress`, `walletAddressHash`, `destinationTag` i `externalUserId`.", "properties": { "address": { "type": "string", "maxLength": 128, "description": "L'adreça de la cartera. Àlies: `walletAddress`." }, "address_hash": { "type": "string", "description": "SHA-256 de l'adreça en minúscules, com a 64 caràcters hexadecimals o 44 caràcters en base64. Envia'l sol per registrar una cartera sense revelar-ne l'adreça; si s'envia amb `address`, ha de ser el hash d'aquesta adreça. Àlies: `walletAddressHash`." }, "chain": { "type": "string", "maxLength": 32 }, "memo": { "type": "string", "maxLength": 256, "description": "L'etiqueta de destinació o memo. XRP: una etiqueta de destinació, un nombre enter de 0 a 4294967295 (s'accepta un número JSON). XLM: un memo de text de fins a 28 bytes, un identificador de 64 bits o un hash de 32 bytes en hex. EOS: fins a 256 bytes. ATOM: fins a 256 caràcters. HBAR: fins a 100 bytes. Les carteres de Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin i Lightning no admeten memo: incloure'n un retorna un `400`." }, "holder_name": { "type": "string", "maxLength": 255 }, "holder_vendor_data": { "type": "string", "maxLength": 255, "description": "El teu identificador intern per al titular. Àlies: `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 l'entrada ja verificada mitjançant una autodeclaració, quan la teva configuració ho permeti." } } }, "WalletAddressImportReport": { "type": "object", "description": "Què ha passat amb cada fila d'una importació, en l'ordre enviat.", "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, començant per 1." }, "status": { "type": "string", "enum": [ "created", "existing", "duplicate", "failed" ], "description": "`created`: afegida al llibre. `existing`: la cartera ja és al llibre i no s'ha modificat. `duplicate`: repeteix una fila anterior d'aquesta importació. `failed`: consulta `errors`." }, "entry_id": { "type": "string", "format": "uuid", "nullable": true, "description": "L'entrada de la llibreta d'adreces que la fila ha creat o trobat." }, "errors": { "type": "object", "description": "Errors de camp d'una fila `failed`; buit altrament." }, "duplicate_of_row": { "type": "integer", "nullable": true, "description": "En una fila `duplicate`, la fila que repeteix." } } } } } }, "TravelRuleCounterpartyContact": { "type": "object", "description": "Una adreça de compliment on escriu el rail EMAIL per a una entrada del directori.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "counterparty": { "type": "string", "format": "uuid", "description": "L'`id` de l'entrada de directori, tal com el mostra GET /v3/travel-rule/vasps/." }, "counterparty_name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string", "description": "Etiqueta opcional, per exemple el nom de l'equip." }, "source": { "type": "string", "enum": [ "staff", "application", "learned" ], "description": "staff: seleccionat per Didit. learned: una adreça d'un dels dominis propis del VASP que ha respost a una sol·licitud a través del seu enllaç de resposta. application: afegida per la teva aplicació." }, "scope": { "type": "string", "enum": [ "platform", "application" ], "description": "platform: gestionat per Didit o obtingut d'una resposta verificada, utilitzat per a tots els clients de Didit, de només lectura per a tu. application: privat per a la teva aplicació." }, "created_by": { "type": "string", "description": "Buit per als contactes de la plataforma i per als contactes que hagi afegit una clau d'API." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan aquesta adreça va respondre per darrera vegada a una sol·licitud mitjançant el seu enllaç de resposta." }, "is_invalid": { "type": "boolean", "description": "true un cop l'adreça ha rebotat o ha presentat una queixa; la via EMAIL l'omet." }, "invalid_reason": { "type": "string", "enum": [ "", "hard_bounce", "soft_bounce", "spam_complaint", "suppressed" ] }, "invalid_detail": { "type": "string", "description": "El motiu del servidor de correu receptor, si n'ha proporcionat algun." }, "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": "L'`id` de l'entrada de directori." }, "email": { "type": "string", "format": "email", "maxLength": 254 }, "name": { "type": "string", "description": "Etiqueta opcional.", "maxLength": 255 } } }, "TravelRuleNameMatch": { "type": "object", "nullable": true, "description": "La comparació de noms que ha decidit la transferència, o null fins que se n'hagi executat una. Mentre les parts estan emmascarades, i a la còpia de l'altre client d'un intercanvi INTERNAL, `transfer_name`, `compared_name`, `matched_names` i `mismatched_names` s'oculten. `score` i `matched` poden discrepar: `matched` segueix l'estrictesa, `score` és la similitud dels dos noms complets.", "properties": { "score": { "type": "integer", "minimum": 0, "maximum": 100, "description": "Similitud dels dos noms complets, de 0 a 100. 0 quan algun dels noms està en blanc." }, "matched": { "type": "boolean", "description": "Si els noms compleixen `strictness`. El resultat de la transferència segueix `data_match`, que compara cada camp, de manera que una transferència pot ser COUNTERPARTY_MISMATCHED_DATA mentre això sigui cert." }, "method": { "type": "string", "enum": [ "none", "exact_token", "token_subset", "token_containment", "sequence_ratio" ], "description": "Com s'ha decidit `matched`: cap (`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 registrat per a la cartera. counterparty_vasp: el nom que la contrapart ha indicat a la pàgina de resposta per correu electrònic, o la resposta del VASP de prova de Didit a sandbox." }, "transfer_name": { "type": "string", "description": "El nom que figura a la transferència." }, "compared_name": { "type": "string", "description": "El nom amb què s'ha comparat." }, "matched_names": { "type": "array", "items": { "type": "string" }, "description": "Paraules de `transfer_name` trobades a `compared_name`." }, "mismatched_names": { "type": "array", "items": { "type": "string" }, "description": "Paraules de `transfer_name` que falten a `compared_name` i, tot seguit, paraules de `compared_name` que falten a `transfer_name`." } } }, "TravelRuleTransferRow": { "type": "object", "description": "Una transferència de Travel Rule tal com la mostra la llista de transferències: només noms de VASP, carteres i memos, mai les dades personals de l'ordenant o del beneficiari.", "properties": { "id": { "type": "string", "format": "uuid", "description": "L'id de la transferència." }, "transaction_id": { "type": "string", "format": "uuid", "description": "La transacció de Didit a la qual pertany la transferència." }, "txn_id": { "type": "string", "nullable": true, "description": "El teu propi identificador per a la transacció. Les transferències que Didit registra per a tu, com ara una transferència entrant de Didit Test VASP, en porten un de generat." }, "txn_date": { "type": "string", "format": "date-time" }, "kind": { "type": "string", "enum": [ "withdrawal", "deposit", "message" ], "description": "withdrawal: sortint. message: una transferència entrant que una via ha creat a partir d'un missatge d'una contrapart (una consulta TRP, el tram entrant INTERNAL o un missatge de GTR, VerifyVASP o Sygna Bridge). deposit: qualsevol altra transferència entrant." }, "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": "Per què una transferència `COUNTERPARTY_VASP_NOT_FOUND` o `COUNTERPARTY_VASP_NOT_REACHABLE` està encallada, el mateix valor que el `reason` de la pròpia transferència, de manera que la llista distingeix un correu electrònic de compliment rebotat d'una contrapart sense ruta sense obrir cada transferència. `\"\"` per a qualsevol altre estat. Consulta [Per què una transferència està encallada](/ca/transaction-monitoring/travel-rule#per-què-una-transferència-està-bloquejada)." }, "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ó." }, "amount": { "type": "string", "description": "L'import com a decimal simple, per exemple \"1.25\"." }, "originator_vasp": { "type": "string", "description": "Sortint: la raó social del teu VASP. Entrant: el nom de la contrapart, a partir de la seva entrada de directori, del membre de la xarxa Didit, del remitent TRP, del Didit Test VASP o del nom declarat a la transferència. Buit quan no se'n coneix cap." }, "beneficiary_vasp": { "type": "string", "description": "Sortint: el nom de la contrapart, calculat de la mateixa manera. Entrant: la raó social del teu VASP." }, "originator_wallet": { "type": "string" }, "beneficiary_wallet": { "type": "string" }, "originator_memo": { "type": "string", "description": "Memo o etiqueta de destinació, buit en cadenes que no en tinguin." }, "beneficiary_memo": { "type": "string" }, "originator_wallet_type": { "type": "string", "enum": [ "vasp", "self_hosted", "own" ], "description": "vasp, self_hosted (declarada no allotjada) o own (una cartera que la teva llibreta d'adreces registra com a teva). La teva part sempre és vasp." }, "beneficiary_wallet_type": { "type": "string", "enum": [ "vasp", "self_hosted", "own" ] }, "matched_transaction_id": { "type": "string", "format": "uuid", "nullable": true, "description": "L'altra part d'un dipòsit que has emparellat manualment amb una transferència anunciada." }, "deadline_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan caduca la transferència si encara està esperant la contrapart. S'estableix a cada transferència que creïs amb `POST /v3/transactions/` que requereixi un intercanvi, de sortida o d'entrada. És null per sota del llindar, en pagaments de Lightning als quals no s'aplica la Travel Rule i en transferències d'entrada que Didit crea quan una contrapart contacta amb tu (una consulta TRP d'entrada, un missatge de xarxa o el tram d'entrada INTERNAL)." }, "created_at": { "type": "string", "format": "date-time" } } }, "BankAccountCheckHolder": { "description": "El nom amb què es comprova el compte. Envia exactament un dels camps `full_name` i `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 del compte, com a codi ISO 3166-1 alpha-3, per exemple `NGA`. S'admeten minúscules.", "example": "NGA" }, "account": { "type": "object", "description": "El compte tal com s'escriu al seu país: un `iban`, o un `account_number` amb el codi de banc o de sucursal que el país necessita (`sort_code`, `routing_number`, `transit_institution`, `bsb`, `ifsc`, `bank_code` o `bic`). Mèxic utilitza una `clabe` i l'Argentina un `cbu_cvu`, que ja identifiquen el banc. Un compte d'empresa afegeix un `registration_id` quan el país ho demana. Els espais, guions i punts s'ignoren. Les claus que la comprovació del país no utilitza s'ignoren; una clau que necessita i no rep és un error `400` que n'indica el nom.", "properties": { "iban": { "type": "string", "maxLength": 64, "description": "L'IBAN, en un país que utilitza IBAN. Ha de pertànyer a `country`." }, "account_number": { "type": "string", "maxLength": 64, "description": "El número de compte, en un país que escriu el compte amb un codi de banc o de sucursal separat." }, "sort_code": { "type": "string", "maxLength": 64, "description": "Regne Unit: el codi de classificació bancària de 6 dígits." }, "routing_number": { "type": "string", "maxLength": 64, "description": "Estats Units: el número d'encaminament ABA de 9 dígits." }, "transit_institution": { "type": "string", "maxLength": 64, "description": "Canadà: el número de trànsit i d'institució de 8 dígits." }, "bsb": { "type": "string", "maxLength": 64, "description": "Austràlia: el BSB de 6 dígits." }, "ifsc": { "type": "string", "maxLength": 64, "description": "Índia: el codi IFSC d'11 caràcters." }, "bank_code": { "type": "string", "maxLength": 64, "description": "El codi del banc, quan el país en necessita un, per exemple a Nigèria." }, "bic": { "type": "string", "maxLength": 64, "description": "El BIC del banc, quan la comprovació del país en demana un." }, "clabe": { "type": "string", "maxLength": 64, "description": "Mèxic: la CLABE de 18 dígits. Ja identifica el banc." }, "cbu_cvu": { "type": "string", "maxLength": 64, "description": "Argentina: el CBU o CVU de 22 dígits. Ja indica el banc." }, "registration_id": { "type": "string", "maxLength": 64, "description": "El número de registre d'un compte d'empresa, quan el país en sol·licita un." } }, "additionalProperties": { "type": "string", "maxLength": 64 }, "example": { "bank_code": "000014", "account_number": "0123450001" } }, "holder": { "$ref": "#/components/schemas/BankAccountCheckHolder" }, "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta comprovació, retornada sense canvis.", "example": "payout_20481" }, "consent": { "type": "boolean", "default": false, "description": "Estableix-ho a `true` quan el titular del compte hagi donat el consentiment explícit per a aquesta comprovació. Requerit als països on la comprovació de comptes necessita aquest consentiment: sense ell, la comprovació es rebutja amb un `400` en què `field` és `consent` i `reason` és `required`, i no es factura res. A la resta de països és opcional, i Didit el registra amb el càrrec de la comprovació quan l'envies.", "example": true } } }, "BankAccountCheckResponse": { "type": "object", "required": [ "request_id", "result", "holder_name", "account", "vendor_data", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "L'ID d'aquesta comprovació." }, "result": { "type": "string", "enum": [ "match", "close_match", "no_match", "cannot_verify" ], "description": "`match`: el banc té el compte sota el nom que has enviat. `close_match`: sota un nom proper, per exemple amb un segon nom absent o una errada tipogràfica. `no_match`: sota un altre nom, o aquest compte no existeix. `cannot_verify`: el banc ha respost sense comparar el nom, per exemple en un compte bloquejat o tancat." }, "holder_name": { "type": "string", "nullable": true, "description": "Només en cas de `close_match`, i només quan el banc l'hagi retornat: el nom al compte, tal com el té el banc. Altrament, `null`." }, "account": { "type": "string", "description": "El compte, emmascarat amb els seus últims 4 caràcters." }, "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència, tal com la vas enviar." }, "created_at": { "type": "string", "format": "date-time", "description": "Quan es va executar la comprovació, en UTC." } } }, "BankAccountCheckError": { "type": "object", "required": [ "detail" ], "properties": { "detail": { "type": "string", "description": "Què ha fallat, en anglès." }, "code": { "type": "string", "description": "Un codi estable per bifurcar. Absent a `401` i `403`." }, "field": { "type": "string", "description": "Només `400`: el camp del cos a corregir, com a ruta amb punts, per exemple `account.sort_code`." }, "reason": { "type": "string", "enum": [ "required", "length", "format", "checksum", "country_mismatch", "rejected" ], "description": "Només `400`: motiu pel qual s'ha rebutjat el camp. `required`, `length`, `format`, `checksum` i `country_mismatch` (un IBAN d'un altre país) són comprovacions pròpies de Didit; `rejected` significa que el banc ha rebutjat el compte tal com s'ha enviat." } } }, "BankVerificationResult": { "type": "object", "description": "El resultat d'un pas de Verificació bancària, per a Verificació d'usuaris i d'empreses. `method` indica com s'ha verificat el compte, i `none` que la persona ha continuat sense banc abans que s'avalués cap intent. `continued_without_bank` indica que la persona ha continuat sense banc, fins i tot després d'un intent avaluat. Consulta [Mètodes de verificació bancària](/ca/core-technology/bank-verification/verification-methods) i [Quan la persona no pot verificar el seu banc](/ca/core-technology/bank-verification/fallbacks).", "properties": { "schema_version": { "type": "integer", "description": "Versió d'aquesta estructura de resultats. Actualment `1`." }, "bank_verification_id": { "type": "string", "format": "uuid", "description": "L'ID d'aquest resultat." }, "node_id": { "type": "string", "description": "El node del flux de treball al qual pertany aquest resultat." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Expired" ], "description": "El veredicte del pas, després de les seves accions i regles d'estat." }, "original_status": { "type": "string", "nullable": true, "description": "El primer veredicte al qual ha arribat el pas, abans de qualsevol canvi posterior com ara una revisió manual." }, "method": { "type": "string", "nullable": true, "enum": [ "open_banking", "account_lookup", "microdeposits", "statement", "none" ], "description": "Com s'ha verificat el compte: `open_banking` (inici de sessió bancari: la persona ha iniciat sessió al seu banc), `account_lookup` (comprovació del compte: la persona ha introduït les dades del compte i el banc ha confirmat el nom), `microdeposits` o `statement` (pujada d'un extracte bancari). `none` quan la persona ha continuat sense un banc abans que s'avalués cap intent, per la qual cosa no s'ha verificat cap compte. Després d'un intent avaluat, manté el mètode d'aquest intent. `null` fins que s'avalua un compte i quan el flux de treball limita les dades que retorna. Les regles del flux de treball llegeixen el mateix valor com a `bank.method`." }, "provider": { "type": "string", "nullable": true, "description": "La clau de la ruta que ha executat la connexió. Llegeix `method`, no aquesta clau, per saber com s'ha verificat el compte." }, "credential_source": { "type": "string", "nullable": true, "enum": [ "native", "byok" ], "description": "`native`: ruta pròpia de Didit, facturada al teu saldo de Didit. `byok`: un proveïdor del marketplace que has connectat amb les teves pròpies credencials." }, "route": { "type": "object", "nullable": true, "description": "La ruta triada abans del consentiment. Mai canvia posteriorment.", "properties": { "provider_key": { "type": "string", "nullable": true, "description": "La clau de la ruta." }, "credential_source": { "type": "string", "enum": [ "native", "byok" ] }, "is_fallback": { "type": "boolean", "description": "Indica si la ruta pròpia de Didit ha substituït un proveïdor del marketplace que no s'ha pogut connectar." }, "provider_connection_id": { "type": "string", "nullable": true, "description": "La connexió del mercat utilitzada, per a `byok`." }, "requested_scopes": { "type": "array", "items": { "type": "string" }, "description": "Les dades que ha sol·licitat la connexió, per exemple `ownership` o `balances`." } } }, "connection": { "type": "object", "nullable": true, "description": "La connexió de l'últim intent. `null` abans del primer intent.", "properties": { "status": { "type": "string", "enum": [ "pending", "connected", "cancelled", "timeout", "failed", "unsupported", "revoked", "expired" ] }, "institution_id": { "type": "string", "nullable": true, "description": "L'identificador del banc. `null` per a una comprovació de compte, on no se selecciona cap banc." }, "institution_name": { "type": "string", "nullable": true, "description": "El nom del banc. `null` per a una comprovació de compte." }, "institution_country": { "type": "string", "nullable": true, "description": "El país del compte, ISO 3166-1 alpha-3." }, "oauth": { "type": "boolean", "nullable": true, "description": "Indica si l'inici de sessió bancari s'ha executat mitjançant OAuth o d'aplicació a aplicació. `null` per a una comprovació de compte." }, "connected_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan la connexió va ser satisfactòria." }, "consent_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan finalitza el consentiment bancari, per a l'inici de sessió bancari." }, "last_refreshed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es van tornar a llegir les dades financeres per darrera vegada." }, "attempts": { "type": "integer", "description": "Els intents que la persona ha dedicat a aquest pas, sumant tots els mètodes." }, "reason_code": { "type": "string", "nullable": true, "description": "Per què la connexió no és simplement `connected`, per exemple `USER_CANCELLED`, `INSTITUTION_DOWN`, `ACCOUNT_NOT_FOUND`, `REFERENCE_IDENTITY_MISSING` o `VERIFICATION_COMPLETED`." } } }, "account": { "type": "object", "nullable": true, "description": "El compte avaluat. `null` fins que s'avaluï un compte.", "properties": { "account_id_masked": { "type": "string", "nullable": true, "description": "El número de compte, emmascarat." }, "iban_masked": { "type": "string", "nullable": true, "description": "L'IBAN, emmascarat." }, "sort_code": { "type": "string", "nullable": true, "description": "El codi de classificació bancari, al Regne Unit." }, "routing_number_masked": { "type": "string", "nullable": true, "description": "El número d'encaminament, emmascarat." }, "type": { "type": "string", "nullable": true, "enum": [ "checking", "current", "savings", "business", "other" ] }, "subtype": { "type": "string", "nullable": true, "description": "El subtipus de compte propi del banc." }, "currency": { "type": "string", "nullable": true, "description": "Moneda ISO 4217 del compte." }, "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": "Com es compara el titular del compte amb la identitat verificada. `null` fins que s'avalua un compte.", "properties": { "result": { "type": "string", "enum": [ "match", "partial_match", "no_match", "unknown", "not_verifiable" ], "description": "`partial_match` és una coincidència propera. `not_verifiable`: el banc ha respost sense cap titular per comparar. `unknown`: no s'ha pogut llegir la prova o no hi havia cap identitat per comparar." }, "reference_identity_source": { "type": "string", "nullable": true, "description": "El pas amb la identitat del qual s'ha comparat el titular: `kyc`, `database_validation`, `expected_details`, `questionnaire`, `document_ai` o `kyb`." }, "name_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "Puntuació de Didit per al nom del titular." }, "provider_name_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "La puntuació del nom del titular pròpia del banc, quan n'ha retornat una." }, "address_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "La puntuació de l'adreça del titular, quan s'ha executat la comprovació de coincidència d'adreça." }, "email_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "La puntuació del correu electrònic del titular, quan s'ha executat la comprovació de coincidència de correu electrònic." }, "phone_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "La puntuació del telèfon del titular, quan s'ha executat la comprovació de coincidència de telèfon." }, "dob_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "La puntuació de la data de naixement del titular, quan el banc n'ha proporcionat una." }, "close_match": { "type": "boolean", "nullable": true, "description": "Si el nom ha quedat a la franja de coincidència propera." }, "holder_confirmation": { "type": "string", "nullable": true, "enum": [ "pending", "confirmed", "rejected" ], "description": "La resposta de la persona quan se li ha demanat que confirmi un nom amb coincidència propera. `null` si mai se li ha demanat." }, "method": { "type": "string", "nullable": true, "enum": [ "exact", "token_set", "nickname", "transliteration", "fuzzy", "provider_only", "microdeposits" ], "description": "Quina comparació de noms ha produït la puntuació. Aquest no és el mètode de verificació: consulta el `method` de nivell superior per a això." }, "matched_holder_index": { "type": "integer", "nullable": true }, "holders": { "type": "array", "items": { "type": "object" }, "description": "Cada titular que el banc ha llistat, amb les seves puntuacions." }, "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": "Quan es va calcular el veredicte." } } }, "financial_data": { "type": "object", "description": "Les dades financeres que el pas ha llegit. Només les llegeix l'inici de sessió bancari.", "properties": { "balances": { "type": "object", "nullable": true, "description": "Amb l'abast `balances`." }, "transactions": { "type": "object", "nullable": true, "description": "Amb l'abast `transactions`." }, "income": { "type": "object", "nullable": true, "description": "Amb l'abast `income`." }, "categorization": { "type": "object", "nullable": true, "description": "Categorització de Didit de les transaccions llegides. `null` si no n'hi ha." }, "not_collected": { "type": "array", "items": { "type": "string", "enum": [ "balances", "income", "transactions" ] }, "description": "Les dades que ha sol·licitat el pas que el mètode que ha verificat el compte no recopila. Els saldos, les transaccions i els ingressos només provenen de l'inici de sessió bancari, de manera que un compte verificat per comprovació de compte els llista aquí. No és mai un error. Buit en cas contrari." } } }, "billing": { "type": "object", "nullable": true, "properties": { "route": { "type": "string", "enum": [ "native", "byok" ] }, "billed": { "type": "boolean" }, "marketplace_fee": { "type": "string", "nullable": true, "description": "La comissió de la plataforma del mercat cobrada, per a `byok`." }, "usage_type": { "type": "string", "nullable": true, "description": "La línia d'ús en què s'ha imputat el càrrec: `bank_verification` per a un inici de sessió bancari o una comprovació de compte, `bank_statement_upload` per a una pujada d'extracte sense cap intent bancari cobrat prèviament, i `bank_byok_fee` per a la comissió del mercat sobre el teu propi proveïdor. `null` quan no s'ha facturat res." } } }, "reference_identity": { "type": "object", "nullable": true, "description": "La identitat amb la qual s'ha comparat el titular, juntament amb el seu origen." }, "signals": { "type": "object", "nullable": true, "description": "Senyals del compte llegits de l'historial de transaccions, quan el pas n'ha llegit un." }, "connection_abandoned": { "type": "boolean", "nullable": true, "description": "Si el pas ha finalitzat sense cap coincidència després que la persona hagi abandonat el procés al seu banc." }, "not_covered": { "type": "boolean", "nullable": true, "description": "Si no s'ha pogut contactar amb el banc o el país de la persona en aquest pas. També és `true` quan la persona ha continuat sense un banc perquè cap mètode podia verificar el seu país o banc." }, "continued_without_bank": { "type": "boolean", "description": "Si la persona ha abandonat el pas amb **Continue without your bank**. Llavors, `continuation` n'indica el motiu. `method` és `none` quan no s'ha avaluat cap intent abans de continuar. Després d'un intent avaluat, com ara un titular que no coincideix, `method` es manté com el mètode d'aquell intent i els seus codis de veredicte i motiu es mantenen vigents. Es retorna fins i tot quan el flux de treball restringeix les dades que retorna." }, "continuation": { "type": "object", "nullable": true, "description": "Com ha continuat la persona sense un banc. `null` quan no ho ha fet. Quan el flux de treball limita les dades que retorna, es continua retornant `reason` i totes les altres claus són `null`.", "properties": { "reason": { "type": "string", "enum": [ "no_route", "institution_unsupported", "attempts_exhausted", "person_choice" ], "description": "Per què, segons ho ha determinat Didit quan la persona ha continuat: `no_route` (cap inici de sessió bancari ni comprovació de compte dona servei al seu país), `institution_unsupported` (el banc que ha triat no es pot utilitzar en aquest pas), `attempts_exhausted` (tots els intents ja s'havien esgotat i cap estava en curs), o `person_choice` (hi havia una manera de verificar-lo i ha decidit continuar, també quan no s'ha pogut contactar amb el seu banc en aquell moment). `no_route` i `institution_unsupported` segueixen `bank_unsupported_action`, `attempts_exhausted` segueix `bank_attempts_exhausted_action`, i `person_choice` segueix `bank_skipped_action`, tret que un intent avaluat ja hagi decidit el pas." }, "country": { "type": "string", "nullable": true, "description": "El país on la persona s'estava verificant, ISO 3166-1 alfa-3. `null` si ha continuat abans de triar-ne un." }, "offered": { "type": "array", "items": { "type": "string", "enum": [ "statement", "microdeposits" ] }, "nullable": true, "description": "Les altres maneres de verificar que el país ha ofert a la persona quan ha continuat, en l'ordre en què les ha ofert: `statement` (una pujada d'un extracte), després `microdeposits`. Buit quan no n'ha ofert cap." }, "institution_id": { "type": "string", "nullable": true, "description": "Per a `institution_unsupported`, l'ID del banc que la persona no ha pogut utilitzar: el banc que va triar o el banc on va acabar el seu últim intent. Didit l'obté de la seva pròpia llista de bancs, mai del dispositiu de la persona, de manera que un banc que no estigui en aquesta llista és `null`. `null` per a qualsevol altre motiu." }, "institution_name": { "type": "string", "nullable": true, "description": "Per a `institution_unsupported`, el nom d'aquest banc, de la mateixa llista que `institution_id`. `null` quan aquesta llista no conté el banc, i per a qualsevol altre motiu." }, "continued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan la persona va continuar." } } }, "evidence_purged_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan es van eliminar les proves bancàries segons `bank_evidence_retention_days`. `null` en cas contrari." }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Codis informatius, per exemple `holder_declared`. Un advertiment mai canvia l'estat per si sol." }, "reason_codes": { "type": "array", "items": { "type": "string" }, "description": "Per què el veredicte ha estat aquest, per exemple `OWNER_NAME_PARTIAL`. Se'n poden aplicar diversos. `NOT_COVERED`: la persona ha continuat sense banc perquè cap mètode podia verificar el seu país o banc. `SKIPPED`: la persona ha decidit continuar sense banc tot i haver-hi una manera de verificar-lo. No s'afegeix cap dels dos quan un intent avaluat ja ha decidit el pas." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "BankAccountCheckPersonHolder": { "type": "object", "description": "La persona que hauria de ser titular del compte.", "required": [ "full_name" ], "properties": { "full_name": { "type": "string", "maxLength": 255, "description": "El nom complet de la persona que hauria de ser titular del compte.", "example": "Maria Oliveira" } } }, "BankAccountCheckBusinessHolder": { "type": "object", "description": "L'empresa que hauria de ser titular del compte. Comprova un compte d'empresa.", "required": [ "business_name" ], "properties": { "business_name": { "type": "string", "maxLength": 255, "description": "El nom de l'empresa que hauria de ser titular del compte. Comprova un compte d'empresa." } } }, "BankVerificationPricing": { "type": "object", "description": "Preus de la llista pública de Bank Verification: la càrrega de l'extracte, la tarifa de la clau de proveïdor pròpia i els mètodes de cada país.", "required": [ "currency", "statement_upload", "own_provider_fee_usd", "countries" ], "properties": { "currency": { "type": "string", "enum": [ "USD" ], "description": "Moneda de cada preu a la resposta.", "example": "USD" }, "statement_upload": { "$ref": "#/components/schemas/BankStatementUploadPricing" }, "own_provider_fee_usd": { "type": "string", "description": "Comissió per cada comprovació de titularitat facturable en una ruta que utilitza el teu propi contracte de proveïdor en lloc del de Didit, cobrada independentment del resultat. Una connexió cancel·lada, que ha superat el temps d'espera o abandonada no es factura. Cadena decimal amb 4 decimals, en USD.", "example": "0.0200" }, "countries": { "type": "object", "description": "Tots els països, indexats pel codi ISO 3166-1 alfa-3.", "additionalProperties": { "$ref": "#/components/schemas/BankVerificationPricingCountry" } } } }, "BankStatementUploadPricing": { "type": "object", "description": "Quin preu té la pujada de l'extracte bancari.", "required": [ "price_usd", "included_after_charged_bank_attempt", "standalone_available" ], "properties": { "price_usd": { "type": "string", "description": "Preu de la càrrega d'un extracte després d'un intent bancari cobrat. Cadena decimal amb 4 decimals, en USD.", "example": "0.0000" }, "included_after_charged_bank_attempt": { "type": "boolean", "description": "`true` quan la pujada s'inclou sense cap càrrec addicional després d'un intent bancari cobrat a la mateixa sessió.", "example": true }, "standalone_available": { "type": "boolean", "description": "`true` quan la pujada d'un extracte es pot executar per si sola, sense cap intent bancari previ. `false` a producció; les sessions sandbox ho poden provar sense facturació.", "example": false } } }, "BankVerificationPricingCountry": { "type": "object", "description": "Els mètodes de Verificació bancària d'un país i els seus preus de llista.", "required": [ "name", "methods" ], "properties": { "name": { "type": "string", "description": "Nom del país en anglès.", "example": "United Kingdom" }, "methods": { "$ref": "#/components/schemas/BankVerificationPricingMethods" } } }, "BankVerificationPricingMethods": { "type": "object", "description": "Els dos mètodes de verificació bancària en 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": "Inici de sessió bancari: la persona inicia sessió al seu banc. Preu segons el mercat, el mateix per a tots els bancs que en formen part.", "required": [ "available", "market", "price_usd", "add_ons" ], "properties": { "available": { "type": "boolean", "description": "`true` només on Didit ofereix l'inici de sessió bancari en aquest país a producció.", "example": true }, "market": { "type": "string", "nullable": true, "description": "El mercat el preu del qual s'aplica. `null` quan no estigui disponible.", "example": "UK and EEA" }, "price_usd": { "type": "string", "nullable": true, "description": "Preu de tarifa d'un inici de sessió bancari. `null` quan no estigui disponible. Cadena decimal amb 4 decimals, en USD.", "example": "0.7900" }, "add_ons": { "type": "object", "description": "Complements amb preu en aquest país, cadascun com a cadena decimal amb 4 decimals en USD, afegits al preu d'inici de sessió bancari. Només es llisten els complements que ofereix el país; buit quan l'inici de sessió bancari no està disponible.", "properties": { "balance": { "type": "string", "description": "Complement de saldo del compte.", "example": "0.3500" }, "transactions": { "type": "string", "description": "Complement de transaccions.", "example": "1.3000" } } } } }, "BankAccountCheckPricing": { "type": "object", "description": "Comprovació de compte: la persona escriu el seu número de compte i Didit el comprova amb el banc. Preu segons el país.", "required": [ "available", "price_usd" ], "properties": { "available": { "type": "boolean", "description": "`true` només on Didit ofereix la comprovació del compte en aquest país a producció.", "example": true }, "price_usd": { "type": "string", "nullable": true, "description": "Preu de tarifa d'una comprovació de compte que respon el banc. `null` quan no estigui disponible. Cadena decimal amb 4 decimals, 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 llista els registres amb la clau. `api_ids`: puja els identificadors de registre des d'una exportació. `export_file`: puja una exportació en el format 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": "Una tasca d'importació de qualsevol tipus, en el format que llegeix el calaix de tasques d'importació 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": "L'estat de la tasca tal com es mostra a la consola; `errors` és una tasca completada amb files rebutjades." }, "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 regulador finalitzat que impedeix l'eliminació sol·licitada.", "required": [ "uuid", "report_number", "report_type", "case_uuid" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID de l'informe." }, "report_number": { "type": "string", "description": "Número d'informe mostrat a la Console (per exemple, SAR-0001)." }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ], "description": "Tipus d'informe regulador." }, "case_uuid": { "type": "string", "format": "uuid", "description": "Cas al qual pertany l'informe." } } }, "FiledReportTransaction": { "type": "object", "description": "Una transacció que no es pot suprimir perquè un informe regulador finalitzat la inclou.", "required": [ "uuid", "transaction_id", "reports" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID de transacció de Didit." }, "transaction_id": { "type": "string", "description": "L'identificador de la transacció proporcionat quan es va crear la transacció." }, "reports": { "type": "array", "items": { "$ref": "#/components/schemas/FiledRegulatoryReport" }, "description": "Informes finalitzats que inclouen aquesta transacció." } } }, "InFiledReportError": { "type": "object", "description": "L'eliminació s'ha rebutjat perquè les dades seleccionades formen part d'un informe regulador finalitzat. No s'ha eliminat res. Elimina l'informe i després repeteix la sol·licitud.", "required": [ "detail", "code" ], "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "in_filed_report" ], "description": "Codi d'error estable per a una eliminació bloquejada per un informe normatiu finalitzat." }, "reports": { "type": "array", "items": { "$ref": "#/components/schemas/FiledRegulatoryReport" }, "description": "Informes que bloquegen la supressió d'una persona, empresa, cas o sessió." }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/FiledReportTransaction" }, "description": "Transaccions que bloquegen l'eliminació d'una transacció, cadascuna amb els informes que la llisten." } } }, "SubjectDeletionInProgressError": { "type": "object", "description": "Una altra sol·licitud encara està suprimint aquesta persona o empresa. Aquesta sol·licitud no ha suprimit res i es pot repetir un cop hagi finalitzat aquesta supressió; en repetir-la, se suprimirà allò que encara estigui seleccionat.", "required": [ "detail", "code" ], "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "subject_deletion_in_progress" ], "description": "Codi d'error estable per a una persona o empresa que una altra sol·licitud encara està eliminant." } } }, "TravelRuleNetworkParticipantSummary": { "type": "object", "nullable": true, "description": "El participant propi d'aquesta aplicació a la xarxa, o null si no en té cap.", "properties": { "mode": { "type": "string", "enum": [ "platform", "own" ], "description": "platform: gestionat a través de la pertinença de Didit; own: alta tramitada sota la pertinença pròpia de l'aplicació." }, "status": { "type": "string", "enum": [ "not_requested", "questionnaire_pending", "submitted_to_network", "active", "suspended", "rejected" ], "description": "not_requested: mai sol·licitat, o la xarxa ha rebutjat la primera sol·licitud (consulta last_error); questionnaire_pending: pendent que s'aprovi el qüestionari de diligència deguda; submitted_to_network: enviat al procés d'alta de la xarxa; active: la xarxa ha assignat a aquesta aplicació el seu propi codi de participant; suspended / rejected: Didit l'ha suspès o rebutjat." }, "participant_code": { "type": "string", "description": "El codi que la xarxa ha assignat a aquesta aplicació (per a GTR, el seu codi de VASP). Els missatges de sortida porten aquest codi, mai 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 resposta de la xarxa quan ha rebutjat el registre; buida en cas contrari." } } }, "TravelRuleNetworkState": { "type": "object", "description": "Com s'enviarien els missatges de Travel Rule en una xarxa per a aquesta aplicació, i per què no es poden enviar. És un estat de configuració, no una comprovació d'estat o de lliurament en directe.", "properties": { "rail": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA" ] }, "mode": { "type": "string", "enum": [ "own", "didit", "off", "unavailable" ], "description": "own: s'utilitza la pertinença connectada de l'aplicació; didit: la pertinença de Didit inclou l'aplicació com a participant actiu propi; off: enrutament de plataforma desactivat a disabled_networks sense pertinença pròpia; unavailable: encara no es pot enviar res en aquesta xarxa (consulta state i 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: envia la teva pertinença connectada; live_through_didit: envia el teu propi participant a través de la pertinença de Didit; off: has desactivat l'enrutament de plataforma; didit_onboarding: la pertinença pròpia de Didit a aquesta xarxa encara no està activa, per la qual cosa no pot donar cabuda a ningú; questionnaire_needed / questionnaire_in_review: cal enviar el qüestionari de diligència deguda o està en revisió per part de Didit; request_access: el qüestionari està aprovat, sol·licita l'accés a la xarxa; request_sent: s'està tramitant l'alta del teu participant; 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": "Detall de l'estat llegible per màquina. own_membership_only: Didit no gestiona aplicacions en aquesta xarxa (TRUST), connecta la teva pròpia pertinença; sandbox_application: les transferències de sandbox mai arriben a una xarxa; provisioning_failed: la xarxa ha rebutjat el registre, el camp last_error del participant n'indica el motiu i sol·licitar la xarxa de nou reintenta l'operació." }, "platform_available": { "type": "boolean", "description": "Indica si la pertinença de Didit a aquesta xarxa està configurada; no és una comprovació de l'estat en temps real." }, "connected": { "type": "boolean", "description": "Indica si existeix una pertinença de client connectada. Les credencials es validen localment; la validació de la xarxa es produeix en un intercanvi en temps real." }, "participant": { "$ref": "#/components/schemas/TravelRuleNetworkParticipantSummary" }, "vasps_reachable": { "type": "integer", "description": "VASP del directori accessibles en aquesta xarxa." }, "routed_30d": { "type": "integer", "description": "Les transferències d'aquesta aplicació cursades en aquesta xarxa en els darrers 30 dies." } } }, "TravelRuleNetworkQuestionnaireAnswers": { "type": "object", "description": "Qüestionari de diligència deguda de xarxa de Didit. Els desats són parcials: un desat manté totes les respostes que no esmenta. Per enviar-lo cal completar tots els camps excepte lei i data_protection_contact_email, i que les tres atestacions siguin certes.", "properties": { "legal_name": { "type": "string", "maxLength": 255 }, "registration_number": { "type": "string", "maxLength": 255 }, "incorporation_country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Codi 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àlid quan s'indica." }, "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": "Codi de país ISO 3166-1 alfa-2." }, "licence_type": { "type": "string", "maxLength": 255 }, "licence_number": { "type": "string", "maxLength": 255 } } }, "description": "Totes les llicències o registres que posseeix el VASP." }, "operating_jurisdictions": { "type": "array", "minItems": 1, "maxItems": 250, "items": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Codi 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": "Ha de ser true per enviar." }, "sanctions_screening_attested": { "type": "boolean", "description": "Ha de ser true per enviar." }, "data_protection_attested": { "type": "boolean", "description": "Ha de ser true per 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": "Volum mensual esperat en USD, amb fins a 2 decimals. Es retorna com una cadena." }, "assets": { "type": "array", "minItems": 1, "maxItems": 200, "items": { "type": "string", "maxLength": 32 }, "description": "Tíquers d'actius, emmagatzemats en majúscules, ordenats i sense duplicats." } } }, "TravelRuleNetworkQuestionnaire": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "draft", "submitted", "changes_requested", "approved", "rejected" ], "description": "Les respostes es poden desar mentre estiguin en draft o changes_requested; correspon a Didit moure submitted, approved i rejected." }, "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 la seva darrera decisió, per exemple què cal canviar." }, "history": { "type": "array", "readOnly": true, "description": "Tots els canvis d'estat, del més antic al més recent.", "items": { "type": "object", "properties": { "at": { "type": "string", "format": "date-time" }, "from": { "type": "string" }, "to": { "type": "string" }, "note": { "type": "string", "description": "Nota de revisió o resposta de la xarxa, quan n'hi hagi." } } } }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } }, "TravelRuleNetworkParticipant": { "type": "object", "description": "El participant propi d'aquesta aplicació en una xarxa.", "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: mai sol·licitat, o la xarxa ha rebutjat la primera sol·licitud (consulta last_error); questionnaire_pending: pendent que s'aprovi el qüestionari de diligència deguda; submitted_to_network: enviat al procés d'alta de la xarxa; active: la xarxa ha assignat a aquesta aplicació el seu propi codi de participant; suspended / rejected: Didit l'ha suspès o rebutjat." }, "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 resposta de la xarxa quan ha rebutjat el registre; buida en cas contrari." }, "history": { "type": "array", "readOnly": true, "description": "Tots els canvis d'estat, del més antic al més recent.", "items": { "type": "object", "properties": { "at": { "type": "string", "format": "date-time" }, "from": { "type": "string" }, "to": { "type": "string" }, "note": { "type": "string", "description": "Nota de revisió o resposta de la xarxa, quan n'hi hagi." } } } } } }, "TravelRuleNetworksOverview": { "type": "object", "properties": { "platform_networks_enabled": { "type": "boolean", "description": "Indica si l'accés a la xarxa mitjançant la pertinença de Didit està obert. Mentre sigui false, el desat de qüestionaris, els enviaments i les sol·licituds de xarxa respondran 403." }, "questionnaire": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleNetworkParticipant" } }, "networks": { "type": "object", "readOnly": true, "description": "Per xarxa, com enviaria aquesta aplicació i per què no pot fer-ho. Cap xarxa, inclosa GTR, s'inclou per defecte: es pot accedir a una xarxa mitjançant la teva pròpia pertinença connectada, o mitjançant la pertinença de Didit un cop la pertinença de Didit a aquesta xarxa estigui activa i el teu propi participant hi estigui actiu. No és una comprovació d'estat o de lliurament en directe.", "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 resultat d'una Address Validation: si l'adreça existeix i la seva forma normalitzada. Només confirma l'adreça; mai vincula l'adreça 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`: l'adreça s'ha confirmat fins a l'edifici (o el pis o l'apartat de correus). `partially_verified`: s'ha confirmat només fins al carrer, o fins al nivell més precís que tenen les dades postals de referència per a aquest lloc. `not_verified`: només ha coincidit la regió o la ciutat, o no ha coincidit res. `unavailable`: la validació no s'ha pogut executar (per exemple, el servei de referència no ha respost); no es cobra i no afecta mai una verificació." }, "verification_level": { "type": "string", "nullable": true, "enum": [ "administrative_area", "locality", "thoroughfare", "premise", "delivery_point", null ], "description": "El nivell més precís amb què s'ha fet coincidir l'adreça. `null` quan no hi ha cap coincidència o `status` és `unavailable`." }, "address": { "type": "object", "nullable": true, "description": "L'adreça normalitzada. `null` quan `status` és `unavailable`.", "properties": { "address_line_1": { "type": "string", "nullable": true, "description": "Primera línia de lliurament, escrita de la manera habitual del país.", "example": "1600 Amphitheatre Pkwy" }, "address_line_2": { "type": "string", "nullable": true, "description": "Segona línia de lliurament (un pis, edifici o barri), quan l'adreça en tingui." }, "city": { "type": "string", "nullable": true, "example": "Mountain View" }, "region": { "type": "string", "nullable": true, "description": "Estat, província o regió.", "example": "CA" }, "postal_code": { "type": "string", "nullable": true, "example": "94043-1351" }, "country": { "type": "string", "nullable": true, "description": "Codi de país ISO 3166-1 alfa-2.", "example": "US" } } }, "formatted_address": { "type": "string", "nullable": true, "description": "L'adreça normalitzada en una línia.", "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 adreça: en una sola línia (`address`) o com a camps estructurats amb almenys `address_line_1`, mai tots dos alhora.", "properties": { "address": { "type": "string", "maxLength": 500, "description": "Tota l'adreça en una sola línia.", "example": "Paseo de la Castellana 259, 28046 Madrid" }, "address_line_1": { "type": "string", "maxLength": 255, "description": "Carrer i número.", "example": "1600 Amphitheatre Pkwy" }, "address_line_2": { "type": "string", "maxLength": 255, "description": "Apartament, suite, planta o edifici." }, "city": { "type": "string", "maxLength": 128, "description": "Ciutat o localitat.", "example": "Mountain View" }, "region": { "type": "string", "maxLength": 128, "description": "Estat, província o regió.", "example": "CA" }, "postal_code": { "type": "string", "maxLength": 32, "example": "94043" }, "country": { "type": "string", "maxLength": 3, "description": "Codi ISO 3166-1 alpha-2 o alpha-3 del país de l'adreça.", "example": "US" } } }, "AddressValidationResponse": { "type": "object", "required": [ "request_id", "address_validation", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Identificador d'aquesta sol·licitud; indica'l a l'equip de suport. No s'ha creat cap sessió." }, "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": "Per què una prova de titularitat de la cartera, o el seu últim intent, no ha arribat a VERIFIED. Buit si no ha fallat res. Una prova PENDING en pot contenir un: l'últim intent ha fallat i l'usuari final pot tornar-ho a provar. DEPOSIT_MISMATCH, DEPOSIT_STALE, TXID_REUSED i REVIEW_REJECTED tanquen la prova com a REJECTED. SIGNATURE_INVALID: la signatura no coincideix amb la cartera i el repte. SIGNATURE_UNSUPPORTED_SCHEME: la cartera ha signat en un format que Didit no verifica. DEPOSIT_NOT_FOUND, DEPOSIT_UNCONFIRMED, DEPOSIT_LOOKUP_FAILED: el dipòsit de prova no es pot llegir o encara no està confirmat; Didit continua comprovant-lo fins que es tanca la finestra de prova. DEPOSIT_MISMATCH: la transacció no envia l'import esperat des de la cartera a l'adreça de dipòsit. DEPOSIT_STALE: la transacció és anterior al repte. TXID_REUSED: la transacció ja ha provat una altra cartera. CHAIN_UNSUPPORTED: el mètode no està disponible en aquesta cadena. WINDOW_EXPIRED: la finestra de prova s'ha tancat. OWNERSHIP_CHANGED: el titular de la cartera ha canviat, o la cartera s'ha suprimit de la teva llibreta d'adreces, després que s'hagués generat la sessió del widget. METHOD_SWITCHED: l'usuari final ha triat un altre mètode abans d'acabar aquest. REVIEW_REJECTED: el teu revisor ha rebutjat la captura de pantalla. ABANDONED: la sessió del widget ha caducat abans que l'usuari final acabés." }, "TravelRuleWidgetProofError": { "type": "object", "properties": { "detail": { "type": "string", "description": "Missatge fàcil de llegir en anglès." }, "code": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "Motiu llegible per màquina, perquè un client pugui mostrar el seu propi missatge traduït." }, "status": { "type": "string", "enum": [ "PENDING", "VERIFIED", "REJECTED", "EXPIRED" ], "description": "Present quan la prova està tancada: REJECTED pel dipòsit que s'acaba d'enviar (400), o REJECTED o EXPIRED quan s'envien evidències a una prova que ja està tancada (409)." }, "proof_id": { "type": "string", "format": "uuid", "description": "Present amb estat: la prova tancada." }, "method": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SATOSHI_TEST", "SCREENSHOT", "SELF_DECLARATION" ], "description": "Present amb estat: el mètode de la prova tancada." }, "max_attempts": { "type": "integer", "description": "Present amb estat: proves de cartera rebutjades que permet aquesta sessió." }, "attempts_used": { "type": "integer", "description": "Present amb estat: proves rebutjades fins ara." }, "attempts_remaining": { "type": "integer", "description": "Present amb estat: quan és 0, iniciar una altra prova respon 409 i es genera una nova sessió del widget." } } }, "TravelRuleWidgetProofCreate": { "type": "object", "required": [ "method" ], "properties": { "method": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SATOSHI_TEST", "SCREENSHOT", "SELF_DECLARATION" ], "description": "El mètode de prova que ha triat l'usuari final. Ha de ser un dels allowed_methods del context." }, "wallet_address": { "type": "string", "maxLength": 128, "description": "Per defecte, el wallet_address de la sessió. Ha de coincidir amb la cartera de la transferència quan la sessió està vinculada a una transferència." }, "chain": { "type": "string", "maxLength": 32, "description": "Per defecte, la cadena de la sessió." } } }, "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": "Present quan la prova és VERIFIED: l'entrada de la llibreta d'adreces ara té la titularitat verificada." }, "transfer_status": { "type": "string", "nullable": true, "description": "Present quan la prova és VERIFIED: l'estat de la transferència vinculada, null si no n'hi ha cap." }, "detail": { "type": "string", "description": "Present mentre la prova roman PENDING: una captura de pantalla enviada pendent de revisió, o un dipòsit de prova que encara no s'ha confirmat." }, "code": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "Present en un dipòsit de prova pendent: el motiu pel qual encara no està confirmat." } } }, "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ònic de la cadena, p. ex. ETH, BTC, SOL, TRX." }, "holder_name": { "type": "string" }, "is_ownership_verified": { "type": "boolean", "description": "Indica si l'entrada de la llibreta d'adreces té la titularitat verificada, mitjançant aquesta prova o una altra." }, "transaction_id": { "type": "string", "format": "uuid", "nullable": true, "description": "La transacció per a la transferència de Travel Rule de la qual es va generar la sessió del widget. Null per a una sessió generada sense transaction_id." }, "file_name": { "type": "string", "nullable": true }, "content_type": { "type": "string", "nullable": true }, "screenshot_url": { "type": "string", "nullable": true, "description": "Enllaç de durada limitada a la captura de pantalla pujada. Torna a llistar la cua per obtenir un enllaç actualitzat." }, "attempts": { "type": "integer", "description": "Quants fitxers ha pujat l'usuari final per a aquest comprovant." }, "failure_reason": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "REVIEW_REJECTED després d'un rebuig, OWNERSHIP_CHANGED quan la cartera ha canviat de titular o s'ha eliminat abans d'una decisió. Buit en cas contrari." }, "method_chosen_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan l'usuari final va triar el mètode de captura de pantalla." }, "decided_at": { "type": "string", "format": "date-time", "nullable": true }, "decided_by": { "type": "string", "description": "Qui ha tancat la prova: review: per a un revisor de la consola, review per a una decisió amb clau d'API, widget o sweeper quan Didit l'ha tancat automàticament. Buit mentre estigui en PENDING." }, "review_note": { "type": "string", "description": "La nota enviada amb la decisió. Buida quan no n'hi ha cap." }, "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. Es conserva amb la prova i es retorna com a review_note." } } }, "DigitalIdWalletApiWalletDigitalCredentialsRequest": { "type": "object", "properties": { "protocol": { "type": "string", "description": "openid4vp-v1-signed." }, "request": { "type": "object", "additionalProperties": {}, "description": "Passa-ho tal com està: navigator.credentials.get({digital: request}) al navegador, o JSON.stringify(request) com a requestJson de GetDigitalCredentialOption a Android. Signat per Didit per a la teva aplicació." } }, "required": [ "protocol", "request" ] }, "DigitalIdWalletApiGoogleWalletWalletVerificationStartRequest": { "type": "object", "description": "Inicia una verificació amb Google Wallet (USA, GBR, BRA, SGP, TWN).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "La teva pròpia referència per a aquesta verificació (p. ex., el teu identificador d'usuari). Es retorna als resultats i als webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objecte JSON opcional emmagatzemat amb la verificació i retornat en resultats i webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Només per a aplicacions de sandbox: el resultat simulat ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error'); amb qualsevol altre escenari (o sense), la verificació és correcta. Es rebutja en aplicacions en producció. El catàleg complet està disponible a GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiGoogleWalletWalletVerificationStartCountryEnum" } ], "description": "País ISO 3166-1 alpha-3 de la identitat Google Wallet.\n\n* `USA` - USA\n* `GBR` - GBR\n* `BRA` - BRA\n* `SGP` - SGP\n* `TWN` - TWN" }, "origin": { "type": "string", "minLength": 1, "description": "On la teva pàgina o aplicació farà la petició a la cartera: l'origen https de la teva pàgina (el seu host ha d'estar a allowed_return_hosts de l'aplicació, o ser el seu domini de marca blanca), p. ex. https://app.example.com, o android:apk-key-hash:. La cartera rebutja la sol·licitud des de qualsevol altre lloc.", "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": "El que la cartera ha respost a la teva pàgina o aplicació, per a una verificació de ``request_digital_credential``.", "properties": { "response": { "type": "object", "additionalProperties": {}, "description": "Exactament el que ha retornat la cartera: {protocol, data} del DigitalCredential de navigator.credentials.get, o el credentialJson analitzat del DigitalCredential d'Android. Xifrat per a Didit; no ho alteris." } }, "required": [ "response" ] }, "SessionFilesExport": { "type": "object", "description": "Un ZIP amb tots els fitxers d'una sessió, amb la qualitat 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 l'exportació. Passa'l a `GET /v3/session/{sessionId}/files-export/{exportId}/`." }, "session_id": { "type": "string", "format": "uuid", "description": "La sessió d'on provenen els fitxers." }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "READY", "FAILED", "EXPIRED" ], "description": "`PENDING` i `PROCESSING` mentre es prepara el ZIP, `READY` un cop es pot descarregar, `FAILED` quan no s'ha pogut preparar (sol·licita una nova exportació), `EXPIRED` un cop s'ha suprimit el ZIP." }, "file_count": { "type": "integer", "nullable": true, "description": "Fitxers del ZIP. Només s'estableix mentre `status` és `READY`." }, "size_bytes": { "type": "integer", "format": "int64", "nullable": true, "description": "Mida del ZIP en bytes. Només s'estableix mentre `status` és `READY`." }, "download_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL signada del ZIP, vàlida durant un període curt. Només s'estableix mentre `status` és `READY`; torna a llegir l'exportació per obtenir-ne una de nova." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan s'elimina el ZIP, 24 hores després d'estar llest. S'estableix només mentre `status` és `READY`." }, "error": { "type": "string", "nullable": true, "description": "Per què ha fallat l'exportació, quan `status` és `FAILED`." }, "created_at": { "type": "string", "format": "date-time", "description": "Quan es va sol·licitar l'exportació." }, "completed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quan el ZIP va estar llest o l'exportació va fallar." } } }, "TransactionRuleSuggestionsCreatedEvent": { "description": "Una execució de suggeriments de regles de transacció ha proposat nous canvis de regles per a la teva aplicació. S'envia quan la configuració de suggeriments de regles té les notificacions per webhook activades. No hi ha cap `status` de nivell superior.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "transaction_rule_suggestions.created" ], "description": "Sempre `transaction_rule_suggestions.created`." }, "run_id": { "type": "string", "format": "uuid", "description": "L'execució de suggeriments que ha generat els nous suggeriments." }, "open_count": { "type": "integer", "description": "Nombre de suggeriments que continuen oberts després d'aquesta execució, inclosos els nous." }, "suggestions": { "type": "array", "description": "Els suggeriments que ha creat aquesta execució.", "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` proposa una regla nova, `TWEAK` modifica una existent, `DISABLE` en desactiva una." }, "title": { "type": "string" }, "rule_id": { "type": "string", "format": "uuid", "nullable": true, "description": "La regla a la qual s'aplica un suggeriment `TWEAK` o `DISABLE`; `null` per a `ADD`." }, "expected_impact": { "type": "object", "additionalProperties": true, "description": "Què faria el canvi, tal com mostra el suggeriment a la Console." } } } } }, "required": [ "webhook_type", "run_id", "open_count", "suggestions" ] } ] }, "GeolocationCheck": { "type": "object", "description": "Un resultat de verificació d'Ubicació, l'intent acceptat d'un node de flux de treball. La mesura, la incertesa i l'autenticitat són claus separades, de manera que una posició precisa no atestada s'interpreta de manera diferent d'una d'imprecisa però atestada.", "properties": { "node_id": { "type": "string", "nullable": true, "description": "Node del flux de treball que ha generat aquest resultat, de manera que un flux de treball amb dos passos de verificació d'ubicació continuï sent llegible." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estat a nivell de funcionalitat d'aquest pas de verificació d'ubicació, resolt a partir de les seves advertències. Independent de l'`status` de la sessió." }, "outcome": { "type": "string", "nullable": true, "description": "Què ha passat en aquest intent.", "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": "Què ha concedit el sistema operatiu o el navegador. `not_requested` significa que el pas només utilitza la ubicació IP de la connexió, de manera que mai no se sol·licita cap permís 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ó. `null` quan no hi ha posició.", "format": "double" }, "longitude": { "type": "number", "nullable": true, "description": "Longitud WGS84 de la posició. `null` quan no hi ha posició.", "format": "double" }, "accuracy_m": { "type": "number", "nullable": true, "description": "Radi d'incertesa en metres, al nivell de confiança indicat a `accuracy_confidence`.", "format": "double" }, "accuracy_confidence": { "type": "string", "nullable": true, "description": "Nivell de confiança que la plataforma assigna a `accuracy_m`: `p95` (navegadors), `p68` (Android) o `unspecified` (iOS).", "enum": [ "p95", "p68", "unspecified", null ] }, "measured_at": { "type": "string", "nullable": true, "description": "Quan el dispositiu va obtenir la posició, segons el seu propi rellotge.", "format": "date-time" }, "age_seconds": { "type": "integer", "nullable": true, "description": "Segons entre el moment en què el dispositiu obté la posició i Didit la rep." }, "source": { "type": "string", "nullable": true, "description": "D'on prové la posició, quan la plataforma ho indica. `ip` significa que la posició és la ubicació IP de la connexió.", "enum": [ "gps", "fused", "network", "wifi", "cell", "browser", "unknown", "ip", null ] }, "platform": { "type": "string", "nullable": true, "description": "El client que ha generat la correcció.", "enum": [ "web", "ios", "android", "react_native", "flutter", null ] }, "sdk_version": { "type": "string", "nullable": true, "description": "Versió de l'SDK que ha produït la correcció." }, "is_mock": { "type": "boolean", "nullable": true, "description": "`true` quan el dispositiu indica que la posició prové d'un proveïdor d'ubicació simulada o programari de simulació. `null` quan la plataforma no ho reporta (els navegadors no ho poden determinar); `null` no és `false`." }, "produced_by_accessory": { "type": "boolean", "nullable": true, "description": "Només per a iOS: `true` quan la posició prové d'un accessori extern. `null` a la resta de casos." }, "integrity": { "type": "string", "enum": [ "attested", "not_attested", "failed", "unsupported", "not_determined" ], "description": "Indica si l'atestació del dispositiu avala la correcció. `unsupported` és el que informen els navegadors, perquè el web no té cap mecanisme d'atestació; no és un error." }, "country_code": { "type": "string", "nullable": true, "description": "País ISO 3166-1 alpha-2 on es troba la posició." }, "region_code": { "type": "string", "nullable": true, "description": "Subdivisió ISO 3166-2 en què es troba la posició." }, "city": { "type": "string", "nullable": true, "description": "Lloc poblat més proper, una etiqueta per als revisors." }, "geofence": { "type": "object", "description": "Resultat de les regles de país i àrea del pas.", "properties": { "enabled": { "type": "boolean", "description": "Si el pas aplica alguna regla de país o de zona." }, "result": { "type": "string", "nullable": true, "description": "On se situa la posició respecte a les regles. `undetermined` significa que el cercle de precisió cavalca la frontera o que la posició no s'ha resolt a cap país; no és una prova que estigui fora.", "enum": [ "inside", "outside", "undetermined", null ] } } }, "inside_geofence": { "type": "boolean", "nullable": true, "description": "`true` quan `geofence.result` és `inside`, `false` quan és `outside`, `null` en cas contrari." }, "geofence_basis": { "type": "string", "nullable": true, "description": "A partir de quina posició s'ha avaluat el resultat de la zona: la ubicació del `device` o la ubicació `ip` de la connexió.", "enum": [ "device", "ip", null ] }, "inside_areas": { "type": "array", "items": { "type": "string" }, "description": "Identificadors de les àrees permeses configurades dins de les quals es troba la posició." }, "blocked_areas": { "type": "array", "items": { "type": "string" }, "description": "Identificadors de les àrees bloquejades configurades en què es troba la posició." }, "position_source": { "type": "string", "nullable": true, "description": "D'on obté la posició el pas, segons la configuració: el dispositiu contrastat amb la ubicació de la IP, només el dispositiu o només la ubicació de la IP.", "enum": [ "device_and_ip", "device_only", "ip_only", null ] }, "anonymizers": { "type": "object", "nullable": true, "description": "Quines característiques tenen la connexió i el dispositiu, cadascuna `true`, `false` o `null` quan la font no ho pot determinar.", "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": "Distància fins a la ubicació IP de la sessió després de restar ambdós radis d'incertesa; `0` quan se superposen.", "format": "double" }, "ip_distance_uncertainty_km": { "type": "number", "nullable": true, "description": "Radi combinat que s'ha restat: el radi de la ubicació de la IP més la precisió d'aquesta ubicació.", "format": "double" }, "ip_consistent": { "type": "boolean", "nullable": true, "description": "Indica si `ip_distance_km` és dins de la distància configurada al pas. `null` quan es desconeix algun dels dos costats." }, "document_distance_km": { "type": "number", "nullable": true, "description": "Distància fins a l'adreça geocodificada del document d'identitat o comprovant de domicili. `null` quan no hi ha cap adreça registrada.", "format": "double" }, "travel_excused": { "type": "boolean", "nullable": true, "description": "Si la tolerància de viatge del pas ha dispensat la distància respecte a l'adreça. `null` quan la tolerància està desactivada." }, "consecutive_mismatches": { "type": "integer", "nullable": true, "description": "En l'intent final: aquesta comprovació més les no-coincidències anteriors de la mateixa persona de forma consecutiva." }, "attempts": { "type": "integer", "description": "Número d'aquest intent dins del node, començant per 1." }, "consent": { "type": "object", "nullable": true, "description": "El consentiment que la persona ha donat abans de la indicació del sistema, registrat amb la versió del redactat i l'idioma que ha vist.", "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 funcionalitat que ha generat aquesta advertència. El valor identifica el bloc de funcionalitat al qual pertany l'advertència. L'array d'advertències de cada mòdul sol utilitzar el valor que coincideix amb el seu mòdul (p. ex. `PHONE` dins de `phone_verifications[].warnings`), però l'enum anterior és vinculant per a totes les advertències de funcionalitats al payload de la decisió." }, "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": "L'ID del node del graf del flux de treball que ha generat aquesta advertència" } } }, "description": "Advertències que ha generat aquest pas de verificació d'ubicació, amb `feature` establert a `GEOLOCATION`. Els codis d'advertència comencen per `LOCATION_`." } } }, "GeolocationAttempt": { "type": "object", "description": "Un intent d'un pas de verificació d'Ubicació: les mateixes claus que `geolocation_checks[]` excepte `warnings`, més el moment en què Didit el va rebre.", "properties": { "node_id": { "type": "string", "nullable": true, "description": "Node del flux de treball que ha generat aquest resultat, de manera que un flux de treball amb dos passos de verificació d'ubicació continuï sent llegible." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Estat a nivell de funcionalitat d'aquest pas de verificació d'ubicació, resolt a partir de les seves advertències. Independent de l'`status` de la sessió." }, "outcome": { "type": "string", "nullable": true, "description": "Què ha passat en aquest intent.", "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": "Què ha concedit el sistema operatiu o el navegador. `not_requested` significa que el pas només utilitza la ubicació IP de la connexió, de manera que mai no se sol·licita cap permís 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ó. `null` quan no hi ha posició.", "format": "double" }, "longitude": { "type": "number", "nullable": true, "description": "Longitud WGS84 de la posició. `null` quan no hi ha posició.", "format": "double" }, "accuracy_m": { "type": "number", "nullable": true, "description": "Radi d'incertesa en metres, al nivell de confiança indicat a `accuracy_confidence`.", "format": "double" }, "accuracy_confidence": { "type": "string", "nullable": true, "description": "Nivell de confiança que la plataforma assigna a `accuracy_m`: `p95` (navegadors), `p68` (Android) o `unspecified` (iOS).", "enum": [ "p95", "p68", "unspecified", null ] }, "measured_at": { "type": "string", "nullable": true, "description": "Quan el dispositiu va obtenir la posició, segons el seu propi rellotge.", "format": "date-time" }, "age_seconds": { "type": "integer", "nullable": true, "description": "Segons entre el moment en què el dispositiu obté la posició i Didit la rep." }, "source": { "type": "string", "nullable": true, "description": "D'on prové la posició, quan la plataforma ho indica. `ip` significa que la posició és la ubicació IP de la connexió.", "enum": [ "gps", "fused", "network", "wifi", "cell", "browser", "unknown", "ip", null ] }, "platform": { "type": "string", "nullable": true, "description": "El client que ha generat la correcció.", "enum": [ "web", "ios", "android", "react_native", "flutter", null ] }, "sdk_version": { "type": "string", "nullable": true, "description": "Versió de l'SDK que ha produït la correcció." }, "is_mock": { "type": "boolean", "nullable": true, "description": "`true` quan el dispositiu indica que la posició prové d'un proveïdor d'ubicació simulada o programari de simulació. `null` quan la plataforma no ho reporta (els navegadors no ho poden determinar); `null` no és `false`." }, "produced_by_accessory": { "type": "boolean", "nullable": true, "description": "Només per a iOS: `true` quan la posició prové d'un accessori extern. `null` a la resta de casos." }, "integrity": { "type": "string", "enum": [ "attested", "not_attested", "failed", "unsupported", "not_determined" ], "description": "Indica si l'atestació del dispositiu avala la correcció. `unsupported` és el que informen els navegadors, perquè el web no té cap mecanisme d'atestació; no és un error." }, "country_code": { "type": "string", "nullable": true, "description": "País ISO 3166-1 alpha-2 on es troba la posició." }, "region_code": { "type": "string", "nullable": true, "description": "Subdivisió ISO 3166-2 en què es troba la posició." }, "city": { "type": "string", "nullable": true, "description": "Lloc poblat més proper, una etiqueta per als revisors." }, "geofence": { "type": "object", "description": "Resultat de les regles de país i àrea del pas.", "properties": { "enabled": { "type": "boolean", "description": "Si el pas aplica alguna regla de país o de zona." }, "result": { "type": "string", "nullable": true, "description": "On se situa la posició respecte a les regles. `undetermined` significa que el cercle de precisió cavalca la frontera o que la posició no s'ha resolt a cap país; no és una prova que estigui fora.", "enum": [ "inside", "outside", "undetermined", null ] } } }, "inside_geofence": { "type": "boolean", "nullable": true, "description": "`true` quan `geofence.result` és `inside`, `false` quan és `outside`, `null` en cas contrari." }, "geofence_basis": { "type": "string", "nullable": true, "description": "A partir de quina posició s'ha avaluat el resultat de la zona: la ubicació del `device` o la ubicació `ip` de la connexió.", "enum": [ "device", "ip", null ] }, "inside_areas": { "type": "array", "items": { "type": "string" }, "description": "Identificadors de les àrees permeses configurades dins de les quals es troba la posició." }, "blocked_areas": { "type": "array", "items": { "type": "string" }, "description": "Identificadors de les àrees bloquejades configurades en què es troba la posició." }, "position_source": { "type": "string", "nullable": true, "description": "D'on obté la posició el pas, segons la configuració: el dispositiu contrastat amb la ubicació de la IP, només el dispositiu o només la ubicació de la IP.", "enum": [ "device_and_ip", "device_only", "ip_only", null ] }, "anonymizers": { "type": "object", "nullable": true, "description": "Quines característiques tenen la connexió i el dispositiu, cadascuna `true`, `false` o `null` quan la font no ho pot determinar.", "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": "Distància fins a la ubicació IP de la sessió després de restar ambdós radis d'incertesa; `0` quan se superposen.", "format": "double" }, "ip_distance_uncertainty_km": { "type": "number", "nullable": true, "description": "Radi combinat que s'ha restat: el radi de la ubicació de la IP més la precisió d'aquesta ubicació.", "format": "double" }, "ip_consistent": { "type": "boolean", "nullable": true, "description": "Indica si `ip_distance_km` és dins de la distància configurada al pas. `null` quan es desconeix algun dels dos costats." }, "document_distance_km": { "type": "number", "nullable": true, "description": "Distància fins a l'adreça geocodificada del document d'identitat o comprovant de domicili. `null` quan no hi ha cap adreça registrada.", "format": "double" }, "travel_excused": { "type": "boolean", "nullable": true, "description": "Si la tolerància de viatge del pas ha dispensat la distància respecte a l'adreça. `null` quan la tolerància està desactivada." }, "consecutive_mismatches": { "type": "integer", "nullable": true, "description": "En l'intent final: aquesta comprovació més les no-coincidències anteriors de la mateixa persona de forma consecutiva." }, "attempts": { "type": "integer", "description": "Número d'aquest intent dins del node, començant per 1." }, "consent": { "type": "object", "nullable": true, "description": "El consentiment que la persona ha donat abans de la indicació del sistema, registrat amb la versió del redactat i l'idioma que ha vist.", "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": "Quan Didit ha rebut l'intent.", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" } } }, "BiometricRetention": { "type": "object", "description": "Quan s'eliminen les dades biomètriques en directe d'aquesta sessió.", "required": [ "jurisdictions", "deletes_at" ], "properties": { "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Codis dels estats dels EUA les regles biomètriques dels quals estableixen un límit d'eliminació per a aquesta persona (`US` quan l'estat és desconegut). Buit quan no se n'aplica cap." }, "deletes_at": { "type": "string", "format": "date-time", "nullable": true, "description": "La data en què s'eliminen les dades biomètriques en viu (imatges facials i plantilles) d'aquesta sessió, a partir de la configuració de conservació de la teva aplicació i, quan sigui aplicable, del límit legal per a la jurisdicció de la persona. `null` quan encara no s'aplica cap data." } } }, "TravelRuleManualMatchRequest": { "type": "object", "required": [ "transaction_id" ], "properties": { "transaction_id": { "type": "string", "format": "uuid", "description": "El `transaction_id` del missatge de Travel Rule rebut (una fila amb `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 clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys." }, "TransactionTokenAuth": { "type": "apiKey", "in": "header", "name": "X-Transaction-Token", "description": "Token d'abast limitat de curta durada generat pel teu backend mitjançant POST /v3/transactions/sdk-token/. Utilitzat pels SDK de Didit als endpoints /v1/transactions/ orientats al dispositiu." }, "SessionTokenAuth": { "type": "apiKey", "in": "header", "name": "Session-Token", "description": "Token de curta durada retornat al camp `session_token` de POST /v3/session/. Utilitzat pel flux de verificació allotjat (i les interfícies de sandbox personalitzades) per cridar endpoints d'abast de sessió en nom de l'usuari que es verifica, sense la teva clau d'API del costat del servidor." }, "BearerAuth": { "type": "http", "scheme": "bearer", "description": "El token d'accés de credencials de client de l'aplicació." }, "CaseRequestToken": { "type": "apiKey", "in": "header", "name": "X-Case-Request-Token", "description": "Credencial específica de la sol·licitud provinent de l'enllaç segur. Concedeix accés només a aquesta sol·licitud." } }, "responses": { "Unauthorized": { "description": "No autoritzat", "content": { "application/json": { "examples": { "Invalid API Key": { "summary": "Clau d'API no vàlida", "value": { "detail": "Invalid API Key." } } } } } }, "Forbidden": { "description": "Prohibit", "content": { "application/json": { "examples": { "No Permission": { "summary": "Sense permís", "value": { "detail": "You do not have permission to perform this action." } }, "Not Enough Credits": { "summary": "No hi ha prou crèdits", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "NotFound": { "description": "No s'ha trobat", "content": { "application/json": { "examples": { "Not Found": { "summary": "No s'ha trobat", "value": { "detail": "Resource not found." } } } } } }, "PhoneRiskValidationError": { "description": "Ha fallat la validació de la sol·licitud.", "content": { "application/json": { "examples": { "Missing phone number": { "summary": "Falta el número de telèfon", "value": { "phone_number": [ "This field is required." ] } }, "Invalid phone number": { "summary": "Número de telèfon no vàlid", "value": { "phone_number": [ "Invalid phone number provided." ] } }, "Invalid signal IP": { "summary": "IP de senyal no vàlida", "value": { "signals": { "ip": [ "Enter a valid IPv4 or IPv6 address." ] } } } } } } }, "EmailRiskValidationError": { "description": "Ha fallat la validació de la sol·licitud.", "content": { "application/json": { "examples": { "Missing email": { "summary": "Falta el correu electrònic", "value": { "email": [ "This field is required." ] } }, "Invalid email": { "summary": "Correu electrònic no vàlid", "value": { "email": [ "Enter a valid email address." ] } }, "Invalid country hint": { "summary": "Indicació de país no vàlida", "value": { "country_code": [ "Ensure this field has no more than 3 characters." ] } } } } } }, "IPRiskValidationError": { "description": "Ha fallat la validació de la sol·licitud.", "content": { "application/json": { "examples": { "Missing IP address": { "summary": "Falta l'adreça IP", "value": { "ip_address": [ "This field is required." ] } }, "Invalid IP address": { "summary": "Adreça IP no vàlida", "value": { "ip_address": [ "Enter a valid IPv4 or IPv6 address." ] } }, "Country hint too long": { "summary": "Indicació de país massa llarga", "value": { "claimed_country": [ "Ensure this field has no more than 3 characters." ] } } } } } }, "RiskPermissionDenied": { "description": "Falta la clau d'API o no és vàlida, o l'organització no pot cobrir la consulta en temps real. Aquesta API mai no retorna `401`.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Sense capçalera `x-api-key`, o la clau no és vàlida o s'ha revocat", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "El saldo de l'organització no pot cobrir el preu de la consulta", "value": { "error": "You don't have enough credits to perform this request." } } } } } }, "RateLimitedWrite": { "description": "S'ha superat el límit compartit d'escriptura de 300 sol·licituds per minut per clau d'API. Respecta `Retry-After` abans 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 cos de la sol·licitud no és vàlid: falta o no es coneix `country`, no hi ha cap adreça, o s'han proporcionat tant `address` com els camps estructurats.", "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 clau d'API o no és vàlida, una clau amb abast restringit no té accés d'escriptura a `sessions`, o l'organització no pot cobrir la validació. Aquesta API mai no retorna `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" } } } } } }, "DocumentProcessingBusy": { "description": "Ara mateix s'estan processant massa documents, de manera que aquesta càrrega no s'ha processat: no s'ha emmagatzemat res i no s'ha consumit cap intent. Torna a enviar el mateix fitxer després del nombre de segons indicat a `Retry-After`. Bifurca segons `code`, no segons el text del missatge.", "headers": { "Retry-After": { "description": "Nombre de segons que cal esperar abans de tornar a enviar la mateixa sol·licitud.", "schema": { "type": "integer", "example": 10 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "detail", "code" ], "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "document_processing_busy" ] } } }, "example": { "detail": "We are busy processing documents. Please try again in a moment.", "code": "document_processing_busy" } } } } }, "parameters": { "WebhookSignature": { "name": "X-Signature", "in": "header", "required": true, "schema": { "type": "string" }, "description": "HMAC-SHA256 en hexadecimal en minúscules, amb la clau del secret de la destinació, del cos exacte de la sol·licitud sense processar." }, "WebhookSignatureV2": { "name": "X-Signature-V2", "in": "header", "required": true, "schema": { "type": "string" }, "description": "HMAC-SHA256 en hexadecimal en minúscules, amb la clau del secret de la destinació, del JSON canònic del cos (claus ordenades, sense espais en blanc, caràcters no ASCII sense escapar). Recomanat, ja que sobreviu al middleware que torna a codificar el cos." }, "WebhookSignatureSimple": { "name": "X-Signature-Simple", "in": "header", "required": true, "deprecated": true, "schema": { "type": "string" }, "description": "HMAC-SHA256 en hexadecimal en minúscules, amb la clau del secret de la destinació, de `{timestamp}:{session_id}:{status}:{webhook_type}` (els camps absents com a cadenes buides). Cobreix només el sobre, mai el payload." }, "WebhookTimestamp": { "name": "X-Timestamp", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Temps Unix en segons, igual al `timestamp` del cos. Rebutja els lliuraments amb més d'uns minuts d'antiguitat." } } }, "x-webhooks": { "status.updated": { "post": { "summary": "L'estat de la sessió ha canviat", "description": "Una sessió de verificació ha canviat d'estat. `decision` només s'envia per a `Approved`, `Declined`, `In Review` i `Abandoned`; té l'estructura de `GET /v3/session/{sessionId}/decision/` per a destinacions a la versió 3 del webhook (per defecte), i l'estructura reduïda anterior per a destinacions de la versió 1 o 2. Les sessions d'empresa sempre reben la decisió d'empresa de la versió 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": "Qualsevol resposta 2xx confirma el lliurament. La resta de respostes i els temps d'espera esgotats donen lloc a reintents; consulta https://docs.didit.me/integration/webhooks." } } } }, "data.updated": { "post": { "summary": "Dades de la sessió modificades", "description": "Les dades d'una sessió de verificació han canviat sense un canvi d'estat, per exemple després d'una edició de revisió manual, una sobreescriptura de pas o un nou cribratge de monitoratge continu. `decision` només s'envia per a `Approved`, `Declined`, `In Review` i `Abandoned`; té l'estructura de `GET /v3/session/{sessionId}/decision/` per a destinacions a la versió 3 del webhook (per defecte), i l'estructura reduïda anterior per a destinacions de versió 1 o 2. Les sessions d'empresa sempre reben la decisió d'empresa de la versió 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": "Qualsevol resposta 2xx confirma el lliurament. La resta de respostes i els temps d'espera esgotats donen lloc a reintents; consulta https://docs.didit.me/integration/webhooks." } } } }, "user.status.updated": { "post": { "summary": "S'ha canviat l'estat de l'usuari", "description": "Un usuari ha canviat d'estat. No s'envia quan es crea l'usuari.", "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": "Qualsevol resposta 2xx confirma el lliurament. La resta de respostes i els temps d'espera esgotats donen lloc a reintents; consulta https://docs.didit.me/integration/webhooks." } } } }, "user.data.updated": { "post": { "summary": "S'han modificat les dades de l'usuari", "description": "Camps d'un usuari modificats. No s'envia quan es crea l'usuari. Una sola acció de desar pot produir alhora un esdeveniment d'estat i un de dades.", "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": "Qualsevol resposta 2xx confirma el lliurament. La resta de respostes i els temps d'espera esgotats donen lloc a reintents; consulta https://docs.didit.me/integration/webhooks." } } } }, "business.status.updated": { "post": { "summary": "Estat de l'empresa modificat", "description": "Una empresa ha canviat d'estat. No s'envia quan es crea l'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": "Qualsevol resposta 2xx confirma el lliurament. La resta de respostes i els temps d'espera esgotats donen lloc a reintents; consulta https://docs.didit.me/integration/webhooks." } } } }, "business.data.updated": { "post": { "summary": "Dades de l'empresa modificades", "description": "Camps d'una empresa modificats. No s'envia quan es crea l'empresa. Una única operació de desament pot produir alhora un esdeveniment d'estat i un de dades.", "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": "Qualsevol resposta 2xx confirma el lliurament. La resta de respostes i els temps d'espera esgotats donen lloc a reintents; consulta https://docs.didit.me/integration/webhooks." } } } }, "transaction.created": { "post": { "summary": "Transacció creada", "description": "S'ha creat una transacció i s'ha sotmès a cribratge. S'envia només per a aplicacions de producció.", "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": "Qualsevol resposta 2xx confirma el lliurament. La resta de respostes i els temps d'espera esgotats donen lloc a reintents; consulta https://docs.didit.me/integration/webhooks." } } } }, "transaction.status.updated": { "post": { "summary": "L'estat de la transacció ha canviat", "description": "Una transacció ha canviat d'estat, a partir d'una regla, una revisió o una acció de l'usuari final. S'envia només per a aplicacions de producció.", "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": "Qualsevol resposta 2xx confirma el lliurament. La resta de respostes i els temps d'espera esgotats donen lloc a reintents; consulta https://docs.didit.me/integration/webhooks." } } } }, "travel_rule.status.updated": { "post": { "summary": "L'estat de Travel Rule ha canviat", "description": "Un intercanvi de Travel Rule ha canviat d'estat. S'envia en cada transició fins a `FINISHED`, `CANCELLED` o `EXPIRED` (inclosos), mai després. S'envia per a aplicacions de producció i, en el cas d'intercanvis de Travel Rule, també per a aplicacions de sandbox (`environment: sandbox`). No hi ha cap `status` de nivell 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": "Qualsevol resposta 2xx confirma el lliurament. La resta de respostes i els temps d'espera esgotats donen lloc a reintents; consulta https://docs.didit.me/integration/webhooks." } } } }, "workflow.compliance_changed": { "post": { "summary": "El compliment del flux de treball ha canviat", "description": "L'estat de compliment d'un flux de treball publicat ha canviat després d'una reavaluació. Un esdeveniment per flux de treball. No hi ha cap `status` de nivell 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": "Qualsevol resposta 2xx confirma el lliurament. La resta de respostes i els temps d'espera esgotats donen lloc a reintents; consulta https://docs.didit.me/integration/webhooks." } } } }, "kyb.registry_search.resolved": { "post": { "summary": "Cerca d'empresa resolta (callback no signat)", "description": "Cos del callback enviat a la `webhook_url` de `POST /v3/kyb/search/` un cop es resol la cerca al registre. No està signat: la sol·licitud inclou `X-Didit-Unsigned-Callback: true` i cap de les capçaleres de signatura, per la qual cosa cal confirmar-lo fent coincidir `request_id` amb una cerca que hagis iniciat. Utilitza `event_type`, no `webhook_type`.", "tags": [ "Webhook" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KYBRegistrySearchResolvedCallback" } } } }, "responses": { "2XX": { "description": "Qualsevol resposta 2xx confirma el lliurament. La resta de respostes i els temps d'espera esgotats donen lloc a reintents; consulta https://docs.didit.me/integration/webhooks." } } } }, "transaction_rule_suggestions.created": { "post": { "summary": "Suggeriments de regles de transacció creats", "description": "Una execució de suggeriments de regles de transacció ha proposat nous canvis de regles per a la teva aplicació. S'envia quan la configuració de suggeriments de regles té les notificacions per webhook activades. No hi ha cap `status` de nivell 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": "Qualsevol resposta 2xx confirma el lliurament. La resta de respostes i els temps d'espera esgotats donen lloc a reintents; consulta https://docs.didit.me/integration/webhooks." } } } } } }